Botan::DilithiumMode Class Reference

#include <dilithium.h>

Public Types
enum	Mode {   Dilithium4x4 = 1 , Dilithium4x4_AES , Dilithium6x5 , Dilithium6x5_AES ,   Dilithium8x7 , Dilithium8x7_AES }

Public Member Functions
	DilithiumMode (const OID &oid)
	DilithiumMode (Mode mode)
	DilithiumMode (std::string_view str)
bool	is_aes () const
bool	is_modern () const
Mode	mode () const
OID	object_identifier () const
std::string	to_string () const

Detailed Description

Definition at line 21 of file dilithium.h.

Member Enumeration Documentation

Mode

enum Botan::DilithiumMode::Mode

Enumerator
Dilithium4x4
Dilithium4x4_AES
Dilithium6x5
Dilithium6x5_AES
Dilithium8x7
Dilithium8x7_AES

Definition at line 23 of file dilithium.h.

{ Dilithium4x4 = 1, Dilithium4x4_AES, Dilithium6x5, Dilithium6x5_AES, Dilithium8x7, Dilithium8x7_AES };

Constructor & Destructor Documentation

DilithiumMode() [1/3]

Botan::DilithiumMode::DilithiumMode ( Mode mode )

inline

Definition at line 26 of file dilithium.h.

: m_mode(mode) {}

DilithiumMode() [2/3]

Botan::DilithiumMode::DilithiumMode ( const OID & oid )

explicit

Definition at line 88 of file dilithium.cpp.

: m_mode(dilithium_mode_from_string(oid.to_formatted_string())) {}

DilithiumMode() [3/3]

Botan::DilithiumMode::DilithiumMode ( std::string_view str )

explicit

Definition at line 90 of file dilithium.cpp.

: m_mode(dilithium_mode_from_string(str)) {}

Member Function Documentation

is_aes()

bool Botan::DilithiumMode::is_aes ( ) const

inline

Definition at line 34 of file dilithium.h.

                          {
         return m_mode == Dilithium4x4_AES || m_mode == Dilithium6x5_AES || m_mode == Dilithium8x7_AES;
      }

Referenced by Botan::Dilithium_Symmetric_Primitives::create().

is_modern()

bool Botan::DilithiumMode::is_modern ( ) const

inline

Definition at line 38 of file dilithium.h.

{ return !is_aes(); }

Referenced by Botan::Dilithium_Symmetric_Primitives::create(), and Botan::DilithiumModeConstants::DilithiumModeConstants().

mode()

Mode Botan::DilithiumMode::mode ( ) const

inline

Definition at line 40 of file dilithium.h.

{ return m_mode; }

Referenced by Botan::DilithiumModeConstants::DilithiumModeConstants().

object_identifier()

OID Botan::DilithiumMode::object_identifier

(

)

const

Definition at line 92 of file dilithium.cpp.

                                           {
   return OID::from_string(to_string());
}

References Botan::OID::from_string(), and to_string().

Referenced by Botan::DilithiumModeConstants::oid().

to_string()

std::string Botan::DilithiumMode::to_string

(

)

const

Definition at line 96 of file dilithium.cpp.

                                         {
   switch(m_mode) {
      case DilithiumMode::Dilithium4x4:
         return "Dilithium-4x4-r3";
      case DilithiumMode::Dilithium4x4_AES:
         return "Dilithium-4x4-AES-r3";
      case DilithiumMode::Dilithium6x5:
         return "Dilithium-6x5-r3";
      case DilithiumMode::Dilithium6x5_AES:
         return "Dilithium-6x5-AES-r3";
      case DilithiumMode::Dilithium8x7:
         return "Dilithium-8x7-r3";
      case DilithiumMode::Dilithium8x7_AES:
         return "Dilithium-8x7-AES-r3";
   }
 
   BOTAN_ASSERT_UNREACHABLE();
}

References BOTAN_ASSERT_UNREACHABLE, Dilithium4x4, Dilithium4x4_AES, Dilithium6x5, Dilithium6x5_AES, Dilithium8x7, and Dilithium8x7_AES.

Referenced by object_identifier().

---

The documentation for this class was generated from the following files:

• src/lib/pubkey/dilithium/dilithium_common/dilithium.h
• src/lib/pubkey/dilithium/dilithium_common/dilithium.cpp