2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 /* ====================================================================
12 * Copyright 2005 Nokia. All rights reserved.
14 * The portions of the attached software ("Contribution") is developed by
15 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
18 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
19 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
20 * support (see RFC 4279) to OpenSSL.
22 * No patent licenses or other rights except those expressly stated in
23 * the OpenSSL open source license shall be deemed granted or received
24 * expressly, by implication, estoppel, or otherwise.
26 * No assurances are provided by Nokia that the Contribution does not
27 * infringe the patent or other intellectual property rights of any third
28 * party or that the license provides you with all the necessary rights
29 * to make use of the Contribution.
31 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
32 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
33 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
34 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
40 #include <openssl/objects.h>
41 #include <openssl/comp.h>
42 #include <openssl/engine.h>
43 #include <openssl/crypto.h>
45 #include "internal/thread_once.h"
47 #define SSL_ENC_DES_IDX 0
48 #define SSL_ENC_3DES_IDX 1
49 #define SSL_ENC_RC4_IDX 2
50 #define SSL_ENC_RC2_IDX 3
51 #define SSL_ENC_IDEA_IDX 4
52 #define SSL_ENC_NULL_IDX 5
53 #define SSL_ENC_AES128_IDX 6
54 #define SSL_ENC_AES256_IDX 7
55 #define SSL_ENC_CAMELLIA128_IDX 8
56 #define SSL_ENC_CAMELLIA256_IDX 9
57 #define SSL_ENC_GOST89_IDX 10
58 #define SSL_ENC_SEED_IDX 11
59 #define SSL_ENC_AES128GCM_IDX 12
60 #define SSL_ENC_AES256GCM_IDX 13
61 #define SSL_ENC_AES128CCM_IDX 14
62 #define SSL_ENC_AES256CCM_IDX 15
63 #define SSL_ENC_AES128CCM8_IDX 16
64 #define SSL_ENC_AES256CCM8_IDX 17
65 #define SSL_ENC_GOST8912_IDX 18
66 #define SSL_ENC_CHACHA_IDX 19
67 #define SSL_ENC_NUM_IDX 20
69 /* NB: make sure indices in these tables match values above */
76 /* Table of NIDs for each cipher */
77 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
78 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
79 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
80 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
81 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
82 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
83 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
84 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
85 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
86 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
87 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
88 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
89 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
90 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
91 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
92 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
93 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
94 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
95 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
96 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX */
97 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305},
100 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
102 #define SSL_COMP_NULL_IDX 0
103 #define SSL_COMP_ZLIB_IDX 1
104 #define SSL_COMP_NUM_IDX 2
106 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
108 #ifndef OPENSSL_NO_COMP
109 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
113 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
117 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
119 /* NB: make sure indices in this table matches values above */
120 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
121 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
122 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
123 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
124 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
125 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
126 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
127 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
128 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
129 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
130 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
131 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
132 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
135 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
136 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
140 static const ssl_cipher_table ssl_cipher_table_kx[] = {
141 {SSL_kRSA, NID_kx_rsa},
142 {SSL_kECDHE, NID_kx_ecdhe},
143 {SSL_kDHE, NID_kx_dhe},
144 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
145 {SSL_kDHEPSK, NID_kx_dhe_psk},
146 {SSL_kRSAPSK, NID_kx_rsa_psk},
147 {SSL_kPSK, NID_kx_psk},
148 {SSL_kSRP, NID_kx_srp},
149 {SSL_kGOST, NID_kx_gost},
150 {SSL_kANY, NID_kx_any}
153 static const ssl_cipher_table ssl_cipher_table_auth[] = {
154 {SSL_aRSA, NID_auth_rsa},
155 {SSL_aECDSA, NID_auth_ecdsa},
156 {SSL_aPSK, NID_auth_psk},
157 {SSL_aDSS, NID_auth_dss},
158 {SSL_aGOST01, NID_auth_gost01},
159 {SSL_aGOST12, NID_auth_gost12},
160 {SSL_aSRP, NID_auth_srp},
161 {SSL_aNULL, NID_auth_null},
162 {SSL_aANY, NID_auth_any}
166 /* Utility function for table lookup */
167 static int ssl_cipher_info_find(const ssl_cipher_table * table,
168 size_t table_cnt, uint32_t mask)
171 for (i = 0; i < table_cnt; i++, table++) {
172 if (table->mask == mask)
178 #define ssl_cipher_info_lookup(table, x) \
179 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
182 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
183 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
186 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
187 /* MD5, SHA, GOST94, MAC89 */
188 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
189 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
190 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
195 static size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
198 #define CIPHER_KILL 2
201 #define CIPHER_SPECIAL 5
203 * Bump the ciphers to the top of the list.
204 * This rule isn't currently supported by the public cipherstring API.
206 #define CIPHER_BUMP 6
208 typedef struct cipher_order_st {
209 const SSL_CIPHER *cipher;
212 struct cipher_order_st *next, *prev;
215 static const SSL_CIPHER cipher_aliases[] = {
216 /* "ALL" doesn't include eNULL (must be specifically enabled) */
217 {0, SSL_TXT_ALL, 0, 0, 0, ~SSL_eNULL},
218 /* "COMPLEMENTOFALL" */
219 {0, SSL_TXT_CMPALL, 0, 0, 0, SSL_eNULL},
222 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
225 {0, SSL_TXT_CMPDEF, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
228 * key exchange aliases (some of those using only a single bit here
229 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
230 * combines DHE_DSS and DHE_RSA)
232 {0, SSL_TXT_kRSA, 0, SSL_kRSA},
234 {0, SSL_TXT_kEDH, 0, SSL_kDHE},
235 {0, SSL_TXT_kDHE, 0, SSL_kDHE},
236 {0, SSL_TXT_DH, 0, SSL_kDHE},
238 {0, SSL_TXT_kEECDH, 0, SSL_kECDHE},
239 {0, SSL_TXT_kECDHE, 0, SSL_kECDHE},
240 {0, SSL_TXT_ECDH, 0, SSL_kECDHE},
242 {0, SSL_TXT_kPSK, 0, SSL_kPSK},
243 {0, SSL_TXT_kRSAPSK, 0, SSL_kRSAPSK},
244 {0, SSL_TXT_kECDHEPSK, 0, SSL_kECDHEPSK},
245 {0, SSL_TXT_kDHEPSK, 0, SSL_kDHEPSK},
246 {0, SSL_TXT_kSRP, 0, SSL_kSRP},
247 {0, SSL_TXT_kGOST, 0, SSL_kGOST},
249 /* server authentication aliases */
250 {0, SSL_TXT_aRSA, 0, 0, SSL_aRSA},
251 {0, SSL_TXT_aDSS, 0, 0, SSL_aDSS},
252 {0, SSL_TXT_DSS, 0, 0, SSL_aDSS},
253 {0, SSL_TXT_aNULL, 0, 0, SSL_aNULL},
254 {0, SSL_TXT_aECDSA, 0, 0, SSL_aECDSA},
255 {0, SSL_TXT_ECDSA, 0, 0, SSL_aECDSA},
256 {0, SSL_TXT_aPSK, 0, 0, SSL_aPSK},
257 {0, SSL_TXT_aGOST01, 0, 0, SSL_aGOST01},
258 {0, SSL_TXT_aGOST12, 0, 0, SSL_aGOST12},
259 {0, SSL_TXT_aGOST, 0, 0, SSL_aGOST01 | SSL_aGOST12},
260 {0, SSL_TXT_aSRP, 0, 0, SSL_aSRP},
262 /* aliases combining key exchange and server authentication */
263 {0, SSL_TXT_EDH, 0, SSL_kDHE, ~SSL_aNULL},
264 {0, SSL_TXT_DHE, 0, SSL_kDHE, ~SSL_aNULL},
265 {0, SSL_TXT_EECDH, 0, SSL_kECDHE, ~SSL_aNULL},
266 {0, SSL_TXT_ECDHE, 0, SSL_kECDHE, ~SSL_aNULL},
267 {0, SSL_TXT_NULL, 0, 0, 0, SSL_eNULL},
268 {0, SSL_TXT_RSA, 0, SSL_kRSA, SSL_aRSA},
269 {0, SSL_TXT_ADH, 0, SSL_kDHE, SSL_aNULL},
270 {0, SSL_TXT_AECDH, 0, SSL_kECDHE, SSL_aNULL},
271 {0, SSL_TXT_PSK, 0, SSL_PSK},
272 {0, SSL_TXT_SRP, 0, SSL_kSRP},
274 /* symmetric encryption aliases */
275 {0, SSL_TXT_3DES, 0, 0, 0, SSL_3DES},
276 {0, SSL_TXT_RC4, 0, 0, 0, SSL_RC4},
277 {0, SSL_TXT_RC2, 0, 0, 0, SSL_RC2},
278 {0, SSL_TXT_IDEA, 0, 0, 0, SSL_IDEA},
279 {0, SSL_TXT_SEED, 0, 0, 0, SSL_SEED},
280 {0, SSL_TXT_eNULL, 0, 0, 0, SSL_eNULL},
281 {0, SSL_TXT_GOST, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
282 {0, SSL_TXT_AES128, 0, 0, 0,
283 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
284 {0, SSL_TXT_AES256, 0, 0, 0,
285 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
286 {0, SSL_TXT_AES, 0, 0, 0, SSL_AES},
287 {0, SSL_TXT_AES_GCM, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
288 {0, SSL_TXT_AES_CCM, 0, 0, 0,
289 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
290 {0, SSL_TXT_AES_CCM_8, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
291 {0, SSL_TXT_CAMELLIA128, 0, 0, 0, SSL_CAMELLIA128},
292 {0, SSL_TXT_CAMELLIA256, 0, 0, 0, SSL_CAMELLIA256},
293 {0, SSL_TXT_CAMELLIA, 0, 0, 0, SSL_CAMELLIA},
294 {0, SSL_TXT_CHACHA20, 0, 0, 0, SSL_CHACHA20},
297 {0, SSL_TXT_MD5, 0, 0, 0, 0, SSL_MD5},
298 {0, SSL_TXT_SHA1, 0, 0, 0, 0, SSL_SHA1},
299 {0, SSL_TXT_SHA, 0, 0, 0, 0, SSL_SHA1},
300 {0, SSL_TXT_GOST94, 0, 0, 0, 0, SSL_GOST94},
301 {0, SSL_TXT_GOST89MAC, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
302 {0, SSL_TXT_SHA256, 0, 0, 0, 0, SSL_SHA256},
303 {0, SSL_TXT_SHA384, 0, 0, 0, 0, SSL_SHA384},
304 {0, SSL_TXT_GOST12, 0, 0, 0, 0, SSL_GOST12_256},
306 /* protocol version aliases */
307 {0, SSL_TXT_SSLV3, 0, 0, 0, 0, 0, SSL3_VERSION},
308 {0, SSL_TXT_TLSV1, 0, 0, 0, 0, 0, TLS1_VERSION},
309 {0, "TLSv1.0", 0, 0, 0, 0, 0, TLS1_VERSION},
310 {0, SSL_TXT_TLSV1_2, 0, 0, 0, 0, 0, TLS1_2_VERSION},
312 /* strength classes */
313 {0, SSL_TXT_LOW, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
314 {0, SSL_TXT_MEDIUM, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
315 {0, SSL_TXT_HIGH, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
316 /* FIPS 140-2 approved ciphersuite */
317 {0, SSL_TXT_FIPS, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
319 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
320 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, 0,
321 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
322 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, 0,
323 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
328 * Search for public key algorithm with given name and return its pkey_id if
329 * it is available. Otherwise return 0
331 #ifdef OPENSSL_NO_ENGINE
333 static int get_optional_pkey_id(const char *pkey_name)
335 const EVP_PKEY_ASN1_METHOD *ameth;
337 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
338 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
347 static int get_optional_pkey_id(const char *pkey_name)
349 const EVP_PKEY_ASN1_METHOD *ameth;
350 ENGINE *tmpeng = NULL;
352 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
354 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
358 ENGINE_finish(tmpeng);
364 /* masks of disabled algorithms */
365 static uint32_t disabled_enc_mask;
366 static uint32_t disabled_mac_mask;
367 static uint32_t disabled_mkey_mask;
368 static uint32_t disabled_auth_mask;
370 int ssl_load_ciphers(void)
373 const ssl_cipher_table *t;
375 disabled_enc_mask = 0;
376 ssl_sort_cipher_list();
377 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
378 if (t->nid == NID_undef) {
379 ssl_cipher_methods[i] = NULL;
381 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
382 ssl_cipher_methods[i] = cipher;
384 disabled_enc_mask |= t->mask;
387 disabled_mac_mask = 0;
388 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
389 const EVP_MD *md = EVP_get_digestbynid(t->nid);
390 ssl_digest_methods[i] = md;
392 disabled_mac_mask |= t->mask;
394 int tmpsize = EVP_MD_size(md);
395 if (!ossl_assert(tmpsize >= 0))
397 ssl_mac_secret_size[i] = tmpsize;
400 /* Make sure we can access MD5 and SHA1 */
401 if (!ossl_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL))
403 if (!ossl_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL))
406 disabled_mkey_mask = 0;
407 disabled_auth_mask = 0;
409 #ifdef OPENSSL_NO_RSA
410 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
411 disabled_auth_mask |= SSL_aRSA;
413 #ifdef OPENSSL_NO_DSA
414 disabled_auth_mask |= SSL_aDSS;
417 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
420 disabled_mkey_mask |= SSL_kECDHEPSK;
421 disabled_auth_mask |= SSL_aECDSA;
423 #ifdef OPENSSL_NO_PSK
424 disabled_mkey_mask |= SSL_PSK;
425 disabled_auth_mask |= SSL_aPSK;
427 #ifdef OPENSSL_NO_SRP
428 disabled_mkey_mask |= SSL_kSRP;
432 * Check for presence of GOST 34.10 algorithms, and if they are not
433 * present, disable appropriate auth and key exchange
435 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
436 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX]) {
437 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
439 disabled_mac_mask |= SSL_GOST89MAC;
442 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
443 get_optional_pkey_id("gost-mac-12");
444 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX]) {
445 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
447 disabled_mac_mask |= SSL_GOST89MAC12;
450 if (!get_optional_pkey_id("gost2001"))
451 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
452 if (!get_optional_pkey_id("gost2012_256"))
453 disabled_auth_mask |= SSL_aGOST12;
454 if (!get_optional_pkey_id("gost2012_512"))
455 disabled_auth_mask |= SSL_aGOST12;
457 * Disable GOST key exchange if no GOST signature algs are available *
459 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
460 (SSL_aGOST01 | SSL_aGOST12))
461 disabled_mkey_mask |= SSL_kGOST;
466 #ifndef OPENSSL_NO_COMP
468 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
470 return ((*a)->id - (*b)->id);
473 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
475 SSL_COMP *comp = NULL;
476 COMP_METHOD *method = COMP_zlib();
478 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
479 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
481 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
482 comp = OPENSSL_malloc(sizeof(*comp));
484 comp->method = method;
485 comp->id = SSL_COMP_ZLIB_IDX;
486 comp->name = COMP_get_name(method);
487 sk_SSL_COMP_push(ssl_comp_methods, comp);
488 sk_SSL_COMP_sort(ssl_comp_methods);
491 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
495 static int load_builtin_compressions(void)
497 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
501 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
502 const EVP_MD **md, int *mac_pkey_type,
503 size_t *mac_secret_size, SSL_COMP **comp, int use_etm)
513 #ifndef OPENSSL_NO_COMP
514 if (!load_builtin_compressions()) {
516 * Currently don't care, since a failure only means that
517 * ssl_comp_methods is NULL, which is perfectly OK
522 ctmp.id = s->compress_meth;
523 if (ssl_comp_methods != NULL) {
524 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
526 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
530 /* If were only interested in comp then return success */
531 if ((enc == NULL) && (md == NULL))
535 if ((enc == NULL) || (md == NULL))
538 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
543 if (i == SSL_ENC_NULL_IDX)
544 *enc = EVP_enc_null();
546 *enc = ssl_cipher_methods[i];
549 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
552 if (mac_pkey_type != NULL)
553 *mac_pkey_type = NID_undef;
554 if (mac_secret_size != NULL)
555 *mac_secret_size = 0;
556 if (c->algorithm_mac == SSL_AEAD)
557 mac_pkey_type = NULL;
559 *md = ssl_digest_methods[i];
560 if (mac_pkey_type != NULL)
561 *mac_pkey_type = ssl_mac_pkey_id[i];
562 if (mac_secret_size != NULL)
563 *mac_secret_size = ssl_mac_secret_size[i];
566 if ((*enc != NULL) &&
567 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
568 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
569 const EVP_CIPHER *evp;
574 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
575 s->ssl_version < TLS1_VERSION)
578 if (c->algorithm_enc == SSL_RC4 &&
579 c->algorithm_mac == SSL_MD5 &&
580 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
581 *enc = evp, *md = NULL;
582 else if (c->algorithm_enc == SSL_AES128 &&
583 c->algorithm_mac == SSL_SHA1 &&
584 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
585 *enc = evp, *md = NULL;
586 else if (c->algorithm_enc == SSL_AES256 &&
587 c->algorithm_mac == SSL_SHA1 &&
588 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
589 *enc = evp, *md = NULL;
590 else if (c->algorithm_enc == SSL_AES128 &&
591 c->algorithm_mac == SSL_SHA256 &&
592 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
593 *enc = evp, *md = NULL;
594 else if (c->algorithm_enc == SSL_AES256 &&
595 c->algorithm_mac == SSL_SHA256 &&
596 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
597 *enc = evp, *md = NULL;
603 const EVP_MD *ssl_md(int idx)
605 idx &= SSL_HANDSHAKE_MAC_MASK;
606 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
608 return ssl_digest_methods[idx];
611 const EVP_MD *ssl_handshake_md(SSL *s)
613 return ssl_md(ssl_get_algorithm2(s));
616 const EVP_MD *ssl_prf_md(SSL *s)
618 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
621 #define ITEM_SEP(a) \
622 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
624 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
631 if (curr->prev != NULL)
632 curr->prev->next = curr->next;
633 if (curr->next != NULL)
634 curr->next->prev = curr->prev;
635 (*tail)->next = curr;
641 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
648 if (curr->next != NULL)
649 curr->next->prev = curr->prev;
650 if (curr->prev != NULL)
651 curr->prev->next = curr->next;
652 (*head)->prev = curr;
658 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
660 uint32_t disabled_mkey,
661 uint32_t disabled_auth,
662 uint32_t disabled_enc,
663 uint32_t disabled_mac,
664 CIPHER_ORDER *co_list,
665 CIPHER_ORDER **head_p,
666 CIPHER_ORDER **tail_p)
672 * We have num_of_ciphers descriptions compiled in, depending on the
673 * method selected (SSLv3, TLSv1 etc).
674 * These will later be sorted in a linked list with at most num
678 /* Get the initial list of ciphers */
679 co_list_num = 0; /* actual count of ciphers */
680 for (i = 0; i < num_of_ciphers; i++) {
681 c = ssl_method->get_cipher(i);
682 /* drop those that use any of that is not available */
683 if (c == NULL || !c->valid)
685 if ((c->algorithm_mkey & disabled_mkey) ||
686 (c->algorithm_auth & disabled_auth) ||
687 (c->algorithm_enc & disabled_enc) ||
688 (c->algorithm_mac & disabled_mac))
690 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
693 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
697 co_list[co_list_num].cipher = c;
698 co_list[co_list_num].next = NULL;
699 co_list[co_list_num].prev = NULL;
700 co_list[co_list_num].active = 0;
705 * Prepare linked list from list entries
707 if (co_list_num > 0) {
708 co_list[0].prev = NULL;
710 if (co_list_num > 1) {
711 co_list[0].next = &co_list[1];
713 for (i = 1; i < co_list_num - 1; i++) {
714 co_list[i].prev = &co_list[i - 1];
715 co_list[i].next = &co_list[i + 1];
718 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
721 co_list[co_list_num - 1].next = NULL;
723 *head_p = &co_list[0];
724 *tail_p = &co_list[co_list_num - 1];
728 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
729 int num_of_group_aliases,
730 uint32_t disabled_mkey,
731 uint32_t disabled_auth,
732 uint32_t disabled_enc,
733 uint32_t disabled_mac,
736 CIPHER_ORDER *ciph_curr;
737 const SSL_CIPHER **ca_curr;
739 uint32_t mask_mkey = ~disabled_mkey;
740 uint32_t mask_auth = ~disabled_auth;
741 uint32_t mask_enc = ~disabled_enc;
742 uint32_t mask_mac = ~disabled_mac;
745 * First, add the real ciphers as already collected
749 while (ciph_curr != NULL) {
750 *ca_curr = ciph_curr->cipher;
752 ciph_curr = ciph_curr->next;
756 * Now we add the available ones from the cipher_aliases[] table.
757 * They represent either one or more algorithms, some of which
758 * in any affected category must be supported (set in enabled_mask),
759 * or represent a cipher strength value (will be added in any case because algorithms=0).
761 for (i = 0; i < num_of_group_aliases; i++) {
762 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
763 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
764 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
765 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
768 if ((algorithm_mkey & mask_mkey) == 0)
772 if ((algorithm_auth & mask_auth) == 0)
776 if ((algorithm_enc & mask_enc) == 0)
780 if ((algorithm_mac & mask_mac) == 0)
783 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
787 *ca_curr = NULL; /* end of list */
790 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
791 uint32_t alg_auth, uint32_t alg_enc,
792 uint32_t alg_mac, int min_tls,
793 uint32_t algo_strength, int rule,
794 int32_t strength_bits, CIPHER_ORDER **head_p,
795 CIPHER_ORDER **tail_p)
797 CIPHER_ORDER *head, *tail, *curr, *next, *last;
798 const SSL_CIPHER *cp;
803 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
804 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
805 algo_strength, strength_bits);
808 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
809 reverse = 1; /* needed to maintain sorting between currently
833 next = reverse ? curr->prev : curr->next;
838 * Selection criteria is either the value of strength_bits
839 * or the algorithms used.
841 if (strength_bits >= 0) {
842 if (strength_bits != cp->strength_bits)
847 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
848 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
849 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
852 if (cipher_id != 0 && (cipher_id != cp->id))
854 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
856 if (alg_auth && !(alg_auth & cp->algorithm_auth))
858 if (alg_enc && !(alg_enc & cp->algorithm_enc))
860 if (alg_mac && !(alg_mac & cp->algorithm_mac))
862 if (min_tls && (min_tls != cp->min_tls))
864 if ((algo_strength & SSL_STRONG_MASK)
865 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
867 if ((algo_strength & SSL_DEFAULT_MASK)
868 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
873 fprintf(stderr, "Action = %d\n", rule);
876 /* add the cipher if it has not been added yet. */
877 if (rule == CIPHER_ADD) {
880 ll_append_tail(&head, curr, &tail);
884 /* Move the added cipher to this location */
885 else if (rule == CIPHER_ORD) {
888 ll_append_tail(&head, curr, &tail);
890 } else if (rule == CIPHER_DEL) {
894 * most recently deleted ciphersuites get best positions for
895 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
896 * in reverse to maintain the order)
898 ll_append_head(&head, curr, &tail);
901 } else if (rule == CIPHER_BUMP) {
903 ll_append_head(&head, curr, &tail);
904 } else if (rule == CIPHER_KILL) {
909 curr->prev->next = curr->next;
913 if (curr->next != NULL)
914 curr->next->prev = curr->prev;
915 if (curr->prev != NULL)
916 curr->prev->next = curr->next;
926 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
927 CIPHER_ORDER **tail_p)
929 int32_t max_strength_bits;
934 * This routine sorts the ciphers with descending strength. The sorting
935 * must keep the pre-sorted sequence, so we apply the normal sorting
936 * routine as '+' movement to the end of the list.
938 max_strength_bits = 0;
940 while (curr != NULL) {
941 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
942 max_strength_bits = curr->cipher->strength_bits;
946 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
947 if (number_uses == NULL) {
948 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
953 * Now find the strength_bits values actually used
956 while (curr != NULL) {
958 number_uses[curr->cipher->strength_bits]++;
962 * Go through the list of used strength_bits values in descending
965 for (i = max_strength_bits; i >= 0; i--)
966 if (number_uses[i] > 0)
967 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
970 OPENSSL_free(number_uses);
974 static int ssl_cipher_process_rulestr(const char *rule_str,
975 CIPHER_ORDER **head_p,
976 CIPHER_ORDER **tail_p,
977 const SSL_CIPHER **ca_list, CERT *c)
979 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
982 int j, multi, found, rule, retval, ok, buflen;
983 uint32_t cipher_id = 0;
996 } else if (ch == '+') {
999 } else if (ch == '!') {
1002 } else if (ch == '@') {
1003 rule = CIPHER_SPECIAL;
1025 #ifndef CHARSET_EBCDIC
1026 while (((ch >= 'A') && (ch <= 'Z')) ||
1027 ((ch >= '0') && (ch <= '9')) ||
1028 ((ch >= 'a') && (ch <= 'z')) ||
1029 (ch == '-') || (ch == '.') || (ch == '='))
1031 while (isalnum(ch) || (ch == '-') || (ch == '.') || (ch == '='))
1040 * We hit something we cannot deal with,
1041 * it is no command or separator nor
1042 * alphanumeric, so we call this an error.
1044 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1050 if (rule == CIPHER_SPECIAL) {
1051 found = 0; /* unused -- avoid compiler warning */
1052 break; /* special treatment */
1055 /* check for multi-part specification */
1063 * Now search for the cipher alias in the ca_list. Be careful
1064 * with the strncmp, because the "buflen" limitation
1065 * will make the rule "ADH:SOME" and the cipher
1066 * "ADH-MY-CIPHER" look like a match for buflen=3.
1067 * So additionally check whether the cipher name found
1068 * has the correct length. We can save a strlen() call:
1069 * just checking for the '\0' at the right place is
1070 * sufficient, we have to strncmp() anyway. (We cannot
1071 * use strcmp(), because buf is not '\0' terminated.)
1075 while (ca_list[j]) {
1076 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1077 && (ca_list[j]->name[buflen] == '\0')) {
1085 break; /* ignore this entry */
1087 if (ca_list[j]->algorithm_mkey) {
1089 alg_mkey &= ca_list[j]->algorithm_mkey;
1095 alg_mkey = ca_list[j]->algorithm_mkey;
1098 if (ca_list[j]->algorithm_auth) {
1100 alg_auth &= ca_list[j]->algorithm_auth;
1106 alg_auth = ca_list[j]->algorithm_auth;
1109 if (ca_list[j]->algorithm_enc) {
1111 alg_enc &= ca_list[j]->algorithm_enc;
1117 alg_enc = ca_list[j]->algorithm_enc;
1120 if (ca_list[j]->algorithm_mac) {
1122 alg_mac &= ca_list[j]->algorithm_mac;
1128 alg_mac = ca_list[j]->algorithm_mac;
1131 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1132 if (algo_strength & SSL_STRONG_MASK) {
1134 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1136 if (!(algo_strength & SSL_STRONG_MASK)) {
1141 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1144 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1145 if (algo_strength & SSL_DEFAULT_MASK) {
1147 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1149 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1155 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1158 if (ca_list[j]->valid) {
1160 * explicit ciphersuite found; its protocol version does not
1161 * become part of the search pattern!
1164 cipher_id = ca_list[j]->id;
1167 * not an explicit ciphersuite; only in this case, the
1168 * protocol version is considered part of the search pattern
1171 if (ca_list[j]->min_tls) {
1172 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1176 min_tls = ca_list[j]->min_tls;
1186 * Ok, we have the rule, now apply it
1188 if (rule == CIPHER_SPECIAL) { /* special command */
1190 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0)
1191 ok = ssl_cipher_strength_sort(head_p, tail_p);
1192 else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1193 int level = buf[9] - '0';
1194 if (level < 0 || level > 5) {
1195 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1196 SSL_R_INVALID_COMMAND);
1198 c->sec_level = level;
1202 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1206 * We do not support any "multi" options
1207 * together with "@", so throw away the
1208 * rest of the command, if any left, until
1209 * end or ':' is found.
1211 while ((*l != '\0') && !ITEM_SEP(*l))
1214 ssl_cipher_apply_rule(cipher_id,
1215 alg_mkey, alg_auth, alg_enc, alg_mac,
1216 min_tls, algo_strength, rule, -1, head_p,
1219 while ((*l != '\0') && !ITEM_SEP(*l))
1229 #ifndef OPENSSL_NO_EC
1230 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1231 const char **prule_str)
1233 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1234 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1235 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1236 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1238 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1239 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1240 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1241 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1242 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1246 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1247 c->cert_flags |= suiteb_flags;
1249 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1253 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1255 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1256 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1257 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1260 # ifndef OPENSSL_NO_EC
1261 switch (suiteb_flags) {
1262 case SSL_CERT_FLAG_SUITEB_128_LOS:
1264 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1267 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1269 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1270 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1272 case SSL_CERT_FLAG_SUITEB_192_LOS:
1273 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1278 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1284 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1285 **cipher_list, STACK_OF(SSL_CIPHER)
1286 **cipher_list_by_id,
1287 const char *rule_str, CERT *c)
1289 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1290 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1291 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1293 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1294 const SSL_CIPHER **ca_list = NULL;
1297 * Return with error if nothing to do.
1299 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1301 #ifndef OPENSSL_NO_EC
1302 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1307 * To reduce the work to do we only want to process the compiled
1308 * in algorithms, so we first get the mask of disabled ciphers.
1311 disabled_mkey = disabled_mkey_mask;
1312 disabled_auth = disabled_auth_mask;
1313 disabled_enc = disabled_enc_mask;
1314 disabled_mac = disabled_mac_mask;
1317 * Now we have to collect the available ciphers from the compiled
1318 * in ciphers. We cannot get more than the number compiled in, so
1319 * it is used for allocation.
1321 num_of_ciphers = ssl_method->num_ciphers();
1323 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1324 if (co_list == NULL) {
1325 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1326 return (NULL); /* Failure */
1329 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1330 disabled_mkey, disabled_auth, disabled_enc,
1331 disabled_mac, co_list, &head, &tail);
1333 /* Now arrange all ciphers by preference. */
1336 * Everything else being equal, prefer ephemeral ECDH over other key
1337 * exchange mechanisms.
1338 * For consistency, prefer ECDSA over RSA (though this only matters if the
1339 * server has both certificates, and is using the DEFAULT, or a client
1342 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1344 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1346 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1349 /* Within each strength group, we prefer GCM over CHACHA... */
1350 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1352 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1356 * ...and generally, our preferred cipher is AES.
1357 * Note that AEADs will be bumped to take preference after sorting by
1360 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1363 /* Temporarily enable everything else for sorting */
1364 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1366 /* Low priority for MD5 */
1367 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1371 * Move anonymous ciphers to the end. Usually, these will remain
1372 * disabled. (For applications that allow them, they aren't too bad, but
1373 * we prefer authenticated ciphers.)
1375 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1379 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1382 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1384 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1387 /* RC4 is sort-of broken -- move the the end */
1388 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1392 * Now sort by symmetric encryption strength. The above ordering remains
1393 * in force within each class
1395 if (!ssl_cipher_strength_sort(&head, &tail)) {
1396 OPENSSL_free(co_list);
1401 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1402 * TODO(openssl-team): is there an easier way to accomplish all this?
1404 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1408 * Irrespective of strength, enforce the following order:
1409 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1410 * Within each group, ciphers remain sorted by strength and previous
1415 * 4) TLS 1.2 > legacy
1417 * Because we now bump ciphers to the top of the list, we proceed in
1418 * reverse order of preference.
1420 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1422 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1423 CIPHER_BUMP, -1, &head, &tail);
1424 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1425 CIPHER_BUMP, -1, &head, &tail);
1427 /* Now disable everything (maintaining the ordering!) */
1428 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1431 * We also need cipher aliases for selecting based on the rule_str.
1432 * There might be two types of entries in the rule_str: 1) names
1433 * of ciphers themselves 2) aliases for groups of ciphers.
1434 * For 1) we need the available ciphers and for 2) the cipher
1435 * groups of cipher_aliases added together in one list (otherwise
1436 * we would be happy with just the cipher_aliases table).
1438 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1439 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1440 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1441 if (ca_list == NULL) {
1442 OPENSSL_free(co_list);
1443 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1444 return (NULL); /* Failure */
1446 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1447 disabled_mkey, disabled_auth, disabled_enc,
1448 disabled_mac, head);
1451 * If the rule_string begins with DEFAULT, apply the default rule
1452 * before using the (possibly available) additional rules.
1456 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1457 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1458 &head, &tail, ca_list, c);
1464 if (ok && (strlen(rule_p) > 0))
1465 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1467 OPENSSL_free(ca_list); /* Not needed anymore */
1469 if (!ok) { /* Rule processing failure */
1470 OPENSSL_free(co_list);
1475 * Allocate new "cipherstack" for the result, return with error
1476 * if we cannot get one.
1478 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1479 OPENSSL_free(co_list);
1484 * The cipher selection for the list is done. The ciphers are added
1485 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1487 for (curr = head; curr != NULL; curr = curr->next) {
1489 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1490 OPENSSL_free(co_list);
1491 sk_SSL_CIPHER_free(cipherstack);
1495 fprintf(stderr, "<%s>\n", curr->cipher->name);
1499 OPENSSL_free(co_list); /* Not needed any longer */
1501 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1502 if (tmp_cipher_list == NULL) {
1503 sk_SSL_CIPHER_free(cipherstack);
1506 sk_SSL_CIPHER_free(*cipher_list);
1507 *cipher_list = cipherstack;
1508 if (*cipher_list_by_id != NULL)
1509 sk_SSL_CIPHER_free(*cipher_list_by_id);
1510 *cipher_list_by_id = tmp_cipher_list;
1511 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1513 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1514 return (cipherstack);
1517 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1520 const char *kx, *au, *enc, *mac;
1521 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1522 static const char *format = "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1526 buf = OPENSSL_malloc(len);
1529 } else if (len < 128)
1532 alg_mkey = cipher->algorithm_mkey;
1533 alg_auth = cipher->algorithm_auth;
1534 alg_enc = cipher->algorithm_enc;
1535 alg_mac = cipher->algorithm_mac;
1537 ver = ssl_protocol_to_string(cipher->min_tls);
1596 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1597 case (SSL_aGOST12 | SSL_aGOST01):
1634 enc = "AESGCM(128)";
1637 enc = "AESGCM(256)";
1640 enc = "AESCCM(128)";
1643 enc = "AESCCM(256)";
1645 case SSL_AES128CCM8:
1646 enc = "AESCCM8(128)";
1648 case SSL_AES256CCM8:
1649 enc = "AESCCM8(256)";
1651 case SSL_CAMELLIA128:
1652 enc = "Camellia(128)";
1654 case SSL_CAMELLIA256:
1655 enc = "Camellia(256)";
1660 case SSL_eGOST2814789CNT:
1661 case SSL_eGOST2814789CNT12:
1662 enc = "GOST89(256)";
1664 case SSL_CHACHA20POLY1305:
1665 enc = "CHACHA20/POLY1305(256)";
1689 case SSL_GOST89MAC12:
1695 case SSL_GOST12_256:
1696 case SSL_GOST12_512:
1704 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1709 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1715 * Backwards-compatibility crutch. In almost all contexts we report TLS
1716 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1718 if (c->min_tls == TLS1_VERSION)
1720 return ssl_protocol_to_string(c->min_tls);
1723 /* return the actual cipher being used */
1724 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1731 /* number of bits for symmetric cipher */
1732 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1737 if (alg_bits != NULL)
1738 *alg_bits = (int)c->alg_bits;
1739 ret = (int)c->strength_bits;
1744 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1749 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1754 if ((n == 0) || (sk == NULL))
1756 nn = sk_SSL_COMP_num(sk);
1757 for (i = 0; i < nn; i++) {
1758 ctmp = sk_SSL_COMP_value(sk, i);
1765 #ifdef OPENSSL_NO_COMP
1766 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1771 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1777 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1783 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1785 load_builtin_compressions();
1786 return (ssl_comp_methods);
1789 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1792 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1793 ssl_comp_methods = meths;
1797 static void cmeth_free(SSL_COMP *cm)
1802 void ssl_comp_free_compression_methods_int(void)
1804 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1805 ssl_comp_methods = NULL;
1806 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1809 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1813 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1817 * According to draft-ietf-tls-compression-04.txt, the
1818 * compression number ranges should be the following:
1820 * 0 to 63: methods defined by the IETF
1821 * 64 to 192: external party methods assigned by IANA
1822 * 193 to 255: reserved for private use
1824 if (id < 193 || id > 255) {
1825 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1826 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1830 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1831 comp = OPENSSL_malloc(sizeof(*comp));
1833 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1834 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1840 load_builtin_compressions();
1841 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1843 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1844 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1845 SSL_R_DUPLICATE_COMPRESSION_ID);
1848 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1850 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1851 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1854 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1859 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1861 #ifndef OPENSSL_NO_COMP
1862 return comp ? COMP_get_name(comp) : NULL;
1868 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
1870 #ifndef OPENSSL_NO_COMP
1877 int SSL_COMP_get_id(const SSL_COMP *comp)
1879 #ifndef OPENSSL_NO_COMP
1886 /* For a cipher return the index corresponding to the certificate type */
1887 int ssl_cipher_get_cert_index(const SSL_CIPHER *c)
1891 alg_a = c->algorithm_auth;
1893 if (alg_a & SSL_aECDSA)
1894 return SSL_PKEY_ECC;
1895 else if (alg_a & SSL_aDSS)
1896 return SSL_PKEY_DSA_SIGN;
1897 else if (alg_a & SSL_aRSA)
1898 return SSL_PKEY_RSA;
1899 else if (alg_a & SSL_aGOST12)
1900 return SSL_PKEY_GOST_EC;
1901 else if (alg_a & SSL_aGOST01)
1902 return SSL_PKEY_GOST01;
1907 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
1910 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
1912 if (c == NULL || (!all && c->valid == 0))
1917 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
1919 return ssl->method->get_cipher_by_char(ptr);
1922 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
1927 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
1930 return ssl_cipher_table_cipher[i].nid;
1933 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
1935 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
1939 return ssl_cipher_table_mac[i].nid;
1942 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
1944 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
1948 return ssl_cipher_table_kx[i].nid;
1951 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
1953 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
1957 return ssl_cipher_table_auth[i].nid;
1960 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
1962 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
1965 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1966 size_t *int_overhead, size_t *blocksize,
1967 size_t *ext_overhead)
1969 size_t mac = 0, in = 0, blk = 0, out = 0;
1971 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1972 * because there are no handy #defines for those. */
1973 if (c->algorithm_enc & SSL_AESGCM) {
1974 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1975 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
1976 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
1977 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
1978 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
1979 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
1981 } else if (c->algorithm_mac & SSL_AEAD) {
1982 /* We're supposed to have handled all the AEAD modes above */
1985 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1986 int digest_nid = SSL_CIPHER_get_digest_nid(c);
1987 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
1992 mac = EVP_MD_size(e_md);
1993 if (c->algorithm_enc != SSL_eNULL) {
1994 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
1995 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
1997 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
1998 known CBC cipher. */
1999 if (e_ciph == NULL ||
2000 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2003 in = 1; /* padding length byte */
2004 out = EVP_CIPHER_iv_length(e_ciph);
2005 blk = EVP_CIPHER_block_size(e_ciph);
2009 *mac_overhead = mac;
2012 *ext_overhead = out;