2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
44 #include <openssl/objects.h>
45 #include <openssl/comp.h>
46 #include <openssl/engine.h>
47 #include <openssl/crypto.h>
49 #include "internal/thread_once.h"
51 #define SSL_ENC_DES_IDX 0
52 #define SSL_ENC_3DES_IDX 1
53 #define SSL_ENC_RC4_IDX 2
54 #define SSL_ENC_RC2_IDX 3
55 #define SSL_ENC_IDEA_IDX 4
56 #define SSL_ENC_NULL_IDX 5
57 #define SSL_ENC_AES128_IDX 6
58 #define SSL_ENC_AES256_IDX 7
59 #define SSL_ENC_CAMELLIA128_IDX 8
60 #define SSL_ENC_CAMELLIA256_IDX 9
61 #define SSL_ENC_GOST89_IDX 10
62 #define SSL_ENC_SEED_IDX 11
63 #define SSL_ENC_AES128GCM_IDX 12
64 #define SSL_ENC_AES256GCM_IDX 13
65 #define SSL_ENC_AES128CCM_IDX 14
66 #define SSL_ENC_AES256CCM_IDX 15
67 #define SSL_ENC_AES128CCM8_IDX 16
68 #define SSL_ENC_AES256CCM8_IDX 17
69 #define SSL_ENC_GOST8912_IDX 18
70 #define SSL_ENC_CHACHA_IDX 19
71 #define SSL_ENC_NUM_IDX 20
73 /* NB: make sure indices in these tables match values above */
80 /* Table of NIDs for each cipher */
81 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
82 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
83 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
84 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
85 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
86 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
87 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
88 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
89 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
90 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
91 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
92 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
93 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
94 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
95 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
96 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
97 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
98 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
99 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
100 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX */
101 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305},
104 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX] = {
105 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
109 #define SSL_COMP_NULL_IDX 0
110 #define SSL_COMP_ZLIB_IDX 1
111 #define SSL_COMP_NUM_IDX 2
113 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
115 #ifndef OPENSSL_NO_COMP
116 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
120 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
124 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
126 /* NB: make sure indices in this table matches values above */
127 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
128 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
129 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
130 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
131 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
132 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
133 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
134 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
135 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
136 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
137 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
138 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
139 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
142 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
143 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
147 static const ssl_cipher_table ssl_cipher_table_kx[] = {
148 {SSL_kRSA, NID_kx_rsa},
149 {SSL_kECDHE, NID_kx_ecdhe},
150 {SSL_kDHE, NID_kx_dhe},
151 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
152 {SSL_kDHEPSK, NID_kx_dhe_psk},
153 {SSL_kRSAPSK, NID_kx_rsa_psk},
154 {SSL_kPSK, NID_kx_psk},
155 {SSL_kSRP, NID_kx_srp},
156 {SSL_kGOST, NID_kx_gost}
159 static const ssl_cipher_table ssl_cipher_table_auth[] = {
160 {SSL_aRSA, NID_auth_rsa},
161 {SSL_aECDSA, NID_auth_ecdsa},
162 {SSL_aPSK, NID_auth_psk},
163 {SSL_aDSS, NID_auth_dss},
164 {SSL_aGOST01, NID_auth_gost01},
165 {SSL_aGOST12, NID_auth_gost12},
166 {SSL_aSRP, NID_auth_srp},
167 {SSL_aNULL, NID_auth_null}
171 /* Utility function for table lookup */
172 static int ssl_cipher_info_find(const ssl_cipher_table * table,
173 size_t table_cnt, uint32_t mask)
176 for (i = 0; i < table_cnt; i++, table++) {
177 if (table->mask == mask)
183 #define ssl_cipher_info_lookup(table, x) \
184 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
187 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
188 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
191 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
192 /* MD5, SHA, GOST94, MAC89 */
193 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
194 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
195 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
200 static size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
203 #define CIPHER_KILL 2
206 #define CIPHER_SPECIAL 5
208 * Bump the ciphers to the top of the list.
209 * This rule isn't currently supported by the public cipherstring API.
211 #define CIPHER_BUMP 6
213 typedef struct cipher_order_st {
214 const SSL_CIPHER *cipher;
217 struct cipher_order_st *next, *prev;
220 static const SSL_CIPHER cipher_aliases[] = {
221 /* "ALL" doesn't include eNULL (must be specifically enabled) */
222 {0, SSL_TXT_ALL, 0, 0, 0, ~SSL_eNULL},
223 /* "COMPLEMENTOFALL" */
224 {0, SSL_TXT_CMPALL, 0, 0, 0, SSL_eNULL},
227 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
230 {0, SSL_TXT_CMPDEF, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
233 * key exchange aliases (some of those using only a single bit here
234 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
235 * combines DHE_DSS and DHE_RSA)
237 {0, SSL_TXT_kRSA, 0, SSL_kRSA},
239 {0, SSL_TXT_kEDH, 0, SSL_kDHE},
240 {0, SSL_TXT_kDHE, 0, SSL_kDHE},
241 {0, SSL_TXT_DH, 0, SSL_kDHE},
243 {0, SSL_TXT_kEECDH, 0, SSL_kECDHE},
244 {0, SSL_TXT_kECDHE, 0, SSL_kECDHE},
245 {0, SSL_TXT_ECDH, 0, SSL_kECDHE},
247 {0, SSL_TXT_kPSK, 0, SSL_kPSK},
248 {0, SSL_TXT_kRSAPSK, 0, SSL_kRSAPSK},
249 {0, SSL_TXT_kECDHEPSK, 0, SSL_kECDHEPSK},
250 {0, SSL_TXT_kDHEPSK, 0, SSL_kDHEPSK},
251 {0, SSL_TXT_kSRP, 0, SSL_kSRP},
252 {0, SSL_TXT_kGOST, 0, SSL_kGOST},
254 /* server authentication aliases */
255 {0, SSL_TXT_aRSA, 0, 0, SSL_aRSA},
256 {0, SSL_TXT_aDSS, 0, 0, SSL_aDSS},
257 {0, SSL_TXT_DSS, 0, 0, SSL_aDSS},
258 {0, SSL_TXT_aNULL, 0, 0, SSL_aNULL},
259 {0, SSL_TXT_aECDSA, 0, 0, SSL_aECDSA},
260 {0, SSL_TXT_ECDSA, 0, 0, SSL_aECDSA},
261 {0, SSL_TXT_aPSK, 0, 0, SSL_aPSK},
262 {0, SSL_TXT_aGOST01, 0, 0, SSL_aGOST01},
263 {0, SSL_TXT_aGOST12, 0, 0, SSL_aGOST12},
264 {0, SSL_TXT_aGOST, 0, 0, SSL_aGOST01 | SSL_aGOST12},
265 {0, SSL_TXT_aSRP, 0, 0, SSL_aSRP},
267 /* aliases combining key exchange and server authentication */
268 {0, SSL_TXT_EDH, 0, SSL_kDHE, ~SSL_aNULL},
269 {0, SSL_TXT_DHE, 0, SSL_kDHE, ~SSL_aNULL},
270 {0, SSL_TXT_EECDH, 0, SSL_kECDHE, ~SSL_aNULL},
271 {0, SSL_TXT_ECDHE, 0, SSL_kECDHE, ~SSL_aNULL},
272 {0, SSL_TXT_NULL, 0, 0, 0, SSL_eNULL},
273 {0, SSL_TXT_RSA, 0, SSL_kRSA, SSL_aRSA},
274 {0, SSL_TXT_ADH, 0, SSL_kDHE, SSL_aNULL},
275 {0, SSL_TXT_AECDH, 0, SSL_kECDHE, SSL_aNULL},
276 {0, SSL_TXT_PSK, 0, SSL_PSK},
277 {0, SSL_TXT_SRP, 0, SSL_kSRP},
279 /* symmetric encryption aliases */
280 {0, SSL_TXT_3DES, 0, 0, 0, SSL_3DES},
281 {0, SSL_TXT_RC4, 0, 0, 0, SSL_RC4},
282 {0, SSL_TXT_RC2, 0, 0, 0, SSL_RC2},
283 {0, SSL_TXT_IDEA, 0, 0, 0, SSL_IDEA},
284 {0, SSL_TXT_SEED, 0, 0, 0, SSL_SEED},
285 {0, SSL_TXT_eNULL, 0, 0, 0, SSL_eNULL},
286 {0, SSL_TXT_GOST, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
287 {0, SSL_TXT_AES128, 0, 0, 0,
288 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
289 {0, SSL_TXT_AES256, 0, 0, 0,
290 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
291 {0, SSL_TXT_AES, 0, 0, 0, SSL_AES},
292 {0, SSL_TXT_AES_GCM, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
293 {0, SSL_TXT_AES_CCM, 0, 0, 0,
294 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
295 {0, SSL_TXT_AES_CCM_8, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
296 {0, SSL_TXT_CAMELLIA128, 0, 0, 0, SSL_CAMELLIA128},
297 {0, SSL_TXT_CAMELLIA256, 0, 0, 0, SSL_CAMELLIA256},
298 {0, SSL_TXT_CAMELLIA, 0, 0, 0, SSL_CAMELLIA},
299 {0, SSL_TXT_CHACHA20, 0, 0, 0, SSL_CHACHA20},
302 {0, SSL_TXT_MD5, 0, 0, 0, 0, SSL_MD5},
303 {0, SSL_TXT_SHA1, 0, 0, 0, 0, SSL_SHA1},
304 {0, SSL_TXT_SHA, 0, 0, 0, 0, SSL_SHA1},
305 {0, SSL_TXT_GOST94, 0, 0, 0, 0, SSL_GOST94},
306 {0, SSL_TXT_GOST89MAC, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
307 {0, SSL_TXT_SHA256, 0, 0, 0, 0, SSL_SHA256},
308 {0, SSL_TXT_SHA384, 0, 0, 0, 0, SSL_SHA384},
309 {0, SSL_TXT_GOST12, 0, 0, 0, 0, SSL_GOST12_256},
311 /* protocol version aliases */
312 {0, SSL_TXT_SSLV3, 0, 0, 0, 0, 0, SSL3_VERSION},
313 {0, SSL_TXT_TLSV1, 0, 0, 0, 0, 0, TLS1_VERSION},
314 {0, "TLSv1.0", 0, 0, 0, 0, 0, TLS1_VERSION},
315 {0, SSL_TXT_TLSV1_2, 0, 0, 0, 0, 0, TLS1_2_VERSION},
317 /* strength classes */
318 {0, SSL_TXT_LOW, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
319 {0, SSL_TXT_MEDIUM, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
320 {0, SSL_TXT_HIGH, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
321 /* FIPS 140-2 approved ciphersuite */
322 {0, SSL_TXT_FIPS, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
324 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
325 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, 0,
326 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
327 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, 0,
328 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
333 * Search for public key algorithm with given name and return its pkey_id if
334 * it is available. Otherwise return 0
336 #ifdef OPENSSL_NO_ENGINE
338 static int get_optional_pkey_id(const char *pkey_name)
340 const EVP_PKEY_ASN1_METHOD *ameth;
342 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
343 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
352 static int get_optional_pkey_id(const char *pkey_name)
354 const EVP_PKEY_ASN1_METHOD *ameth;
355 ENGINE *tmpeng = NULL;
357 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
359 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
363 ENGINE_finish(tmpeng);
369 /* masks of disabled algorithms */
370 static uint32_t disabled_enc_mask;
371 static uint32_t disabled_mac_mask;
372 static uint32_t disabled_mkey_mask;
373 static uint32_t disabled_auth_mask;
375 void ssl_load_ciphers(void)
378 const ssl_cipher_table *t;
380 disabled_enc_mask = 0;
381 ssl_sort_cipher_list();
382 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
383 if (t->nid == NID_undef) {
384 ssl_cipher_methods[i] = NULL;
386 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
387 ssl_cipher_methods[i] = cipher;
389 disabled_enc_mask |= t->mask;
392 #ifdef SSL_FORBID_ENULL
393 disabled_enc_mask |= SSL_eNULL;
395 disabled_mac_mask = 0;
396 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
397 const EVP_MD *md = EVP_get_digestbynid(t->nid);
398 ssl_digest_methods[i] = md;
400 disabled_mac_mask |= t->mask;
402 int tmpsize = EVP_MD_size(md);
403 OPENSSL_assert(tmpsize >= 0);
404 ssl_mac_secret_size[i] = tmpsize;
407 /* Make sure we can access MD5 and SHA1 */
408 OPENSSL_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL);
409 OPENSSL_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL);
411 disabled_mkey_mask = 0;
412 disabled_auth_mask = 0;
414 #ifdef OPENSSL_NO_RSA
415 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
416 disabled_auth_mask |= SSL_aRSA;
418 #ifdef OPENSSL_NO_DSA
419 disabled_auth_mask |= SSL_aDSS;
422 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
425 disabled_mkey_mask |= SSL_kECDHEPSK;
426 disabled_auth_mask |= SSL_aECDSA;
428 #ifdef OPENSSL_NO_PSK
429 disabled_mkey_mask |= SSL_PSK;
430 disabled_auth_mask |= SSL_aPSK;
432 #ifdef OPENSSL_NO_SRP
433 disabled_mkey_mask |= SSL_kSRP;
437 * Check for presence of GOST 34.10 algorithms, and if they are not
438 * present, disable appropriate auth and key exchange
440 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
441 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX]) {
442 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
444 disabled_mac_mask |= SSL_GOST89MAC;
447 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
448 get_optional_pkey_id("gost-mac-12");
449 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX]) {
450 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
452 disabled_mac_mask |= SSL_GOST89MAC12;
455 if (!get_optional_pkey_id("gost2001"))
456 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
457 if (!get_optional_pkey_id("gost2012_256"))
458 disabled_auth_mask |= SSL_aGOST12;
459 if (!get_optional_pkey_id("gost2012_512"))
460 disabled_auth_mask |= SSL_aGOST12;
462 * Disable GOST key exchange if no GOST signature algs are available *
464 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
465 (SSL_aGOST01 | SSL_aGOST12))
466 disabled_mkey_mask |= SSL_kGOST;
469 #ifndef OPENSSL_NO_COMP
471 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
473 return ((*a)->id - (*b)->id);
476 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
478 SSL_COMP *comp = NULL;
479 COMP_METHOD *method = COMP_zlib();
481 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
482 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
484 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
485 comp = OPENSSL_malloc(sizeof(*comp));
487 comp->method = method;
488 comp->id = SSL_COMP_ZLIB_IDX;
489 comp->name = COMP_get_name(method);
490 sk_SSL_COMP_push(ssl_comp_methods, comp);
491 sk_SSL_COMP_sort(ssl_comp_methods);
494 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
498 static int load_builtin_compressions(void)
500 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
504 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
505 const EVP_MD **md, int *mac_pkey_type,
506 size_t *mac_secret_size, SSL_COMP **comp, int use_etm)
516 #ifndef OPENSSL_NO_COMP
517 if (!load_builtin_compressions()) {
519 * Currently don't care, since a failure only means that
520 * ssl_comp_methods is NULL, which is perfectly OK
525 ctmp.id = s->compress_meth;
526 if (ssl_comp_methods != NULL) {
527 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
529 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
533 /* If were only interested in comp then return success */
534 if ((enc == NULL) && (md == NULL))
538 if ((enc == NULL) || (md == NULL))
541 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
546 if (i == SSL_ENC_NULL_IDX)
547 *enc = EVP_enc_null();
549 *enc = ssl_cipher_methods[i];
552 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
555 if (mac_pkey_type != NULL)
556 *mac_pkey_type = NID_undef;
557 if (mac_secret_size != NULL)
558 *mac_secret_size = 0;
559 if (c->algorithm_mac == SSL_AEAD)
560 mac_pkey_type = NULL;
562 *md = ssl_digest_methods[i];
563 if (mac_pkey_type != NULL)
564 *mac_pkey_type = ssl_mac_pkey_id[i];
565 if (mac_secret_size != NULL)
566 *mac_secret_size = ssl_mac_secret_size[i];
569 if ((*enc != NULL) &&
570 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
571 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
572 const EVP_CIPHER *evp;
577 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
578 s->ssl_version < TLS1_VERSION)
584 if (c->algorithm_enc == SSL_RC4 &&
585 c->algorithm_mac == SSL_MD5 &&
586 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
587 *enc = evp, *md = NULL;
588 else if (c->algorithm_enc == SSL_AES128 &&
589 c->algorithm_mac == SSL_SHA1 &&
590 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
591 *enc = evp, *md = NULL;
592 else if (c->algorithm_enc == SSL_AES256 &&
593 c->algorithm_mac == SSL_SHA1 &&
594 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
595 *enc = evp, *md = NULL;
596 else if (c->algorithm_enc == SSL_AES128 &&
597 c->algorithm_mac == SSL_SHA256 &&
598 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
599 *enc = evp, *md = NULL;
600 else if (c->algorithm_enc == SSL_AES256 &&
601 c->algorithm_mac == SSL_SHA256 &&
602 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
603 *enc = evp, *md = NULL;
609 const EVP_MD *ssl_md(int idx)
611 idx &= SSL_HANDSHAKE_MAC_MASK;
612 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
614 return ssl_digest_methods[idx];
617 const EVP_MD *ssl_handshake_md(SSL *s)
619 return ssl_md(ssl_get_algorithm2(s));
622 const EVP_MD *ssl_prf_md(SSL *s)
624 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
627 #define ITEM_SEP(a) \
628 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
630 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
637 if (curr->prev != NULL)
638 curr->prev->next = curr->next;
639 if (curr->next != NULL)
640 curr->next->prev = curr->prev;
641 (*tail)->next = curr;
647 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
654 if (curr->next != NULL)
655 curr->next->prev = curr->prev;
656 if (curr->prev != NULL)
657 curr->prev->next = curr->next;
658 (*head)->prev = curr;
664 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
666 uint32_t disabled_mkey,
667 uint32_t disabled_auth,
668 uint32_t disabled_enc,
669 uint32_t disabled_mac,
670 CIPHER_ORDER *co_list,
671 CIPHER_ORDER **head_p,
672 CIPHER_ORDER **tail_p)
678 * We have num_of_ciphers descriptions compiled in, depending on the
679 * method selected (SSLv3, TLSv1 etc).
680 * These will later be sorted in a linked list with at most num
684 /* Get the initial list of ciphers */
685 co_list_num = 0; /* actual count of ciphers */
686 for (i = 0; i < num_of_ciphers; i++) {
687 c = ssl_method->get_cipher(i);
688 /* drop those that use any of that is not available */
689 if (c == NULL || !c->valid)
691 if (FIPS_mode() && (c->algo_strength & SSL_FIPS))
693 if ((c->algorithm_mkey & disabled_mkey) ||
694 (c->algorithm_auth & disabled_auth) ||
695 (c->algorithm_enc & disabled_enc) ||
696 (c->algorithm_mac & disabled_mac))
698 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
701 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
705 co_list[co_list_num].cipher = c;
706 co_list[co_list_num].next = NULL;
707 co_list[co_list_num].prev = NULL;
708 co_list[co_list_num].active = 0;
711 * if (!sk_push(ca_list,(char *)c)) goto err;
716 * Prepare linked list from list entries
718 if (co_list_num > 0) {
719 co_list[0].prev = NULL;
721 if (co_list_num > 1) {
722 co_list[0].next = &co_list[1];
724 for (i = 1; i < co_list_num - 1; i++) {
725 co_list[i].prev = &co_list[i - 1];
726 co_list[i].next = &co_list[i + 1];
729 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
732 co_list[co_list_num - 1].next = NULL;
734 *head_p = &co_list[0];
735 *tail_p = &co_list[co_list_num - 1];
739 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
740 int num_of_group_aliases,
741 uint32_t disabled_mkey,
742 uint32_t disabled_auth,
743 uint32_t disabled_enc,
744 uint32_t disabled_mac,
747 CIPHER_ORDER *ciph_curr;
748 const SSL_CIPHER **ca_curr;
750 uint32_t mask_mkey = ~disabled_mkey;
751 uint32_t mask_auth = ~disabled_auth;
752 uint32_t mask_enc = ~disabled_enc;
753 uint32_t mask_mac = ~disabled_mac;
756 * First, add the real ciphers as already collected
760 while (ciph_curr != NULL) {
761 *ca_curr = ciph_curr->cipher;
763 ciph_curr = ciph_curr->next;
767 * Now we add the available ones from the cipher_aliases[] table.
768 * They represent either one or more algorithms, some of which
769 * in any affected category must be supported (set in enabled_mask),
770 * or represent a cipher strength value (will be added in any case because algorithms=0).
772 for (i = 0; i < num_of_group_aliases; i++) {
773 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
774 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
775 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
776 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
779 if ((algorithm_mkey & mask_mkey) == 0)
783 if ((algorithm_auth & mask_auth) == 0)
787 if ((algorithm_enc & mask_enc) == 0)
791 if ((algorithm_mac & mask_mac) == 0)
794 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
798 *ca_curr = NULL; /* end of list */
801 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
802 uint32_t alg_auth, uint32_t alg_enc,
803 uint32_t alg_mac, int min_tls,
804 uint32_t algo_strength, int rule,
805 int32_t strength_bits, CIPHER_ORDER **head_p,
806 CIPHER_ORDER **tail_p)
808 CIPHER_ORDER *head, *tail, *curr, *next, *last;
809 const SSL_CIPHER *cp;
814 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
815 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
816 algo_strength, strength_bits);
819 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
820 reverse = 1; /* needed to maintain sorting between currently
844 next = reverse ? curr->prev : curr->next;
849 * Selection criteria is either the value of strength_bits
850 * or the algorithms used.
852 if (strength_bits >= 0) {
853 if (strength_bits != cp->strength_bits)
858 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
859 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
860 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
863 if (cipher_id != 0 && (cipher_id != cp->id))
865 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
867 if (alg_auth && !(alg_auth & cp->algorithm_auth))
869 if (alg_enc && !(alg_enc & cp->algorithm_enc))
871 if (alg_mac && !(alg_mac & cp->algorithm_mac))
873 if (min_tls && (min_tls != cp->min_tls))
875 if ((algo_strength & SSL_STRONG_MASK)
876 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
878 if ((algo_strength & SSL_DEFAULT_MASK)
879 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
884 fprintf(stderr, "Action = %d\n", rule);
887 /* add the cipher if it has not been added yet. */
888 if (rule == CIPHER_ADD) {
891 ll_append_tail(&head, curr, &tail);
895 /* Move the added cipher to this location */
896 else if (rule == CIPHER_ORD) {
899 ll_append_tail(&head, curr, &tail);
901 } else if (rule == CIPHER_DEL) {
905 * most recently deleted ciphersuites get best positions for
906 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
907 * in reverse to maintain the order)
909 ll_append_head(&head, curr, &tail);
912 } else if (rule == CIPHER_BUMP) {
914 ll_append_head(&head, curr, &tail);
915 } else if (rule == CIPHER_KILL) {
920 curr->prev->next = curr->next;
924 if (curr->next != NULL)
925 curr->next->prev = curr->prev;
926 if (curr->prev != NULL)
927 curr->prev->next = curr->next;
937 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
938 CIPHER_ORDER **tail_p)
940 int32_t max_strength_bits;
945 * This routine sorts the ciphers with descending strength. The sorting
946 * must keep the pre-sorted sequence, so we apply the normal sorting
947 * routine as '+' movement to the end of the list.
949 max_strength_bits = 0;
951 while (curr != NULL) {
952 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
953 max_strength_bits = curr->cipher->strength_bits;
957 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
958 if (number_uses == NULL) {
959 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
964 * Now find the strength_bits values actually used
967 while (curr != NULL) {
969 number_uses[curr->cipher->strength_bits]++;
973 * Go through the list of used strength_bits values in descending
976 for (i = max_strength_bits; i >= 0; i--)
977 if (number_uses[i] > 0)
978 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
981 OPENSSL_free(number_uses);
985 static int ssl_cipher_process_rulestr(const char *rule_str,
986 CIPHER_ORDER **head_p,
987 CIPHER_ORDER **tail_p,
988 const SSL_CIPHER **ca_list, CERT *c)
990 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
993 int j, multi, found, rule, retval, ok, buflen;
994 uint32_t cipher_id = 0;
1007 } else if (ch == '+') {
1010 } else if (ch == '!') {
1013 } else if (ch == '@') {
1014 rule = CIPHER_SPECIAL;
1036 #ifndef CHARSET_EBCDIC
1037 while (((ch >= 'A') && (ch <= 'Z')) ||
1038 ((ch >= '0') && (ch <= '9')) ||
1039 ((ch >= 'a') && (ch <= 'z')) ||
1040 (ch == '-') || (ch == '.') || (ch == '='))
1042 while (isalnum(ch) || (ch == '-') || (ch == '.') || (ch == '='))
1051 * We hit something we cannot deal with,
1052 * it is no command or separator nor
1053 * alphanumeric, so we call this an error.
1055 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1061 if (rule == CIPHER_SPECIAL) {
1062 found = 0; /* unused -- avoid compiler warning */
1063 break; /* special treatment */
1066 /* check for multi-part specification */
1074 * Now search for the cipher alias in the ca_list. Be careful
1075 * with the strncmp, because the "buflen" limitation
1076 * will make the rule "ADH:SOME" and the cipher
1077 * "ADH-MY-CIPHER" look like a match for buflen=3.
1078 * So additionally check whether the cipher name found
1079 * has the correct length. We can save a strlen() call:
1080 * just checking for the '\0' at the right place is
1081 * sufficient, we have to strncmp() anyway. (We cannot
1082 * use strcmp(), because buf is not '\0' terminated.)
1086 while (ca_list[j]) {
1087 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1088 && (ca_list[j]->name[buflen] == '\0')) {
1096 break; /* ignore this entry */
1098 if (ca_list[j]->algorithm_mkey) {
1100 alg_mkey &= ca_list[j]->algorithm_mkey;
1106 alg_mkey = ca_list[j]->algorithm_mkey;
1109 if (ca_list[j]->algorithm_auth) {
1111 alg_auth &= ca_list[j]->algorithm_auth;
1117 alg_auth = ca_list[j]->algorithm_auth;
1120 if (ca_list[j]->algorithm_enc) {
1122 alg_enc &= ca_list[j]->algorithm_enc;
1128 alg_enc = ca_list[j]->algorithm_enc;
1131 if (ca_list[j]->algorithm_mac) {
1133 alg_mac &= ca_list[j]->algorithm_mac;
1139 alg_mac = ca_list[j]->algorithm_mac;
1142 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1143 if (algo_strength & SSL_STRONG_MASK) {
1145 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1147 if (!(algo_strength & SSL_STRONG_MASK)) {
1152 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1155 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1156 if (algo_strength & SSL_DEFAULT_MASK) {
1158 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1160 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1166 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1169 if (ca_list[j]->valid) {
1171 * explicit ciphersuite found; its protocol version does not
1172 * become part of the search pattern!
1175 cipher_id = ca_list[j]->id;
1178 * not an explicit ciphersuite; only in this case, the
1179 * protocol version is considered part of the search pattern
1182 if (ca_list[j]->min_tls) {
1183 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1187 min_tls = ca_list[j]->min_tls;
1197 * Ok, we have the rule, now apply it
1199 if (rule == CIPHER_SPECIAL) { /* special command */
1201 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0)
1202 ok = ssl_cipher_strength_sort(head_p, tail_p);
1203 else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1204 int level = buf[9] - '0';
1205 if (level < 0 || level > 5) {
1206 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1207 SSL_R_INVALID_COMMAND);
1209 c->sec_level = level;
1213 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1217 * We do not support any "multi" options
1218 * together with "@", so throw away the
1219 * rest of the command, if any left, until
1220 * end or ':' is found.
1222 while ((*l != '\0') && !ITEM_SEP(*l))
1225 ssl_cipher_apply_rule(cipher_id,
1226 alg_mkey, alg_auth, alg_enc, alg_mac,
1227 min_tls, algo_strength, rule, -1, head_p,
1230 while ((*l != '\0') && !ITEM_SEP(*l))
1240 #ifndef OPENSSL_NO_EC
1241 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1242 const char **prule_str)
1244 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1245 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1246 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1247 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1249 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1250 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1251 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1252 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1253 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1257 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1258 c->cert_flags |= suiteb_flags;
1260 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1264 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1266 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1267 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1268 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1271 # ifndef OPENSSL_NO_EC
1272 switch (suiteb_flags) {
1273 case SSL_CERT_FLAG_SUITEB_128_LOS:
1275 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1278 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1280 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1281 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1283 case SSL_CERT_FLAG_SUITEB_192_LOS:
1284 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1289 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1295 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1296 **cipher_list, STACK_OF(SSL_CIPHER)
1297 **cipher_list_by_id,
1298 const char *rule_str, CERT *c)
1300 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1301 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1302 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1304 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1305 const SSL_CIPHER **ca_list = NULL;
1308 * Return with error if nothing to do.
1310 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1312 #ifndef OPENSSL_NO_EC
1313 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1318 * To reduce the work to do we only want to process the compiled
1319 * in algorithms, so we first get the mask of disabled ciphers.
1322 disabled_mkey = disabled_mkey_mask;
1323 disabled_auth = disabled_auth_mask;
1324 disabled_enc = disabled_enc_mask;
1325 disabled_mac = disabled_mac_mask;
1328 * Now we have to collect the available ciphers from the compiled
1329 * in ciphers. We cannot get more than the number compiled in, so
1330 * it is used for allocation.
1332 num_of_ciphers = ssl_method->num_ciphers();
1334 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1335 if (co_list == NULL) {
1336 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1337 return (NULL); /* Failure */
1340 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1341 disabled_mkey, disabled_auth, disabled_enc,
1342 disabled_mac, co_list, &head, &tail);
1344 /* Now arrange all ciphers by preference. */
1347 * Everything else being equal, prefer ephemeral ECDH over other key
1348 * exchange mechanisms.
1349 * For consistency, prefer ECDSA over RSA (though this only matters if the
1350 * server has both certificates, and is using the DEFAULT, or a client
1353 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1355 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1357 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1360 /* Within each strength group, we prefer GCM over CHACHA... */
1361 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1363 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1367 * ...and generally, our preferred cipher is AES.
1368 * Note that AEADs will be bumped to take preference after sorting by
1371 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1374 /* Temporarily enable everything else for sorting */
1375 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1377 /* Low priority for MD5 */
1378 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1382 * Move anonymous ciphers to the end. Usually, these will remain
1383 * disabled. (For applications that allow them, they aren't too bad, but
1384 * we prefer authenticated ciphers.)
1386 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1390 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1393 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1395 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1398 /* RC4 is sort-of broken -- move the the end */
1399 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1403 * Now sort by symmetric encryption strength. The above ordering remains
1404 * in force within each class
1406 if (!ssl_cipher_strength_sort(&head, &tail)) {
1407 OPENSSL_free(co_list);
1412 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1413 * TODO(openssl-team): is there an easier way to accomplish all this?
1415 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1419 * Irrespective of strength, enforce the following order:
1420 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1421 * Within each group, ciphers remain sorted by strength and previous
1426 * 4) TLS 1.2 > legacy
1428 * Because we now bump ciphers to the top of the list, we proceed in
1429 * reverse order of preference.
1431 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1433 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1434 CIPHER_BUMP, -1, &head, &tail);
1435 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1436 CIPHER_BUMP, -1, &head, &tail);
1438 /* Now disable everything (maintaining the ordering!) */
1439 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1442 * We also need cipher aliases for selecting based on the rule_str.
1443 * There might be two types of entries in the rule_str: 1) names
1444 * of ciphers themselves 2) aliases for groups of ciphers.
1445 * For 1) we need the available ciphers and for 2) the cipher
1446 * groups of cipher_aliases added together in one list (otherwise
1447 * we would be happy with just the cipher_aliases table).
1449 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1450 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1451 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1452 if (ca_list == NULL) {
1453 OPENSSL_free(co_list);
1454 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1455 return (NULL); /* Failure */
1457 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1458 disabled_mkey, disabled_auth, disabled_enc,
1459 disabled_mac, head);
1462 * If the rule_string begins with DEFAULT, apply the default rule
1463 * before using the (possibly available) additional rules.
1467 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1468 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1469 &head, &tail, ca_list, c);
1475 if (ok && (strlen(rule_p) > 0))
1476 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1478 OPENSSL_free(ca_list); /* Not needed anymore */
1480 if (!ok) { /* Rule processing failure */
1481 OPENSSL_free(co_list);
1486 * Allocate new "cipherstack" for the result, return with error
1487 * if we cannot get one.
1489 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1490 OPENSSL_free(co_list);
1495 * The cipher selection for the list is done. The ciphers are added
1496 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1498 for (curr = head; curr != NULL; curr = curr->next) {
1500 && (!FIPS_mode() || curr->cipher->algo_strength & SSL_FIPS)) {
1501 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1502 OPENSSL_free(co_list);
1503 sk_SSL_CIPHER_free(cipherstack);
1507 fprintf(stderr, "<%s>\n", curr->cipher->name);
1511 OPENSSL_free(co_list); /* Not needed any longer */
1513 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1514 if (tmp_cipher_list == NULL) {
1515 sk_SSL_CIPHER_free(cipherstack);
1518 sk_SSL_CIPHER_free(*cipher_list);
1519 *cipher_list = cipherstack;
1520 if (*cipher_list_by_id != NULL)
1521 sk_SSL_CIPHER_free(*cipher_list_by_id);
1522 *cipher_list_by_id = tmp_cipher_list;
1523 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1525 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1526 return (cipherstack);
1529 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1532 const char *kx, *au, *enc, *mac;
1533 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1534 static const char *format = "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1538 buf = OPENSSL_malloc(len);
1541 } else if (len < 128)
1544 alg_mkey = cipher->algorithm_mkey;
1545 alg_auth = cipher->algorithm_auth;
1546 alg_enc = cipher->algorithm_enc;
1547 alg_mac = cipher->algorithm_mac;
1549 ver = ssl_protocol_to_string(cipher->min_tls);
1605 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1606 case (SSL_aGOST12 | SSL_aGOST01):
1640 enc = "AESGCM(128)";
1643 enc = "AESGCM(256)";
1646 enc = "AESCCM(128)";
1649 enc = "AESCCM(256)";
1651 case SSL_AES128CCM8:
1652 enc = "AESCCM8(128)";
1654 case SSL_AES256CCM8:
1655 enc = "AESCCM8(256)";
1657 case SSL_CAMELLIA128:
1658 enc = "Camellia(128)";
1660 case SSL_CAMELLIA256:
1661 enc = "Camellia(256)";
1666 case SSL_eGOST2814789CNT:
1667 case SSL_eGOST2814789CNT12:
1668 enc = "GOST89(256)";
1670 case SSL_CHACHA20POLY1305:
1671 enc = "CHACHA20/POLY1305(256)";
1695 case SSL_GOST89MAC12:
1701 case SSL_GOST12_256:
1702 case SSL_GOST12_512:
1710 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1715 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1721 * Backwards-compatibility crutch. In almost all contexts we report TLS
1722 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1724 if (c->min_tls == TLS1_VERSION)
1726 return ssl_protocol_to_string(c->min_tls);
1729 /* return the actual cipher being used */
1730 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1737 /* number of bits for symmetric cipher */
1738 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1743 if (alg_bits != NULL)
1744 *alg_bits = (int)c->alg_bits;
1745 ret = (int)c->strength_bits;
1750 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1755 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1760 if ((n == 0) || (sk == NULL))
1762 nn = sk_SSL_COMP_num(sk);
1763 for (i = 0; i < nn; i++) {
1764 ctmp = sk_SSL_COMP_value(sk, i);
1771 #ifdef OPENSSL_NO_COMP
1772 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1777 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1783 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1789 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1791 load_builtin_compressions();
1792 return (ssl_comp_methods);
1795 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1798 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1799 ssl_comp_methods = meths;
1803 static void cmeth_free(SSL_COMP *cm)
1808 void ssl_comp_free_compression_methods_int(void)
1810 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1811 ssl_comp_methods = NULL;
1812 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1815 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1819 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1823 * According to draft-ietf-tls-compression-04.txt, the
1824 * compression number ranges should be the following:
1826 * 0 to 63: methods defined by the IETF
1827 * 64 to 192: external party methods assigned by IANA
1828 * 193 to 255: reserved for private use
1830 if (id < 193 || id > 255) {
1831 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1832 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1836 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1837 comp = OPENSSL_malloc(sizeof(*comp));
1839 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1840 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1846 load_builtin_compressions();
1847 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1849 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1850 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1851 SSL_R_DUPLICATE_COMPRESSION_ID);
1854 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1856 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1857 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1860 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1865 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1867 #ifndef OPENSSL_NO_COMP
1868 return comp ? COMP_get_name(comp) : NULL;
1874 /* For a cipher return the index corresponding to the certificate type */
1875 int ssl_cipher_get_cert_index(const SSL_CIPHER *c)
1879 alg_a = c->algorithm_auth;
1881 if (alg_a & SSL_aECDSA)
1882 return SSL_PKEY_ECC;
1883 else if (alg_a & SSL_aDSS)
1884 return SSL_PKEY_DSA_SIGN;
1885 else if (alg_a & SSL_aRSA)
1886 return SSL_PKEY_RSA_ENC;
1887 else if (alg_a & SSL_aGOST12)
1888 return SSL_PKEY_GOST_EC;
1889 else if (alg_a & SSL_aGOST01)
1890 return SSL_PKEY_GOST01;
1895 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr)
1897 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
1899 if (c == NULL || c->valid == 0)
1904 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
1906 return ssl->method->get_cipher_by_char(ptr);
1909 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
1914 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
1917 return ssl_cipher_table_cipher[i].nid;
1920 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
1922 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
1926 return ssl_cipher_table_mac[i].nid;
1929 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
1931 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
1935 return ssl_cipher_table_kx[i].nid;
1938 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
1940 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
1944 return ssl_cipher_table_auth[i].nid;
1947 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
1949 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
1952 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1953 size_t *int_overhead, size_t *blocksize,
1954 size_t *ext_overhead)
1956 size_t mac = 0, in = 0, blk = 0, out = 0;
1958 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1959 * because there are no handy #defines for those. */
1960 if (c->algorithm_enc & SSL_AESGCM) {
1961 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1962 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
1963 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
1964 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
1965 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
1966 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
1968 } else if (c->algorithm_mac & SSL_AEAD) {
1969 /* We're supposed to have handled all the AEAD modes above */
1972 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1973 int digest_nid = SSL_CIPHER_get_digest_nid(c);
1974 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
1979 mac = EVP_MD_size(e_md);
1980 if (c->algorithm_enc != SSL_eNULL) {
1981 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
1982 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
1984 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
1985 known CBC cipher. */
1986 if (e_ciph == NULL ||
1987 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
1990 in = 1; /* padding length byte */
1991 out = EVP_CIPHER_iv_length(e_ciph);
1992 blk = EVP_CIPHER_block_size(e_ciph);
1996 *mac_overhead = mac;
1999 *ext_overhead = out;