2 * Copyright 1995-2019 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 OpenSSL license (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 "internal/nelem.h"
20 #include "ssl_local.h"
21 #include "internal/thread_once.h"
22 #include "internal/cryptlib.h"
24 #define SSL_ENC_DES_IDX 0
25 #define SSL_ENC_3DES_IDX 1
26 #define SSL_ENC_RC4_IDX 2
27 #define SSL_ENC_RC2_IDX 3
28 #define SSL_ENC_IDEA_IDX 4
29 #define SSL_ENC_NULL_IDX 5
30 #define SSL_ENC_AES128_IDX 6
31 #define SSL_ENC_AES256_IDX 7
32 #define SSL_ENC_CAMELLIA128_IDX 8
33 #define SSL_ENC_CAMELLIA256_IDX 9
34 #define SSL_ENC_GOST89_IDX 10
35 #define SSL_ENC_SEED_IDX 11
36 #define SSL_ENC_AES128GCM_IDX 12
37 #define SSL_ENC_AES256GCM_IDX 13
38 #define SSL_ENC_AES128CCM_IDX 14
39 #define SSL_ENC_AES256CCM_IDX 15
40 #define SSL_ENC_AES128CCM8_IDX 16
41 #define SSL_ENC_AES256CCM8_IDX 17
42 #define SSL_ENC_GOST8912_IDX 18
43 #define SSL_ENC_CHACHA_IDX 19
44 #define SSL_ENC_ARIA128GCM_IDX 20
45 #define SSL_ENC_ARIA256GCM_IDX 21
46 #define SSL_ENC_NUM_IDX 22
48 /* NB: make sure indices in these tables match values above */
55 /* Table of NIDs for each cipher */
56 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
57 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
58 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
59 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
60 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
61 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
62 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
63 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
64 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
65 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
66 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
67 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
68 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
69 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
70 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
71 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
72 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
73 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
74 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
75 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX 18 */
76 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305}, /* SSL_ENC_CHACHA_IDX 19 */
77 {SSL_ARIA128GCM, NID_aria_128_gcm}, /* SSL_ENC_ARIA128GCM_IDX 20 */
78 {SSL_ARIA256GCM, NID_aria_256_gcm}, /* SSL_ENC_ARIA256GCM_IDX 21 */
81 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
83 #define SSL_COMP_NULL_IDX 0
84 #define SSL_COMP_ZLIB_IDX 1
85 #define SSL_COMP_NUM_IDX 2
87 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
89 #ifndef OPENSSL_NO_COMP
90 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
94 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
98 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
100 /* NB: make sure indices in this table matches values above */
101 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
102 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
103 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
104 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
105 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
106 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
107 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
108 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
109 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
110 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
111 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
112 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
113 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
116 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
117 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
121 static const ssl_cipher_table ssl_cipher_table_kx[] = {
122 {SSL_kRSA, NID_kx_rsa},
123 {SSL_kECDHE, NID_kx_ecdhe},
124 {SSL_kDHE, NID_kx_dhe},
125 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
126 {SSL_kDHEPSK, NID_kx_dhe_psk},
127 {SSL_kRSAPSK, NID_kx_rsa_psk},
128 {SSL_kPSK, NID_kx_psk},
129 {SSL_kSRP, NID_kx_srp},
130 {SSL_kGOST, NID_kx_gost},
131 {SSL_kANY, NID_kx_any}
134 static const ssl_cipher_table ssl_cipher_table_auth[] = {
135 {SSL_aRSA, NID_auth_rsa},
136 {SSL_aECDSA, NID_auth_ecdsa},
137 {SSL_aPSK, NID_auth_psk},
138 {SSL_aDSS, NID_auth_dss},
139 {SSL_aGOST01, NID_auth_gost01},
140 {SSL_aGOST12, NID_auth_gost12},
141 {SSL_aSRP, NID_auth_srp},
142 {SSL_aNULL, NID_auth_null},
143 {SSL_aANY, NID_auth_any}
147 /* Utility function for table lookup */
148 static int ssl_cipher_info_find(const ssl_cipher_table * table,
149 size_t table_cnt, uint32_t mask)
152 for (i = 0; i < table_cnt; i++, table++) {
153 if (table->mask == mask)
159 #define ssl_cipher_info_lookup(table, x) \
160 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
163 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
164 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
167 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
168 /* MD5, SHA, GOST94, MAC89 */
169 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
170 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
171 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
174 /* MD5/SHA1, SHA224, SHA512 */
175 NID_undef, NID_undef, NID_undef
178 static size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
181 #define CIPHER_KILL 2
184 #define CIPHER_SPECIAL 5
186 * Bump the ciphers to the top of the list.
187 * This rule isn't currently supported by the public cipherstring API.
189 #define CIPHER_BUMP 6
191 typedef struct cipher_order_st {
192 const SSL_CIPHER *cipher;
195 struct cipher_order_st *next, *prev;
198 static const SSL_CIPHER cipher_aliases[] = {
199 /* "ALL" doesn't include eNULL (must be specifically enabled) */
200 {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
201 /* "COMPLEMENTOFALL" */
202 {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
205 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
208 {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
211 * key exchange aliases (some of those using only a single bit here
212 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
213 * combines DHE_DSS and DHE_RSA)
215 {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
217 {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
218 {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
219 {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
221 {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
222 {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
223 {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
225 {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
226 {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
227 {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
228 {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
229 {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
230 {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
232 /* server authentication aliases */
233 {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
234 {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
235 {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
236 {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
237 {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
238 {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
239 {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
240 {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
241 {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
242 {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
243 {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
245 /* aliases combining key exchange and server authentication */
246 {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
247 {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
248 {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
249 {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
250 {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
251 {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
252 {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
253 {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
254 {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
255 {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
257 /* symmetric encryption aliases */
258 {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
259 {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
260 {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
261 {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
262 {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
263 {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
264 {0, SSL_TXT_GOST, NULL, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
265 {0, SSL_TXT_AES128, NULL, 0, 0, 0,
266 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
267 {0, SSL_TXT_AES256, NULL, 0, 0, 0,
268 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
269 {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
270 {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
271 {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
272 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
273 {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
274 {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
275 {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
276 {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
277 {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
279 {0, SSL_TXT_ARIA, NULL, 0, 0, 0, SSL_ARIA},
280 {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
281 {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
282 {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
285 {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
286 {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
287 {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
288 {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
289 {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
290 {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
291 {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
292 {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
294 /* protocol version aliases */
295 {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
296 {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
297 {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
298 {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
300 /* strength classes */
301 {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
302 {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
303 {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
304 /* FIPS 140-2 approved ciphersuite */
305 {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
307 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
308 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
309 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
310 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
311 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
316 * Search for public key algorithm with given name and return its pkey_id if
317 * it is available. Otherwise return 0
319 #ifdef OPENSSL_NO_ENGINE
321 static int get_optional_pkey_id(const char *pkey_name)
323 const EVP_PKEY_ASN1_METHOD *ameth;
325 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
326 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
334 static int get_optional_pkey_id(const char *pkey_name)
336 const EVP_PKEY_ASN1_METHOD *ameth;
337 ENGINE *tmpeng = NULL;
339 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
341 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
345 ENGINE_finish(tmpeng);
351 /* masks of disabled algorithms */
352 static uint32_t disabled_enc_mask;
353 static uint32_t disabled_mac_mask;
354 static uint32_t disabled_mkey_mask;
355 static uint32_t disabled_auth_mask;
357 int ssl_load_ciphers(void)
360 const ssl_cipher_table *t;
362 disabled_enc_mask = 0;
363 ssl_sort_cipher_list();
364 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
365 if (t->nid == NID_undef) {
366 ssl_cipher_methods[i] = NULL;
368 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
369 ssl_cipher_methods[i] = cipher;
371 disabled_enc_mask |= t->mask;
374 disabled_mac_mask = 0;
375 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
376 const EVP_MD *md = EVP_get_digestbynid(t->nid);
377 ssl_digest_methods[i] = md;
379 disabled_mac_mask |= t->mask;
381 int tmpsize = EVP_MD_size(md);
382 if (!ossl_assert(tmpsize >= 0))
384 ssl_mac_secret_size[i] = tmpsize;
387 /* Make sure we can access MD5 and SHA1 */
388 if (!ossl_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL))
390 if (!ossl_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL))
393 disabled_mkey_mask = 0;
394 disabled_auth_mask = 0;
396 #ifdef OPENSSL_NO_RSA
397 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
398 disabled_auth_mask |= SSL_aRSA;
400 #ifdef OPENSSL_NO_DSA
401 disabled_auth_mask |= SSL_aDSS;
404 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
407 disabled_mkey_mask |= SSL_kECDHE | SSL_kECDHEPSK;
408 disabled_auth_mask |= SSL_aECDSA;
410 #ifdef OPENSSL_NO_PSK
411 disabled_mkey_mask |= SSL_PSK;
412 disabled_auth_mask |= SSL_aPSK;
414 #ifdef OPENSSL_NO_SRP
415 disabled_mkey_mask |= SSL_kSRP;
419 * Check for presence of GOST 34.10 algorithms, and if they are not
420 * present, disable appropriate auth and key exchange
422 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
423 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
424 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
426 disabled_mac_mask |= SSL_GOST89MAC;
428 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
429 get_optional_pkey_id("gost-mac-12");
430 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
431 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
433 disabled_mac_mask |= SSL_GOST89MAC12;
435 if (!get_optional_pkey_id("gost2001"))
436 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
437 if (!get_optional_pkey_id("gost2012_256"))
438 disabled_auth_mask |= SSL_aGOST12;
439 if (!get_optional_pkey_id("gost2012_512"))
440 disabled_auth_mask |= SSL_aGOST12;
442 * Disable GOST key exchange if no GOST signature algs are available *
444 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
445 (SSL_aGOST01 | SSL_aGOST12))
446 disabled_mkey_mask |= SSL_kGOST;
451 #ifndef OPENSSL_NO_COMP
453 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
455 return ((*a)->id - (*b)->id);
458 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
460 SSL_COMP *comp = NULL;
461 COMP_METHOD *method = COMP_zlib();
463 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
464 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
466 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
467 comp = OPENSSL_malloc(sizeof(*comp));
469 comp->method = method;
470 comp->id = SSL_COMP_ZLIB_IDX;
471 comp->name = COMP_get_name(method);
472 sk_SSL_COMP_push(ssl_comp_methods, comp);
473 sk_SSL_COMP_sort(ssl_comp_methods);
476 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
480 static int load_builtin_compressions(void)
482 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
486 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
487 const EVP_MD **md, int *mac_pkey_type,
488 size_t *mac_secret_size, SSL_COMP **comp, int use_etm)
498 #ifndef OPENSSL_NO_COMP
499 if (!load_builtin_compressions()) {
501 * Currently don't care, since a failure only means that
502 * ssl_comp_methods is NULL, which is perfectly OK
507 ctmp.id = s->compress_meth;
508 if (ssl_comp_methods != NULL) {
509 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
510 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
512 /* If were only interested in comp then return success */
513 if ((enc == NULL) && (md == NULL))
517 if ((enc == NULL) || (md == NULL))
520 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
525 if (i == SSL_ENC_NULL_IDX)
526 *enc = EVP_enc_null();
528 *enc = ssl_cipher_methods[i];
531 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
534 if (mac_pkey_type != NULL)
535 *mac_pkey_type = NID_undef;
536 if (mac_secret_size != NULL)
537 *mac_secret_size = 0;
538 if (c->algorithm_mac == SSL_AEAD)
539 mac_pkey_type = NULL;
541 *md = ssl_digest_methods[i];
542 if (mac_pkey_type != NULL)
543 *mac_pkey_type = ssl_mac_pkey_id[i];
544 if (mac_secret_size != NULL)
545 *mac_secret_size = ssl_mac_secret_size[i];
548 if ((*enc != NULL) &&
549 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
550 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
551 const EVP_CIPHER *evp;
556 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
557 s->ssl_version < TLS1_VERSION)
560 if (c->algorithm_enc == SSL_RC4 &&
561 c->algorithm_mac == SSL_MD5 &&
562 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
563 *enc = evp, *md = NULL;
564 else if (c->algorithm_enc == SSL_AES128 &&
565 c->algorithm_mac == SSL_SHA1 &&
566 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
567 *enc = evp, *md = NULL;
568 else if (c->algorithm_enc == SSL_AES256 &&
569 c->algorithm_mac == SSL_SHA1 &&
570 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
571 *enc = evp, *md = NULL;
572 else if (c->algorithm_enc == SSL_AES128 &&
573 c->algorithm_mac == SSL_SHA256 &&
574 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
575 *enc = evp, *md = NULL;
576 else if (c->algorithm_enc == SSL_AES256 &&
577 c->algorithm_mac == SSL_SHA256 &&
578 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
579 *enc = evp, *md = NULL;
586 const EVP_MD *ssl_md(int idx)
588 idx &= SSL_HANDSHAKE_MAC_MASK;
589 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
591 return ssl_digest_methods[idx];
594 const EVP_MD *ssl_handshake_md(SSL *s)
596 return ssl_md(ssl_get_algorithm2(s));
599 const EVP_MD *ssl_prf_md(SSL *s)
601 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
604 #define ITEM_SEP(a) \
605 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
607 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
614 if (curr->prev != NULL)
615 curr->prev->next = curr->next;
616 if (curr->next != NULL)
617 curr->next->prev = curr->prev;
618 (*tail)->next = curr;
624 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
631 if (curr->next != NULL)
632 curr->next->prev = curr->prev;
633 if (curr->prev != NULL)
634 curr->prev->next = curr->next;
635 (*head)->prev = curr;
641 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
643 uint32_t disabled_mkey,
644 uint32_t disabled_auth,
645 uint32_t disabled_enc,
646 uint32_t disabled_mac,
647 CIPHER_ORDER *co_list,
648 CIPHER_ORDER **head_p,
649 CIPHER_ORDER **tail_p)
655 * We have num_of_ciphers descriptions compiled in, depending on the
656 * method selected (SSLv3, TLSv1 etc).
657 * These will later be sorted in a linked list with at most num
661 /* Get the initial list of ciphers */
662 co_list_num = 0; /* actual count of ciphers */
663 for (i = 0; i < num_of_ciphers; i++) {
664 c = ssl_method->get_cipher(i);
665 /* drop those that use any of that is not available */
666 if (c == NULL || !c->valid)
668 if ((c->algorithm_mkey & disabled_mkey) ||
669 (c->algorithm_auth & disabled_auth) ||
670 (c->algorithm_enc & disabled_enc) ||
671 (c->algorithm_mac & disabled_mac))
673 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
676 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
680 co_list[co_list_num].cipher = c;
681 co_list[co_list_num].next = NULL;
682 co_list[co_list_num].prev = NULL;
683 co_list[co_list_num].active = 0;
688 * Prepare linked list from list entries
690 if (co_list_num > 0) {
691 co_list[0].prev = NULL;
693 if (co_list_num > 1) {
694 co_list[0].next = &co_list[1];
696 for (i = 1; i < co_list_num - 1; i++) {
697 co_list[i].prev = &co_list[i - 1];
698 co_list[i].next = &co_list[i + 1];
701 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
704 co_list[co_list_num - 1].next = NULL;
706 *head_p = &co_list[0];
707 *tail_p = &co_list[co_list_num - 1];
711 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
712 int num_of_group_aliases,
713 uint32_t disabled_mkey,
714 uint32_t disabled_auth,
715 uint32_t disabled_enc,
716 uint32_t disabled_mac,
719 CIPHER_ORDER *ciph_curr;
720 const SSL_CIPHER **ca_curr;
722 uint32_t mask_mkey = ~disabled_mkey;
723 uint32_t mask_auth = ~disabled_auth;
724 uint32_t mask_enc = ~disabled_enc;
725 uint32_t mask_mac = ~disabled_mac;
728 * First, add the real ciphers as already collected
732 while (ciph_curr != NULL) {
733 *ca_curr = ciph_curr->cipher;
735 ciph_curr = ciph_curr->next;
739 * Now we add the available ones from the cipher_aliases[] table.
740 * They represent either one or more algorithms, some of which
741 * in any affected category must be supported (set in enabled_mask),
742 * or represent a cipher strength value (will be added in any case because algorithms=0).
744 for (i = 0; i < num_of_group_aliases; i++) {
745 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
746 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
747 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
748 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
751 if ((algorithm_mkey & mask_mkey) == 0)
755 if ((algorithm_auth & mask_auth) == 0)
759 if ((algorithm_enc & mask_enc) == 0)
763 if ((algorithm_mac & mask_mac) == 0)
766 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
770 *ca_curr = NULL; /* end of list */
773 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
774 uint32_t alg_auth, uint32_t alg_enc,
775 uint32_t alg_mac, int min_tls,
776 uint32_t algo_strength, int rule,
777 int32_t strength_bits, CIPHER_ORDER **head_p,
778 CIPHER_ORDER **tail_p)
780 CIPHER_ORDER *head, *tail, *curr, *next, *last;
781 const SSL_CIPHER *cp;
786 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
787 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
788 algo_strength, strength_bits);
791 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
792 reverse = 1; /* needed to maintain sorting between currently
816 next = reverse ? curr->prev : curr->next;
821 * Selection criteria is either the value of strength_bits
822 * or the algorithms used.
824 if (strength_bits >= 0) {
825 if (strength_bits != cp->strength_bits)
830 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
831 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
832 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
835 if (cipher_id != 0 && (cipher_id != cp->id))
837 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
839 if (alg_auth && !(alg_auth & cp->algorithm_auth))
841 if (alg_enc && !(alg_enc & cp->algorithm_enc))
843 if (alg_mac && !(alg_mac & cp->algorithm_mac))
845 if (min_tls && (min_tls != cp->min_tls))
847 if ((algo_strength & SSL_STRONG_MASK)
848 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
850 if ((algo_strength & SSL_DEFAULT_MASK)
851 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
856 fprintf(stderr, "Action = %d\n", rule);
859 /* add the cipher if it has not been added yet. */
860 if (rule == CIPHER_ADD) {
863 ll_append_tail(&head, curr, &tail);
867 /* Move the added cipher to this location */
868 else if (rule == CIPHER_ORD) {
871 ll_append_tail(&head, curr, &tail);
873 } else if (rule == CIPHER_DEL) {
877 * most recently deleted ciphersuites get best positions for
878 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
879 * in reverse to maintain the order)
881 ll_append_head(&head, curr, &tail);
884 } else if (rule == CIPHER_BUMP) {
886 ll_append_head(&head, curr, &tail);
887 } else if (rule == CIPHER_KILL) {
892 curr->prev->next = curr->next;
896 if (curr->next != NULL)
897 curr->next->prev = curr->prev;
898 if (curr->prev != NULL)
899 curr->prev->next = curr->next;
909 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
910 CIPHER_ORDER **tail_p)
912 int32_t max_strength_bits;
917 * This routine sorts the ciphers with descending strength. The sorting
918 * must keep the pre-sorted sequence, so we apply the normal sorting
919 * routine as '+' movement to the end of the list.
921 max_strength_bits = 0;
923 while (curr != NULL) {
924 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
925 max_strength_bits = curr->cipher->strength_bits;
929 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
930 if (number_uses == NULL) {
931 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
936 * Now find the strength_bits values actually used
939 while (curr != NULL) {
941 number_uses[curr->cipher->strength_bits]++;
945 * Go through the list of used strength_bits values in descending
948 for (i = max_strength_bits; i >= 0; i--)
949 if (number_uses[i] > 0)
950 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
953 OPENSSL_free(number_uses);
957 static int ssl_cipher_process_rulestr(const char *rule_str,
958 CIPHER_ORDER **head_p,
959 CIPHER_ORDER **tail_p,
960 const SSL_CIPHER **ca_list, CERT *c)
962 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
965 int j, multi, found, rule, retval, ok, buflen;
966 uint32_t cipher_id = 0;
979 } else if (ch == '+') {
982 } else if (ch == '!') {
985 } else if (ch == '@') {
986 rule = CIPHER_SPECIAL;
1008 #ifndef CHARSET_EBCDIC
1009 while (((ch >= 'A') && (ch <= 'Z')) ||
1010 ((ch >= '0') && (ch <= '9')) ||
1011 ((ch >= 'a') && (ch <= 'z')) ||
1012 (ch == '-') || (ch == '.') || (ch == '='))
1014 while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1024 * We hit something we cannot deal with,
1025 * it is no command or separator nor
1026 * alphanumeric, so we call this an error.
1028 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1034 if (rule == CIPHER_SPECIAL) {
1035 found = 0; /* unused -- avoid compiler warning */
1036 break; /* special treatment */
1039 /* check for multi-part specification */
1048 * Now search for the cipher alias in the ca_list. Be careful
1049 * with the strncmp, because the "buflen" limitation
1050 * will make the rule "ADH:SOME" and the cipher
1051 * "ADH-MY-CIPHER" look like a match for buflen=3.
1052 * So additionally check whether the cipher name found
1053 * has the correct length. We can save a strlen() call:
1054 * just checking for the '\0' at the right place is
1055 * sufficient, we have to strncmp() anyway. (We cannot
1056 * use strcmp(), because buf is not '\0' terminated.)
1060 while (ca_list[j]) {
1061 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1062 && (ca_list[j]->name[buflen] == '\0')) {
1070 break; /* ignore this entry */
1072 if (ca_list[j]->algorithm_mkey) {
1074 alg_mkey &= ca_list[j]->algorithm_mkey;
1080 alg_mkey = ca_list[j]->algorithm_mkey;
1084 if (ca_list[j]->algorithm_auth) {
1086 alg_auth &= ca_list[j]->algorithm_auth;
1092 alg_auth = ca_list[j]->algorithm_auth;
1096 if (ca_list[j]->algorithm_enc) {
1098 alg_enc &= ca_list[j]->algorithm_enc;
1104 alg_enc = ca_list[j]->algorithm_enc;
1108 if (ca_list[j]->algorithm_mac) {
1110 alg_mac &= ca_list[j]->algorithm_mac;
1116 alg_mac = ca_list[j]->algorithm_mac;
1120 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1121 if (algo_strength & SSL_STRONG_MASK) {
1123 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1125 if (!(algo_strength & SSL_STRONG_MASK)) {
1130 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1134 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1135 if (algo_strength & SSL_DEFAULT_MASK) {
1137 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1139 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1145 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1149 if (ca_list[j]->valid) {
1151 * explicit ciphersuite found; its protocol version does not
1152 * become part of the search pattern!
1155 cipher_id = ca_list[j]->id;
1158 * not an explicit ciphersuite; only in this case, the
1159 * protocol version is considered part of the search pattern
1162 if (ca_list[j]->min_tls) {
1163 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1167 min_tls = ca_list[j]->min_tls;
1177 * Ok, we have the rule, now apply it
1179 if (rule == CIPHER_SPECIAL) { /* special command */
1181 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1182 ok = ssl_cipher_strength_sort(head_p, tail_p);
1183 } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1184 int level = buf[9] - '0';
1185 if (level < 0 || level > 5) {
1186 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1187 SSL_R_INVALID_COMMAND);
1189 c->sec_level = level;
1193 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1198 * We do not support any "multi" options
1199 * together with "@", so throw away the
1200 * rest of the command, if any left, until
1201 * end or ':' is found.
1203 while ((*l != '\0') && !ITEM_SEP(*l))
1206 ssl_cipher_apply_rule(cipher_id,
1207 alg_mkey, alg_auth, alg_enc, alg_mac,
1208 min_tls, algo_strength, rule, -1, head_p,
1211 while ((*l != '\0') && !ITEM_SEP(*l))
1221 #ifndef OPENSSL_NO_EC
1222 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1223 const char **prule_str)
1225 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1226 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1227 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1228 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1230 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1231 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1232 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1233 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1234 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1238 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1239 c->cert_flags |= suiteb_flags;
1241 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1246 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1248 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1249 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1250 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1253 # ifndef OPENSSL_NO_EC
1254 switch (suiteb_flags) {
1255 case SSL_CERT_FLAG_SUITEB_128_LOS:
1257 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1260 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1262 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1263 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1265 case SSL_CERT_FLAG_SUITEB_192_LOS:
1266 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1271 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1277 static int ciphersuite_cb(const char *elem, int len, void *arg)
1279 STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
1280 const SSL_CIPHER *cipher;
1281 /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
1284 if (len > (int)(sizeof(name) - 1)) {
1285 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1289 memcpy(name, elem, len);
1292 cipher = ssl3_get_cipher_by_std_name(name);
1293 if (cipher == NULL) {
1294 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1298 if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
1299 SSLerr(SSL_F_CIPHERSUITE_CB, ERR_R_INTERNAL_ERROR);
1306 static __owur int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
1308 STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
1310 if (newciphers == NULL)
1313 /* Parse the list. We explicitly allow an empty list */
1315 && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
1316 sk_SSL_CIPHER_free(newciphers);
1319 sk_SSL_CIPHER_free(*currciphers);
1320 *currciphers = newciphers;
1325 static int update_cipher_list_by_id(STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1326 STACK_OF(SSL_CIPHER) *cipherstack)
1328 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1330 if (tmp_cipher_list == NULL) {
1334 sk_SSL_CIPHER_free(*cipher_list_by_id);
1335 *cipher_list_by_id = tmp_cipher_list;
1337 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1338 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1343 static int update_cipher_list(STACK_OF(SSL_CIPHER) **cipher_list,
1344 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1345 STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
1348 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(*cipher_list);
1350 if (tmp_cipher_list == NULL)
1354 * Delete any existing TLSv1.3 ciphersuites. These are always first in the
1357 while (sk_SSL_CIPHER_num(tmp_cipher_list) > 0
1358 && sk_SSL_CIPHER_value(tmp_cipher_list, 0)->min_tls
1360 sk_SSL_CIPHER_delete(tmp_cipher_list, 0);
1362 /* Insert the new TLSv1.3 ciphersuites */
1363 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
1364 sk_SSL_CIPHER_insert(tmp_cipher_list,
1365 sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
1367 if (!update_cipher_list_by_id(cipher_list_by_id, tmp_cipher_list))
1370 sk_SSL_CIPHER_free(*cipher_list);
1371 *cipher_list = tmp_cipher_list;
1376 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
1378 int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
1380 if (ret && ctx->cipher_list != NULL)
1381 return update_cipher_list(&ctx->cipher_list, &ctx->cipher_list_by_id,
1382 ctx->tls13_ciphersuites);
1387 int SSL_set_ciphersuites(SSL *s, const char *str)
1389 STACK_OF(SSL_CIPHER) *cipher_list;
1390 int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
1392 if (s->cipher_list == NULL) {
1393 if ((cipher_list = SSL_get_ciphers(s)) != NULL)
1394 s->cipher_list = sk_SSL_CIPHER_dup(cipher_list);
1396 if (ret && s->cipher_list != NULL)
1397 return update_cipher_list(&s->cipher_list, &s->cipher_list_by_id,
1398 s->tls13_ciphersuites);
1403 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
1404 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
1405 STACK_OF(SSL_CIPHER) **cipher_list,
1406 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1407 const char *rule_str,
1410 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases, i;
1411 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1412 STACK_OF(SSL_CIPHER) *cipherstack;
1414 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1415 const SSL_CIPHER **ca_list = NULL;
1418 * Return with error if nothing to do.
1420 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1422 #ifndef OPENSSL_NO_EC
1423 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1428 * To reduce the work to do we only want to process the compiled
1429 * in algorithms, so we first get the mask of disabled ciphers.
1432 disabled_mkey = disabled_mkey_mask;
1433 disabled_auth = disabled_auth_mask;
1434 disabled_enc = disabled_enc_mask;
1435 disabled_mac = disabled_mac_mask;
1438 * Now we have to collect the available ciphers from the compiled
1439 * in ciphers. We cannot get more than the number compiled in, so
1440 * it is used for allocation.
1442 num_of_ciphers = ssl_method->num_ciphers();
1444 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1445 if (co_list == NULL) {
1446 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1447 return NULL; /* Failure */
1450 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1451 disabled_mkey, disabled_auth, disabled_enc,
1452 disabled_mac, co_list, &head, &tail);
1454 /* Now arrange all ciphers by preference. */
1457 * Everything else being equal, prefer ephemeral ECDH over other key
1458 * exchange mechanisms.
1459 * For consistency, prefer ECDSA over RSA (though this only matters if the
1460 * server has both certificates, and is using the DEFAULT, or a client
1463 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1465 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1467 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1470 /* Within each strength group, we prefer GCM over CHACHA... */
1471 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1473 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1477 * ...and generally, our preferred cipher is AES.
1478 * Note that AEADs will be bumped to take preference after sorting by
1481 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1484 /* Temporarily enable everything else for sorting */
1485 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1487 /* Low priority for MD5 */
1488 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1492 * Move anonymous ciphers to the end. Usually, these will remain
1493 * disabled. (For applications that allow them, they aren't too bad, but
1494 * we prefer authenticated ciphers.)
1496 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1499 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1501 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1504 /* RC4 is sort-of broken -- move to the end */
1505 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1509 * Now sort by symmetric encryption strength. The above ordering remains
1510 * in force within each class
1512 if (!ssl_cipher_strength_sort(&head, &tail)) {
1513 OPENSSL_free(co_list);
1518 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1519 * TODO(openssl-team): is there an easier way to accomplish all this?
1521 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1525 * Irrespective of strength, enforce the following order:
1526 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1527 * Within each group, ciphers remain sorted by strength and previous
1532 * 4) TLS 1.2 > legacy
1534 * Because we now bump ciphers to the top of the list, we proceed in
1535 * reverse order of preference.
1537 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1539 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1540 CIPHER_BUMP, -1, &head, &tail);
1541 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1542 CIPHER_BUMP, -1, &head, &tail);
1544 /* Now disable everything (maintaining the ordering!) */
1545 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1548 * We also need cipher aliases for selecting based on the rule_str.
1549 * There might be two types of entries in the rule_str: 1) names
1550 * of ciphers themselves 2) aliases for groups of ciphers.
1551 * For 1) we need the available ciphers and for 2) the cipher
1552 * groups of cipher_aliases added together in one list (otherwise
1553 * we would be happy with just the cipher_aliases table).
1555 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1556 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1557 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1558 if (ca_list == NULL) {
1559 OPENSSL_free(co_list);
1560 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1561 return NULL; /* Failure */
1563 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1564 disabled_mkey, disabled_auth, disabled_enc,
1565 disabled_mac, head);
1568 * If the rule_string begins with DEFAULT, apply the default rule
1569 * before using the (possibly available) additional rules.
1573 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1574 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1575 &head, &tail, ca_list, c);
1581 if (ok && (strlen(rule_p) > 0))
1582 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1584 OPENSSL_free(ca_list); /* Not needed anymore */
1586 if (!ok) { /* Rule processing failure */
1587 OPENSSL_free(co_list);
1592 * Allocate new "cipherstack" for the result, return with error
1593 * if we cannot get one.
1595 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1596 OPENSSL_free(co_list);
1600 /* Add TLSv1.3 ciphers first - we always prefer those if possible */
1601 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++) {
1602 if (!sk_SSL_CIPHER_push(cipherstack,
1603 sk_SSL_CIPHER_value(tls13_ciphersuites, i))) {
1604 sk_SSL_CIPHER_free(cipherstack);
1610 * The cipher selection for the list is done. The ciphers are added
1611 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1613 for (curr = head; curr != NULL; curr = curr->next) {
1615 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1616 OPENSSL_free(co_list);
1617 sk_SSL_CIPHER_free(cipherstack);
1621 fprintf(stderr, "<%s>\n", curr->cipher->name);
1625 OPENSSL_free(co_list); /* Not needed any longer */
1627 if (!update_cipher_list_by_id(cipher_list_by_id, cipherstack)) {
1628 sk_SSL_CIPHER_free(cipherstack);
1631 sk_SSL_CIPHER_free(*cipher_list);
1632 *cipher_list = cipherstack;
1637 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1640 const char *kx, *au, *enc, *mac;
1641 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1642 static const char *format = "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1646 if ((buf = OPENSSL_malloc(len)) == NULL) {
1647 SSLerr(SSL_F_SSL_CIPHER_DESCRIPTION, ERR_R_MALLOC_FAILURE);
1650 } else if (len < 128) {
1654 alg_mkey = cipher->algorithm_mkey;
1655 alg_auth = cipher->algorithm_auth;
1656 alg_enc = cipher->algorithm_enc;
1657 alg_mac = cipher->algorithm_mac;
1659 ver = ssl_protocol_to_string(cipher->min_tls);
1718 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1719 case (SSL_aGOST12 | SSL_aGOST01):
1756 enc = "AESGCM(128)";
1759 enc = "AESGCM(256)";
1762 enc = "AESCCM(128)";
1765 enc = "AESCCM(256)";
1767 case SSL_AES128CCM8:
1768 enc = "AESCCM8(128)";
1770 case SSL_AES256CCM8:
1771 enc = "AESCCM8(256)";
1773 case SSL_CAMELLIA128:
1774 enc = "Camellia(128)";
1776 case SSL_CAMELLIA256:
1777 enc = "Camellia(256)";
1779 case SSL_ARIA128GCM:
1780 enc = "ARIAGCM(128)";
1782 case SSL_ARIA256GCM:
1783 enc = "ARIAGCM(256)";
1788 case SSL_eGOST2814789CNT:
1789 case SSL_eGOST2814789CNT12:
1790 enc = "GOST89(256)";
1792 case SSL_CHACHA20POLY1305:
1793 enc = "CHACHA20/POLY1305(256)";
1817 case SSL_GOST89MAC12:
1823 case SSL_GOST12_256:
1824 case SSL_GOST12_512:
1832 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1837 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1843 * Backwards-compatibility crutch. In almost all contexts we report TLS
1844 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1846 if (c->min_tls == TLS1_VERSION)
1848 return ssl_protocol_to_string(c->min_tls);
1851 /* return the actual cipher being used */
1852 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1859 /* return the actual cipher being used in RFC standard name */
1860 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1867 /* return the OpenSSL name based on given RFC standard name */
1868 const char *OPENSSL_cipher_name(const char *stdname)
1870 const SSL_CIPHER *c;
1872 if (stdname == NULL)
1874 c = ssl3_get_cipher_by_std_name(stdname);
1875 return SSL_CIPHER_get_name(c);
1878 /* number of bits for symmetric cipher */
1879 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1884 if (alg_bits != NULL)
1885 *alg_bits = (int)c->alg_bits;
1886 ret = (int)c->strength_bits;
1891 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1896 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1898 return c->id & 0xFFFF;
1901 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1906 if ((n == 0) || (sk == NULL))
1908 nn = sk_SSL_COMP_num(sk);
1909 for (i = 0; i < nn; i++) {
1910 ctmp = sk_SSL_COMP_value(sk, i);
1917 #ifdef OPENSSL_NO_COMP
1918 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1923 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1929 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1935 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1937 load_builtin_compressions();
1938 return ssl_comp_methods;
1941 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1944 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1945 ssl_comp_methods = meths;
1949 static void cmeth_free(SSL_COMP *cm)
1954 void ssl_comp_free_compression_methods_int(void)
1956 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1957 ssl_comp_methods = NULL;
1958 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1961 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1965 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1969 * According to draft-ietf-tls-compression-04.txt, the
1970 * compression number ranges should be the following:
1972 * 0 to 63: methods defined by the IETF
1973 * 64 to 192: external party methods assigned by IANA
1974 * 193 to 255: reserved for private use
1976 if (id < 193 || id > 255) {
1977 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1978 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1982 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1983 comp = OPENSSL_malloc(sizeof(*comp));
1985 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1986 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1992 load_builtin_compressions();
1993 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1995 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1996 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1997 SSL_R_DUPLICATE_COMPRESSION_ID);
2000 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
2002 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
2003 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
2006 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
2011 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
2013 #ifndef OPENSSL_NO_COMP
2014 return comp ? COMP_get_name(comp) : NULL;
2020 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
2022 #ifndef OPENSSL_NO_COMP
2029 int SSL_COMP_get_id(const SSL_COMP *comp)
2031 #ifndef OPENSSL_NO_COMP
2038 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
2041 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
2043 if (c == NULL || (!all && c->valid == 0))
2048 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
2050 return ssl->method->get_cipher_by_char(ptr);
2053 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2058 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2061 return ssl_cipher_table_cipher[i].nid;
2064 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2066 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2070 return ssl_cipher_table_mac[i].nid;
2073 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2075 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2079 return ssl_cipher_table_kx[i].nid;
2082 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2084 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2088 return ssl_cipher_table_auth[i].nid;
2091 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
2093 int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
2095 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
2097 return ssl_digest_methods[idx];
2100 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2102 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
2105 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2106 size_t *int_overhead, size_t *blocksize,
2107 size_t *ext_overhead)
2109 size_t mac = 0, in = 0, blk = 0, out = 0;
2111 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
2112 * because there are no handy #defines for those. */
2113 if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
2114 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
2115 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
2116 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
2117 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
2118 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
2119 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
2121 } else if (c->algorithm_mac & SSL_AEAD) {
2122 /* We're supposed to have handled all the AEAD modes above */
2125 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
2126 int digest_nid = SSL_CIPHER_get_digest_nid(c);
2127 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2132 mac = EVP_MD_size(e_md);
2133 if (c->algorithm_enc != SSL_eNULL) {
2134 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2135 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2137 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2138 known CBC cipher. */
2139 if (e_ciph == NULL ||
2140 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2143 in = 1; /* padding length byte */
2144 out = EVP_CIPHER_iv_length(e_ciph);
2145 blk = EVP_CIPHER_block_size(e_ciph);
2149 *mac_overhead = mac;
2152 *ext_overhead = out;
2157 int ssl_cert_is_disabled(size_t idx)
2159 const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2161 if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)