Botan 3.12.0
Crypto and TLS for C&
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_Codepqc_hybrid_ecc () const
std::optional< std::string > to_string () const
constexpr uint16_t wire_code () const

Static Public Member Functions

static std::optional< Group_Paramsfrom_string (std::string_view group_name)

Detailed Description

Definition at line 137 of file tls_algos.h.

Constructor & Destructor Documentation

◆ Group_Params() [1/3]

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

Definition at line 141 of file tls_algos.h.

References Botan::NONE.

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

◆ Group_Params() [2/3]

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

Definition at line 144 of file tls_algos.h.

144: m_code(code) {}
constexpr Group_Params_Code code() const
Definition tls_algos.h:160

References code().

◆ Group_Params() [3/3]

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

Definition at line 147 of file tls_algos.h.

147: 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 160 of file tls_algos.h.

160{ 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 275 of file tls_algos.cpp.

275 {
276 if(group_name == "secp256r1") {
277 return Group_Params::SECP256R1;
278 }
279 if(group_name == "secp384r1") {
280 return Group_Params::SECP384R1;
281 }
282 if(group_name == "secp521r1") {
283 return Group_Params::SECP521R1;
284 }
285 if(group_name == "brainpool256r1") {
286 return Group_Params::BRAINPOOL256R1;
287 }
288 if(group_name == "brainpool384r1") {
289 return Group_Params::BRAINPOOL384R1;
290 }
291 if(group_name == "brainpool512r1") {
292 return Group_Params::BRAINPOOL512R1;
293 }
294 if(group_name == "x25519") {
295 return Group_Params::X25519;
296 }
297 if(group_name == "x448") {
298 return Group_Params::X448;
299 }
300
301 if(group_name == "ffdhe/ietf/2048") {
302 return Group_Params::FFDHE_2048;
303 }
304 if(group_name == "ffdhe/ietf/3072") {
305 return Group_Params::FFDHE_3072;
306 }
307 if(group_name == "ffdhe/ietf/4096") {
308 return Group_Params::FFDHE_4096;
309 }
310 if(group_name == "ffdhe/ietf/6144") {
311 return Group_Params::FFDHE_6144;
312 }
313 if(group_name == "ffdhe/ietf/8192") {
314 return Group_Params::FFDHE_8192;
315 }
316
317 if(group_name == "ML-KEM-512") {
318 return Group_Params::ML_KEM_512;
319 }
320 if(group_name == "ML-KEM-768") {
321 return Group_Params::ML_KEM_768;
322 }
323 if(group_name == "ML-KEM-1024") {
324 return Group_Params::ML_KEM_1024;
325 }
326
327 if(group_name == "eFrodoKEM-640-SHAKE") {
328 return Group_Params::eFRODOKEM_640_SHAKE_OQS;
329 }
330 if(group_name == "eFrodoKEM-976-SHAKE") {
331 return Group_Params::eFRODOKEM_976_SHAKE_OQS;
332 }
333 if(group_name == "eFrodoKEM-1344-SHAKE") {
334 return Group_Params::eFRODOKEM_1344_SHAKE_OQS;
335 }
336 if(group_name == "eFrodoKEM-640-AES") {
337 return Group_Params::eFRODOKEM_640_AES_OQS;
338 }
339 if(group_name == "eFrodoKEM-976-AES") {
340 return Group_Params::eFRODOKEM_976_AES_OQS;
341 }
342 if(group_name == "eFrodoKEM-1344-AES") {
343 return Group_Params::eFRODOKEM_1344_AES_OQS;
344 }
345
346 if(group_name == "x25519/ML-KEM-768") {
347 return Group_Params::HYBRID_X25519_ML_KEM_768;
348 }
349 if(group_name == "secp256r1/ML-KEM-768") {
350 return Group_Params::HYBRID_SECP256R1_ML_KEM_768;
351 }
352 if(group_name == "secp384r1/ML-KEM-1024") {
353 return Group_Params::HYBRID_SECP384R1_ML_KEM_1024;
354 }
355
356 if(group_name == "x25519/eFrodoKEM-640-SHAKE") {
357 return Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS;
358 }
359 if(group_name == "x25519/eFrodoKEM-640-AES") {
360 return Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS;
361 }
362 if(group_name == "x448/eFrodoKEM-976-SHAKE") {
363 return Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS;
364 }
365 if(group_name == "x448/eFrodoKEM-976-AES") {
366 return Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS;
367 }
368
369 if(group_name == "secp256r1/eFrodoKEM-640-SHAKE") {
370 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS;
371 }
372 if(group_name == "secp256r1/eFrodoKEM-640-AES") {
373 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS;
374 }
375
376 if(group_name == "secp384r1/eFrodoKEM-976-SHAKE") {
377 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS;
378 }
379 if(group_name == "secp384r1/eFrodoKEM-976-AES") {
380 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS;
381 }
382
383 if(group_name == "secp521r1/eFrodoKEM-1344-SHAKE") {
384 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS;
385 }
386 if(group_name == "secp521r1/eFrodoKEM-1344-AES") {
387 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
388 }
389
390 return std::nullopt;
391}

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 234 of file tls_algos.cpp.

234 {
235 // For group codes we recognize, check the build-time availability table.
236 // Unknown codes may be user-supplied custom groups handled via callbacks.
237 if(to_string().has_value()) {
238 static constexpr auto codes = available_group_params();
239 return std::binary_search(codes.begin(), codes.end(), this->code());
240 }
241 return true;
242}
std::optional< std::string > to_string() const

References to_string().

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

◆ is_dh_named_group()

◆ is_ecdh_named_curve()

◆ is_in_ffdhe_range()

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

Definition at line 179 of file tls_algos.h.

179 {
180 // See RFC 7919
181 return wire_code() >= 256 && wire_code() < 512;
182 }
constexpr uint16_t wire_code() const
Definition tls_algos.h:162

References wire_code().

◆ is_kem()

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

Definition at line 236 of file tls_algos.h.

236 {
239
241
243 }
#define BOTAN_DIAGNOSTIC_POP
Definition api.h:122
#define BOTAN_DIAGNOSTIC_PUSH
Definition api.h:119
#define BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
Definition api.h:120
constexpr bool is_pqc_hybrid() const
Definition tls_algos.h:234
constexpr bool is_pure_frodokem() const
Definition tls_algos.h:195
constexpr bool is_pure_ml_kem() const
Definition tls_algos.h:190

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

◆ is_pqc_hybrid()

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

Definition at line 234 of file tls_algos.h.

constexpr bool is_pqc_hybrid_frodokem() const
Definition tls_algos.h:221
constexpr bool is_pqc_hybrid_ml_kem() const
Definition tls_algos.h:215

References is_pqc_hybrid_frodokem(), and is_pqc_hybrid_ml_kem().

Referenced by 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 221 of file tls_algos.h.

221 {
232 }

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_pqc_hybrid().

◆ is_pqc_hybrid_ml_kem()

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

◆ is_pure_ecc_group()

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

Definition at line 204 of file tls_algos.h.

204{ return is_x25519() || is_x448() || is_ecdh_named_curve(); }
constexpr bool is_ecdh_named_curve() const
Definition tls_algos.h:173
constexpr bool is_x448() const
Definition tls_algos.h:171
constexpr bool is_x25519() const
Definition tls_algos.h:169

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

◆ is_pure_frodokem()

◆ is_pure_ml_kem()

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

◆ is_x25519()

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

◆ is_x448()

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

◆ operator<()

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

Definition at line 158 of file tls_algos.h.

158{ 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 156 of file tls_algos.h.

156{ 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 154 of file tls_algos.h.

154{ 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 244 of file tls_algos.cpp.

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.

◆ to_string()

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

Definition at line 393 of file tls_algos.cpp.

393 {
394 switch(m_code) {
395 case Group_Params::SECP256R1:
396 return "secp256r1";
397 case Group_Params::SECP384R1:
398 return "secp384r1";
399 case Group_Params::SECP521R1:
400 return "secp521r1";
401 case Group_Params::BRAINPOOL256R1:
402 return "brainpool256r1";
403 case Group_Params::BRAINPOOL384R1:
404 return "brainpool384r1";
405 case Group_Params::BRAINPOOL512R1:
406 return "brainpool512r1";
407 case Group_Params::X25519:
408 return "x25519";
409 case Group_Params::X448:
410 return "x448";
411
412 case Group_Params::FFDHE_2048:
413 return "ffdhe/ietf/2048";
414 case Group_Params::FFDHE_3072:
415 return "ffdhe/ietf/3072";
416 case Group_Params::FFDHE_4096:
417 return "ffdhe/ietf/4096";
418 case Group_Params::FFDHE_6144:
419 return "ffdhe/ietf/6144";
420 case Group_Params::FFDHE_8192:
421 return "ffdhe/ietf/8192";
422
423 case Group_Params::ML_KEM_512:
424 return "ML-KEM-512";
425 case Group_Params::ML_KEM_768:
426 return "ML-KEM-768";
427 case Group_Params::ML_KEM_1024:
428 return "ML-KEM-1024";
429
430 case Group_Params::eFRODOKEM_640_SHAKE_OQS:
431 return "eFrodoKEM-640-SHAKE";
432 case Group_Params::eFRODOKEM_976_SHAKE_OQS:
433 return "eFrodoKEM-976-SHAKE";
434 case Group_Params::eFRODOKEM_1344_SHAKE_OQS:
435 return "eFrodoKEM-1344-SHAKE";
436 case Group_Params::eFRODOKEM_640_AES_OQS:
437 return "eFrodoKEM-640-AES";
438 case Group_Params::eFRODOKEM_976_AES_OQS:
439 return "eFrodoKEM-976-AES";
440 case Group_Params::eFRODOKEM_1344_AES_OQS:
441 return "eFrodoKEM-1344-AES";
442
443 case Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS:
444 return "x25519/eFrodoKEM-640-SHAKE";
445 case Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS:
446 return "x25519/eFrodoKEM-640-AES";
447 case Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS:
448 return "x448/eFrodoKEM-976-SHAKE";
449 case Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS:
450 return "x448/eFrodoKEM-976-AES";
451 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS:
452 return "secp256r1/eFrodoKEM-640-SHAKE";
453 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS:
454 return "secp256r1/eFrodoKEM-640-AES";
455 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS:
456 return "secp384r1/eFrodoKEM-976-SHAKE";
457 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS:
458 return "secp384r1/eFrodoKEM-976-AES";
459 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS:
460 return "secp521r1/eFrodoKEM-1344-SHAKE";
461 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS:
462 return "secp521r1/eFrodoKEM-1344-AES";
463
464 case Group_Params::HYBRID_X25519_ML_KEM_768:
465 return "x25519/ML-KEM-768";
466 case Group_Params::HYBRID_SECP256R1_ML_KEM_768:
467 return "secp256r1/ML-KEM-768";
468 case Group_Params::HYBRID_SECP384R1_ML_KEM_1024:
469 return "secp384r1/ML-KEM-1024";
470
471 default:
472 return std::nullopt;
473 }
474}

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

◆ wire_code()

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

Definition at line 162 of file tls_algos.h.

162{ 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: