2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
14 #include <openssl/objects.h>
15 #include <openssl/comp.h>
16 #include <openssl/engine.h>
17 #include <openssl/crypto.h>
18 #include <openssl/conf.h>
19 #include <openssl/trace.h>
20 #include "internal/nelem.h"
22 #include "internal/thread_once.h"
23 #include "internal/cryptlib.h"
25 #define SSL_ENC_DES_IDX 0
26 #define SSL_ENC_3DES_IDX 1
27 #define SSL_ENC_RC4_IDX 2
28 #define SSL_ENC_RC2_IDX 3
29 #define SSL_ENC_IDEA_IDX 4
30 #define SSL_ENC_NULL_IDX 5
31 #define SSL_ENC_AES128_IDX 6
32 #define SSL_ENC_AES256_IDX 7
33 #define SSL_ENC_CAMELLIA128_IDX 8
34 #define SSL_ENC_CAMELLIA256_IDX 9
35 #define SSL_ENC_GOST89_IDX 10
36 #define SSL_ENC_SEED_IDX 11
37 #define SSL_ENC_AES128GCM_IDX 12
38 #define SSL_ENC_AES256GCM_IDX 13
39 #define SSL_ENC_AES128CCM_IDX 14
40 #define SSL_ENC_AES256CCM_IDX 15
41 #define SSL_ENC_AES128CCM8_IDX 16
42 #define SSL_ENC_AES256CCM8_IDX 17
43 #define SSL_ENC_GOST8912_IDX 18
44 #define SSL_ENC_CHACHA_IDX 19
45 #define SSL_ENC_ARIA128GCM_IDX 20
46 #define SSL_ENC_ARIA256GCM_IDX 21
47 #define SSL_ENC_NUM_IDX 22
49 /* NB: make sure indices in these tables match values above */
56 /* Table of NIDs for each cipher */
57 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
58 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
59 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
60 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
61 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
62 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
63 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
64 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
65 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
66 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
67 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
68 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
69 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
70 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
71 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
72 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
73 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
74 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
75 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
76 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX 18 */
77 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305}, /* SSL_ENC_CHACHA_IDX 19 */
78 {SSL_ARIA128GCM, NID_aria_128_gcm}, /* SSL_ENC_ARIA128GCM_IDX 20 */
79 {SSL_ARIA256GCM, NID_aria_256_gcm}, /* SSL_ENC_ARIA256GCM_IDX 21 */
82 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
84 #define SSL_COMP_NULL_IDX 0
85 #define SSL_COMP_ZLIB_IDX 1
86 #define SSL_COMP_NUM_IDX 2
88 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
90 #ifndef OPENSSL_NO_COMP
91 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
95 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
99 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
101 /* NB: make sure indices in this table matches values above */
102 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
103 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
104 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
105 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
106 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
107 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
108 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
109 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
110 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
111 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
112 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
113 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
114 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
117 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
118 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
122 static const ssl_cipher_table ssl_cipher_table_kx[] = {
123 {SSL_kRSA, NID_kx_rsa},
124 {SSL_kECDHE, NID_kx_ecdhe},
125 {SSL_kDHE, NID_kx_dhe},
126 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
127 {SSL_kDHEPSK, NID_kx_dhe_psk},
128 {SSL_kRSAPSK, NID_kx_rsa_psk},
129 {SSL_kPSK, NID_kx_psk},
130 {SSL_kSRP, NID_kx_srp},
131 {SSL_kGOST, NID_kx_gost},
132 {SSL_kANY, NID_kx_any}
135 static const ssl_cipher_table ssl_cipher_table_auth[] = {
136 {SSL_aRSA, NID_auth_rsa},
137 {SSL_aECDSA, NID_auth_ecdsa},
138 {SSL_aPSK, NID_auth_psk},
139 {SSL_aDSS, NID_auth_dss},
140 {SSL_aGOST01, NID_auth_gost01},
141 {SSL_aGOST12, NID_auth_gost12},
142 {SSL_aSRP, NID_auth_srp},
143 {SSL_aNULL, NID_auth_null},
144 {SSL_aANY, NID_auth_any}
148 /* Utility function for table lookup */
149 static int ssl_cipher_info_find(const ssl_cipher_table * table,
150 size_t table_cnt, uint32_t mask)
153 for (i = 0; i < table_cnt; i++, table++) {
154 if (table->mask == mask)
160 #define ssl_cipher_info_lookup(table, x) \
161 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
164 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
165 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
168 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
169 /* MD5, SHA, GOST94, MAC89 */
170 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
171 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
172 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
175 /* MD5/SHA1, SHA224, SHA512 */
176 NID_undef, NID_undef, NID_undef
179 static size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
182 #define CIPHER_KILL 2
185 #define CIPHER_SPECIAL 5
187 * Bump the ciphers to the top of the list.
188 * This rule isn't currently supported by the public cipherstring API.
190 #define CIPHER_BUMP 6
192 typedef struct cipher_order_st {
193 const SSL_CIPHER *cipher;
196 struct cipher_order_st *next, *prev;
199 static const SSL_CIPHER cipher_aliases[] = {
200 /* "ALL" doesn't include eNULL (must be specifically enabled) */
201 {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
202 /* "COMPLEMENTOFALL" */
203 {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
206 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
209 {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
212 * key exchange aliases (some of those using only a single bit here
213 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
214 * combines DHE_DSS and DHE_RSA)
216 {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
218 {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
219 {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
220 {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
222 {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
223 {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
224 {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
226 {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
227 {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
228 {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
229 {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
230 {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
231 {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
233 /* server authentication aliases */
234 {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
235 {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
236 {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
237 {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
238 {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
239 {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
240 {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
241 {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
242 {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
243 {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
244 {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
246 /* aliases combining key exchange and server authentication */
247 {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
248 {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
249 {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
250 {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
251 {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
252 {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
253 {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
254 {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
255 {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
256 {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
258 /* symmetric encryption aliases */
259 {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
260 {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
261 {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
262 {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
263 {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
264 {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
265 {0, SSL_TXT_GOST, NULL, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
266 {0, SSL_TXT_AES128, NULL, 0, 0, 0,
267 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
268 {0, SSL_TXT_AES256, NULL, 0, 0, 0,
269 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
270 {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
271 {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
272 {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
273 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
274 {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
275 {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
276 {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
277 {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
278 {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
280 {0, SSL_TXT_ARIA, NULL, 0, 0, 0, SSL_ARIA},
281 {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
282 {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
283 {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
286 {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
287 {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
288 {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
289 {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
290 {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
291 {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
292 {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
293 {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
295 /* protocol version aliases */
296 {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
297 {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
298 {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
299 {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
301 /* strength classes */
302 {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
303 {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
304 {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
305 /* FIPS 140-2 approved ciphersuite */
306 {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
308 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
309 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
310 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
311 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
312 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
317 * Search for public key algorithm with given name and return its pkey_id if
318 * it is available. Otherwise return 0
320 #ifdef OPENSSL_NO_ENGINE
322 static int get_optional_pkey_id(const char *pkey_name)
324 const EVP_PKEY_ASN1_METHOD *ameth;
326 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
327 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
335 static int get_optional_pkey_id(const char *pkey_name)
337 const EVP_PKEY_ASN1_METHOD *ameth;
338 ENGINE *tmpeng = NULL;
340 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
342 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
346 ENGINE_finish(tmpeng);
352 /* masks of disabled algorithms */
353 static uint32_t disabled_enc_mask;
354 static uint32_t disabled_mac_mask;
355 static uint32_t disabled_mkey_mask;
356 static uint32_t disabled_auth_mask;
358 int ssl_load_ciphers(void)
361 const ssl_cipher_table *t;
363 disabled_enc_mask = 0;
364 ssl_sort_cipher_list();
365 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
366 if (t->nid == NID_undef) {
367 ssl_cipher_methods[i] = NULL;
369 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
370 ssl_cipher_methods[i] = cipher;
372 disabled_enc_mask |= t->mask;
375 disabled_mac_mask = 0;
376 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
377 const EVP_MD *md = EVP_get_digestbynid(t->nid);
378 ssl_digest_methods[i] = md;
380 disabled_mac_mask |= t->mask;
382 int tmpsize = EVP_MD_size(md);
383 if (!ossl_assert(tmpsize >= 0))
385 ssl_mac_secret_size[i] = tmpsize;
388 /* Make sure we can access MD5 and SHA1 */
389 if (!ossl_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL))
391 if (!ossl_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL))
394 disabled_mkey_mask = 0;
395 disabled_auth_mask = 0;
397 #ifdef OPENSSL_NO_RSA
398 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
399 disabled_auth_mask |= SSL_aRSA;
401 #ifdef OPENSSL_NO_DSA
402 disabled_auth_mask |= SSL_aDSS;
405 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
408 disabled_mkey_mask |= SSL_kECDHE | SSL_kECDHEPSK;
409 disabled_auth_mask |= SSL_aECDSA;
411 #ifdef OPENSSL_NO_PSK
412 disabled_mkey_mask |= SSL_PSK;
413 disabled_auth_mask |= SSL_aPSK;
415 #ifdef OPENSSL_NO_SRP
416 disabled_mkey_mask |= SSL_kSRP;
420 * Check for presence of GOST 34.10 algorithms, and if they are not
421 * present, disable appropriate auth and key exchange
423 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
424 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
425 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
427 disabled_mac_mask |= SSL_GOST89MAC;
429 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
430 get_optional_pkey_id("gost-mac-12");
431 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
432 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
434 disabled_mac_mask |= SSL_GOST89MAC12;
436 if (!get_optional_pkey_id("gost2001"))
437 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
438 if (!get_optional_pkey_id("gost2012_256"))
439 disabled_auth_mask |= SSL_aGOST12;
440 if (!get_optional_pkey_id("gost2012_512"))
441 disabled_auth_mask |= SSL_aGOST12;
443 * Disable GOST key exchange if no GOST signature algs are available *
445 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
446 (SSL_aGOST01 | SSL_aGOST12))
447 disabled_mkey_mask |= SSL_kGOST;
452 #ifndef OPENSSL_NO_COMP
454 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
456 return ((*a)->id - (*b)->id);
459 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
461 SSL_COMP *comp = NULL;
462 COMP_METHOD *method = COMP_zlib();
464 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
465 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
467 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
468 comp = OPENSSL_malloc(sizeof(*comp));
470 comp->method = method;
471 comp->id = SSL_COMP_ZLIB_IDX;
472 comp->name = COMP_get_name(method);
473 sk_SSL_COMP_push(ssl_comp_methods, comp);
474 sk_SSL_COMP_sort(ssl_comp_methods);
477 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
481 static int load_builtin_compressions(void)
483 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
487 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
488 const EVP_MD **md, int *mac_pkey_type,
489 size_t *mac_secret_size, SSL_COMP **comp, int use_etm)
499 #ifndef OPENSSL_NO_COMP
500 if (!load_builtin_compressions()) {
502 * Currently don't care, since a failure only means that
503 * ssl_comp_methods is NULL, which is perfectly OK
508 ctmp.id = s->compress_meth;
509 if (ssl_comp_methods != NULL) {
510 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
511 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
513 /* If were only interested in comp then return success */
514 if ((enc == NULL) && (md == NULL))
518 if ((enc == NULL) || (md == NULL))
521 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
526 if (i == SSL_ENC_NULL_IDX)
527 *enc = EVP_enc_null();
529 *enc = ssl_cipher_methods[i];
532 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
535 if (mac_pkey_type != NULL)
536 *mac_pkey_type = NID_undef;
537 if (mac_secret_size != NULL)
538 *mac_secret_size = 0;
539 if (c->algorithm_mac == SSL_AEAD)
540 mac_pkey_type = NULL;
542 *md = ssl_digest_methods[i];
543 if (mac_pkey_type != NULL)
544 *mac_pkey_type = ssl_mac_pkey_id[i];
545 if (mac_secret_size != NULL)
546 *mac_secret_size = ssl_mac_secret_size[i];
549 if ((*enc != NULL) &&
550 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
551 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
552 const EVP_CIPHER *evp;
557 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
558 s->ssl_version < TLS1_VERSION)
561 if (c->algorithm_enc == SSL_RC4 &&
562 c->algorithm_mac == SSL_MD5 &&
563 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
564 *enc = evp, *md = NULL;
565 else if (c->algorithm_enc == SSL_AES128 &&
566 c->algorithm_mac == SSL_SHA1 &&
567 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
568 *enc = evp, *md = NULL;
569 else if (c->algorithm_enc == SSL_AES256 &&
570 c->algorithm_mac == SSL_SHA1 &&
571 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
572 *enc = evp, *md = NULL;
573 else if (c->algorithm_enc == SSL_AES128 &&
574 c->algorithm_mac == SSL_SHA256 &&
575 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
576 *enc = evp, *md = NULL;
577 else if (c->algorithm_enc == SSL_AES256 &&
578 c->algorithm_mac == SSL_SHA256 &&
579 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
580 *enc = evp, *md = NULL;
587 const EVP_MD *ssl_md(int idx)
589 idx &= SSL_HANDSHAKE_MAC_MASK;
590 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
592 return ssl_digest_methods[idx];
595 const EVP_MD *ssl_handshake_md(SSL *s)
597 return ssl_md(ssl_get_algorithm2(s));
600 const EVP_MD *ssl_prf_md(SSL *s)
602 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
605 #define ITEM_SEP(a) \
606 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
608 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
615 if (curr->prev != NULL)
616 curr->prev->next = curr->next;
617 if (curr->next != NULL)
618 curr->next->prev = curr->prev;
619 (*tail)->next = curr;
625 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
632 if (curr->next != NULL)
633 curr->next->prev = curr->prev;
634 if (curr->prev != NULL)
635 curr->prev->next = curr->next;
636 (*head)->prev = curr;
642 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
644 uint32_t disabled_mkey,
645 uint32_t disabled_auth,
646 uint32_t disabled_enc,
647 uint32_t disabled_mac,
648 CIPHER_ORDER *co_list,
649 CIPHER_ORDER **head_p,
650 CIPHER_ORDER **tail_p)
656 * We have num_of_ciphers descriptions compiled in, depending on the
657 * method selected (SSLv3, TLSv1 etc).
658 * These will later be sorted in a linked list with at most num
662 /* Get the initial list of ciphers */
663 co_list_num = 0; /* actual count of ciphers */
664 for (i = 0; i < num_of_ciphers; i++) {
665 c = ssl_method->get_cipher(i);
666 /* drop those that use any of that is not available */
667 if (c == NULL || !c->valid)
669 if ((c->algorithm_mkey & disabled_mkey) ||
670 (c->algorithm_auth & disabled_auth) ||
671 (c->algorithm_enc & disabled_enc) ||
672 (c->algorithm_mac & disabled_mac))
674 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
677 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
681 co_list[co_list_num].cipher = c;
682 co_list[co_list_num].next = NULL;
683 co_list[co_list_num].prev = NULL;
684 co_list[co_list_num].active = 0;
689 * Prepare linked list from list entries
691 if (co_list_num > 0) {
692 co_list[0].prev = NULL;
694 if (co_list_num > 1) {
695 co_list[0].next = &co_list[1];
697 for (i = 1; i < co_list_num - 1; i++) {
698 co_list[i].prev = &co_list[i - 1];
699 co_list[i].next = &co_list[i + 1];
702 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
705 co_list[co_list_num - 1].next = NULL;
707 *head_p = &co_list[0];
708 *tail_p = &co_list[co_list_num - 1];
712 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
713 int num_of_group_aliases,
714 uint32_t disabled_mkey,
715 uint32_t disabled_auth,
716 uint32_t disabled_enc,
717 uint32_t disabled_mac,
720 CIPHER_ORDER *ciph_curr;
721 const SSL_CIPHER **ca_curr;
723 uint32_t mask_mkey = ~disabled_mkey;
724 uint32_t mask_auth = ~disabled_auth;
725 uint32_t mask_enc = ~disabled_enc;
726 uint32_t mask_mac = ~disabled_mac;
729 * First, add the real ciphers as already collected
733 while (ciph_curr != NULL) {
734 *ca_curr = ciph_curr->cipher;
736 ciph_curr = ciph_curr->next;
740 * Now we add the available ones from the cipher_aliases[] table.
741 * They represent either one or more algorithms, some of which
742 * in any affected category must be supported (set in enabled_mask),
743 * or represent a cipher strength value (will be added in any case because algorithms=0).
745 for (i = 0; i < num_of_group_aliases; i++) {
746 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
747 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
748 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
749 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
752 if ((algorithm_mkey & mask_mkey) == 0)
756 if ((algorithm_auth & mask_auth) == 0)
760 if ((algorithm_enc & mask_enc) == 0)
764 if ((algorithm_mac & mask_mac) == 0)
767 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
771 *ca_curr = NULL; /* end of list */
774 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
775 uint32_t alg_auth, uint32_t alg_enc,
776 uint32_t alg_mac, int min_tls,
777 uint32_t algo_strength, int rule,
778 int32_t strength_bits, CIPHER_ORDER **head_p,
779 CIPHER_ORDER **tail_p)
781 CIPHER_ORDER *head, *tail, *curr, *next, *last;
782 const SSL_CIPHER *cp;
785 OSSL_TRACE_BEGIN(TLS_CIPHER){
787 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
788 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
789 algo_strength, strength_bits);
792 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
793 reverse = 1; /* needed to maintain sorting between currently
817 next = reverse ? curr->prev : curr->next;
822 * Selection criteria is either the value of strength_bits
823 * or the algorithms used.
825 if (strength_bits >= 0) {
826 if (strength_bits != cp->strength_bits)
829 if (trc_out != NULL) {
832 "\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
833 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
834 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
837 if (cipher_id != 0 && (cipher_id != cp->id))
839 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
841 if (alg_auth && !(alg_auth & cp->algorithm_auth))
843 if (alg_enc && !(alg_enc & cp->algorithm_enc))
845 if (alg_mac && !(alg_mac & cp->algorithm_mac))
847 if (min_tls && (min_tls != cp->min_tls))
849 if ((algo_strength & SSL_STRONG_MASK)
850 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
852 if ((algo_strength & SSL_DEFAULT_MASK)
853 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
858 BIO_printf(trc_out, "Action = %d\n", rule);
860 /* add the cipher if it has not been added yet. */
861 if (rule == CIPHER_ADD) {
864 ll_append_tail(&head, curr, &tail);
868 /* Move the added cipher to this location */
869 else if (rule == CIPHER_ORD) {
872 ll_append_tail(&head, curr, &tail);
874 } else if (rule == CIPHER_DEL) {
878 * most recently deleted ciphersuites get best positions for
879 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
880 * in reverse to maintain the order)
882 ll_append_head(&head, curr, &tail);
885 } else if (rule == CIPHER_BUMP) {
887 ll_append_head(&head, curr, &tail);
888 } else if (rule == CIPHER_KILL) {
893 curr->prev->next = curr->next;
897 if (curr->next != NULL)
898 curr->next->prev = curr->prev;
899 if (curr->prev != NULL)
900 curr->prev->next = curr->next;
909 OSSL_TRACE_END(TLS_CIPHER);
912 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
913 CIPHER_ORDER **tail_p)
915 int32_t max_strength_bits;
920 * This routine sorts the ciphers with descending strength. The sorting
921 * must keep the pre-sorted sequence, so we apply the normal sorting
922 * routine as '+' movement to the end of the list.
924 max_strength_bits = 0;
926 while (curr != NULL) {
927 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
928 max_strength_bits = curr->cipher->strength_bits;
932 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
933 if (number_uses == NULL) {
934 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
939 * Now find the strength_bits values actually used
942 while (curr != NULL) {
944 number_uses[curr->cipher->strength_bits]++;
948 * Go through the list of used strength_bits values in descending
951 for (i = max_strength_bits; i >= 0; i--)
952 if (number_uses[i] > 0)
953 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
956 OPENSSL_free(number_uses);
960 static int ssl_cipher_process_rulestr(const char *rule_str,
961 CIPHER_ORDER **head_p,
962 CIPHER_ORDER **tail_p,
963 const SSL_CIPHER **ca_list, CERT *c)
965 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
968 int j, multi, found, rule, retval, ok, buflen;
969 uint32_t cipher_id = 0;
982 } else if (ch == '+') {
985 } else if (ch == '!') {
988 } else if (ch == '@') {
989 rule = CIPHER_SPECIAL;
1011 #ifndef CHARSET_EBCDIC
1012 while (((ch >= 'A') && (ch <= 'Z')) ||
1013 ((ch >= '0') && (ch <= '9')) ||
1014 ((ch >= 'a') && (ch <= 'z')) ||
1015 (ch == '-') || (ch == '.') || (ch == '='))
1017 while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1027 * We hit something we cannot deal with,
1028 * it is no command or separator nor
1029 * alphanumeric, so we call this an error.
1031 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1037 if (rule == CIPHER_SPECIAL) {
1038 found = 0; /* unused -- avoid compiler warning */
1039 break; /* special treatment */
1042 /* check for multi-part specification */
1051 * Now search for the cipher alias in the ca_list. Be careful
1052 * with the strncmp, because the "buflen" limitation
1053 * will make the rule "ADH:SOME" and the cipher
1054 * "ADH-MY-CIPHER" look like a match for buflen=3.
1055 * So additionally check whether the cipher name found
1056 * has the correct length. We can save a strlen() call:
1057 * just checking for the '\0' at the right place is
1058 * sufficient, we have to strncmp() anyway. (We cannot
1059 * use strcmp(), because buf is not '\0' terminated.)
1063 while (ca_list[j]) {
1064 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1065 && (ca_list[j]->name[buflen] == '\0')) {
1073 break; /* ignore this entry */
1075 if (ca_list[j]->algorithm_mkey) {
1077 alg_mkey &= ca_list[j]->algorithm_mkey;
1083 alg_mkey = ca_list[j]->algorithm_mkey;
1087 if (ca_list[j]->algorithm_auth) {
1089 alg_auth &= ca_list[j]->algorithm_auth;
1095 alg_auth = ca_list[j]->algorithm_auth;
1099 if (ca_list[j]->algorithm_enc) {
1101 alg_enc &= ca_list[j]->algorithm_enc;
1107 alg_enc = ca_list[j]->algorithm_enc;
1111 if (ca_list[j]->algorithm_mac) {
1113 alg_mac &= ca_list[j]->algorithm_mac;
1119 alg_mac = ca_list[j]->algorithm_mac;
1123 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1124 if (algo_strength & SSL_STRONG_MASK) {
1126 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1128 if (!(algo_strength & SSL_STRONG_MASK)) {
1133 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1137 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1138 if (algo_strength & SSL_DEFAULT_MASK) {
1140 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1142 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1148 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1152 if (ca_list[j]->valid) {
1154 * explicit ciphersuite found; its protocol version does not
1155 * become part of the search pattern!
1158 cipher_id = ca_list[j]->id;
1161 * not an explicit ciphersuite; only in this case, the
1162 * protocol version is considered part of the search pattern
1165 if (ca_list[j]->min_tls) {
1166 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1170 min_tls = ca_list[j]->min_tls;
1180 * Ok, we have the rule, now apply it
1182 if (rule == CIPHER_SPECIAL) { /* special command */
1184 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1185 ok = ssl_cipher_strength_sort(head_p, tail_p);
1186 } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1187 int level = buf[9] - '0';
1188 if (level < 0 || level > 5) {
1189 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1190 SSL_R_INVALID_COMMAND);
1192 c->sec_level = level;
1196 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1201 * We do not support any "multi" options
1202 * together with "@", so throw away the
1203 * rest of the command, if any left, until
1204 * end or ':' is found.
1206 while ((*l != '\0') && !ITEM_SEP(*l))
1209 ssl_cipher_apply_rule(cipher_id,
1210 alg_mkey, alg_auth, alg_enc, alg_mac,
1211 min_tls, algo_strength, rule, -1, head_p,
1214 while ((*l != '\0') && !ITEM_SEP(*l))
1224 #ifndef OPENSSL_NO_EC
1225 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1226 const char **prule_str)
1228 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1229 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1230 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1231 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1233 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1234 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1235 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1236 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1237 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1241 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1242 c->cert_flags |= suiteb_flags;
1244 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1249 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1251 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1252 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1253 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1256 # ifndef OPENSSL_NO_EC
1257 switch (suiteb_flags) {
1258 case SSL_CERT_FLAG_SUITEB_128_LOS:
1260 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1263 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1265 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1266 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1268 case SSL_CERT_FLAG_SUITEB_192_LOS:
1269 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1274 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1280 static int ciphersuite_cb(const char *elem, int len, void *arg)
1282 STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
1283 const SSL_CIPHER *cipher;
1284 /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
1287 if (len > (int)(sizeof(name) - 1)) {
1288 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1292 memcpy(name, elem, len);
1295 cipher = ssl3_get_cipher_by_std_name(name);
1296 if (cipher == NULL) {
1297 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1301 if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
1302 SSLerr(SSL_F_CIPHERSUITE_CB, ERR_R_INTERNAL_ERROR);
1309 static __owur int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
1311 STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
1313 if (newciphers == NULL)
1316 /* Parse the list. We explicitly allow an empty list */
1318 && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
1319 sk_SSL_CIPHER_free(newciphers);
1322 sk_SSL_CIPHER_free(*currciphers);
1323 *currciphers = newciphers;
1328 static int update_cipher_list_by_id(STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1329 STACK_OF(SSL_CIPHER) *cipherstack)
1331 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1333 if (tmp_cipher_list == NULL) {
1337 sk_SSL_CIPHER_free(*cipher_list_by_id);
1338 *cipher_list_by_id = tmp_cipher_list;
1340 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1341 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1346 static int update_cipher_list(STACK_OF(SSL_CIPHER) **cipher_list,
1347 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1348 STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
1351 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(*cipher_list);
1353 if (tmp_cipher_list == NULL)
1357 * Delete any existing TLSv1.3 ciphersuites. These are always first in the
1360 while (sk_SSL_CIPHER_num(tmp_cipher_list) > 0
1361 && sk_SSL_CIPHER_value(tmp_cipher_list, 0)->min_tls
1363 sk_SSL_CIPHER_delete(tmp_cipher_list, 0);
1365 /* Insert the new TLSv1.3 ciphersuites */
1366 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
1367 sk_SSL_CIPHER_insert(tmp_cipher_list,
1368 sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
1370 if (!update_cipher_list_by_id(cipher_list_by_id, tmp_cipher_list))
1373 sk_SSL_CIPHER_free(*cipher_list);
1374 *cipher_list = tmp_cipher_list;
1379 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
1381 int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
1383 if (ret && ctx->cipher_list != NULL)
1384 return update_cipher_list(&ctx->cipher_list, &ctx->cipher_list_by_id,
1385 ctx->tls13_ciphersuites);
1390 int SSL_set_ciphersuites(SSL *s, const char *str)
1392 STACK_OF(SSL_CIPHER) *cipher_list;
1393 int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
1395 if (s->cipher_list == NULL) {
1396 if ((cipher_list = SSL_get_ciphers(s)) != NULL)
1397 s->cipher_list = sk_SSL_CIPHER_dup(cipher_list);
1399 if (ret && s->cipher_list != NULL)
1400 return update_cipher_list(&s->cipher_list, &s->cipher_list_by_id,
1401 s->tls13_ciphersuites);
1406 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
1407 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
1408 STACK_OF(SSL_CIPHER) **cipher_list,
1409 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1410 const char *rule_str,
1413 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases, i;
1414 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1415 STACK_OF(SSL_CIPHER) *cipherstack;
1417 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1418 const SSL_CIPHER **ca_list = NULL;
1421 * Return with error if nothing to do.
1423 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1425 #ifndef OPENSSL_NO_EC
1426 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1431 * To reduce the work to do we only want to process the compiled
1432 * in algorithms, so we first get the mask of disabled ciphers.
1435 disabled_mkey = disabled_mkey_mask;
1436 disabled_auth = disabled_auth_mask;
1437 disabled_enc = disabled_enc_mask;
1438 disabled_mac = disabled_mac_mask;
1441 * Now we have to collect the available ciphers from the compiled
1442 * in ciphers. We cannot get more than the number compiled in, so
1443 * it is used for allocation.
1445 num_of_ciphers = ssl_method->num_ciphers();
1447 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1448 if (co_list == NULL) {
1449 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1450 return NULL; /* Failure */
1453 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1454 disabled_mkey, disabled_auth, disabled_enc,
1455 disabled_mac, co_list, &head, &tail);
1457 /* Now arrange all ciphers by preference. */
1460 * Everything else being equal, prefer ephemeral ECDH over other key
1461 * exchange mechanisms.
1462 * For consistency, prefer ECDSA over RSA (though this only matters if the
1463 * server has both certificates, and is using the DEFAULT, or a client
1466 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1468 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1470 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1473 /* Within each strength group, we prefer GCM over CHACHA... */
1474 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1476 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1480 * ...and generally, our preferred cipher is AES.
1481 * Note that AEADs will be bumped to take preference after sorting by
1484 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1487 /* Temporarily enable everything else for sorting */
1488 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1490 /* Low priority for MD5 */
1491 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1495 * Move anonymous ciphers to the end. Usually, these will remain
1496 * disabled. (For applications that allow them, they aren't too bad, but
1497 * we prefer authenticated ciphers.)
1499 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1502 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1504 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1507 /* RC4 is sort-of broken -- move to the end */
1508 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1512 * Now sort by symmetric encryption strength. The above ordering remains
1513 * in force within each class
1515 if (!ssl_cipher_strength_sort(&head, &tail)) {
1516 OPENSSL_free(co_list);
1521 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1522 * TODO(openssl-team): is there an easier way to accomplish all this?
1524 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1528 * Irrespective of strength, enforce the following order:
1529 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1530 * Within each group, ciphers remain sorted by strength and previous
1535 * 4) TLS 1.2 > legacy
1537 * Because we now bump ciphers to the top of the list, we proceed in
1538 * reverse order of preference.
1540 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1542 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1543 CIPHER_BUMP, -1, &head, &tail);
1544 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1545 CIPHER_BUMP, -1, &head, &tail);
1547 /* Now disable everything (maintaining the ordering!) */
1548 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1551 * We also need cipher aliases for selecting based on the rule_str.
1552 * There might be two types of entries in the rule_str: 1) names
1553 * of ciphers themselves 2) aliases for groups of ciphers.
1554 * For 1) we need the available ciphers and for 2) the cipher
1555 * groups of cipher_aliases added together in one list (otherwise
1556 * we would be happy with just the cipher_aliases table).
1558 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1559 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1560 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1561 if (ca_list == NULL) {
1562 OPENSSL_free(co_list);
1563 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1564 return NULL; /* Failure */
1566 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1567 disabled_mkey, disabled_auth, disabled_enc,
1568 disabled_mac, head);
1571 * If the rule_string begins with DEFAULT, apply the default rule
1572 * before using the (possibly available) additional rules.
1576 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1577 ok = ssl_cipher_process_rulestr(OSSL_default_cipher_list(),
1578 &head, &tail, ca_list, c);
1584 if (ok && (strlen(rule_p) > 0))
1585 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1587 OPENSSL_free(ca_list); /* Not needed anymore */
1589 if (!ok) { /* Rule processing failure */
1590 OPENSSL_free(co_list);
1595 * Allocate new "cipherstack" for the result, return with error
1596 * if we cannot get one.
1598 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1599 OPENSSL_free(co_list);
1603 /* Add TLSv1.3 ciphers first - we always prefer those if possible */
1604 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++) {
1605 if (!sk_SSL_CIPHER_push(cipherstack,
1606 sk_SSL_CIPHER_value(tls13_ciphersuites, i))) {
1607 sk_SSL_CIPHER_free(cipherstack);
1612 OSSL_TRACE_BEGIN(TLS_CIPHER) {
1613 BIO_printf(trc_out, "cipher selection:\n");
1616 * The cipher selection for the list is done. The ciphers are added
1617 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1619 for (curr = head; curr != NULL; curr = curr->next) {
1621 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1622 OPENSSL_free(co_list);
1623 sk_SSL_CIPHER_free(cipherstack);
1624 OSSL_TRACE_CANCEL(TLS_CIPHER);
1627 if (trc_out != NULL)
1628 BIO_printf(trc_out, "<%s>\n", curr->cipher->name);
1631 OPENSSL_free(co_list); /* Not needed any longer */
1632 OSSL_TRACE_END(TLS_CIPHER);
1634 if (!update_cipher_list_by_id(cipher_list_by_id, cipherstack)) {
1635 sk_SSL_CIPHER_free(cipherstack);
1638 sk_SSL_CIPHER_free(*cipher_list);
1639 *cipher_list = cipherstack;
1644 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1647 const char *kx, *au, *enc, *mac;
1648 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1649 static const char *format = "%-30s %-7s Kx=%-8s Au=%-5s Enc=%-9s Mac=%-4s\n";
1653 if ((buf = OPENSSL_malloc(len)) == NULL) {
1654 SSLerr(SSL_F_SSL_CIPHER_DESCRIPTION, ERR_R_MALLOC_FAILURE);
1657 } else if (len < 128) {
1661 alg_mkey = cipher->algorithm_mkey;
1662 alg_auth = cipher->algorithm_auth;
1663 alg_enc = cipher->algorithm_enc;
1664 alg_mac = cipher->algorithm_mac;
1666 ver = ssl_protocol_to_string(cipher->min_tls);
1725 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1726 case (SSL_aGOST12 | SSL_aGOST01):
1763 enc = "AESGCM(128)";
1766 enc = "AESGCM(256)";
1769 enc = "AESCCM(128)";
1772 enc = "AESCCM(256)";
1774 case SSL_AES128CCM8:
1775 enc = "AESCCM8(128)";
1777 case SSL_AES256CCM8:
1778 enc = "AESCCM8(256)";
1780 case SSL_CAMELLIA128:
1781 enc = "Camellia(128)";
1783 case SSL_CAMELLIA256:
1784 enc = "Camellia(256)";
1786 case SSL_ARIA128GCM:
1787 enc = "ARIAGCM(128)";
1789 case SSL_ARIA256GCM:
1790 enc = "ARIAGCM(256)";
1795 case SSL_eGOST2814789CNT:
1796 case SSL_eGOST2814789CNT12:
1797 enc = "GOST89(256)";
1799 case SSL_CHACHA20POLY1305:
1800 enc = "CHACHA20/POLY1305(256)";
1824 case SSL_GOST89MAC12:
1830 case SSL_GOST12_256:
1831 case SSL_GOST12_512:
1839 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1844 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1850 * Backwards-compatibility crutch. In almost all contexts we report TLS
1851 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1853 if (c->min_tls == TLS1_VERSION)
1855 return ssl_protocol_to_string(c->min_tls);
1858 /* return the actual cipher being used */
1859 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1866 /* return the actual cipher being used in RFC standard name */
1867 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1874 /* return the OpenSSL name based on given RFC standard name */
1875 const char *OPENSSL_cipher_name(const char *stdname)
1877 const SSL_CIPHER *c;
1879 if (stdname == NULL)
1881 c = ssl3_get_cipher_by_std_name(stdname);
1882 return SSL_CIPHER_get_name(c);
1885 /* number of bits for symmetric cipher */
1886 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1891 if (alg_bits != NULL)
1892 *alg_bits = (int)c->alg_bits;
1893 ret = (int)c->strength_bits;
1898 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1903 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1905 return c->id & 0xFFFF;
1908 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1913 if ((n == 0) || (sk == NULL))
1915 nn = sk_SSL_COMP_num(sk);
1916 for (i = 0; i < nn; i++) {
1917 ctmp = sk_SSL_COMP_value(sk, i);
1924 #ifdef OPENSSL_NO_COMP
1925 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1930 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1936 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1942 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1944 load_builtin_compressions();
1945 return ssl_comp_methods;
1948 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1951 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1952 ssl_comp_methods = meths;
1956 static void cmeth_free(SSL_COMP *cm)
1961 void ssl_comp_free_compression_methods_int(void)
1963 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1964 ssl_comp_methods = NULL;
1965 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1968 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1972 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1976 * According to draft-ietf-tls-compression-04.txt, the
1977 * compression number ranges should be the following:
1979 * 0 to 63: methods defined by the IETF
1980 * 64 to 192: external party methods assigned by IANA
1981 * 193 to 255: reserved for private use
1983 if (id < 193 || id > 255) {
1984 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1985 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1989 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1990 comp = OPENSSL_malloc(sizeof(*comp));
1992 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1993 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1999 load_builtin_compressions();
2000 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
2002 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
2003 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
2004 SSL_R_DUPLICATE_COMPRESSION_ID);
2007 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
2009 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
2010 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
2013 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
2018 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
2020 #ifndef OPENSSL_NO_COMP
2021 return comp ? COMP_get_name(comp) : NULL;
2027 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
2029 #ifndef OPENSSL_NO_COMP
2036 int SSL_COMP_get_id(const SSL_COMP *comp)
2038 #ifndef OPENSSL_NO_COMP
2045 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
2048 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
2050 if (c == NULL || (!all && c->valid == 0))
2055 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
2057 return ssl->method->get_cipher_by_char(ptr);
2060 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2065 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2068 return ssl_cipher_table_cipher[i].nid;
2071 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2073 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2077 return ssl_cipher_table_mac[i].nid;
2080 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2082 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2086 return ssl_cipher_table_kx[i].nid;
2089 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2091 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2095 return ssl_cipher_table_auth[i].nid;
2098 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
2100 int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
2102 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
2104 return ssl_digest_methods[idx];
2107 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2109 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
2112 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2113 size_t *int_overhead, size_t *blocksize,
2114 size_t *ext_overhead)
2116 size_t mac = 0, in = 0, blk = 0, out = 0;
2118 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
2119 * because there are no handy #defines for those. */
2120 if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
2121 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
2122 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
2123 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
2124 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
2125 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
2126 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
2128 } else if (c->algorithm_mac & SSL_AEAD) {
2129 /* We're supposed to have handled all the AEAD modes above */
2132 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
2133 int digest_nid = SSL_CIPHER_get_digest_nid(c);
2134 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2139 mac = EVP_MD_size(e_md);
2140 if (c->algorithm_enc != SSL_eNULL) {
2141 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2142 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2144 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2145 known CBC cipher. */
2146 if (e_ciph == NULL ||
2147 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2150 in = 1; /* padding length byte */
2151 out = EVP_CIPHER_iv_length(e_ciph);
2152 blk = EVP_CIPHER_block_size(e_ciph);
2156 *mac_overhead = mac;
2159 *ext_overhead = out;
2164 int ssl_cert_is_disabled(size_t idx)
2166 const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2168 if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)
2174 * Default list of TLSv1.2 (and earlier) ciphers
2175 * SSL_DEFAULT_CIPHER_LIST deprecated in 3.0.0
2176 * Update both macro and function simultaneously
2178 const char *OSSL_default_cipher_list(void)
2180 return "ALL:!COMPLEMENTOFDEFAULT:!eNULL";
2184 * Default list of TLSv1.3 (and later) ciphers
2185 * TLS_DEFAULT_CIPHERSUITES deprecated in 3.0.0
2186 * Update both macro and function simultaneously
2188 const char *OSSL_default_ciphersuites(void)
2190 return "TLS_AES_256_GCM_SHA384:"
2191 #if !defined(OPENSSL_NO_CHACHA) && !defined(OPENSSL_NO_POLY1305)
2192 "TLS_CHACHA20_POLY1305_SHA256:"
2194 "TLS_AES_128_GCM_SHA256";