#include <frodo_constants.h>

Public Member Functions
size_t	b () const

uint16_t	cdf_table_at (size_t i) const

size_t	cdf_table_len () const

size_t	d () const

FrodoDomainSeparator	encapsulation_domain_separator () const

size_t	estimated_strength () const

	FrodoKEMConstants (const FrodoKEMConstants &other)

	FrodoKEMConstants (FrodoKEMConstants &&other)=default

	FrodoKEMConstants (FrodoKEMMode mode)

FrodoDomainSeparator	keygen_domain_separator () const

size_t	len_a_bytes () const

size_t	len_ct_bytes () const

size_t	len_packed_b_bytes () const

size_t	len_packed_c_bytes () const

size_t	len_private_key_bytes () const

size_t	len_public_key_bytes () const

size_t	len_salt_bytes () const

size_t	len_se_bytes () const

size_t	len_sec_bytes () const

FrodoKEMMode	mode () const

size_t	n () const

size_t	n_bar () const

FrodoKEMConstants &	operator= (const FrodoKEMConstants &other)=delete

FrodoKEMConstants &	operator= (FrodoKEMConstants &&other)=default

XOF &	SHAKE_XOF () const

	~FrodoKEMConstants ()

Detailed Description

Definition at line 25 of file frodo_constants.h.

Constructor & Destructor Documentation

◆ FrodoKEMConstants() [1/3]

Botan::FrodoKEMConstants::FrodoKEMConstants ( FrodoKEMMode mode )

Definition at line 17 of file frodo_constants.cpp.

                                                      : m_mode(mode), m_len_a(128), m_n_bar(8) {
   if(!mode.is_available()) {
      throw Not_Implemented("FrodoKEM mode " + mode.to_string() + " is not available");
   }
 
   if(mode.is_ephemeral()) {
      m_len_salt = 0;
   }
 
   switch(mode.mode()) {
      case FrodoKEMMode::FrodoKEM640_SHAKE:
      case FrodoKEMMode::FrodoKEM640_AES:
      case FrodoKEMMode::eFrodoKEM640_SHAKE:
      case FrodoKEMMode::eFrodoKEM640_AES:
         m_nist_strength = 128;
         m_d = 15;
         m_n = 640;
         m_b = 2;
         if(mode.is_static()) {
            m_len_salt = 256;
            m_len_se = 256;
         } else if(mode.is_ephemeral()) {
            m_len_se = 128;
         } else {
            BOTAN_ASSERT_UNREACHABLE();
         }
 
         m_cdf_table = {4643, 13363, 20579, 25843, 29227, 31145, 32103, 32525, 32689, 32745, 32762, 32766, 32767};
 
         m_shake = "SHAKE-128";
         break;
 
      case FrodoKEMMode::FrodoKEM976_SHAKE:
      case FrodoKEMMode::FrodoKEM976_AES:
      case FrodoKEMMode::eFrodoKEM976_SHAKE:
      case FrodoKEMMode::eFrodoKEM976_AES:
         m_nist_strength = 192;
         m_d = 16;
         m_n = 976;
         m_b = 3;
         if(mode.is_static()) {
            m_len_salt = 384;
            m_len_se = 384;
         } else if(mode.is_ephemeral()) {
            m_len_se = 192;
         } else {
            BOTAN_ASSERT_UNREACHABLE();
         }
 
         m_cdf_table = {5638, 15915, 23689, 28571, 31116, 32217, 32613, 32731, 32760, 32766, 32767};
 
         m_shake = "SHAKE-256";
         break;
 
      case FrodoKEMMode::FrodoKEM1344_SHAKE:
      case FrodoKEMMode::FrodoKEM1344_AES:
      case FrodoKEMMode::eFrodoKEM1344_SHAKE:
      case FrodoKEMMode::eFrodoKEM1344_AES:
         m_nist_strength = 256;
         m_d = 16;
         m_n = 1344;
         m_b = 4;
         if(mode.is_static()) {
            m_len_salt = 512;
            m_len_se = 512;
         } else if(mode.is_ephemeral()) {
            m_len_se = 256;
         } else {
            BOTAN_ASSERT_UNREACHABLE();
         }
 
         m_cdf_table = {9142, 23462, 30338, 32361, 32725, 32765, 32767};
 
         m_shake = "SHAKE-256";
         break;
   }
 
   m_shake_xof = XOF::create_or_throw(m_shake);
}

References Botan::FrodoKEMMode::eFrodoKEM1344_AES, Botan::FrodoKEMMode::eFrodoKEM1344_SHAKE, Botan::FrodoKEMMode::eFrodoKEM976_AES, Botan::FrodoKEMMode::eFrodoKEM976_SHAKE, Botan::FrodoKEMMode::FrodoKEM1344_AES, Botan::FrodoKEMMode::FrodoKEM1344_SHAKE, Botan::FrodoKEMMode::FrodoKEM976_AES, Botan::FrodoKEMMode::FrodoKEM976_SHAKE, Botan::FrodoKEMMode::is_available(), Botan::FrodoKEMMode::is_ephemeral(), Botan::FrodoKEMMode::is_static(), mode(), and Botan::FrodoKEMMode::mode().

◆ ~FrodoKEMConstants()

Botan::FrodoKEMConstants::~FrodoKEMConstants ( )

default

◆ FrodoKEMConstants() [2/3]

Botan::FrodoKEMConstants::FrodoKEMConstants ( const FrodoKEMConstants & other )

inline

Definition at line 31 of file frodo_constants.h.

31: FrodoKEMConstants(other.m_mode) {}

Botan::FrodoKEMConstants::FrodoKEMConstants

FrodoKEMConstants(FrodoKEMMode mode)

Definition frodo_constants.cpp:17

◆ FrodoKEMConstants() [3/3]

Botan::FrodoKEMConstants::FrodoKEMConstants ( FrodoKEMConstants && other )

default

Member Function Documentation

◆ b()

size_t Botan::FrodoKEMConstants::b ( ) const

inline

Definition at line 47 of file frodo_constants.h.

47{ return m_b; } // extracted bits

Referenced by Botan::FrodoMatrix::decode(), and Botan::FrodoMatrix::encode().

◆ cdf_table_at()

uint16_t Botan::FrodoKEMConstants::cdf_table_at ( size_t i ) const

inline

Definition at line 41 of file frodo_constants.h.

41{ return m_cdf_table.at(i); }

Referenced by Botan::FrodoMatrix::sample().

◆ cdf_table_len()

size_t Botan::FrodoKEMConstants::cdf_table_len ( ) const

inline

Definition at line 39 of file frodo_constants.h.

39{ return m_cdf_table.size(); }

Referenced by Botan::FrodoMatrix::sample().

◆ d()

size_t Botan::FrodoKEMConstants::d ( ) const

inline

Definition at line 49 of file frodo_constants.h.

49{ return m_d; } // D = logq

Referenced by Botan::FrodoMatrix::decode(), Botan::FrodoMatrix::encode(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey(), Botan::FrodoMatrix::pack(), Botan::FrodoMatrix::packed_size(), Botan::FrodoMatrix::reduce(), and Botan::FrodoMatrix::unpack().

◆ encapsulation_domain_separator()

FrodoDomainSeparator Botan::FrodoKEMConstants::encapsulation_domain_separator ( ) const

inline

Definition at line 75 of file frodo_constants.h.

75{ return FrodoDomainSeparator({0x96}); }

Botan::FrodoDomainSeparator

Strong< std::array< uint8_t, 1 >, struct FrodoDoaminSeparator_ > FrodoDomainSeparator

Definition frodo_types.h:47

◆ estimated_strength()

size_t Botan::FrodoKEMConstants::estimated_strength ( ) const

inline

Definition at line 43 of file frodo_constants.h.

43{ return m_nist_strength; }

◆ keygen_domain_separator()

FrodoDomainSeparator Botan::FrodoKEMConstants::keygen_domain_separator ( ) const

inline

Definition at line 77 of file frodo_constants.h.

77{ return FrodoDomainSeparator({0x5F}); }

Referenced by Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey().

◆ len_a_bytes()

size_t Botan::FrodoKEMConstants::len_a_bytes ( ) const

inline

Definition at line 53 of file frodo_constants.h.

53{ return m_len_a / 8; } // len of seed_a in bytes

Referenced by Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), and Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey().

◆ len_ct_bytes()

size_t Botan::FrodoKEMConstants::len_ct_bytes ( ) const

inline

Definition at line 61 of file frodo_constants.h.

                                  {
         return (m_d * m_n * m_n_bar + m_d * m_n_bar * m_n_bar + m_len_salt) / 8;
      }  // Ciphertext length in bytes

◆ len_packed_b_bytes()

size_t Botan::FrodoKEMConstants::len_packed_b_bytes ( ) const

inline

Definition at line 71 of file frodo_constants.h.

71{ return (m_d * m_n * m_n_bar) / 8; }

◆ len_packed_c_bytes()

size_t Botan::FrodoKEMConstants::len_packed_c_bytes ( ) const

inline

Definition at line 73 of file frodo_constants.h.

73{ return (m_d * m_n_bar * m_n_bar) / 8; }

◆ len_private_key_bytes()

size_t Botan::FrodoKEMConstants::len_private_key_bytes ( ) const

inline

Definition at line 67 of file frodo_constants.h.

                                           {
         return (m_nist_strength + m_len_a + (m_d * m_n * m_n_bar) + (m_n_bar * m_n * 16) + m_nist_strength) / 8;
      }

Referenced by Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey().

◆ len_public_key_bytes()

size_t Botan::FrodoKEMConstants::len_public_key_bytes ( ) const

inline

Definition at line 65 of file frodo_constants.h.

65{ return (m_len_a + (m_d * m_n * m_n_bar)) / 8; }

Referenced by Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey().

◆ len_salt_bytes()

size_t Botan::FrodoKEMConstants::len_salt_bytes ( ) const

inline

Definition at line 59 of file frodo_constants.h.

59{ return m_len_salt / 8; }

◆ len_se_bytes()

size_t Botan::FrodoKEMConstants::len_se_bytes ( ) const

inline

Definition at line 55 of file frodo_constants.h.

55{ return m_len_se / 8; }

Referenced by Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey().

◆ len_sec_bytes()

size_t Botan::FrodoKEMConstants::len_sec_bytes ( ) const

inline

Definition at line 57 of file frodo_constants.h.

57{ return m_nist_strength / 8; }

Referenced by Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), and Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey().

◆ mode()

FrodoKEMMode Botan::FrodoKEMConstants::mode ( ) const

inline

Definition at line 37 of file frodo_constants.h.

37{ return m_mode; }

Referenced by Botan::create_aes_row_generator(), Botan::create_shake_row_generator(), and FrodoKEMConstants().

◆ n()

size_t Botan::FrodoKEMConstants::n ( ) const

inline

Definition at line 45 of file frodo_constants.h.

45{ return m_n; }

Referenced by Botan::create_aes_row_generator(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey(), Botan::FrodoMatrix::mul_add_as_plus_e(), Botan::FrodoMatrix::mul_add_sa_plus_e(), Botan::FrodoMatrix::mul_add_sb_plus_e(), and Botan::FrodoMatrix::mul_bs().

◆ n_bar()

size_t Botan::FrodoKEMConstants::n_bar ( ) const

inline

Definition at line 51 of file frodo_constants.h.

51{ return m_n_bar; }

Referenced by Botan::FrodoMatrix::add(), Botan::FrodoMatrix::decode(), Botan::FrodoMatrix::encode(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey(), Botan::FrodoMatrix::mul_add_as_plus_e(), Botan::FrodoMatrix::mul_add_sa_plus_e(), Botan::FrodoMatrix::mul_add_sb_plus_e(), Botan::FrodoMatrix::mul_bs(), and Botan::FrodoMatrix::sub().

◆ operator=() [1/2]

FrodoKEMConstants & Botan::FrodoKEMConstants::operator= ( const FrodoKEMConstants & other )

delete

◆ operator=() [2/2]

FrodoKEMConstants & Botan::FrodoKEMConstants::operator= ( FrodoKEMConstants && other )

default

◆ SHAKE_XOF()

XOF & Botan::FrodoKEMConstants::SHAKE_XOF ( ) const

Definition at line 99 of file frodo_constants.cpp.

                                        {
   m_shake_xof->clear();
   return *m_shake_xof;
}

References Botan::XOF::clear().

Referenced by Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey().

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

src/lib/pubkey/frodokem/frodokem_common/frodo_constants.h
src/lib/pubkey/frodokem/frodokem_common/frodo_constants.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrodoKEMConstants() [1/3]

◆ ~FrodoKEMConstants()

◆ FrodoKEMConstants() [2/3]

◆ FrodoKEMConstants() [3/3]

Member Function Documentation

◆ b()

◆ cdf_table_at()

◆ cdf_table_len()

◆ d()

◆ encapsulation_domain_separator()

◆ estimated_strength()

◆ keygen_domain_separator()

◆ len_a_bytes()

◆ len_ct_bytes()

◆ len_packed_b_bytes()

◆ len_packed_c_bytes()

◆ len_private_key_bytes()

◆ len_public_key_bytes()

◆ len_salt_bytes()

◆ len_se_bytes()

◆ len_sec_bytes()

◆ mode()

◆ n()

◆ n_bar()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SHAKE_XOF()