Botan 3.14.1
Crypto and TLS for C&
tls_algos.cpp
Go to the documentation of this file.
1/*
2* (C) 2017 Jack Lloyd
3*
4* Botan is released under the Simplified BSD License (see license.txt)
5*/
6
7#include <botan/tls_algos.h>
8
9#include <botan/ec_group.h>
10#include <botan/exceptn.h>
11#include <botan/internal/fmt.h>
12#include <botan/internal/tls_messages_internal.h>
13
14#if defined(BOTAN_HAS_FRODOKEM)
15 #include <botan/frodo_mode.h>
16#endif
17
18namespace Botan::TLS {
19
20std::string kdf_algo_to_string(KDF_Algo algo) {
21 switch(algo) {
22 case KDF_Algo::SHA_1:
23 return "SHA-1";
25 return "SHA-256";
27 return "SHA-384";
28 }
29
30 throw Invalid_State("kdf_algo_to_string unknown enum value");
31}
32
33std::string kex_method_to_string(Kex_Algo method) {
34 switch(method) {
36 return "RSA";
37 case Kex_Algo::DH:
38 return "DH";
39 case Kex_Algo::ECDH:
40 return "ECDH";
41 case Kex_Algo::PSK:
42 return "PSK";
44 return "ECDHE_PSK";
46 return "DHE_PSK";
47 case Kex_Algo::KEM:
48 return "KEM";
50 return "KEM_PSK";
52 return "HYBRID";
54 return "HYBRID_PSK";
56 return "UNDEFINED";
57 }
58
59 throw Invalid_State("kex_method_to_string unknown enum value");
60}
61
62Kex_Algo kex_method_from_string(std::string_view str) {
63 if(str == "RSA") {
65 }
66
67 if(str == "DH") {
68 return Kex_Algo::DH;
69 }
70
71 if(str == "ECDH") {
72 return Kex_Algo::ECDH;
73 }
74
75 if(str == "PSK") {
76 return Kex_Algo::PSK;
77 }
78
79 if(str == "ECDHE_PSK") {
81 }
82
83 if(str == "DHE_PSK") {
84 return Kex_Algo::DHE_PSK;
85 }
86
87 if(str == "KEM") {
88 return Kex_Algo::KEM;
89 }
90
91 if(str == "KEM_PSK") {
92 return Kex_Algo::KEM_PSK;
93 }
94
95 if(str == "HYBRID") {
96 return Kex_Algo::HYBRID;
97 }
98
99 if(str == "HYBRID_PSK") {
101 }
102
103 if(str == "UNDEFINED") {
104 return Kex_Algo::UNDEFINED;
105 }
106
107 throw Invalid_Argument(fmt("Unknown kex method '{}'", str));
108}
109
111 switch(method) {
112 case Auth_Method::RSA:
113 return "RSA";
115 return "ECDSA";
117 return "IMPLICIT";
119 return "UNDEFINED";
120 }
121
122 throw Invalid_State("auth_method_to_string unknown enum value");
123}
124
126 if(str == "RSA") {
127 return Auth_Method::RSA;
128 }
129 if(str == "ECDSA") {
130 return Auth_Method::ECDSA;
131 }
132 if(str == "IMPLICIT") {
134 }
135 if(str == "UNDEFINED") {
137 }
138
139 throw Invalid_Argument(fmt("Unknown TLS signature method '{}'", str));
140}
141
142#if defined(BOTAN_HAS_TLS_13_PQC)
143
144namespace {
145
146// The KEM component of a hybrid group
147Group_Params pqc_hybrid_kem(Group_Params group) {
148 switch(group.code()) {
149 case Group_Params::HYBRID_X25519_ML_KEM_768:
150 case Group_Params::HYBRID_SECP256R1_ML_KEM_768:
151 return Group_Params::ML_KEM_768;
152 case Group_Params::HYBRID_SECP384R1_ML_KEM_1024:
153 return Group_Params::ML_KEM_1024;
154
155 case Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS:
156 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS:
157 return Group_Params::eFRODOKEM_640_SHAKE_OQS;
158 case Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS:
159 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS:
160 return Group_Params::eFRODOKEM_640_AES_OQS;
161
162 case Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS:
163 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS:
164 return Group_Params::eFRODOKEM_976_SHAKE_OQS;
165 case Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS:
166 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS:
167 return Group_Params::eFRODOKEM_976_AES_OQS;
168
169 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS:
170 return Group_Params::eFRODOKEM_1344_SHAKE_OQS;
171 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS:
172 return Group_Params::eFRODOKEM_1344_AES_OQS;
173
174 default:
175 return Group_Params::NONE;
176 }
177}
178
179} // namespace
180
181#endif
182
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}
232
234 if(version.is_pre_tls_13()) {
235 return !group.is_kem() && //
236 group != Group_Params::BRAINPOOL256R1TLS13 && //
237 group != Group_Params::BRAINPOOL384R1TLS13 && //
238 group != Group_Params::BRAINPOOL512R1TLS13;
239 } else {
240 return group != Group_Params::BRAINPOOL256R1 && //
241 group != Group_Params::BRAINPOOL384R1 && //
242 group != Group_Params::BRAINPOOL512R1;
243 }
244}
245
246std::vector<Group_Params> groups_usable_in_version(std::span<const Group_Params> groups, Protocol_Version version) {
247 std::vector<Group_Params> usable;
248 for(const auto group : groups) {
249 if(group_usable_in_version(group, version)) {
250 usable.push_back(group);
251 }
252 }
253 return usable;
254}
255
257 return group.is_pure_ecc_group() || (!group.to_string().has_value() && !group.is_in_ffdhe_range());
258}
259
290
291std::optional<Group_Params> Group_Params::from_string(std::string_view group_name) {
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}
417
418std::optional<std::string> Group_Params::to_string() const {
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}
506
507std::optional<std::string> Group_Params::to_algorithm_spec() const {
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}
524
526 switch(type) {
528 return "X509";
530 return "RawPublicKey";
531 }
532
533 return "Unknown";
534}
535
536Certificate_Type certificate_type_from_string(const std::string& type_str) {
537 if(type_str == "X509") {
539 } else if(type_str == "RawPublicKey") {
541 } else {
542 throw Decoding_Error("Unknown certificate type: " + type_str);
543 }
544}
545
546} // namespace Botan::TLS
static bool supports_named_group(std::string_view name)
Definition ec_group.cpp:473
bool is_available() const
std::optional< std::string > to_algorithm_spec() const
constexpr bool is_dh_named_group() const
Definition tls_algos.h:190
constexpr bool is_in_ffdhe_range() const
Definition tls_algos.h:185
constexpr bool is_pqc_hybrid() const
Definition tls_algos.h:240
constexpr bool is_kem() const
Definition tls_algos.h:242
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
static std::optional< Group_Params > from_string(std::string_view group_name)
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_pure_ecc_group() const
Definition tls_algos.h:210
constexpr bool is_x25519() const
Definition tls_algos.h:173
Kex_Algo kex_method_from_string(std::string_view str)
Definition tls_algos.cpp:62
std::string certificate_type_to_string(Certificate_Type type)
bool group_usable_in_version(Group_Params group, Protocol_Version version)
Auth_Method auth_method_from_string(std::string_view str)
std::string kdf_algo_to_string(KDF_Algo algo)
Definition tls_algos.cpp:20
std::vector< Group_Params > groups_usable_in_version(std::span< const Group_Params > groups, Protocol_Version version)
bool group_may_be_ecc(Group_Params group)
std::string kex_method_to_string(Kex_Algo method)
Definition tls_algos.cpp:33
std::string auth_method_to_string(Auth_Method method)
Certificate_Type certificate_type_from_string(const std::string &type_str)
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53