Botan 3.7.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_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 136 of file tls_algos.h.

Constructor & Destructor Documentation

◆ Group_Params() [1/3]

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

Definition at line 140 of file tls_algos.h.

References Botan::NONE.

◆ Group_Params() [2/3]

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

Definition at line 142 of file tls_algos.h.

142: m_code(code) {}
constexpr Group_Params_Code code() const
Definition tls_algos.h:157

◆ Group_Params() [3/3]

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

Definition at line 144 of file tls_algos.h.

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

Member Function Documentation

◆ code()

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

Definition at line 157 of file tls_algos.h.

157{ return m_code; }

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

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

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 }
143 return false;
144 }
145#endif
146
147#if !defined(BOTAN_HAS_X448)
148 if(is_x448()) {
149 return false;
150 }
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)
164 return false;
165 }
166#endif
167
168#if !defined(BOTAN_HAS_FRODOKEM)
170 return false;
171 }
172#endif
173
174 return true;
175}
constexpr bool is_in_ffdhe_range() const
Definition tls_algos.h:176
constexpr bool is_pqc_hybrid() const
Definition tls_algos.h:230
constexpr bool is_pure_frodokem() const
Definition tls_algos.h:192
std::optional< Group_Params_Code > pqc_hybrid_ecc() const
constexpr bool is_pqc_hybrid_frodokem() const
Definition tls_algos.h:217
constexpr bool is_pure_ml_kem() const
Definition tls_algos.h:187
constexpr bool is_pqc_hybrid_ml_kem() const
Definition tls_algos.h:212
constexpr bool is_x448() const
Definition tls_algos.h:168
constexpr bool is_x25519() const
Definition tls_algos.h:166

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

◆ is_ecdh_named_curve()

◆ is_in_ffdhe_range()

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

Definition at line 176 of file tls_algos.h.

176 {
177 // See RFC 7919
178 return wire_code() >= 256 && wire_code() < 512;
179 }
constexpr uint16_t wire_code() const
Definition tls_algos.h:159

Referenced by is_available().

◆ 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

Definition at line 230 of file tls_algos.h.

Referenced by is_available(), 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 217 of file tls_algos.h.

217 {
228 }

Referenced by is_available().

◆ is_pqc_hybrid_ml_kem()

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

Definition at line 212 of file tls_algos.h.

Referenced by is_available().

◆ is_pure_ecc_group()

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

Definition at line 201 of file tls_algos.h.

201{ return is_x25519() || is_x448() || is_ecdh_named_curve(); }
constexpr bool is_ecdh_named_curve() const
Definition tls_algos.h:170

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

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

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

◆ is_x448()

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

Definition at line 168 of file tls_algos.h.

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

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

◆ operator<()

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

Definition at line 155 of file tls_algos.h.

155{ return m_code < other.m_code; }

◆ operator==() [1/2]

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

Definition at line 153 of file tls_algos.h.

153{ return m_code == other.m_code; }

◆ operator==() [2/2]

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

Definition at line 151 of file tls_algos.h.

151{ return m_code == 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.

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

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

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

◆ wire_code()

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

Definition at line 159 of file tls_algos.h.

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

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