Botan 3.14.1
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_Code > pqc_hybrid_ecc () const
std::optional< std::string > to_algorithm_spec () 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 141 of file tls_algos.h.

Constructor & Destructor Documentation

◆ Group_Params() [1/3]

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

Definition at line 145 of file tls_algos.h.

References Botan::NONE.

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

◆ Group_Params() [2/3]

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

Definition at line 148 of file tls_algos.h.

148: m_code(code) {}
constexpr Group_Params_Code code() const
Definition tls_algos.h:164

References code().

◆ Group_Params() [3/3]

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

Definition at line 151 of file tls_algos.h.

151: 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 164 of file tls_algos.h.

164{ 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 291 of file tls_algos.cpp.

291 {
292 if(group_name == "secp256r1") {
293 return Group_Params::SECP256R1;
294 }
295 if(group_name == "secp384r1") {
296 return Group_Params::SECP384R1;
297 }
298 if(group_name == "secp521r1") {
299 return Group_Params::SECP521R1;
300 }
301 if(group_name == "brainpool256r1") {
302 return Group_Params::BRAINPOOL256R1;
303 }
304 if(group_name == "brainpool384r1") {
305 return Group_Params::BRAINPOOL384R1;
306 }
307 if(group_name == "brainpool512r1") {
308 return Group_Params::BRAINPOOL512R1;
309 }
310 if(group_name == "x25519") {
311 return Group_Params::X25519;
312 }
313 if(group_name == "x448") {
314 return Group_Params::X448;
315 }
316 if(group_name == "brainpool256r1tls13") {
317 return Group_Params::BRAINPOOL256R1TLS13;
318 }
319 if(group_name == "brainpool384r1tls13") {
320 return Group_Params::BRAINPOOL384R1TLS13;
321 }
322 if(group_name == "brainpool512r1tls13") {
323 return Group_Params::BRAINPOOL512R1TLS13;
324 }
325
326 if(group_name == "ffdhe/ietf/2048") {
327 return Group_Params::FFDHE_2048;
328 }
329 if(group_name == "ffdhe/ietf/3072") {
330 return Group_Params::FFDHE_3072;
331 }
332 if(group_name == "ffdhe/ietf/4096") {
333 return Group_Params::FFDHE_4096;
334 }
335 if(group_name == "ffdhe/ietf/6144") {
336 return Group_Params::FFDHE_6144;
337 }
338 if(group_name == "ffdhe/ietf/8192") {
339 return Group_Params::FFDHE_8192;
340 }
341
342 if(group_name == "ML-KEM-512") {
343 return Group_Params::ML_KEM_512;
344 }
345 if(group_name == "ML-KEM-768") {
346 return Group_Params::ML_KEM_768;
347 }
348 if(group_name == "ML-KEM-1024") {
349 return Group_Params::ML_KEM_1024;
350 }
351
352 if(group_name == "eFrodoKEM-640-SHAKE") {
353 return Group_Params::eFRODOKEM_640_SHAKE_OQS;
354 }
355 if(group_name == "eFrodoKEM-976-SHAKE") {
356 return Group_Params::eFRODOKEM_976_SHAKE_OQS;
357 }
358 if(group_name == "eFrodoKEM-1344-SHAKE") {
359 return Group_Params::eFRODOKEM_1344_SHAKE_OQS;
360 }
361 if(group_name == "eFrodoKEM-640-AES") {
362 return Group_Params::eFRODOKEM_640_AES_OQS;
363 }
364 if(group_name == "eFrodoKEM-976-AES") {
365 return Group_Params::eFRODOKEM_976_AES_OQS;
366 }
367 if(group_name == "eFrodoKEM-1344-AES") {
368 return Group_Params::eFRODOKEM_1344_AES_OQS;
369 }
370
371 if(group_name == "x25519/ML-KEM-768") {
372 return Group_Params::HYBRID_X25519_ML_KEM_768;
373 }
374 if(group_name == "secp256r1/ML-KEM-768") {
375 return Group_Params::HYBRID_SECP256R1_ML_KEM_768;
376 }
377 if(group_name == "secp384r1/ML-KEM-1024") {
378 return Group_Params::HYBRID_SECP384R1_ML_KEM_1024;
379 }
380
381 if(group_name == "x25519/eFrodoKEM-640-SHAKE") {
382 return Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS;
383 }
384 if(group_name == "x25519/eFrodoKEM-640-AES") {
385 return Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS;
386 }
387 if(group_name == "x448/eFrodoKEM-976-SHAKE") {
388 return Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS;
389 }
390 if(group_name == "x448/eFrodoKEM-976-AES") {
391 return Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS;
392 }
393
394 if(group_name == "secp256r1/eFrodoKEM-640-SHAKE") {
395 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS;
396 }
397 if(group_name == "secp256r1/eFrodoKEM-640-AES") {
398 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS;
399 }
400
401 if(group_name == "secp384r1/eFrodoKEM-976-SHAKE") {
402 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS;
403 }
404 if(group_name == "secp384r1/eFrodoKEM-976-AES") {
405 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS;
406 }
407
408 if(group_name == "secp521r1/eFrodoKEM-1344-SHAKE") {
409 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS;
410 }
411 if(group_name == "secp521r1/eFrodoKEM-1344-AES") {
412 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
413 }
414
415 return std::nullopt;
416}

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

183 {
184 // Unknown codes may be user-supplied custom groups handled via callbacks
185 if(!to_string().has_value()) {
186 return true;
187 }
188
189 // This must agree with what TLS::Callbacks can generate keys for
190 if(is_ecdh_named_curve()) {
192 }
193
194#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
195 if(is_dh_named_group()) {
196 return true;
197 }
198#endif
199
200#if defined(BOTAN_HAS_X25519)
201 if(is_x25519()) {
202 return true;
203 }
204#endif
205
206#if defined(BOTAN_HAS_X448)
207 if(is_x448()) {
208 return true;
209 }
210#endif
211
212#if defined(BOTAN_HAS_ML_KEM)
213 if(is_pure_ml_kem()) {
214 return true;
215 }
216#endif
217
218#if defined(BOTAN_HAS_FRODOKEM)
219 if(is_pure_frodokem()) {
220 return FrodoKEMMode(to_algorithm_spec().value()).is_available();
221 }
222#endif
223
224#if defined(BOTAN_HAS_TLS_13_PQC)
225 if(is_pqc_hybrid()) {
226 return Group_Params(pqc_hybrid_ecc().value()).is_available() && pqc_hybrid_kem(*this).is_available();
227 }
228#endif
229
230 return false;
231}
static bool supports_named_group(std::string_view name)
Definition ec_group.cpp:473
std::optional< std::string > to_algorithm_spec() const
constexpr bool is_dh_named_group() const
Definition tls_algos.h:190
constexpr bool is_pqc_hybrid() const
Definition tls_algos.h:240
constexpr bool is_ecdh_named_curve() const
Definition tls_algos.h:177
constexpr bool is_pure_frodokem() const
Definition tls_algos.h:201
std::optional< Group_Params_Code > pqc_hybrid_ecc() const
std::optional< std::string > to_string() const
constexpr bool is_pure_ml_kem() const
Definition tls_algos.h:196
constexpr bool is_x448() const
Definition tls_algos.h:175
constexpr bool is_x25519() const
Definition tls_algos.h:173

References Group_Params(), Botan::FrodoKEMMode::is_available(), is_dh_named_group(), is_ecdh_named_curve(), is_pqc_hybrid(), is_pure_frodokem(), is_pure_ml_kem(), is_x25519(), is_x448(), pqc_hybrid_ecc(), Botan::EC_Group::supports_named_group(), to_algorithm_spec(), and to_string().

Referenced by Botan::TLS::Policy::key_exchange_groups(), and Botan::TLS::Text_Policy::read_group_list().

◆ is_dh_named_group()

◆ is_ecdh_named_curve()

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

Definition at line 177 of file tls_algos.h.

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

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

◆ is_in_ffdhe_range()

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

Definition at line 185 of file tls_algos.h.

185 {
186 // See RFC 7919
187 return wire_code() >= 256 && wire_code() < 512;
188 }
constexpr uint16_t wire_code() const
Definition tls_algos.h:166

References wire_code().

Referenced by Botan::TLS::group_may_be_ecc().

◆ is_kem()

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

◆ 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

◆ is_pqc_hybrid_frodokem()

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

Definition at line 227 of file tls_algos.h.

227 {
238 }

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 210 of file tls_algos.h.

210{ return is_x25519() || is_x448() || is_ecdh_named_curve(); }

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

Referenced by Botan::TLS::group_may_be_ecc().

◆ 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

Definition at line 173 of file tls_algos.h.

References Botan::TLS::X25519.

Referenced by is_available(), and is_pure_ecc_group().

◆ is_x448()

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

Definition at line 175 of file tls_algos.h.

References Botan::TLS::X448.

Referenced by is_available(), and is_pure_ecc_group().

◆ operator<()

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

Definition at line 162 of file tls_algos.h.

162{ 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 160 of file tls_algos.h.

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

158{ 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 260 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.

Referenced by is_available().

◆ to_algorithm_spec()

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

Definition at line 507 of file tls_algos.cpp.

507 {
508 switch(m_code) {
509 // Brainpool curves have two sets of code points. See RFCs 7027 and 8734.
510 case Group_Params::BRAINPOOL256R1:
511 case Group_Params::BRAINPOOL256R1TLS13:
512 return "brainpool256r1";
513 case Group_Params::BRAINPOOL384R1:
514 case Group_Params::BRAINPOOL384R1TLS13:
515 return "brainpool384r1";
516 case Group_Params::BRAINPOOL512R1:
517 case Group_Params::BRAINPOOL512R1TLS13:
518 return "brainpool512r1";
519
520 default:
521 return to_string();
522 }
523}

References to_string().

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

◆ to_string()

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

Definition at line 418 of file tls_algos.cpp.

418 {
419 switch(m_code) {
420 case Group_Params::SECP256R1:
421 return "secp256r1";
422 case Group_Params::SECP384R1:
423 return "secp384r1";
424 case Group_Params::SECP521R1:
425 return "secp521r1";
426 case Group_Params::BRAINPOOL256R1:
427 return "brainpool256r1";
428 case Group_Params::BRAINPOOL384R1:
429 return "brainpool384r1";
430 case Group_Params::BRAINPOOL512R1:
431 return "brainpool512r1";
432 case Group_Params::X25519:
433 return "x25519";
434 case Group_Params::X448:
435 return "x448";
436 case Group_Params::BRAINPOOL256R1TLS13:
437 return "brainpool256r1tls13";
438 case Group_Params::BRAINPOOL384R1TLS13:
439 return "brainpool384r1tls13";
440 case Group_Params::BRAINPOOL512R1TLS13:
441 return "brainpool512r1tls13";
442
443 case Group_Params::FFDHE_2048:
444 return "ffdhe/ietf/2048";
445 case Group_Params::FFDHE_3072:
446 return "ffdhe/ietf/3072";
447 case Group_Params::FFDHE_4096:
448 return "ffdhe/ietf/4096";
449 case Group_Params::FFDHE_6144:
450 return "ffdhe/ietf/6144";
451 case Group_Params::FFDHE_8192:
452 return "ffdhe/ietf/8192";
453
454 case Group_Params::ML_KEM_512:
455 return "ML-KEM-512";
456 case Group_Params::ML_KEM_768:
457 return "ML-KEM-768";
458 case Group_Params::ML_KEM_1024:
459 return "ML-KEM-1024";
460
461 case Group_Params::eFRODOKEM_640_SHAKE_OQS:
462 return "eFrodoKEM-640-SHAKE";
463 case Group_Params::eFRODOKEM_976_SHAKE_OQS:
464 return "eFrodoKEM-976-SHAKE";
465 case Group_Params::eFRODOKEM_1344_SHAKE_OQS:
466 return "eFrodoKEM-1344-SHAKE";
467 case Group_Params::eFRODOKEM_640_AES_OQS:
468 return "eFrodoKEM-640-AES";
469 case Group_Params::eFRODOKEM_976_AES_OQS:
470 return "eFrodoKEM-976-AES";
471 case Group_Params::eFRODOKEM_1344_AES_OQS:
472 return "eFrodoKEM-1344-AES";
473
474 case Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS:
475 return "x25519/eFrodoKEM-640-SHAKE";
476 case Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS:
477 return "x25519/eFrodoKEM-640-AES";
478 case Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS:
479 return "x448/eFrodoKEM-976-SHAKE";
480 case Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS:
481 return "x448/eFrodoKEM-976-AES";
482 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS:
483 return "secp256r1/eFrodoKEM-640-SHAKE";
484 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS:
485 return "secp256r1/eFrodoKEM-640-AES";
486 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS:
487 return "secp384r1/eFrodoKEM-976-SHAKE";
488 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS:
489 return "secp384r1/eFrodoKEM-976-AES";
490 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS:
491 return "secp521r1/eFrodoKEM-1344-SHAKE";
492 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS:
493 return "secp521r1/eFrodoKEM-1344-AES";
494
495 case Group_Params::HYBRID_X25519_ML_KEM_768:
496 return "x25519/ML-KEM-768";
497 case Group_Params::HYBRID_SECP256R1_ML_KEM_768:
498 return "secp256r1/ML-KEM-768";
499 case Group_Params::HYBRID_SECP384R1_ML_KEM_1024:
500 return "secp384r1/ML-KEM-1024";
501
502 default:
503 return std::nullopt;
504 }
505}

Referenced by Botan::TLS::group_may_be_ecc(), is_available(), and to_algorithm_spec().

◆ wire_code()

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

Definition at line 166 of file tls_algos.h.

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