2 * Copyright 1995-2017 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 "internal/nelem.h"
20 #include "internal/thread_once.h"
21 #include "internal/cryptlib.h"
23 #define SSL_ENC_DES_IDX 0
24 #define SSL_ENC_3DES_IDX 1
25 #define SSL_ENC_RC4_IDX 2
26 #define SSL_ENC_RC2_IDX 3
27 #define SSL_ENC_IDEA_IDX 4
28 #define SSL_ENC_NULL_IDX 5
29 #define SSL_ENC_AES128_IDX 6
30 #define SSL_ENC_AES256_IDX 7
31 #define SSL_ENC_CAMELLIA128_IDX 8
32 #define SSL_ENC_CAMELLIA256_IDX 9
33 #define SSL_ENC_GOST89_IDX 10
34 #define SSL_ENC_SEED_IDX 11
35 #define SSL_ENC_AES128GCM_IDX 12
36 #define SSL_ENC_AES256GCM_IDX 13
37 #define SSL_ENC_AES128CCM_IDX 14
38 #define SSL_ENC_AES256CCM_IDX 15
39 #define SSL_ENC_AES128CCM8_IDX 16
40 #define SSL_ENC_AES256CCM8_IDX 17
41 #define SSL_ENC_GOST8912_IDX 18
42 #define SSL_ENC_CHACHA_IDX 19
43 #define SSL_ENC_ARIA128GCM_IDX 20
44 #define SSL_ENC_ARIA256GCM_IDX 21
45 #define SSL_ENC_NUM_IDX 22
47 /* NB: make sure indices in these tables match values above */
54 /* Table of NIDs for each cipher */
55 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
56 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
57 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
58 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
59 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
60 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
61 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
62 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
63 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
64 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
65 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
66 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
67 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
68 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
69 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
70 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
71 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
72 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
73 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
74 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX 18 */
75 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305}, /* SSL_ENC_CHACHA_IDX 19 */
76 {SSL_ARIA128GCM, NID_aria_128_gcm}, /* SSL_ENC_ARIA128GCM_IDX 20 */
77 {SSL_ARIA256GCM, NID_aria_256_gcm}, /* SSL_ENC_ARIA256GCM_IDX 21 */
80 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
82 #define SSL_COMP_NULL_IDX 0
83 #define SSL_COMP_ZLIB_IDX 1
84 #define SSL_COMP_NUM_IDX 2
86 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
88 #ifndef OPENSSL_NO_COMP
89 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
93 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
97 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
99 /* NB: make sure indices in this table matches values above */
100 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
101 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
102 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
103 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
104 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
105 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
106 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
107 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
108 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
109 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
110 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
111 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
112 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
115 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
116 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
120 static const ssl_cipher_table ssl_cipher_table_kx[] = {
121 {SSL_kRSA, NID_kx_rsa},
122 {SSL_kECDHE, NID_kx_ecdhe},
123 {SSL_kDHE, NID_kx_dhe},
124 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
125 {SSL_kDHEPSK, NID_kx_dhe_psk},
126 {SSL_kRSAPSK, NID_kx_rsa_psk},
127 {SSL_kPSK, NID_kx_psk},
128 {SSL_kSRP, NID_kx_srp},
129 {SSL_kGOST, NID_kx_gost},
130 {SSL_kANY, NID_kx_any}
133 static const ssl_cipher_table ssl_cipher_table_auth[] = {
134 {SSL_aRSA, NID_auth_rsa},
135 {SSL_aECDSA, NID_auth_ecdsa},
136 {SSL_aPSK, NID_auth_psk},
137 {SSL_aDSS, NID_auth_dss},
138 {SSL_aGOST01, NID_auth_gost01},
139 {SSL_aGOST12, NID_auth_gost12},
140 {SSL_aSRP, NID_auth_srp},
141 {SSL_aNULL, NID_auth_null},
142 {SSL_aANY, NID_auth_any}
146 /* Utility function for table lookup */
147 static int ssl_cipher_info_find(const ssl_cipher_table * table,
148 size_t table_cnt, uint32_t mask)
151 for (i = 0; i < table_cnt; i++, table++) {
152 if (table->mask == mask)
158 #define ssl_cipher_info_lookup(table, x) \
159 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
162 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
163 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
166 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
167 /* MD5, SHA, GOST94, MAC89 */
168 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
169 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
170 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
175 static size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
178 #define CIPHER_KILL 2
181 #define CIPHER_SPECIAL 5
183 * Bump the ciphers to the top of the list.
184 * This rule isn't currently supported by the public cipherstring API.
186 #define CIPHER_BUMP 6
188 typedef struct cipher_order_st {
189 const SSL_CIPHER *cipher;
192 struct cipher_order_st *next, *prev;
195 static const SSL_CIPHER cipher_aliases[] = {
196 /* "ALL" doesn't include eNULL (must be specifically enabled) */
197 {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
198 /* "COMPLEMENTOFALL" */
199 {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
202 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
205 {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
208 * key exchange aliases (some of those using only a single bit here
209 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
210 * combines DHE_DSS and DHE_RSA)
212 {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
214 {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
215 {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
216 {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
218 {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
219 {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
220 {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
222 {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
223 {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
224 {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
225 {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
226 {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
227 {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
229 /* server authentication aliases */
230 {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
231 {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
232 {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
233 {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
234 {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
235 {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
236 {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
237 {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
238 {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
239 {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
240 {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
242 /* aliases combining key exchange and server authentication */
243 {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
244 {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
245 {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
246 {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
247 {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
248 {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
249 {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
250 {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
251 {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
252 {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
254 /* symmetric encryption aliases */
255 {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
256 {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
257 {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
258 {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
259 {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
260 {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
261 {0, SSL_TXT_GOST, NULL, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
262 {0, SSL_TXT_AES128, NULL, 0, 0, 0,
263 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
264 {0, SSL_TXT_AES256, NULL, 0, 0, 0,
265 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
266 {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
267 {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
268 {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
269 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
270 {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
271 {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
272 {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
273 {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
274 {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
276 {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
277 {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
278 {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
281 {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
282 {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
283 {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
284 {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
285 {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
286 {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
287 {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
288 {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
290 /* protocol version aliases */
291 {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
292 {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
293 {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
294 {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
296 /* strength classes */
297 {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
298 {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
299 {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
300 /* FIPS 140-2 approved ciphersuite */
301 {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
303 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
304 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
305 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
306 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
307 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
312 * Search for public key algorithm with given name and return its pkey_id if
313 * it is available. Otherwise return 0
315 #ifdef OPENSSL_NO_ENGINE
317 static int get_optional_pkey_id(const char *pkey_name)
319 const EVP_PKEY_ASN1_METHOD *ameth;
321 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
322 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
330 static int get_optional_pkey_id(const char *pkey_name)
332 const EVP_PKEY_ASN1_METHOD *ameth;
333 ENGINE *tmpeng = NULL;
335 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
337 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
341 ENGINE_finish(tmpeng);
347 /* masks of disabled algorithms */
348 static uint32_t disabled_enc_mask;
349 static uint32_t disabled_mac_mask;
350 static uint32_t disabled_mkey_mask;
351 static uint32_t disabled_auth_mask;
353 int ssl_load_ciphers(void)
356 const ssl_cipher_table *t;
358 disabled_enc_mask = 0;
359 ssl_sort_cipher_list();
360 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
361 if (t->nid == NID_undef) {
362 ssl_cipher_methods[i] = NULL;
364 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
365 ssl_cipher_methods[i] = cipher;
367 disabled_enc_mask |= t->mask;
370 disabled_mac_mask = 0;
371 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
372 const EVP_MD *md = EVP_get_digestbynid(t->nid);
373 ssl_digest_methods[i] = md;
375 disabled_mac_mask |= t->mask;
377 int tmpsize = EVP_MD_size(md);
378 if (!ossl_assert(tmpsize >= 0))
380 ssl_mac_secret_size[i] = tmpsize;
383 /* Make sure we can access MD5 and SHA1 */
384 if (!ossl_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL))
386 if (!ossl_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL))
389 disabled_mkey_mask = 0;
390 disabled_auth_mask = 0;
392 #ifdef OPENSSL_NO_RSA
393 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
394 disabled_auth_mask |= SSL_aRSA;
396 #ifdef OPENSSL_NO_DSA
397 disabled_auth_mask |= SSL_aDSS;
400 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
403 disabled_mkey_mask |= SSL_kECDHEPSK;
404 disabled_auth_mask |= SSL_aECDSA;
406 #ifdef OPENSSL_NO_PSK
407 disabled_mkey_mask |= SSL_PSK;
408 disabled_auth_mask |= SSL_aPSK;
410 #ifdef OPENSSL_NO_SRP
411 disabled_mkey_mask |= SSL_kSRP;
415 * Check for presence of GOST 34.10 algorithms, and if they are not
416 * present, disable appropriate auth and key exchange
418 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
419 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
420 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
422 disabled_mac_mask |= SSL_GOST89MAC;
424 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
425 get_optional_pkey_id("gost-mac-12");
426 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
427 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
429 disabled_mac_mask |= SSL_GOST89MAC12;
431 if (!get_optional_pkey_id("gost2001"))
432 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
433 if (!get_optional_pkey_id("gost2012_256"))
434 disabled_auth_mask |= SSL_aGOST12;
435 if (!get_optional_pkey_id("gost2012_512"))
436 disabled_auth_mask |= SSL_aGOST12;
438 * Disable GOST key exchange if no GOST signature algs are available *
440 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
441 (SSL_aGOST01 | SSL_aGOST12))
442 disabled_mkey_mask |= SSL_kGOST;
447 #ifndef OPENSSL_NO_COMP
449 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
451 return ((*a)->id - (*b)->id);
454 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
456 SSL_COMP *comp = NULL;
457 COMP_METHOD *method = COMP_zlib();
459 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
460 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
462 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
463 comp = OPENSSL_malloc(sizeof(*comp));
465 comp->method = method;
466 comp->id = SSL_COMP_ZLIB_IDX;
467 comp->name = COMP_get_name(method);
468 sk_SSL_COMP_push(ssl_comp_methods, comp);
469 sk_SSL_COMP_sort(ssl_comp_methods);
472 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
476 static int load_builtin_compressions(void)
478 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
482 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
483 const EVP_MD **md, int *mac_pkey_type,
484 size_t *mac_secret_size, SSL_COMP **comp, int use_etm)
494 #ifndef OPENSSL_NO_COMP
495 if (!load_builtin_compressions()) {
497 * Currently don't care, since a failure only means that
498 * ssl_comp_methods is NULL, which is perfectly OK
503 ctmp.id = s->compress_meth;
504 if (ssl_comp_methods != NULL) {
505 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
507 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
511 /* If were only interested in comp then return success */
512 if ((enc == NULL) && (md == NULL))
516 if ((enc == NULL) || (md == NULL))
519 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
524 if (i == SSL_ENC_NULL_IDX)
525 *enc = EVP_enc_null();
527 *enc = ssl_cipher_methods[i];
530 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
533 if (mac_pkey_type != NULL)
534 *mac_pkey_type = NID_undef;
535 if (mac_secret_size != NULL)
536 *mac_secret_size = 0;
537 if (c->algorithm_mac == SSL_AEAD)
538 mac_pkey_type = NULL;
540 *md = ssl_digest_methods[i];
541 if (mac_pkey_type != NULL)
542 *mac_pkey_type = ssl_mac_pkey_id[i];
543 if (mac_secret_size != NULL)
544 *mac_secret_size = ssl_mac_secret_size[i];
547 if ((*enc != NULL) &&
548 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
549 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
550 const EVP_CIPHER *evp;
555 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
556 s->ssl_version < TLS1_VERSION)
559 if (c->algorithm_enc == SSL_RC4 &&
560 c->algorithm_mac == SSL_MD5 &&
561 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
562 *enc = evp, *md = NULL;
563 else if (c->algorithm_enc == SSL_AES128 &&
564 c->algorithm_mac == SSL_SHA1 &&
565 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
566 *enc = evp, *md = NULL;
567 else if (c->algorithm_enc == SSL_AES256 &&
568 c->algorithm_mac == SSL_SHA1 &&
569 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
570 *enc = evp, *md = NULL;
571 else if (c->algorithm_enc == SSL_AES128 &&
572 c->algorithm_mac == SSL_SHA256 &&
573 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
574 *enc = evp, *md = NULL;
575 else if (c->algorithm_enc == SSL_AES256 &&
576 c->algorithm_mac == SSL_SHA256 &&
577 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
578 *enc = evp, *md = NULL;
585 const EVP_MD *ssl_md(int idx)
587 idx &= SSL_HANDSHAKE_MAC_MASK;
588 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
590 return ssl_digest_methods[idx];
593 const EVP_MD *ssl_handshake_md(SSL *s)
595 return ssl_md(ssl_get_algorithm2(s));
598 const EVP_MD *ssl_prf_md(SSL *s)
600 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
603 #define ITEM_SEP(a) \
604 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
606 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
613 if (curr->prev != NULL)
614 curr->prev->next = curr->next;
615 if (curr->next != NULL)
616 curr->next->prev = curr->prev;
617 (*tail)->next = curr;
623 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
630 if (curr->next != NULL)
631 curr->next->prev = curr->prev;
632 if (curr->prev != NULL)
633 curr->prev->next = curr->next;
634 (*head)->prev = curr;
640 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
642 uint32_t disabled_mkey,
643 uint32_t disabled_auth,
644 uint32_t disabled_enc,
645 uint32_t disabled_mac,
646 CIPHER_ORDER *co_list,
647 CIPHER_ORDER **head_p,
648 CIPHER_ORDER **tail_p)
654 * We have num_of_ciphers descriptions compiled in, depending on the
655 * method selected (SSLv3, TLSv1 etc).
656 * These will later be sorted in a linked list with at most num
660 /* Get the initial list of ciphers */
661 co_list_num = 0; /* actual count of ciphers */
662 for (i = 0; i < num_of_ciphers; i++) {
663 c = ssl_method->get_cipher(i);
664 /* drop those that use any of that is not available */
665 if (c == NULL || !c->valid)
667 if ((c->algorithm_mkey & disabled_mkey) ||
668 (c->algorithm_auth & disabled_auth) ||
669 (c->algorithm_enc & disabled_enc) ||
670 (c->algorithm_mac & disabled_mac))
672 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
675 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
679 co_list[co_list_num].cipher = c;
680 co_list[co_list_num].next = NULL;
681 co_list[co_list_num].prev = NULL;
682 co_list[co_list_num].active = 0;
687 * Prepare linked list from list entries
689 if (co_list_num > 0) {
690 co_list[0].prev = NULL;
692 if (co_list_num > 1) {
693 co_list[0].next = &co_list[1];
695 for (i = 1; i < co_list_num - 1; i++) {
696 co_list[i].prev = &co_list[i - 1];
697 co_list[i].next = &co_list[i + 1];
700 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
703 co_list[co_list_num - 1].next = NULL;
705 *head_p = &co_list[0];
706 *tail_p = &co_list[co_list_num - 1];
710 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
711 int num_of_group_aliases,
712 uint32_t disabled_mkey,
713 uint32_t disabled_auth,
714 uint32_t disabled_enc,
715 uint32_t disabled_mac,
718 CIPHER_ORDER *ciph_curr;
719 const SSL_CIPHER **ca_curr;
721 uint32_t mask_mkey = ~disabled_mkey;
722 uint32_t mask_auth = ~disabled_auth;
723 uint32_t mask_enc = ~disabled_enc;
724 uint32_t mask_mac = ~disabled_mac;
727 * First, add the real ciphers as already collected
731 while (ciph_curr != NULL) {
732 *ca_curr = ciph_curr->cipher;
734 ciph_curr = ciph_curr->next;
738 * Now we add the available ones from the cipher_aliases[] table.
739 * They represent either one or more algorithms, some of which
740 * in any affected category must be supported (set in enabled_mask),
741 * or represent a cipher strength value (will be added in any case because algorithms=0).
743 for (i = 0; i < num_of_group_aliases; i++) {
744 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
745 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
746 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
747 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
750 if ((algorithm_mkey & mask_mkey) == 0)
754 if ((algorithm_auth & mask_auth) == 0)
758 if ((algorithm_enc & mask_enc) == 0)
762 if ((algorithm_mac & mask_mac) == 0)
765 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
769 *ca_curr = NULL; /* end of list */
772 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
773 uint32_t alg_auth, uint32_t alg_enc,
774 uint32_t alg_mac, int min_tls,
775 uint32_t algo_strength, int rule,
776 int32_t strength_bits, CIPHER_ORDER **head_p,
777 CIPHER_ORDER **tail_p)
779 CIPHER_ORDER *head, *tail, *curr, *next, *last;
780 const SSL_CIPHER *cp;
785 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
786 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
787 algo_strength, strength_bits);
790 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
791 reverse = 1; /* needed to maintain sorting between currently
815 next = reverse ? curr->prev : curr->next;
820 * Selection criteria is either the value of strength_bits
821 * or the algorithms used.
823 if (strength_bits >= 0) {
824 if (strength_bits != cp->strength_bits)
829 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
830 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
831 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
834 if (cipher_id != 0 && (cipher_id != cp->id))
836 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
838 if (alg_auth && !(alg_auth & cp->algorithm_auth))
840 if (alg_enc && !(alg_enc & cp->algorithm_enc))
842 if (alg_mac && !(alg_mac & cp->algorithm_mac))
844 if (min_tls && (min_tls != cp->min_tls))
846 if ((algo_strength & SSL_STRONG_MASK)
847 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
849 if ((algo_strength & SSL_DEFAULT_MASK)
850 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
855 fprintf(stderr, "Action = %d\n", rule);
858 /* add the cipher if it has not been added yet. */
859 if (rule == CIPHER_ADD) {
862 ll_append_tail(&head, curr, &tail);
866 /* Move the added cipher to this location */
867 else if (rule == CIPHER_ORD) {
870 ll_append_tail(&head, curr, &tail);
872 } else if (rule == CIPHER_DEL) {
876 * most recently deleted ciphersuites get best positions for
877 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
878 * in reverse to maintain the order)
880 ll_append_head(&head, curr, &tail);
883 } else if (rule == CIPHER_BUMP) {
885 ll_append_head(&head, curr, &tail);
886 } else if (rule == CIPHER_KILL) {
891 curr->prev->next = curr->next;
895 if (curr->next != NULL)
896 curr->next->prev = curr->prev;
897 if (curr->prev != NULL)
898 curr->prev->next = curr->next;
908 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
909 CIPHER_ORDER **tail_p)
911 int32_t max_strength_bits;
916 * This routine sorts the ciphers with descending strength. The sorting
917 * must keep the pre-sorted sequence, so we apply the normal sorting
918 * routine as '+' movement to the end of the list.
920 max_strength_bits = 0;
922 while (curr != NULL) {
923 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
924 max_strength_bits = curr->cipher->strength_bits;
928 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
929 if (number_uses == NULL) {
930 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
935 * Now find the strength_bits values actually used
938 while (curr != NULL) {
940 number_uses[curr->cipher->strength_bits]++;
944 * Go through the list of used strength_bits values in descending
947 for (i = max_strength_bits; i >= 0; i--)
948 if (number_uses[i] > 0)
949 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
952 OPENSSL_free(number_uses);
956 static int ssl_cipher_process_rulestr(const char *rule_str,
957 CIPHER_ORDER **head_p,
958 CIPHER_ORDER **tail_p,
959 const SSL_CIPHER **ca_list, CERT *c)
961 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
964 int j, multi, found, rule, retval, ok, buflen;
965 uint32_t cipher_id = 0;
978 } else if (ch == '+') {
981 } else if (ch == '!') {
984 } else if (ch == '@') {
985 rule = CIPHER_SPECIAL;
1007 #ifndef CHARSET_EBCDIC
1008 while (((ch >= 'A') && (ch <= 'Z')) ||
1009 ((ch >= '0') && (ch <= '9')) ||
1010 ((ch >= 'a') && (ch <= 'z')) ||
1011 (ch == '-') || (ch == '.') || (ch == '='))
1013 while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1023 * We hit something we cannot deal with,
1024 * it is no command or separator nor
1025 * alphanumeric, so we call this an error.
1027 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1033 if (rule == CIPHER_SPECIAL) {
1034 found = 0; /* unused -- avoid compiler warning */
1035 break; /* special treatment */
1038 /* check for multi-part specification */
1047 * Now search for the cipher alias in the ca_list. Be careful
1048 * with the strncmp, because the "buflen" limitation
1049 * will make the rule "ADH:SOME" and the cipher
1050 * "ADH-MY-CIPHER" look like a match for buflen=3.
1051 * So additionally check whether the cipher name found
1052 * has the correct length. We can save a strlen() call:
1053 * just checking for the '\0' at the right place is
1054 * sufficient, we have to strncmp() anyway. (We cannot
1055 * use strcmp(), because buf is not '\0' terminated.)
1059 while (ca_list[j]) {
1060 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1061 && (ca_list[j]->name[buflen] == '\0')) {
1069 break; /* ignore this entry */
1071 if (ca_list[j]->algorithm_mkey) {
1073 alg_mkey &= ca_list[j]->algorithm_mkey;
1079 alg_mkey = ca_list[j]->algorithm_mkey;
1083 if (ca_list[j]->algorithm_auth) {
1085 alg_auth &= ca_list[j]->algorithm_auth;
1091 alg_auth = ca_list[j]->algorithm_auth;
1095 if (ca_list[j]->algorithm_enc) {
1097 alg_enc &= ca_list[j]->algorithm_enc;
1103 alg_enc = ca_list[j]->algorithm_enc;
1107 if (ca_list[j]->algorithm_mac) {
1109 alg_mac &= ca_list[j]->algorithm_mac;
1115 alg_mac = ca_list[j]->algorithm_mac;
1119 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1120 if (algo_strength & SSL_STRONG_MASK) {
1122 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1124 if (!(algo_strength & SSL_STRONG_MASK)) {
1129 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1133 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1134 if (algo_strength & SSL_DEFAULT_MASK) {
1136 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1138 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1144 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1148 if (ca_list[j]->valid) {
1150 * explicit ciphersuite found; its protocol version does not
1151 * become part of the search pattern!
1154 cipher_id = ca_list[j]->id;
1157 * not an explicit ciphersuite; only in this case, the
1158 * protocol version is considered part of the search pattern
1161 if (ca_list[j]->min_tls) {
1162 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1166 min_tls = ca_list[j]->min_tls;
1176 * Ok, we have the rule, now apply it
1178 if (rule == CIPHER_SPECIAL) { /* special command */
1180 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1181 ok = ssl_cipher_strength_sort(head_p, tail_p);
1182 } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1183 int level = buf[9] - '0';
1184 if (level < 0 || level > 5) {
1185 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1186 SSL_R_INVALID_COMMAND);
1188 c->sec_level = level;
1192 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1197 * We do not support any "multi" options
1198 * together with "@", so throw away the
1199 * rest of the command, if any left, until
1200 * end or ':' is found.
1202 while ((*l != '\0') && !ITEM_SEP(*l))
1205 ssl_cipher_apply_rule(cipher_id,
1206 alg_mkey, alg_auth, alg_enc, alg_mac,
1207 min_tls, algo_strength, rule, -1, head_p,
1210 while ((*l != '\0') && !ITEM_SEP(*l))
1220 #ifndef OPENSSL_NO_EC
1221 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1222 const char **prule_str)
1224 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1225 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1226 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1227 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1229 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1230 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1231 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1232 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1233 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1237 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1238 c->cert_flags |= suiteb_flags;
1240 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1245 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1247 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1248 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1249 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1252 # ifndef OPENSSL_NO_EC
1253 switch (suiteb_flags) {
1254 case SSL_CERT_FLAG_SUITEB_128_LOS:
1256 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1259 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1261 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1262 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1264 case SSL_CERT_FLAG_SUITEB_192_LOS:
1265 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1270 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1276 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1277 **cipher_list, STACK_OF(SSL_CIPHER)
1278 **cipher_list_by_id,
1279 const char *rule_str, CERT *c)
1281 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1282 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1283 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1285 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1286 const SSL_CIPHER **ca_list = NULL;
1289 * Return with error if nothing to do.
1291 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1293 #ifndef OPENSSL_NO_EC
1294 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1299 * To reduce the work to do we only want to process the compiled
1300 * in algorithms, so we first get the mask of disabled ciphers.
1303 disabled_mkey = disabled_mkey_mask;
1304 disabled_auth = disabled_auth_mask;
1305 disabled_enc = disabled_enc_mask;
1306 disabled_mac = disabled_mac_mask;
1309 * Now we have to collect the available ciphers from the compiled
1310 * in ciphers. We cannot get more than the number compiled in, so
1311 * it is used for allocation.
1313 num_of_ciphers = ssl_method->num_ciphers();
1315 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1316 if (co_list == NULL) {
1317 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1318 return NULL; /* Failure */
1321 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1322 disabled_mkey, disabled_auth, disabled_enc,
1323 disabled_mac, co_list, &head, &tail);
1325 /* Now arrange all ciphers by preference. */
1328 * Everything else being equal, prefer ephemeral ECDH over other key
1329 * exchange mechanisms.
1330 * For consistency, prefer ECDSA over RSA (though this only matters if the
1331 * server has both certificates, and is using the DEFAULT, or a client
1334 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1336 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1338 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1341 /* Within each strength group, we prefer GCM over CHACHA... */
1342 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1344 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1348 * ...and generally, our preferred cipher is AES.
1349 * Note that AEADs will be bumped to take preference after sorting by
1352 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1355 /* Temporarily enable everything else for sorting */
1356 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1358 /* Low priority for MD5 */
1359 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1363 * Move anonymous ciphers to the end. Usually, these will remain
1364 * disabled. (For applications that allow them, they aren't too bad, but
1365 * we prefer authenticated ciphers.)
1367 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1371 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1374 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1376 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1379 /* RC4 is sort-of broken -- move to the end */
1380 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1384 * Now sort by symmetric encryption strength. The above ordering remains
1385 * in force within each class
1387 if (!ssl_cipher_strength_sort(&head, &tail)) {
1388 OPENSSL_free(co_list);
1393 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1394 * TODO(openssl-team): is there an easier way to accomplish all this?
1396 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1400 * Irrespective of strength, enforce the following order:
1401 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1402 * Within each group, ciphers remain sorted by strength and previous
1407 * 4) TLS 1.2 > legacy
1409 * Because we now bump ciphers to the top of the list, we proceed in
1410 * reverse order of preference.
1412 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1414 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1415 CIPHER_BUMP, -1, &head, &tail);
1416 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1417 CIPHER_BUMP, -1, &head, &tail);
1419 /* Now disable everything (maintaining the ordering!) */
1420 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1423 * We also need cipher aliases for selecting based on the rule_str.
1424 * There might be two types of entries in the rule_str: 1) names
1425 * of ciphers themselves 2) aliases for groups of ciphers.
1426 * For 1) we need the available ciphers and for 2) the cipher
1427 * groups of cipher_aliases added together in one list (otherwise
1428 * we would be happy with just the cipher_aliases table).
1430 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1431 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1432 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1433 if (ca_list == NULL) {
1434 OPENSSL_free(co_list);
1435 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1436 return NULL; /* Failure */
1438 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1439 disabled_mkey, disabled_auth, disabled_enc,
1440 disabled_mac, head);
1443 * If the rule_string begins with DEFAULT, apply the default rule
1444 * before using the (possibly available) additional rules.
1448 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1449 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1450 &head, &tail, ca_list, c);
1456 if (ok && (strlen(rule_p) > 0))
1457 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1459 OPENSSL_free(ca_list); /* Not needed anymore */
1461 if (!ok) { /* Rule processing failure */
1462 OPENSSL_free(co_list);
1467 * Allocate new "cipherstack" for the result, return with error
1468 * if we cannot get one.
1470 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1471 OPENSSL_free(co_list);
1476 * The cipher selection for the list is done. The ciphers are added
1477 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1479 for (curr = head; curr != NULL; curr = curr->next) {
1481 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1482 OPENSSL_free(co_list);
1483 sk_SSL_CIPHER_free(cipherstack);
1487 fprintf(stderr, "<%s>\n", curr->cipher->name);
1491 OPENSSL_free(co_list); /* Not needed any longer */
1493 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1494 if (tmp_cipher_list == NULL) {
1495 sk_SSL_CIPHER_free(cipherstack);
1498 sk_SSL_CIPHER_free(*cipher_list);
1499 *cipher_list = cipherstack;
1500 if (*cipher_list_by_id != NULL)
1501 sk_SSL_CIPHER_free(*cipher_list_by_id);
1502 *cipher_list_by_id = tmp_cipher_list;
1503 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1505 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1509 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1512 const char *kx, *au, *enc, *mac;
1513 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1514 static const char *format = "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1518 buf = OPENSSL_malloc(len);
1521 } else if (len < 128) {
1525 alg_mkey = cipher->algorithm_mkey;
1526 alg_auth = cipher->algorithm_auth;
1527 alg_enc = cipher->algorithm_enc;
1528 alg_mac = cipher->algorithm_mac;
1530 ver = ssl_protocol_to_string(cipher->min_tls);
1589 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1590 case (SSL_aGOST12 | SSL_aGOST01):
1627 enc = "AESGCM(128)";
1630 enc = "AESGCM(256)";
1633 enc = "AESCCM(128)";
1636 enc = "AESCCM(256)";
1638 case SSL_AES128CCM8:
1639 enc = "AESCCM8(128)";
1641 case SSL_AES256CCM8:
1642 enc = "AESCCM8(256)";
1644 case SSL_CAMELLIA128:
1645 enc = "Camellia(128)";
1647 case SSL_CAMELLIA256:
1648 enc = "Camellia(256)";
1650 case SSL_ARIA128GCM:
1651 enc = "ARIAGCM(128)";
1653 case SSL_ARIA256GCM:
1654 enc = "ARIAGCM(256)";
1659 case SSL_eGOST2814789CNT:
1660 case SSL_eGOST2814789CNT12:
1661 enc = "GOST89(256)";
1663 case SSL_CHACHA20POLY1305:
1664 enc = "CHACHA20/POLY1305(256)";
1688 case SSL_GOST89MAC12:
1694 case SSL_GOST12_256:
1695 case SSL_GOST12_512:
1703 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1708 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1714 * Backwards-compatibility crutch. In almost all contexts we report TLS
1715 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1717 if (c->min_tls == TLS1_VERSION)
1719 return ssl_protocol_to_string(c->min_tls);
1722 /* return the actual cipher being used */
1723 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1730 /* return the actual cipher being used in RFC standard name */
1731 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1738 /* return the OpenSSL name based on given RFC standard name */
1739 const char *OPENSSL_cipher_name(const char *stdname)
1741 const SSL_CIPHER *c;
1743 if (stdname == NULL)
1745 c = ssl3_get_cipher_by_std_name(stdname);
1746 return SSL_CIPHER_get_name(c);
1749 /* number of bits for symmetric cipher */
1750 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1755 if (alg_bits != NULL)
1756 *alg_bits = (int)c->alg_bits;
1757 ret = (int)c->strength_bits;
1762 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1767 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1769 return c->id & 0xFFFF;
1772 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1777 if ((n == 0) || (sk == NULL))
1779 nn = sk_SSL_COMP_num(sk);
1780 for (i = 0; i < nn; i++) {
1781 ctmp = sk_SSL_COMP_value(sk, i);
1788 #ifdef OPENSSL_NO_COMP
1789 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1794 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1800 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1806 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1808 load_builtin_compressions();
1809 return ssl_comp_methods;
1812 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1815 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1816 ssl_comp_methods = meths;
1820 static void cmeth_free(SSL_COMP *cm)
1825 void ssl_comp_free_compression_methods_int(void)
1827 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1828 ssl_comp_methods = NULL;
1829 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1832 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1836 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1840 * According to draft-ietf-tls-compression-04.txt, the
1841 * compression number ranges should be the following:
1843 * 0 to 63: methods defined by the IETF
1844 * 64 to 192: external party methods assigned by IANA
1845 * 193 to 255: reserved for private use
1847 if (id < 193 || id > 255) {
1848 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1849 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1853 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1854 comp = OPENSSL_malloc(sizeof(*comp));
1856 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1857 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1863 load_builtin_compressions();
1864 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1866 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1867 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1868 SSL_R_DUPLICATE_COMPRESSION_ID);
1871 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1873 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1874 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1877 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1882 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1884 #ifndef OPENSSL_NO_COMP
1885 return comp ? COMP_get_name(comp) : NULL;
1891 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
1893 #ifndef OPENSSL_NO_COMP
1900 int SSL_COMP_get_id(const SSL_COMP *comp)
1902 #ifndef OPENSSL_NO_COMP
1909 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
1912 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
1914 if (c == NULL || (!all && c->valid == 0))
1919 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
1921 return ssl->method->get_cipher_by_char(ptr);
1924 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
1929 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
1932 return ssl_cipher_table_cipher[i].nid;
1935 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
1937 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
1941 return ssl_cipher_table_mac[i].nid;
1944 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
1946 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
1950 return ssl_cipher_table_kx[i].nid;
1953 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
1955 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
1959 return ssl_cipher_table_auth[i].nid;
1962 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
1964 int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
1966 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
1968 return ssl_digest_methods[idx];
1971 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
1973 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
1976 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1977 size_t *int_overhead, size_t *blocksize,
1978 size_t *ext_overhead)
1980 size_t mac = 0, in = 0, blk = 0, out = 0;
1982 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1983 * because there are no handy #defines for those. */
1984 if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
1985 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1986 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
1987 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
1988 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
1989 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
1990 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
1992 } else if (c->algorithm_mac & SSL_AEAD) {
1993 /* We're supposed to have handled all the AEAD modes above */
1996 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1997 int digest_nid = SSL_CIPHER_get_digest_nid(c);
1998 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2003 mac = EVP_MD_size(e_md);
2004 if (c->algorithm_enc != SSL_eNULL) {
2005 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2006 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2008 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2009 known CBC cipher. */
2010 if (e_ciph == NULL ||
2011 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2014 in = 1; /* padding length byte */
2015 out = EVP_CIPHER_iv_length(e_ciph);
2016 blk = EVP_CIPHER_block_size(e_ciph);
2020 *mac_overhead = mac;
2023 *ext_overhead = out;
2028 int ssl_cert_is_disabled(size_t idx)
2030 const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2032 if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)