Botan 3.14.1
Crypto and TLS for C&
Botan::KyberMode Class Referencefinal

#include <kyber.h>

Public Types

enum  Mode : uint8_t {
  Kyber512_R3 = 0 , Kyber768_R3 = 1 , Kyber1024_R3 = 2 , Kyber512 = 0 ,
  Kyber768 = 1 , Kyber1024 = 2 , ML_KEM_512 = 3 , ML_KEM_768 = 4 ,
  ML_KEM_1024 = 5 , Kyber512_90s = 6 , Kyber768_90s = 7 , Kyber1024_90s = 8
}

Public Member Functions

bool is_90s () const
bool is_available () const
bool is_kyber_round3 () const
bool is_ml_kem () const
bool is_modern () const
 KyberMode (const OID &oid)
 KyberMode (Mode mode)
 KyberMode (std::string_view str)
Mode mode () const
OID object_identifier () const
bool operator!= (const KyberMode &other) const
bool operator== (const KyberMode &other) const
std::string to_string () const

Detailed Description

Definition at line 29 of file kyber.h.

Member Enumeration Documentation

◆ Mode

enum Botan::KyberMode::Mode : uint8_t
Enumerator
Kyber512_R3 
Kyber768_R3 
Kyber1024_R3 
Kyber512 
Kyber768 
Kyber1024 
ML_KEM_512 
ML_KEM_768 
ML_KEM_1024 
Kyber512_90s 
Kyber768_90s 
Kyber1024_90s 

Definition at line 31 of file kyber.h.

31 : uint8_t /* NOLINT(*-use-enum-class) */ {
32 // Kyber512 as proposed in round 3 of the NIST competition
33 Kyber512_R3 BOTAN_DEPRECATED("Kyber R3 is deprecated - use ML-KEM") = 0,
34 // Kyber768 as proposed in round 3 of the NIST competition
35 Kyber768_R3 BOTAN_DEPRECATED("Kyber R3 is deprecated - use ML-KEM") = 1,
36 // Kyber1024 as proposed in round 3 of the NIST competition
37 Kyber1024_R3 BOTAN_DEPRECATED("Kyber R3 is deprecated - use ML-KEM") = 2,
38
39 Kyber512 BOTAN_DEPRECATED("Kyber R3 is deprecated - use ML-KEM") = 0,
40 Kyber768 BOTAN_DEPRECATED("Kyber R3 is deprecated - use ML-KEM") = 1,
41 Kyber1024 BOTAN_DEPRECATED("Kyber R3 is deprecated - use ML-KEM") = 2,
42
43 ML_KEM_512 = 3,
44 ML_KEM_768 = 4,
45 ML_KEM_1024 = 5,
46
47 Kyber512_90s BOTAN_DEPRECATED("Kyber 90s mode is deprecated") = 6,
48 Kyber768_90s BOTAN_DEPRECATED("Kyber 90s mode is deprecated") = 7,
49 Kyber1024_90s BOTAN_DEPRECATED("Kyber 90s mode is deprecated") = 8,
50 };
#define BOTAN_DEPRECATED(msg)
Definition api.h:73

Constructor & Destructor Documentation

◆ KyberMode() [1/3]

Botan::KyberMode::KyberMode ( Mode mode)

Definition at line 85 of file kyber.cpp.

85: m_mode(mode) {}
Mode mode() const
Definition kyber.h:61

References mode().

Referenced by operator!=(), and operator==().

◆ KyberMode() [2/3]

Botan::KyberMode::KyberMode ( const OID & oid)
explicit

Definition at line 87 of file kyber.cpp.

87: m_mode(kyber_mode_from_oid(oid)) {}

◆ KyberMode() [3/3]

Botan::KyberMode::KyberMode ( std::string_view str)
explicit

Definition at line 89 of file kyber.cpp.

89: m_mode(kyber_mode_from_string(str)) {}

Member Function Documentation

◆ is_90s()

bool Botan::KyberMode::is_90s ( ) const

Definition at line 120 of file kyber.cpp.

120 {
121 return m_mode == Kyber512_90s || m_mode == Kyber768_90s || m_mode == Kyber1024_90s;
122}

References Kyber1024_90s, Kyber512_90s, and Kyber768_90s.

Referenced by is_available(), and is_modern().

◆ is_available()

bool Botan::KyberMode::is_available ( ) const

Definition at line 137 of file kyber.cpp.

137 {
138#if defined(BOTAN_HAS_KYBER)
139 if(is_kyber_round3() && is_modern()) {
140 return true;
141 }
142#endif
143
144#if defined(BOTAN_HAS_KYBER_90S)
145 if(is_kyber_round3() && is_90s()) {
146 return true;
147 }
148#endif
149
150#if defined(BOTAN_HAS_ML_KEM)
151 if(is_ml_kem()) {
152 return true;
153 }
154#endif
155
156 return false;
157}
bool is_kyber_round3() const
Definition kyber.cpp:132
bool is_modern() const
Definition kyber.cpp:124
bool is_90s() const
Definition kyber.cpp:120
bool is_ml_kem() const
Definition kyber.cpp:128

References is_90s(), is_kyber_round3(), is_ml_kem(), and is_modern().

◆ is_kyber_round3()

bool Botan::KyberMode::is_kyber_round3 ( ) const

Definition at line 132 of file kyber.cpp.

132 {
133 return m_mode == KyberMode::Kyber512_R3 || m_mode == KyberMode::Kyber768_R3 || m_mode == KyberMode::Kyber1024_R3 ||
135}

References Kyber1024_90s, Kyber1024_R3, Kyber512_90s, Kyber512_R3, Kyber768_90s, and Kyber768_R3.

Referenced by is_available().

◆ is_ml_kem()

bool Botan::KyberMode::is_ml_kem ( ) const

Definition at line 128 of file kyber.cpp.

128 {
129 return m_mode == KyberMode::ML_KEM_512 || m_mode == KyberMode::ML_KEM_768 || m_mode == KyberMode::ML_KEM_1024;
130}

References ML_KEM_1024, ML_KEM_512, and ML_KEM_768.

Referenced by Botan::Kyber_PublicKey::algo_name(), Botan::decode_ml_kem_private_key(), and is_available().

◆ is_modern()

bool Botan::KyberMode::is_modern ( ) const

Definition at line 124 of file kyber.cpp.

124 {
125 return !is_90s();
126}

References is_90s().

Referenced by is_available().

◆ mode()

Mode Botan::KyberMode::mode ( ) const
inline

Definition at line 61 of file kyber.h.

61{ return m_mode; }

Referenced by KyberMode().

◆ object_identifier()

OID Botan::KyberMode::object_identifier ( ) const

Definition at line 91 of file kyber.cpp.

91 {
93}
std::string to_string() const
Definition kyber.cpp:95
static OID from_string(std::string_view str)
Definition asn1_oid.cpp:80

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

Referenced by Botan::Kyber_PublicKey::object_identifier().

◆ operator!=()

bool Botan::KyberMode::operator!= ( const KyberMode & other) const
inline

Definition at line 75 of file kyber.h.

75{ return !(*this == other); }

References KyberMode().

◆ operator==()

bool Botan::KyberMode::operator== ( const KyberMode & other) const
inline

Definition at line 73 of file kyber.h.

73{ return m_mode == other.m_mode; }

References KyberMode().

◆ to_string()

std::string Botan::KyberMode::to_string ( ) const

Definition at line 95 of file kyber.cpp.

95 {
96 switch(m_mode) {
97 case Kyber512_90s:
98 return "Kyber-512-90s-r3";
99 case Kyber768_90s:
100 return "Kyber-768-90s-r3";
101 case Kyber1024_90s:
102 return "Kyber-1024-90s-r3";
103 case Kyber512_R3:
104 return "Kyber-512-r3";
105 case Kyber768_R3:
106 return "Kyber-768-r3";
107 case Kyber1024_R3:
108 return "Kyber-1024-r3";
109 case ML_KEM_512:
110 return "ML-KEM-512";
111 case ML_KEM_768:
112 return "ML-KEM-768";
113 case ML_KEM_1024:
114 return "ML-KEM-1024";
115 }
116
118}
#define BOTAN_ASSERT_UNREACHABLE()
Definition assert.h:173

References BOTAN_ASSERT_UNREACHABLE, Kyber1024_90s, Kyber1024_R3, Kyber512_90s, Kyber512_R3, Kyber768_90s, Kyber768_R3, ML_KEM_1024, ML_KEM_512, and ML_KEM_768.

Referenced by object_identifier().


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