Botan 3.10.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::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 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 if(group_name == "secp384r1/ML-KEM-1024") {
285 return Group_Params::HYBRID_SECP384R1_ML_KEM_1024;
286 }
287
288 if(group_name == "x25519/eFrodoKEM-640-SHAKE") {
289 return Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS;
290 }
291 if(group_name == "x25519/eFrodoKEM-640-AES") {
292 return Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS;
293 }
294 if(group_name == "x448/eFrodoKEM-976-SHAKE") {
295 return Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS;
296 }
297 if(group_name == "x448/eFrodoKEM-976-AES") {
298 return Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS;
299 }
300
301 if(group_name == "secp256r1/eFrodoKEM-640-SHAKE") {
302 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS;
303 }
304 if(group_name == "secp256r1/eFrodoKEM-640-AES") {
305 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS;
306 }
307
308 if(group_name == "secp384r1/eFrodoKEM-976-SHAKE") {
309 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS;
310 }
311 if(group_name == "secp384r1/eFrodoKEM-976-AES") {
312 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS;
313 }
314
315 if(group_name == "secp521r1/eFrodoKEM-1344-SHAKE") {
316 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS;
317 }
318 if(group_name == "secp521r1/eFrodoKEM-1344-AES") {
319 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
320 }
321
322 return std::nullopt;
323}

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

136 {
137#if !defined(BOTAN_HAS_X25519)
138 if(is_x25519()) {
139 return false;
140 }
141 if(is_pqc_hybrid() && pqc_hybrid_ecc() == Group_Params_Code::X25519) {
142 return false;
143 }
144#endif
145
146#if !defined(BOTAN_HAS_X448)
147 if(is_x448()) {
148 return false;
149 }
150 if(is_pqc_hybrid() && pqc_hybrid_ecc() == Group_Params_Code::X448) {
151 return false;
152 }
153#endif
154
155#if !defined(BOTAN_HAS_DIFFIE_HELLMAN)
156 if(is_in_ffdhe_range()) {
157 return false;
158 }
159#endif
160
161#if !defined(BOTAN_HAS_ML_KEM)
162 if(is_pure_ml_kem() || is_pqc_hybrid_ml_kem()) {
163 return false;
164 }
165#endif
166
167#if !defined(BOTAN_HAS_FRODOKEM)
168 if(is_pure_frodokem() || is_pqc_hybrid_frodokem()) {
169 return false;
170 }
171#endif
172
173 return true;
174}
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:176
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 176 of file tls_algos.cpp.

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

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

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

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.15.0