Botan 3.5.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)
 
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_pure_ecc_group () const
 
constexpr bool is_pure_frodokem () const
 
constexpr bool is_pure_kyber () 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< 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 151 of file tls_algos.h.

Constructor & Destructor Documentation

◆ Group_Params() [1/3]

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

Definition at line 155 of file tls_algos.h.

155: m_code(Group_Params_Code::NONE) {}

References Botan::NONE.

◆ Group_Params() [2/3]

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

Definition at line 157 of file tls_algos.h.

157: m_code(code) {}
Botan::TLS::Group_Params::code
constexpr Group_Params_Code code() const
Definition tls_algos.h:172

◆ Group_Params() [3/3]

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

Definition at line 159 of file tls_algos.h.

159: 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 172 of file tls_algos.h.

172{ 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 137 of file tls_algos.cpp.

137 {
138 if(group_name == "secp256r1") {
139 return Group_Params::SECP256R1;
140 }
141 if(group_name == "secp384r1") {
142 return Group_Params::SECP384R1;
143 }
144 if(group_name == "secp521r1") {
145 return Group_Params::SECP521R1;
146 }
147 if(group_name == "brainpool256r1") {
148 return Group_Params::BRAINPOOL256R1;
149 }
150 if(group_name == "brainpool384r1") {
151 return Group_Params::BRAINPOOL384R1;
152 }
153 if(group_name == "brainpool512r1") {
154 return Group_Params::BRAINPOOL512R1;
155 }
156 if(group_name == "x25519") {
157 return Group_Params::X25519;
158 }
159 if(group_name == "x448") {
160 return Group_Params::X448;
161 }
162
163 if(group_name == "ffdhe/ietf/2048") {
164 return Group_Params::FFDHE_2048;
165 }
166 if(group_name == "ffdhe/ietf/3072") {
167 return Group_Params::FFDHE_3072;
168 }
169 if(group_name == "ffdhe/ietf/4096") {
170 return Group_Params::FFDHE_4096;
171 }
172 if(group_name == "ffdhe/ietf/6144") {
173 return Group_Params::FFDHE_6144;
174 }
175 if(group_name == "ffdhe/ietf/8192") {
176 return Group_Params::FFDHE_8192;
177 }
178
179 if(group_name == "Kyber-512-r3") {
180 return Group_Params::KYBER_512_R3_OQS;
181 }
182 if(group_name == "Kyber-768-r3") {
183 return Group_Params::KYBER_768_R3_OQS;
184 }
185 if(group_name == "Kyber-1024-r3") {
186 return Group_Params::KYBER_1024_R3_OQS;
187 }
188
189 if(group_name == "eFrodoKEM-640-SHAKE") {
190 return Group_Params::eFRODOKEM_640_SHAKE_OQS;
191 }
192 if(group_name == "eFrodoKEM-976-SHAKE") {
193 return Group_Params::eFRODOKEM_976_SHAKE_OQS;
194 }
195 if(group_name == "eFrodoKEM-1344-SHAKE") {
196 return Group_Params::eFRODOKEM_1344_SHAKE_OQS;
197 }
198 if(group_name == "eFrodoKEM-640-AES") {
199 return Group_Params::eFRODOKEM_640_AES_OQS;
200 }
201 if(group_name == "eFrodoKEM-976-AES") {
202 return Group_Params::eFRODOKEM_976_AES_OQS;
203 }
204 if(group_name == "eFrodoKEM-1344-AES") {
205 return Group_Params::eFRODOKEM_1344_AES_OQS;
206 }
207
208 if(group_name == "x25519/Kyber-512-r3/cloudflare") {
209 return Group_Params::HYBRID_X25519_KYBER_512_R3_CLOUDFLARE;
210 }
211 if(group_name == "x25519/Kyber-512-r3") {
212 return Group_Params::HYBRID_X25519_KYBER_512_R3_OQS;
213 }
214 if(group_name == "x25519/Kyber-768-r3") {
215 return Group_Params::HYBRID_X25519_KYBER_768_R3_OQS;
216 }
217 if(group_name == "x448/Kyber-768-r3") {
218 return Group_Params::HYBRID_X448_KYBER_768_R3_OQS;
219 }
220 if(group_name == "x25519/eFrodoKEM-640-SHAKE") {
221 return Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS;
222 }
223 if(group_name == "x25519/eFrodoKEM-640-AES") {
224 return Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS;
225 }
226 if(group_name == "x448/eFrodoKEM-976-SHAKE") {
227 return Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS;
228 }
229 if(group_name == "x448/eFrodoKEM-976-AES") {
230 return Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS;
231 }
232
233 if(group_name == "secp256r1/Kyber-512-r3") {
234 return Group_Params::HYBRID_SECP256R1_KYBER_512_R3_OQS;
235 }
236 if(group_name == "secp256r1/Kyber-768-r3") {
237 return Group_Params::HYBRID_SECP256R1_KYBER_768_R3_OQS;
238 }
239 if(group_name == "secp256r1/eFrodoKEM-640-SHAKE") {
240 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS;
241 }
242 if(group_name == "secp256r1/eFrodoKEM-640-AES") {
243 return Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS;
244 }
245
246 if(group_name == "secp384r1/Kyber-768-r3") {
247 return Group_Params::HYBRID_SECP384R1_KYBER_768_R3_OQS;
248 }
249 if(group_name == "secp384r1/eFrodoKEM-976-SHAKE") {
250 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS;
251 }
252 if(group_name == "secp384r1/eFrodoKEM-976-AES") {
253 return Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS;
254 }
255
256 if(group_name == "secp521r1/Kyber-1024-r3") {
257 return Group_Params::HYBRID_SECP521R1_KYBER_1024_R3_OQS;
258 }
259 if(group_name == "secp521r1/eFrodoKEM-1344-SHAKE") {
260 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS;
261 }
262 if(group_name == "secp521r1/eFrodoKEM-1344-AES") {
263 return Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
264 }
265
266 return std::nullopt;
267}

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

191 {
192 return m_code == Group_Params_Code::FFDHE_2048 || m_code == Group_Params_Code::FFDHE_3072 ||
193 m_code == Group_Params_Code::FFDHE_4096 || m_code == Group_Params_Code::FFDHE_6144 ||
194 m_code == Group_Params_Code::FFDHE_8192;
195 }

◆ is_ecdh_named_curve()

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

Definition at line 180 of file tls_algos.h.

180 {
181 return m_code == Group_Params_Code::SECP256R1 || m_code == Group_Params_Code::SECP384R1 ||
182 m_code == Group_Params_Code::SECP521R1 || m_code == Group_Params_Code::BRAINPOOL256R1 ||
183 m_code == Group_Params_Code::BRAINPOOL384R1 || m_code == Group_Params_Code::BRAINPOOL512R1;
184 }

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

◆ is_in_ffdhe_range()

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

Definition at line 186 of file tls_algos.h.

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

◆ is_kem()

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

Definition at line 236 of file tls_algos.h.

236{ return is_pure_kyber() || is_pure_frodokem() || is_pqc_hybrid(); }
Botan::TLS::Group_Params::is_pqc_hybrid
constexpr bool is_pqc_hybrid() const
Definition tls_algos.h:215
Botan::TLS::Group_Params::is_pure_frodokem
constexpr bool is_pure_frodokem() const
Definition tls_algos.h:202
Botan::TLS::Group_Params::is_pure_kyber
constexpr bool is_pure_kyber() const
Definition tls_algos.h:197

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

213{ return is_pure_kyber() || is_pure_frodokem() || is_pqc_hybrid(); }

◆ is_pqc_hybrid()

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

Definition at line 215 of file tls_algos.h.

215 {
216 return m_code == Group_Params_Code::HYBRID_X25519_KYBER_512_R3_CLOUDFLARE ||
217 m_code == Group_Params_Code::HYBRID_X25519_KYBER_512_R3_OQS ||
218 m_code == Group_Params_Code::HYBRID_X25519_KYBER_768_R3_OQS ||
219 m_code == Group_Params_Code::HYBRID_X448_KYBER_768_R3_OQS ||
220 m_code == Group_Params_Code::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS ||
221 m_code == Group_Params_Code::HYBRID_X25519_eFRODOKEM_640_AES_OQS ||
222 m_code == Group_Params_Code::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS ||
223 m_code == Group_Params_Code::HYBRID_X448_eFRODOKEM_976_AES_OQS ||
224 m_code == Group_Params_Code::HYBRID_SECP256R1_KYBER_512_R3_OQS ||
225 m_code == Group_Params_Code::HYBRID_SECP256R1_KYBER_768_R3_OQS ||
226 m_code == Group_Params_Code::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS ||
227 m_code == Group_Params_Code::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS ||
228 m_code == Group_Params_Code::HYBRID_SECP384R1_KYBER_768_R3_OQS ||
229 m_code == Group_Params_Code::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS ||
230 m_code == Group_Params_Code::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS ||
231 m_code == Group_Params_Code::HYBRID_SECP521R1_KYBER_1024_R3_OQS ||
232 m_code == Group_Params_Code::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS ||
233 m_code == Group_Params_Code::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS;
234 }

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

◆ is_pure_ecc_group()

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

Definition at line 211 of file tls_algos.h.

211{ 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:180
Botan::TLS::Group_Params::is_x448
constexpr bool is_x448() const
Definition tls_algos.h:178
Botan::TLS::Group_Params::is_x25519
constexpr bool is_x25519() const
Definition tls_algos.h:176

◆ is_pure_frodokem()

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

Definition at line 202 of file tls_algos.h.

202 {
203 return m_code == Group_Params_Code::eFRODOKEM_640_SHAKE_OQS ||
204 m_code == Group_Params_Code::eFRODOKEM_976_SHAKE_OQS ||
205 m_code == Group_Params_Code::eFRODOKEM_1344_SHAKE_OQS ||
206 m_code == Group_Params_Code::eFRODOKEM_640_AES_OQS ||
207 m_code == Group_Params_Code::eFRODOKEM_976_AES_OQS ||
208 m_code == Group_Params_Code::eFRODOKEM_1344_AES_OQS;
209 }

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

◆ is_pure_kyber()

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

Definition at line 197 of file tls_algos.h.

197 {
198 return m_code == Group_Params_Code::KYBER_512_R3_OQS || m_code == Group_Params_Code::KYBER_768_R3_OQS ||
199 m_code == Group_Params_Code::KYBER_1024_R3_OQS;
200 }

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

◆ is_x25519()

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

Definition at line 176 of file tls_algos.h.

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

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

◆ is_x448()

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

Definition at line 178 of file tls_algos.h.

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

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

◆ operator<()

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

Definition at line 170 of file tls_algos.h.

170{ return m_code < other.m_code; }

◆ operator==() [1/2]

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

Definition at line 168 of file tls_algos.h.

168{ return m_code == other.m_code; }

◆ operator==() [2/2]

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

Definition at line 166 of file tls_algos.h.

166{ return m_code == code; }

◆ to_string()

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

Definition at line 269 of file tls_algos.cpp.

269 {
270 switch(m_code) {
271 case Group_Params::SECP256R1:
272 return "secp256r1";
273 case Group_Params::SECP384R1:
274 return "secp384r1";
275 case Group_Params::SECP521R1:
276 return "secp521r1";
277 case Group_Params::BRAINPOOL256R1:
278 return "brainpool256r1";
279 case Group_Params::BRAINPOOL384R1:
280 return "brainpool384r1";
281 case Group_Params::BRAINPOOL512R1:
282 return "brainpool512r1";
283 case Group_Params::X25519:
284 return "x25519";
285 case Group_Params::X448:
286 return "x448";
287
288 case Group_Params::FFDHE_2048:
289 return "ffdhe/ietf/2048";
290 case Group_Params::FFDHE_3072:
291 return "ffdhe/ietf/3072";
292 case Group_Params::FFDHE_4096:
293 return "ffdhe/ietf/4096";
294 case Group_Params::FFDHE_6144:
295 return "ffdhe/ietf/6144";
296 case Group_Params::FFDHE_8192:
297 return "ffdhe/ietf/8192";
298
299 case Group_Params::KYBER_512_R3_OQS:
300 return "Kyber-512-r3";
301 case Group_Params::KYBER_768_R3_OQS:
302 return "Kyber-768-r3";
303 case Group_Params::KYBER_1024_R3_OQS:
304 return "Kyber-1024-r3";
305
306 case Group_Params::eFRODOKEM_640_SHAKE_OQS:
307 return "eFrodoKEM-640-SHAKE";
308 case Group_Params::eFRODOKEM_976_SHAKE_OQS:
309 return "eFrodoKEM-976-SHAKE";
310 case Group_Params::eFRODOKEM_1344_SHAKE_OQS:
311 return "eFrodoKEM-1344-SHAKE";
312 case Group_Params::eFRODOKEM_640_AES_OQS:
313 return "eFrodoKEM-640-AES";
314 case Group_Params::eFRODOKEM_976_AES_OQS:
315 return "eFrodoKEM-976-AES";
316 case Group_Params::eFRODOKEM_1344_AES_OQS:
317 return "eFrodoKEM-1344-AES";
318
319 case Group_Params::HYBRID_X25519_eFRODOKEM_640_SHAKE_OQS:
320 return "x25519/eFrodoKEM-640-SHAKE";
321 case Group_Params::HYBRID_X25519_eFRODOKEM_640_AES_OQS:
322 return "x25519/eFrodoKEM-640-AES";
323 case Group_Params::HYBRID_X448_eFRODOKEM_976_SHAKE_OQS:
324 return "x448/eFrodoKEM-976-SHAKE";
325 case Group_Params::HYBRID_X448_eFRODOKEM_976_AES_OQS:
326 return "x448/eFrodoKEM-976-AES";
327 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_SHAKE_OQS:
328 return "secp256r1/eFrodoKEM-640-SHAKE";
329 case Group_Params::HYBRID_SECP256R1_eFRODOKEM_640_AES_OQS:
330 return "secp256r1/eFrodoKEM-640-AES";
331 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_SHAKE_OQS:
332 return "secp384r1/eFrodoKEM-976-SHAKE";
333 case Group_Params::HYBRID_SECP384R1_eFRODOKEM_976_AES_OQS:
334 return "secp384r1/eFrodoKEM-976-AES";
335 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_SHAKE_OQS:
336 return "secp521r1/eFrodoKEM-1344-SHAKE";
337 case Group_Params::HYBRID_SECP521R1_eFRODOKEM_1344_AES_OQS:
338 return "secp521r1/eFrodoKEM-1344-AES";
339
340 case Group_Params::HYBRID_X25519_KYBER_512_R3_CLOUDFLARE:
341 return "x25519/Kyber-512-r3/cloudflare";
342
343 case Group_Params::HYBRID_X25519_KYBER_512_R3_OQS:
344 return "x25519/Kyber-512-r3";
345 case Group_Params::HYBRID_X25519_KYBER_768_R3_OQS:
346 return "x25519/Kyber-768-r3";
347 case Group_Params::HYBRID_X448_KYBER_768_R3_OQS:
348 return "x448/Kyber-768-r3";
349
350 case Group_Params::HYBRID_SECP256R1_KYBER_512_R3_OQS:
351 return "secp256r1/Kyber-512-r3";
352 case Group_Params::HYBRID_SECP256R1_KYBER_768_R3_OQS:
353 return "secp256r1/Kyber-768-r3";
354 case Group_Params::HYBRID_SECP384R1_KYBER_768_R3_OQS:
355 return "secp384r1/Kyber-768-r3";
356 case Group_Params::HYBRID_SECP521R1_KYBER_1024_R3_OQS:
357 return "secp521r1/Kyber-1024-r3";
358
359 default:
360 return std::nullopt;
361 }
362}

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

◆ wire_code()

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

Definition at line 174 of file tls_algos.h.

174{ return static_cast<uint16_t>(m_code); }
The documentation for this class was generated from the following files:
Generated by doxygen 1.11.0