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_NUM_IDX 20
45 /* NB: make sure indices in these tables match values above */
52 /* Table of NIDs for each cipher */
53 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
54 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
55 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
56 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
57 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
58 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
59 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
60 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
61 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
62 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
63 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
64 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
65 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
66 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
67 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
68 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
69 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
70 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
71 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
72 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX */
73 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305},
76 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
78 #define SSL_COMP_NULL_IDX 0
79 #define SSL_COMP_ZLIB_IDX 1
80 #define SSL_COMP_NUM_IDX 2
82 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
84 #ifndef OPENSSL_NO_COMP
85 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
89 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
93 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
95 /* NB: make sure indices in this table matches values above */
96 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
97 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
98 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
99 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
100 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
101 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
102 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
103 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
104 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
105 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
106 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
107 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
108 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
111 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
112 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
116 static const ssl_cipher_table ssl_cipher_table_kx[] = {
117 {SSL_kRSA, NID_kx_rsa},
118 {SSL_kECDHE, NID_kx_ecdhe},
119 {SSL_kDHE, NID_kx_dhe},
120 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
121 {SSL_kDHEPSK, NID_kx_dhe_psk},
122 {SSL_kRSAPSK, NID_kx_rsa_psk},
123 {SSL_kPSK, NID_kx_psk},
124 {SSL_kSRP, NID_kx_srp},
125 {SSL_kGOST, NID_kx_gost},
126 {SSL_kANY, NID_kx_any}
129 static const ssl_cipher_table ssl_cipher_table_auth[] = {
130 {SSL_aRSA, NID_auth_rsa},
131 {SSL_aECDSA, NID_auth_ecdsa},
132 {SSL_aPSK, NID_auth_psk},
133 {SSL_aDSS, NID_auth_dss},
134 {SSL_aGOST01, NID_auth_gost01},
135 {SSL_aGOST12, NID_auth_gost12},
136 {SSL_aSRP, NID_auth_srp},
137 {SSL_aNULL, NID_auth_null},
138 {SSL_aANY, NID_auth_any}
142 /* Utility function for table lookup */
143 static int ssl_cipher_info_find(const ssl_cipher_table * table,
144 size_t table_cnt, uint32_t mask)
147 for (i = 0; i < table_cnt; i++, table++) {
148 if (table->mask == mask)
154 #define ssl_cipher_info_lookup(table, x) \
155 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
158 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
159 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
162 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
163 /* MD5, SHA, GOST94, MAC89 */
164 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
165 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
166 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
171 static size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
174 #define CIPHER_KILL 2
177 #define CIPHER_SPECIAL 5
179 * Bump the ciphers to the top of the list.
180 * This rule isn't currently supported by the public cipherstring API.
182 #define CIPHER_BUMP 6
184 typedef struct cipher_order_st {
185 const SSL_CIPHER *cipher;
188 struct cipher_order_st *next, *prev;
191 static const SSL_CIPHER cipher_aliases[] = {
192 /* "ALL" doesn't include eNULL (must be specifically enabled) */
193 {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
194 /* "COMPLEMENTOFALL" */
195 {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
198 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
201 {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
204 * key exchange aliases (some of those using only a single bit here
205 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
206 * combines DHE_DSS and DHE_RSA)
208 {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
210 {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
211 {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
212 {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
214 {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
215 {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
216 {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
218 {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
219 {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
220 {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
221 {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
222 {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
223 {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
225 /* server authentication aliases */
226 {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
227 {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
228 {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
229 {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
230 {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
231 {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
232 {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
233 {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
234 {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
235 {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
236 {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
238 /* aliases combining key exchange and server authentication */
239 {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
240 {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
241 {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
242 {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
243 {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
244 {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
245 {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
246 {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
247 {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
248 {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
250 /* symmetric encryption aliases */
251 {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
252 {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
253 {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
254 {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
255 {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
256 {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
257 {0, SSL_TXT_GOST, NULL, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
258 {0, SSL_TXT_AES128, NULL, 0, 0, 0,
259 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
260 {0, SSL_TXT_AES256, NULL, 0, 0, 0,
261 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
262 {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
263 {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
264 {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
265 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
266 {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
267 {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
268 {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
269 {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
270 {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
273 {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
274 {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
275 {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
276 {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
277 {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
278 {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
279 {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
280 {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
282 /* protocol version aliases */
283 {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
284 {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
285 {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
286 {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
288 /* strength classes */
289 {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
290 {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
291 {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
292 /* FIPS 140-2 approved ciphersuite */
293 {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
295 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
296 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
297 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
298 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
299 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
304 * Search for public key algorithm with given name and return its pkey_id if
305 * it is available. Otherwise return 0
307 #ifdef OPENSSL_NO_ENGINE
309 static int get_optional_pkey_id(const char *pkey_name)
311 const EVP_PKEY_ASN1_METHOD *ameth;
313 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
314 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
322 static int get_optional_pkey_id(const char *pkey_name)
324 const EVP_PKEY_ASN1_METHOD *ameth;
325 ENGINE *tmpeng = NULL;
327 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
329 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
333 ENGINE_finish(tmpeng);
339 /* masks of disabled algorithms */
340 static uint32_t disabled_enc_mask;
341 static uint32_t disabled_mac_mask;
342 static uint32_t disabled_mkey_mask;
343 static uint32_t disabled_auth_mask;
345 int ssl_load_ciphers(void)
348 const ssl_cipher_table *t;
350 disabled_enc_mask = 0;
351 ssl_sort_cipher_list();
352 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
353 if (t->nid == NID_undef) {
354 ssl_cipher_methods[i] = NULL;
356 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
357 ssl_cipher_methods[i] = cipher;
359 disabled_enc_mask |= t->mask;
362 disabled_mac_mask = 0;
363 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
364 const EVP_MD *md = EVP_get_digestbynid(t->nid);
365 ssl_digest_methods[i] = md;
367 disabled_mac_mask |= t->mask;
369 int tmpsize = EVP_MD_size(md);
370 if (!ossl_assert(tmpsize >= 0))
372 ssl_mac_secret_size[i] = tmpsize;
375 /* Make sure we can access MD5 and SHA1 */
376 if (!ossl_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL))
378 if (!ossl_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL))
381 disabled_mkey_mask = 0;
382 disabled_auth_mask = 0;
384 #ifdef OPENSSL_NO_RSA
385 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
386 disabled_auth_mask |= SSL_aRSA;
388 #ifdef OPENSSL_NO_DSA
389 disabled_auth_mask |= SSL_aDSS;
392 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
395 disabled_mkey_mask |= SSL_kECDHEPSK;
396 disabled_auth_mask |= SSL_aECDSA;
398 #ifdef OPENSSL_NO_PSK
399 disabled_mkey_mask |= SSL_PSK;
400 disabled_auth_mask |= SSL_aPSK;
402 #ifdef OPENSSL_NO_SRP
403 disabled_mkey_mask |= SSL_kSRP;
407 * Check for presence of GOST 34.10 algorithms, and if they are not
408 * present, disable appropriate auth and key exchange
410 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
411 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
412 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
414 disabled_mac_mask |= SSL_GOST89MAC;
416 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
417 get_optional_pkey_id("gost-mac-12");
418 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
419 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
421 disabled_mac_mask |= SSL_GOST89MAC12;
423 if (!get_optional_pkey_id("gost2001"))
424 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
425 if (!get_optional_pkey_id("gost2012_256"))
426 disabled_auth_mask |= SSL_aGOST12;
427 if (!get_optional_pkey_id("gost2012_512"))
428 disabled_auth_mask |= SSL_aGOST12;
430 * Disable GOST key exchange if no GOST signature algs are available *
432 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
433 (SSL_aGOST01 | SSL_aGOST12))
434 disabled_mkey_mask |= SSL_kGOST;
439 #ifndef OPENSSL_NO_COMP
441 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
443 return ((*a)->id - (*b)->id);
446 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
448 SSL_COMP *comp = NULL;
449 COMP_METHOD *method = COMP_zlib();
451 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
452 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
454 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
455 comp = OPENSSL_malloc(sizeof(*comp));
457 comp->method = method;
458 comp->id = SSL_COMP_ZLIB_IDX;
459 comp->name = COMP_get_name(method);
460 sk_SSL_COMP_push(ssl_comp_methods, comp);
461 sk_SSL_COMP_sort(ssl_comp_methods);
464 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
468 static int load_builtin_compressions(void)
470 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
474 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
475 const EVP_MD **md, int *mac_pkey_type,
476 size_t *mac_secret_size, SSL_COMP **comp, int use_etm)
486 #ifndef OPENSSL_NO_COMP
487 if (!load_builtin_compressions()) {
489 * Currently don't care, since a failure only means that
490 * ssl_comp_methods is NULL, which is perfectly OK
495 ctmp.id = s->compress_meth;
496 if (ssl_comp_methods != NULL) {
497 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
499 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
503 /* If were only interested in comp then return success */
504 if ((enc == NULL) && (md == NULL))
508 if ((enc == NULL) || (md == NULL))
511 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
516 if (i == SSL_ENC_NULL_IDX)
517 *enc = EVP_enc_null();
519 *enc = ssl_cipher_methods[i];
522 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
525 if (mac_pkey_type != NULL)
526 *mac_pkey_type = NID_undef;
527 if (mac_secret_size != NULL)
528 *mac_secret_size = 0;
529 if (c->algorithm_mac == SSL_AEAD)
530 mac_pkey_type = NULL;
532 *md = ssl_digest_methods[i];
533 if (mac_pkey_type != NULL)
534 *mac_pkey_type = ssl_mac_pkey_id[i];
535 if (mac_secret_size != NULL)
536 *mac_secret_size = ssl_mac_secret_size[i];
539 if ((*enc != NULL) &&
540 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
541 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
542 const EVP_CIPHER *evp;
547 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
548 s->ssl_version < TLS1_VERSION)
551 if (c->algorithm_enc == SSL_RC4 &&
552 c->algorithm_mac == SSL_MD5 &&
553 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
554 *enc = evp, *md = NULL;
555 else if (c->algorithm_enc == SSL_AES128 &&
556 c->algorithm_mac == SSL_SHA1 &&
557 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
558 *enc = evp, *md = NULL;
559 else if (c->algorithm_enc == SSL_AES256 &&
560 c->algorithm_mac == SSL_SHA1 &&
561 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
562 *enc = evp, *md = NULL;
563 else if (c->algorithm_enc == SSL_AES128 &&
564 c->algorithm_mac == SSL_SHA256 &&
565 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
566 *enc = evp, *md = NULL;
567 else if (c->algorithm_enc == SSL_AES256 &&
568 c->algorithm_mac == SSL_SHA256 &&
569 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
570 *enc = evp, *md = NULL;
577 const EVP_MD *ssl_md(int idx)
579 idx &= SSL_HANDSHAKE_MAC_MASK;
580 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
582 return ssl_digest_methods[idx];
585 const EVP_MD *ssl_handshake_md(SSL *s)
587 return ssl_md(ssl_get_algorithm2(s));
590 const EVP_MD *ssl_prf_md(SSL *s)
592 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
595 #define ITEM_SEP(a) \
596 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
598 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
605 if (curr->prev != NULL)
606 curr->prev->next = curr->next;
607 if (curr->next != NULL)
608 curr->next->prev = curr->prev;
609 (*tail)->next = curr;
615 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
622 if (curr->next != NULL)
623 curr->next->prev = curr->prev;
624 if (curr->prev != NULL)
625 curr->prev->next = curr->next;
626 (*head)->prev = curr;
632 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
634 uint32_t disabled_mkey,
635 uint32_t disabled_auth,
636 uint32_t disabled_enc,
637 uint32_t disabled_mac,
638 CIPHER_ORDER *co_list,
639 CIPHER_ORDER **head_p,
640 CIPHER_ORDER **tail_p)
646 * We have num_of_ciphers descriptions compiled in, depending on the
647 * method selected (SSLv3, TLSv1 etc).
648 * These will later be sorted in a linked list with at most num
652 /* Get the initial list of ciphers */
653 co_list_num = 0; /* actual count of ciphers */
654 for (i = 0; i < num_of_ciphers; i++) {
655 c = ssl_method->get_cipher(i);
656 /* drop those that use any of that is not available */
657 if (c == NULL || !c->valid)
659 if ((c->algorithm_mkey & disabled_mkey) ||
660 (c->algorithm_auth & disabled_auth) ||
661 (c->algorithm_enc & disabled_enc) ||
662 (c->algorithm_mac & disabled_mac))
664 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
667 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
671 co_list[co_list_num].cipher = c;
672 co_list[co_list_num].next = NULL;
673 co_list[co_list_num].prev = NULL;
674 co_list[co_list_num].active = 0;
679 * Prepare linked list from list entries
681 if (co_list_num > 0) {
682 co_list[0].prev = NULL;
684 if (co_list_num > 1) {
685 co_list[0].next = &co_list[1];
687 for (i = 1; i < co_list_num - 1; i++) {
688 co_list[i].prev = &co_list[i - 1];
689 co_list[i].next = &co_list[i + 1];
692 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
695 co_list[co_list_num - 1].next = NULL;
697 *head_p = &co_list[0];
698 *tail_p = &co_list[co_list_num - 1];
702 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
703 int num_of_group_aliases,
704 uint32_t disabled_mkey,
705 uint32_t disabled_auth,
706 uint32_t disabled_enc,
707 uint32_t disabled_mac,
710 CIPHER_ORDER *ciph_curr;
711 const SSL_CIPHER **ca_curr;
713 uint32_t mask_mkey = ~disabled_mkey;
714 uint32_t mask_auth = ~disabled_auth;
715 uint32_t mask_enc = ~disabled_enc;
716 uint32_t mask_mac = ~disabled_mac;
719 * First, add the real ciphers as already collected
723 while (ciph_curr != NULL) {
724 *ca_curr = ciph_curr->cipher;
726 ciph_curr = ciph_curr->next;
730 * Now we add the available ones from the cipher_aliases[] table.
731 * They represent either one or more algorithms, some of which
732 * in any affected category must be supported (set in enabled_mask),
733 * or represent a cipher strength value (will be added in any case because algorithms=0).
735 for (i = 0; i < num_of_group_aliases; i++) {
736 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
737 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
738 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
739 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
742 if ((algorithm_mkey & mask_mkey) == 0)
746 if ((algorithm_auth & mask_auth) == 0)
750 if ((algorithm_enc & mask_enc) == 0)
754 if ((algorithm_mac & mask_mac) == 0)
757 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
761 *ca_curr = NULL; /* end of list */
764 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
765 uint32_t alg_auth, uint32_t alg_enc,
766 uint32_t alg_mac, int min_tls,
767 uint32_t algo_strength, int rule,
768 int32_t strength_bits, CIPHER_ORDER **head_p,
769 CIPHER_ORDER **tail_p)
771 CIPHER_ORDER *head, *tail, *curr, *next, *last;
772 const SSL_CIPHER *cp;
777 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
778 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
779 algo_strength, strength_bits);
782 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
783 reverse = 1; /* needed to maintain sorting between currently
807 next = reverse ? curr->prev : curr->next;
812 * Selection criteria is either the value of strength_bits
813 * or the algorithms used.
815 if (strength_bits >= 0) {
816 if (strength_bits != cp->strength_bits)
821 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
822 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
823 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
826 if (cipher_id != 0 && (cipher_id != cp->id))
828 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
830 if (alg_auth && !(alg_auth & cp->algorithm_auth))
832 if (alg_enc && !(alg_enc & cp->algorithm_enc))
834 if (alg_mac && !(alg_mac & cp->algorithm_mac))
836 if (min_tls && (min_tls != cp->min_tls))
838 if ((algo_strength & SSL_STRONG_MASK)
839 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
841 if ((algo_strength & SSL_DEFAULT_MASK)
842 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
847 fprintf(stderr, "Action = %d\n", rule);
850 /* add the cipher if it has not been added yet. */
851 if (rule == CIPHER_ADD) {
854 ll_append_tail(&head, curr, &tail);
858 /* Move the added cipher to this location */
859 else if (rule == CIPHER_ORD) {
862 ll_append_tail(&head, curr, &tail);
864 } else if (rule == CIPHER_DEL) {
868 * most recently deleted ciphersuites get best positions for
869 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
870 * in reverse to maintain the order)
872 ll_append_head(&head, curr, &tail);
875 } else if (rule == CIPHER_BUMP) {
877 ll_append_head(&head, curr, &tail);
878 } else if (rule == CIPHER_KILL) {
883 curr->prev->next = curr->next;
887 if (curr->next != NULL)
888 curr->next->prev = curr->prev;
889 if (curr->prev != NULL)
890 curr->prev->next = curr->next;
900 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
901 CIPHER_ORDER **tail_p)
903 int32_t max_strength_bits;
908 * This routine sorts the ciphers with descending strength. The sorting
909 * must keep the pre-sorted sequence, so we apply the normal sorting
910 * routine as '+' movement to the end of the list.
912 max_strength_bits = 0;
914 while (curr != NULL) {
915 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
916 max_strength_bits = curr->cipher->strength_bits;
920 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
921 if (number_uses == NULL) {
922 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
927 * Now find the strength_bits values actually used
930 while (curr != NULL) {
932 number_uses[curr->cipher->strength_bits]++;
936 * Go through the list of used strength_bits values in descending
939 for (i = max_strength_bits; i >= 0; i--)
940 if (number_uses[i] > 0)
941 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
944 OPENSSL_free(number_uses);
948 static int ssl_cipher_process_rulestr(const char *rule_str,
949 CIPHER_ORDER **head_p,
950 CIPHER_ORDER **tail_p,
951 const SSL_CIPHER **ca_list, CERT *c)
953 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
956 int j, multi, found, rule, retval, ok, buflen;
957 uint32_t cipher_id = 0;
970 } else if (ch == '+') {
973 } else if (ch == '!') {
976 } else if (ch == '@') {
977 rule = CIPHER_SPECIAL;
999 #ifndef CHARSET_EBCDIC
1000 while (((ch >= 'A') && (ch <= 'Z')) ||
1001 ((ch >= '0') && (ch <= '9')) ||
1002 ((ch >= 'a') && (ch <= 'z')) ||
1003 (ch == '-') || (ch == '.') || (ch == '='))
1005 while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1015 * We hit something we cannot deal with,
1016 * it is no command or separator nor
1017 * alphanumeric, so we call this an error.
1019 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1025 if (rule == CIPHER_SPECIAL) {
1026 found = 0; /* unused -- avoid compiler warning */
1027 break; /* special treatment */
1030 /* check for multi-part specification */
1039 * Now search for the cipher alias in the ca_list. Be careful
1040 * with the strncmp, because the "buflen" limitation
1041 * will make the rule "ADH:SOME" and the cipher
1042 * "ADH-MY-CIPHER" look like a match for buflen=3.
1043 * So additionally check whether the cipher name found
1044 * has the correct length. We can save a strlen() call:
1045 * just checking for the '\0' at the right place is
1046 * sufficient, we have to strncmp() anyway. (We cannot
1047 * use strcmp(), because buf is not '\0' terminated.)
1051 while (ca_list[j]) {
1052 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1053 && (ca_list[j]->name[buflen] == '\0')) {
1061 break; /* ignore this entry */
1063 if (ca_list[j]->algorithm_mkey) {
1065 alg_mkey &= ca_list[j]->algorithm_mkey;
1071 alg_mkey = ca_list[j]->algorithm_mkey;
1075 if (ca_list[j]->algorithm_auth) {
1077 alg_auth &= ca_list[j]->algorithm_auth;
1083 alg_auth = ca_list[j]->algorithm_auth;
1087 if (ca_list[j]->algorithm_enc) {
1089 alg_enc &= ca_list[j]->algorithm_enc;
1095 alg_enc = ca_list[j]->algorithm_enc;
1099 if (ca_list[j]->algorithm_mac) {
1101 alg_mac &= ca_list[j]->algorithm_mac;
1107 alg_mac = ca_list[j]->algorithm_mac;
1111 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1112 if (algo_strength & SSL_STRONG_MASK) {
1114 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1116 if (!(algo_strength & SSL_STRONG_MASK)) {
1121 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1125 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1126 if (algo_strength & SSL_DEFAULT_MASK) {
1128 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1130 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1136 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1140 if (ca_list[j]->valid) {
1142 * explicit ciphersuite found; its protocol version does not
1143 * become part of the search pattern!
1146 cipher_id = ca_list[j]->id;
1149 * not an explicit ciphersuite; only in this case, the
1150 * protocol version is considered part of the search pattern
1153 if (ca_list[j]->min_tls) {
1154 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1158 min_tls = ca_list[j]->min_tls;
1168 * Ok, we have the rule, now apply it
1170 if (rule == CIPHER_SPECIAL) { /* special command */
1172 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1173 ok = ssl_cipher_strength_sort(head_p, tail_p);
1174 } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1175 int level = buf[9] - '0';
1176 if (level < 0 || level > 5) {
1177 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1178 SSL_R_INVALID_COMMAND);
1180 c->sec_level = level;
1184 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1189 * We do not support any "multi" options
1190 * together with "@", so throw away the
1191 * rest of the command, if any left, until
1192 * end or ':' is found.
1194 while ((*l != '\0') && !ITEM_SEP(*l))
1197 ssl_cipher_apply_rule(cipher_id,
1198 alg_mkey, alg_auth, alg_enc, alg_mac,
1199 min_tls, algo_strength, rule, -1, head_p,
1202 while ((*l != '\0') && !ITEM_SEP(*l))
1212 #ifndef OPENSSL_NO_EC
1213 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1214 const char **prule_str)
1216 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1217 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1218 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1219 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1221 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1222 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1223 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1224 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1225 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1229 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1230 c->cert_flags |= suiteb_flags;
1232 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1237 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1239 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1240 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1241 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1244 # ifndef OPENSSL_NO_EC
1245 switch (suiteb_flags) {
1246 case SSL_CERT_FLAG_SUITEB_128_LOS:
1248 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1251 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1253 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1254 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1256 case SSL_CERT_FLAG_SUITEB_192_LOS:
1257 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1262 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1268 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1269 **cipher_list, STACK_OF(SSL_CIPHER)
1270 **cipher_list_by_id,
1271 const char *rule_str, CERT *c)
1273 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1274 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1275 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1277 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1278 const SSL_CIPHER **ca_list = NULL;
1281 * Return with error if nothing to do.
1283 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1285 #ifndef OPENSSL_NO_EC
1286 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1291 * To reduce the work to do we only want to process the compiled
1292 * in algorithms, so we first get the mask of disabled ciphers.
1295 disabled_mkey = disabled_mkey_mask;
1296 disabled_auth = disabled_auth_mask;
1297 disabled_enc = disabled_enc_mask;
1298 disabled_mac = disabled_mac_mask;
1301 * Now we have to collect the available ciphers from the compiled
1302 * in ciphers. We cannot get more than the number compiled in, so
1303 * it is used for allocation.
1305 num_of_ciphers = ssl_method->num_ciphers();
1307 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1308 if (co_list == NULL) {
1309 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1310 return NULL; /* Failure */
1313 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1314 disabled_mkey, disabled_auth, disabled_enc,
1315 disabled_mac, co_list, &head, &tail);
1317 /* Now arrange all ciphers by preference. */
1320 * Everything else being equal, prefer ephemeral ECDH over other key
1321 * exchange mechanisms.
1322 * For consistency, prefer ECDSA over RSA (though this only matters if the
1323 * server has both certificates, and is using the DEFAULT, or a client
1326 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1328 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1330 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1333 /* Within each strength group, we prefer GCM over CHACHA... */
1334 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1336 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1340 * ...and generally, our preferred cipher is AES.
1341 * Note that AEADs will be bumped to take preference after sorting by
1344 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1347 /* Temporarily enable everything else for sorting */
1348 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1350 /* Low priority for MD5 */
1351 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1355 * Move anonymous ciphers to the end. Usually, these will remain
1356 * disabled. (For applications that allow them, they aren't too bad, but
1357 * we prefer authenticated ciphers.)
1359 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1363 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1366 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1368 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1371 /* RC4 is sort-of broken -- move to the end */
1372 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1376 * Now sort by symmetric encryption strength. The above ordering remains
1377 * in force within each class
1379 if (!ssl_cipher_strength_sort(&head, &tail)) {
1380 OPENSSL_free(co_list);
1385 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1386 * TODO(openssl-team): is there an easier way to accomplish all this?
1388 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1392 * Irrespective of strength, enforce the following order:
1393 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1394 * Within each group, ciphers remain sorted by strength and previous
1399 * 4) TLS 1.2 > legacy
1401 * Because we now bump ciphers to the top of the list, we proceed in
1402 * reverse order of preference.
1404 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1406 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1407 CIPHER_BUMP, -1, &head, &tail);
1408 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1409 CIPHER_BUMP, -1, &head, &tail);
1411 /* Now disable everything (maintaining the ordering!) */
1412 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1415 * We also need cipher aliases for selecting based on the rule_str.
1416 * There might be two types of entries in the rule_str: 1) names
1417 * of ciphers themselves 2) aliases for groups of ciphers.
1418 * For 1) we need the available ciphers and for 2) the cipher
1419 * groups of cipher_aliases added together in one list (otherwise
1420 * we would be happy with just the cipher_aliases table).
1422 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1423 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1424 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1425 if (ca_list == NULL) {
1426 OPENSSL_free(co_list);
1427 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1428 return NULL; /* Failure */
1430 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1431 disabled_mkey, disabled_auth, disabled_enc,
1432 disabled_mac, head);
1435 * If the rule_string begins with DEFAULT, apply the default rule
1436 * before using the (possibly available) additional rules.
1440 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1441 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1442 &head, &tail, ca_list, c);
1448 if (ok && (strlen(rule_p) > 0))
1449 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1451 OPENSSL_free(ca_list); /* Not needed anymore */
1453 if (!ok) { /* Rule processing failure */
1454 OPENSSL_free(co_list);
1459 * Allocate new "cipherstack" for the result, return with error
1460 * if we cannot get one.
1462 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1463 OPENSSL_free(co_list);
1468 * The cipher selection for the list is done. The ciphers are added
1469 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1471 for (curr = head; curr != NULL; curr = curr->next) {
1473 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1474 OPENSSL_free(co_list);
1475 sk_SSL_CIPHER_free(cipherstack);
1479 fprintf(stderr, "<%s>\n", curr->cipher->name);
1483 OPENSSL_free(co_list); /* Not needed any longer */
1485 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1486 if (tmp_cipher_list == NULL) {
1487 sk_SSL_CIPHER_free(cipherstack);
1490 sk_SSL_CIPHER_free(*cipher_list);
1491 *cipher_list = cipherstack;
1492 if (*cipher_list_by_id != NULL)
1493 sk_SSL_CIPHER_free(*cipher_list_by_id);
1494 *cipher_list_by_id = tmp_cipher_list;
1495 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1497 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1501 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1504 const char *kx, *au, *enc, *mac;
1505 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1506 static const char *format = "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1510 buf = OPENSSL_malloc(len);
1513 } else if (len < 128) {
1517 alg_mkey = cipher->algorithm_mkey;
1518 alg_auth = cipher->algorithm_auth;
1519 alg_enc = cipher->algorithm_enc;
1520 alg_mac = cipher->algorithm_mac;
1522 ver = ssl_protocol_to_string(cipher->min_tls);
1581 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1582 case (SSL_aGOST12 | SSL_aGOST01):
1619 enc = "AESGCM(128)";
1622 enc = "AESGCM(256)";
1625 enc = "AESCCM(128)";
1628 enc = "AESCCM(256)";
1630 case SSL_AES128CCM8:
1631 enc = "AESCCM8(128)";
1633 case SSL_AES256CCM8:
1634 enc = "AESCCM8(256)";
1636 case SSL_CAMELLIA128:
1637 enc = "Camellia(128)";
1639 case SSL_CAMELLIA256:
1640 enc = "Camellia(256)";
1645 case SSL_eGOST2814789CNT:
1646 case SSL_eGOST2814789CNT12:
1647 enc = "GOST89(256)";
1649 case SSL_CHACHA20POLY1305:
1650 enc = "CHACHA20/POLY1305(256)";
1674 case SSL_GOST89MAC12:
1680 case SSL_GOST12_256:
1681 case SSL_GOST12_512:
1689 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1694 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1700 * Backwards-compatibility crutch. In almost all contexts we report TLS
1701 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1703 if (c->min_tls == TLS1_VERSION)
1705 return ssl_protocol_to_string(c->min_tls);
1708 /* return the actual cipher being used */
1709 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1716 /* return the actual cipher being used in RFC standard name */
1717 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1724 /* return the OpenSSL name based on given RFC standard name */
1725 const char *OPENSSL_cipher_name(const char *stdname)
1727 const SSL_CIPHER *c;
1729 if (stdname == NULL)
1731 c = ssl3_get_cipher_by_std_name(stdname);
1732 return SSL_CIPHER_get_name(c);
1735 /* number of bits for symmetric cipher */
1736 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1741 if (alg_bits != NULL)
1742 *alg_bits = (int)c->alg_bits;
1743 ret = (int)c->strength_bits;
1748 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1753 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1758 if ((n == 0) || (sk == NULL))
1760 nn = sk_SSL_COMP_num(sk);
1761 for (i = 0; i < nn; i++) {
1762 ctmp = sk_SSL_COMP_value(sk, i);
1769 #ifdef OPENSSL_NO_COMP
1770 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1775 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1781 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1787 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1789 load_builtin_compressions();
1790 return ssl_comp_methods;
1793 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1796 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1797 ssl_comp_methods = meths;
1801 static void cmeth_free(SSL_COMP *cm)
1806 void ssl_comp_free_compression_methods_int(void)
1808 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1809 ssl_comp_methods = NULL;
1810 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1813 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1817 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1821 * According to draft-ietf-tls-compression-04.txt, the
1822 * compression number ranges should be the following:
1824 * 0 to 63: methods defined by the IETF
1825 * 64 to 192: external party methods assigned by IANA
1826 * 193 to 255: reserved for private use
1828 if (id < 193 || id > 255) {
1829 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1830 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1834 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1835 comp = OPENSSL_malloc(sizeof(*comp));
1837 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1838 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1844 load_builtin_compressions();
1845 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1847 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1848 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1849 SSL_R_DUPLICATE_COMPRESSION_ID);
1852 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1854 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1855 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1858 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1863 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1865 #ifndef OPENSSL_NO_COMP
1866 return comp ? COMP_get_name(comp) : NULL;
1872 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
1874 #ifndef OPENSSL_NO_COMP
1881 int SSL_COMP_get_id(const SSL_COMP *comp)
1883 #ifndef OPENSSL_NO_COMP
1890 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
1893 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
1895 if (c == NULL || (!all && c->valid == 0))
1900 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
1902 return ssl->method->get_cipher_by_char(ptr);
1905 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
1910 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
1913 return ssl_cipher_table_cipher[i].nid;
1916 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
1918 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
1922 return ssl_cipher_table_mac[i].nid;
1925 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
1927 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
1931 return ssl_cipher_table_kx[i].nid;
1934 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
1936 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
1940 return ssl_cipher_table_auth[i].nid;
1943 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
1945 int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
1947 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
1949 return ssl_digest_methods[idx];
1952 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
1954 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
1957 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1958 size_t *int_overhead, size_t *blocksize,
1959 size_t *ext_overhead)
1961 size_t mac = 0, in = 0, blk = 0, out = 0;
1963 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1964 * because there are no handy #defines for those. */
1965 if (c->algorithm_enc & SSL_AESGCM) {
1966 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1967 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
1968 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
1969 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
1970 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
1971 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
1973 } else if (c->algorithm_mac & SSL_AEAD) {
1974 /* We're supposed to have handled all the AEAD modes above */
1977 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1978 int digest_nid = SSL_CIPHER_get_digest_nid(c);
1979 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
1984 mac = EVP_MD_size(e_md);
1985 if (c->algorithm_enc != SSL_eNULL) {
1986 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
1987 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
1989 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
1990 known CBC cipher. */
1991 if (e_ciph == NULL ||
1992 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
1995 in = 1; /* padding length byte */
1996 out = EVP_CIPHER_iv_length(e_ciph);
1997 blk = EVP_CIPHER_block_size(e_ciph);
2001 *mac_overhead = mac;
2004 *ext_overhead = out;
2009 int ssl_cert_is_disabled(size_t idx)
2011 const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2013 if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)