Botan 3.9.0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::TLS::Group_Params Class Referencefinal

#include <tls_algos.h>

Public Member Functions

constexpr Group_Params_Code code () const
constexpr Group_Params ()
constexpr Group_Params (Group_Params_Code code)
constexpr Group_Params (uint16_t code)
bool is_available () const
constexpr bool is_dh_named_group () const
constexpr bool is_ecdh_named_curve () const
constexpr bool is_in_ffdhe_range () const
constexpr bool is_kem () const
constexpr bool is_post_quantum () const
constexpr bool is_pqc_hybrid () const
constexpr bool is_pqc_hybrid_frodokem () const
constexpr bool is_pqc_hybrid_ml_kem () const
constexpr bool is_pure_ecc_group () const
constexpr bool is_pure_frodokem () const
constexpr bool is_pure_ml_kem () const
constexpr bool is_x25519 () const
constexpr bool is_x448 () const
constexpr bool operator< (Group_Params other) const
constexpr bool operator== (Group_Params other) const
constexpr bool operator== (Group_Params_Code code) const
std::optional< Group_Params_Code > pqc_hybrid_ecc () const
std::optional< std::string > to_string () const
constexpr uint16_t wire_code () const

Static Public Member Functions

static std::optional< Group_Params > from_string (std::string_view group_name)

Detailed Description

Definition at line 140 of file tls_algos.h.

Constructor & Destructor Documentation

◆ Group_Params() [1/3]

Botan::TLS::Group_Params::Group_Params ( )
inlineconstexpr

Definition at line 144 of file tls_algos.h.

144: m_code(Group_Params_Code::NONE) {}

References Botan::TLS::NONE.

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

◆ Group_Params() [2/3]

Botan::TLS::Group_Params::Group_Params ( Group_Params_Code code)
inlineconstexpr

Definition at line 147 of file tls_algos.h.

147: m_code(code) {}
Botan::TLS::Group_Params::code
constexpr Group_Params_Code code() const
Definition tls_algos.h:163

References code().

◆ Group_Params() [3/3]

Botan::TLS::Group_Params::Group_Params ( uint16_t code)
inlineconstexpr

Definition at line 150 of file tls_algos.h.

150: m_code(static_cast<Group_Params_Code>(code)) {}

References code().

Member Function Documentation

◆ code()

Group_Params_Code Botan::TLS::Group_Params::code ( ) const
inlineconstexpr

Definition at line 163 of file tls_algos.h.

163{ return m_code; }

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

◆ from_string()

std::optional< Group_Params > Botan::TLS::Group_Params::from_string ( std::string_view group_name)
static
Returns
std::nullopt if an unknown name

Definition at line 208 of file tls_algos.cpp.

208 {
209 if(group_name == "secp256r1") {
210 return Group_Params::SECP256R1;
211 }
212 if(group_name == "secp384r1") {
213 return Group_Params::SECP384R1;
214 }
215 if(group_name == "secp521r1") {
216 return Group_Params::SECP521R1;
217 }
218 if(group_name == "brainpool256r1") {
219 return Group_Params::BRAINPOOL256R1;
220 }
221 if(group_name == "brainpool384r1") {
222 return Group_Params::BRAINPOOL384R1;
223 }
224 if(group_name == "brainpool512r1") {
225 return Group_Params::BRAINPOOL512R1;
226 }
227 if(group_name == "x25519") {
228 return Group_Params::X25519;
229 }
230 if(group_name == "x448") {
231 return Group_Params::X448;
232 }
233
234 if(group_name == "ffdhe/ietf/2048") {
235 return Group_Params::FFDHE_2048;
236 }
237 if(group_name == "ffdhe/ietf/3072") {
238 return Group_Params::FFDHE_3072;
239 }
240 if(group_name == "ffdhe/ietf/4096") {
241 return Group_Params::FFDHE_4096;
242 }
243 if(group_name == "ffdhe/ietf/6144") {
244 return Group_Params::FFDHE_6144;
245 }
246 if(group_name == "ffdhe/ietf/8192") {
247 return Group_Params::FFDHE_8192;
248 }
249
250 if(group_name == "ML-KEM-512") {
251 return Group_Params::ML_KEM_512;
252 }
253 if(group_name == "ML-KEM-768") {
254 return Group_Params::ML_KEM_768;
255 }
256 if(group_name == "ML-KEM-1024") {
257 return Group_Params::ML_KEM_1024;
258 }
259
260 if(group_name == "eFrodoKEM-640-SHAKE") {
261 return Group_Params::eFRODOKEM_640_SHAKE_OQS;
262 }
263 if(group_name == "eFrodoKEM-976-SHAKE") {
264 return Group_Params::eFRODOKEM_976_SHAKE_OQS;
265 }
266 if(group_name == "eFrodoKEM-1344-SHAKE") {
267 return Group_Params::eFRODOKEM_1344_SHAKE_OQS;
268 }
269 if(group_name == "eFrodoKEM-640-AES") {
270 return Group_Params::eFRODOKEM_640_AES_OQS;
271 }
272 if(group_name == "eFrodoKEM-976-AES") {
273 return Group_Params::eFRODOKEM_976_AES_OQS;
274 }
275 if(group_name == "eFrodoKEM-1344-AES") {
276 return Group_Params::eFRODOKEM_1344_AES_OQS;
277 }
278
279 if(group_name == "x25519/ML-KEM-768") {
280 return Group_Params::HYBRID_X25519_ML_KEM_768;
281 }
282 if(group_name == "secp256r1/ML-KEM-768") {
283 return Group_Params::HYBRID_SECP256R1_ML_KEM_768;
284 }
285 if(group_name == "secp384r1/ML-KEM-1024") {
286 return Group_Params::HYBRID_SECP384R1_ML_KEM_1024;
287 }
288
289 if(group_name == "x25519/eFrodoKEM-640-SHAKE") {
290 return Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS;
291 }
292 if(group_name == "x25519/eFrodoKEM-640-AES") {
293 return Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS;
294 }
295 if(group_name == "x448/eFrodoKEM-976-SHAKE") {
296 return Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS;
297 }
298 if(group_name == "x448/eFrodoKEM-976-AES") {
299 return Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS;
300 }
301
302 if(group_name == "secp256r1/eFrodoKEM-640-SHAKE") {
303 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS;
304 }
305 if(group_name == "secp256r1/eFrodoKEM-640-AES") {
306 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS;
307 }
308
309 if(group_name == "secp384r1/eFrodoKEM-976-SHAKE") {
310 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS;
311 }
312 if(group_name == "secp384r1/eFrodoKEM-976-AES") {
313 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS;
314 }
315
316 if(group_name == "secp521r1/eFrodoKEM-1344-SHAKE") {
317 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS;
318 }
319 if(group_name == "secp521r1/eFrodoKEM-1344-AES") {
320 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
321 }
322
323 return std::nullopt;
324}

Referenced by Botan::TLS::Text_Policy::read_group_list().

◆ is_available()

bool Botan::TLS::Group_Params::is_available ( ) const

Returns false if this group/KEX is not available in the build configuration

Definition at line 137 of file tls_algos.cpp.

137 {
138#if !defined(BOTAN_HAS_X25519)
139 if(is_x25519()) {
140 return false;
141 }
142 if(is_pqc_hybrid() && pqc_hybrid_ecc() == Group_Params_Code::X25519) {
143 return false;
144 }
145#endif
146
147#if !defined(BOTAN_HAS_X448)
148 if(is_x448()) {
149 return false;
150 }
151 if(is_pqc_hybrid() && pqc_hybrid_ecc() == Group_Params_Code::X448) {
152 return false;
153 }
154#endif
155
156#if !defined(BOTAN_HAS_DIFFIE_HELLMAN)
157 if(is_in_ffdhe_range()) {
158 return false;
159 }
160#endif
161
162#if !defined(BOTAN_HAS_ML_KEM)
163 if(is_pure_ml_kem() || is_pqc_hybrid_ml_kem()) {
164 return false;
165 }
166#endif
167
168#if !defined(BOTAN_HAS_FRODOKEM)
169 if(is_pure_frodokem() || is_pqc_hybrid_frodokem()) {
170 return false;
171 }
172#endif
173
174 return true;
175}
Botan::TLS::Group_Params::is_in_ffdhe_range
constexpr bool is_in_ffdhe_range() const
Definition tls_algos.h:182
Botan::TLS::Group_Params::is_pqc_hybrid
constexpr bool is_pqc_hybrid() const
Definition tls_algos.h:237
Botan::TLS::Group_Params::is_pure_frodokem
constexpr bool is_pure_frodokem() const
Definition tls_algos.h:198
Botan::TLS::Group_Params::pqc_hybrid_ecc
std::optional< Group_Params_Code > pqc_hybrid_ecc() const
Definition tls_algos.cpp:177
Botan::TLS::Group_Params::is_pqc_hybrid_frodokem
constexpr bool is_pqc_hybrid_frodokem() const
Definition tls_algos.h:224
Botan::TLS::Group_Params::is_pure_ml_kem
constexpr bool is_pure_ml_kem() const
Definition tls_algos.h:193
Botan::TLS::Group_Params::is_pqc_hybrid_ml_kem
constexpr bool is_pqc_hybrid_ml_kem() const
Definition tls_algos.h:218
Botan::TLS::Group_Params::is_x448
constexpr bool is_x448() const
Definition tls_algos.h:174
Botan::TLS::Group_Params::is_x25519
constexpr bool is_x25519() const
Definition tls_algos.h:172

References is_in_ffdhe_range(), is_pqc_hybrid(), is_pqc_hybrid_frodokem(), is_pqc_hybrid_ml_kem(), is_pure_frodokem(), is_pure_ml_kem(), is_x25519(), is_x448(), pqc_hybrid_ecc(), Botan::TLS::X25519, and Botan::TLS::X448.

Referenced by Botan::TLS::Text_Policy::read_group_list().

◆ is_dh_named_group()

bool Botan::TLS::Group_Params::is_dh_named_group ( ) const
inlineconstexpr

Definition at line 187 of file tls_algos.h.

187 {
188 return m_code == Group_Params_Code::FFDHE_2048 || m_code == Group_Params_Code::FFDHE_3072 ||
189 m_code == Group_Params_Code::FFDHE_4096 || m_code == Group_Params_Code::FFDHE_6144 ||
190 m_code == Group_Params_Code::FFDHE_8192;
191 }

References Botan::TLS::FFDHE_2048, Botan::TLS::FFDHE_3072, Botan::TLS::FFDHE_4096, Botan::TLS::FFDHE_6144, and Botan::TLS::FFDHE_8192.

◆ is_ecdh_named_curve()

bool Botan::TLS::Group_Params::is_ecdh_named_curve ( ) const
inlineconstexpr

Definition at line 176 of file tls_algos.h.

176 {
177 return m_code == Group_Params_Code::SECP256R1 || m_code == Group_Params_Code::SECP384R1 ||
178 m_code == Group_Params_Code::SECP521R1 || m_code == Group_Params_Code::BRAINPOOL256R1 ||
179 m_code == Group_Params_Code::BRAINPOOL384R1 || m_code == Group_Params_Code::BRAINPOOL512R1;
180 }

References Botan::TLS::BRAINPOOL256R1, Botan::TLS::BRAINPOOL384R1, Botan::TLS::BRAINPOOL512R1, Botan::TLS::SECP256R1, Botan::TLS::SECP384R1, and Botan::TLS::SECP521R1.

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), and is_pure_ecc_group().

◆ is_in_ffdhe_range()

bool Botan::TLS::Group_Params::is_in_ffdhe_range ( ) const
inlineconstexpr

Definition at line 182 of file tls_algos.h.

182 {
183 // See RFC 7919
184 return wire_code() >= 256 && wire_code() < 512;
185 }
Botan::TLS::Group_Params::wire_code
constexpr uint16_t wire_code() const
Definition tls_algos.h:165

References wire_code().

Referenced by is_available().

◆ is_kem()

bool Botan::TLS::Group_Params::is_kem ( ) const
inlineconstexpr

Definition at line 239 of file tls_algos.h.

239 {
240 BOTAN_DIAGNOSTIC_PUSH
241 BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
242
243 return is_pure_ml_kem() || is_pure_frodokem() || is_pqc_hybrid();
244
245 BOTAN_DIAGNOSTIC_POP
246 }
BOTAN_DIAGNOSTIC_POP
#define BOTAN_DIAGNOSTIC_POP
Definition api.h:122
BOTAN_DIAGNOSTIC_PUSH
#define BOTAN_DIAGNOSTIC_PUSH
Definition api.h:119
BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
#define BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
Definition api.h:120

References BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS, BOTAN_DIAGNOSTIC_POP, BOTAN_DIAGNOSTIC_PUSH, is_pqc_hybrid(), is_pure_frodokem(), and is_pure_ml_kem().

Referenced by Botan::TLS::Callbacks::tls_kem_decapsulate(), and Botan::TLS::Callbacks::tls_kem_encapsulate().

◆ is_post_quantum()

bool Botan::TLS::Group_Params::is_post_quantum ( ) const
inlineconstexpr

Definition at line 209 of file tls_algos.h.

209 {
210 BOTAN_DIAGNOSTIC_PUSH
211 BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
212
213 return is_pure_ml_kem() || is_pure_frodokem() || is_pqc_hybrid();
214
215 BOTAN_DIAGNOSTIC_POP
216 }

References BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS, BOTAN_DIAGNOSTIC_POP, BOTAN_DIAGNOSTIC_PUSH, is_pqc_hybrid(), is_pure_frodokem(), and is_pure_ml_kem().

◆ is_pqc_hybrid()

bool Botan::TLS::Group_Params::is_pqc_hybrid ( ) const
inlineconstexpr

Definition at line 237 of file tls_algos.h.

237{ return is_pqc_hybrid_ml_kem() || is_pqc_hybrid_frodokem(); }

References is_pqc_hybrid_frodokem(), and is_pqc_hybrid_ml_kem().

Referenced by is_available(), is_kem(), is_post_quantum(), and Botan::TLS::Callbacks::tls_kem_generate_key().

◆ is_pqc_hybrid_frodokem()

bool Botan::TLS::Group_Params::is_pqc_hybrid_frodokem ( ) const
inlineconstexpr

Definition at line 224 of file tls_algos.h.

224 {
225 return m_code == Group_Params_Code::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS ||
226 m_code == Group_Params_Code::HYBRID_X25519_eFRODOKEM_640_AES_OQS ||
227 m_code == Group_Params_Code::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS ||
228 m_code == Group_Params_Code::HYBRID_X448_eFRODOKEM_976_AES_OQS ||
229 m_code == Group_Params_Code::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS ||
230 m_code == Group_Params_Code::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS ||
231 m_code == Group_Params_Code::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS ||
232 m_code == Group_Params_Code::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS ||
233 m_code == Group_Params_Code::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS ||
234 m_code == Group_Params_Code::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
235 }

References Botan::TLS::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS, Botan::TLS::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS, Botan::TLS::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS, Botan::TLS::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS, Botan::TLS::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS, Botan::TLS::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS, Botan::TLS::HYBRID_X25519_eFRODOKEM_640_AES_OQS, Botan::TLS::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS, Botan::TLS::HYBRID_X448_eFRODOKEM_976_AES_OQS, and Botan::TLS::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS.

Referenced by is_available(), and is_pqc_hybrid().

◆ is_pqc_hybrid_ml_kem()

bool Botan::TLS::Group_Params::is_pqc_hybrid_ml_kem ( ) const
inlineconstexpr

Definition at line 218 of file tls_algos.h.

218 {
219 return m_code == Group_Params_Code::HYBRID_SECP256R1_ML_KEM_768 ||
220 m_code == Group_Params_Code::HYBRID_SECP384R1_ML_KEM_1024 ||
221 m_code == Group_Params_Code::HYBRID_X25519_ML_KEM_768;
222 }

References Botan::TLS::HYBRID_SECP256R1_ML_KEM_768, Botan::TLS::HYBRID_SECP384R1_ML_KEM_1024, and Botan::TLS::HYBRID_X25519_ML_KEM_768.

Referenced by is_available(), and is_pqc_hybrid().

◆ is_pure_ecc_group()

bool Botan::TLS::Group_Params::is_pure_ecc_group ( ) const
inlineconstexpr

Definition at line 207 of file tls_algos.h.

207{ return is_x25519() || is_x448() || is_ecdh_named_curve(); }
Botan::TLS::Group_Params::is_ecdh_named_curve
constexpr bool is_ecdh_named_curve() const
Definition tls_algos.h:176

References is_ecdh_named_curve(), is_x25519(), and is_x448().

◆ is_pure_frodokem()

bool Botan::TLS::Group_Params::is_pure_frodokem ( ) const
inlineconstexpr

Definition at line 198 of file tls_algos.h.

198 {
199 return m_code == Group_Params_Code::eFRODOKEM_640_SHAKE_OQS ||
200 m_code == Group_Params_Code::eFRODOKEM_976_SHAKE_OQS ||
201 m_code == Group_Params_Code::eFRODOKEM_1344_SHAKE_OQS ||
202 m_code == Group_Params_Code::eFRODOKEM_640_AES_OQS ||
203 m_code == Group_Params_Code::eFRODOKEM_976_AES_OQS ||
204 m_code == Group_Params_Code::eFRODOKEM_1344_AES_OQS;
205 }

References Botan::TLS::eFRODOKEM_1344_AES_OQS, Botan::TLS::eFRODOKEM_1344_SHAKE_OQS, Botan::TLS::eFRODOKEM_640_AES_OQS, Botan::TLS::eFRODOKEM_640_SHAKE_OQS, Botan::TLS::eFRODOKEM_976_AES_OQS, and Botan::TLS::eFRODOKEM_976_SHAKE_OQS.

Referenced by is_available(), is_kem(), is_post_quantum(), and Botan::TLS::Callbacks::tls_kem_generate_key().

◆ is_pure_ml_kem()

bool Botan::TLS::Group_Params::is_pure_ml_kem ( ) const
inlineconstexpr

Definition at line 193 of file tls_algos.h.

193 {
194 return m_code == Group_Params_Code::ML_KEM_512 || m_code == Group_Params_Code::ML_KEM_768 ||
195 m_code == Group_Params_Code::ML_KEM_1024;
196 }

References Botan::TLS::ML_KEM_1024, Botan::TLS::ML_KEM_512, and Botan::TLS::ML_KEM_768.

Referenced by is_available(), is_kem(), is_post_quantum(), and Botan::TLS::Callbacks::tls_kem_generate_key().

◆ is_x25519()

bool Botan::TLS::Group_Params::is_x25519 ( ) const
inlineconstexpr

Definition at line 172 of file tls_algos.h.

172{ return m_code == Group_Params_Code::X25519; }

References Botan::TLS::X25519.

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), is_available(), and is_pure_ecc_group().

◆ is_x448()

bool Botan::TLS::Group_Params::is_x448 ( ) const
inlineconstexpr

Definition at line 174 of file tls_algos.h.

174{ return m_code == Group_Params_Code::X448; }

References Botan::TLS::X448.

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), is_available(), and is_pure_ecc_group().

◆ operator<()

bool Botan::TLS::Group_Params::operator< ( Group_Params other) const
inlineconstexpr

Definition at line 161 of file tls_algos.h.

161{ return m_code < other.m_code; }

References Group_Params().

◆ operator==() [1/2]

bool Botan::TLS::Group_Params::operator== ( Group_Params other) const
inlineconstexpr

Definition at line 159 of file tls_algos.h.

159{ return m_code == other.m_code; }

References Group_Params().

◆ operator==() [2/2]

bool Botan::TLS::Group_Params::operator== ( Group_Params_Code code) const
inlineconstexpr

Definition at line 157 of file tls_algos.h.

157{ return m_code == code; }

References code().

◆ pqc_hybrid_ecc()

std::optional< Group_Params_Code > Botan::TLS::Group_Params::pqc_hybrid_ecc ( ) const

Definition at line 177 of file tls_algos.cpp.

177 {
178 switch(m_code) {
179 case Group_Params_Code::HYBRID_X25519_ML_KEM_768:
180
181 case Group_Params_Code::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS:
182 case Group_Params_Code::HYBRID_X25519_eFRODOKEM_640_AES_OQS:
183 return Group_Params_Code::X25519;
184
185 case Group_Params_Code::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS:
186 case Group_Params_Code::HYBRID_X448_eFRODOKEM_976_AES_OQS:
187 return Group_Params_Code::X448;
188
189 case Group_Params_Code::HYBRID_SECP256R1_ML_KEM_768:
190 case Group_Params_Code::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS:
191 case Group_Params_Code::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS:
192 return Group_Params_Code::SECP256R1;
193
194 case Group_Params_Code::HYBRID_SECP384R1_ML_KEM_1024:
195 case Group_Params_Code::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS:
196 case Group_Params_Code::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS:
197 return Group_Params_Code::SECP384R1;
198
199 case Group_Params_Code::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS:
200 case Group_Params_Code::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS:
201 return Group_Params_Code::SECP521R1;
202
203 default:
204 return {};
205 }
206}

References Botan::TLS::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS, Botan::TLS::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS, Botan::TLS::HYBRID_SECP256R1_ML_KEM_768, Botan::TLS::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS, Botan::TLS::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS, Botan::TLS::HYBRID_SECP384R1_ML_KEM_1024, Botan::TLS::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS, Botan::TLS::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS, Botan::TLS::HYBRID_X25519_eFRODOKEM_640_AES_OQS, Botan::TLS::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS, Botan::TLS::HYBRID_X25519_ML_KEM_768, Botan::TLS::HYBRID_X448_eFRODOKEM_976_AES_OQS, Botan::TLS::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS, Botan::TLS::SECP256R1, Botan::TLS::SECP384R1, Botan::TLS::SECP521R1, Botan::TLS::X25519, and Botan::TLS::X448.

Referenced by is_available().

◆ to_string()

std::optional< std::string > Botan::TLS::Group_Params::to_string ( ) const

Definition at line 326 of file tls_algos.cpp.

326 {
327 switch(m_code) {
328 case Group_Params::SECP256R1:
329 return "secp256r1";
330 case Group_Params::SECP384R1:
331 return "secp384r1";
332 case Group_Params::SECP521R1:
333 return "secp521r1";
334 case Group_Params::BRAINPOOL256R1:
335 return "brainpool256r1";
336 case Group_Params::BRAINPOOL384R1:
337 return "brainpool384r1";
338 case Group_Params::BRAINPOOL512R1:
339 return "brainpool512r1";
340 case Group_Params::X25519:
341 return "x25519";
342 case Group_Params::X448:
343 return "x448";
344
345 case Group_Params::FFDHE_2048:
346 return "ffdhe/ietf/2048";
347 case Group_Params::FFDHE_3072:
348 return "ffdhe/ietf/3072";
349 case Group_Params::FFDHE_4096:
350 return "ffdhe/ietf/4096";
351 case Group_Params::FFDHE_6144:
352 return "ffdhe/ietf/6144";
353 case Group_Params::FFDHE_8192:
354 return "ffdhe/ietf/8192";
355
356 case Group_Params::ML_KEM_512:
357 return "ML-KEM-512";
358 case Group_Params::ML_KEM_768:
359 return "ML-KEM-768";
360 case Group_Params::ML_KEM_1024:
361 return "ML-KEM-1024";
362
363 case Group_Params::eFRODOKEM_640_SHAKE_OQS:
364 return "eFrodoKEM-640-SHAKE";
365 case Group_Params::eFRODOKEM_976_SHAKE_OQS:
366 return "eFrodoKEM-976-SHAKE";
367 case Group_Params::eFRODOKEM_1344_SHAKE_OQS:
368 return "eFrodoKEM-1344-SHAKE";
369 case Group_Params::eFRODOKEM_640_AES_OQS:
370 return "eFrodoKEM-640-AES";
371 case Group_Params::eFRODOKEM_976_AES_OQS:
372 return "eFrodoKEM-976-AES";
373 case Group_Params::eFRODOKEM_1344_AES_OQS:
374 return "eFrodoKEM-1344-AES";
375
376 case Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS:
377 return "x25519/eFrodoKEM-640-SHAKE";
378 case Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS:
379 return "x25519/eFrodoKEM-640-AES";
380 case Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS:
381 return "x448/eFrodoKEM-976-SHAKE";
382 case Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS:
383 return "x448/eFrodoKEM-976-AES";
384 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS:
385 return "secp256r1/eFrodoKEM-640-SHAKE";
386 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS:
387 return "secp256r1/eFrodoKEM-640-AES";
388 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS:
389 return "secp384r1/eFrodoKEM-976-SHAKE";
390 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS:
391 return "secp384r1/eFrodoKEM-976-AES";
392 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS:
393 return "secp521r1/eFrodoKEM-1344-SHAKE";
394 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS:
395 return "secp521r1/eFrodoKEM-1344-AES";
396
397 case Group_Params::HYBRID_X25519_ML_KEM_768:
398 return "x25519/ML-KEM-768";
399 case Group_Params::HYBRID_SECP256R1_ML_KEM_768:
400 return "secp256r1/ML-KEM-768";
401 case Group_Params::HYBRID_SECP384R1_ML_KEM_1024:
402 return "secp384r1/ML-KEM-1024";
403
404 default:
405 return std::nullopt;
406 }
407}

Referenced by Botan::TLS::Callbacks::tls_kem_generate_key().

◆ wire_code()

uint16_t Botan::TLS::Group_Params::wire_code ( ) const
inlineconstexpr

Definition at line 165 of file tls_algos.h.

165{ return static_cast<uint16_t>(m_code); }

Referenced by is_in_ffdhe_range(), and Botan::TLS::Server_Key_Exchange::Server_Key_Exchange().

The documentation for this class was generated from the following files:
Generated by doxygen 1.14.0