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
146 static const ssl_cipher_table ssl_cipher_table_kx[] = {
147 { SSL_kRSA, NID_kx_rsa },
148 { SSL_kECDHE, NID_kx_ecdhe },
149 { SSL_kDHE, NID_kx_dhe },
150 { SSL_kECDHEPSK, NID_kx_ecdhe_psk },
151 { SSL_kDHEPSK, NID_kx_dhe_psk },
152 { SSL_kRSAPSK, NID_kx_rsa_psk },
153 { SSL_kPSK, NID_kx_psk },
154 { SSL_kSRP, NID_kx_srp },
155 { SSL_kGOST, NID_kx_gost }
158 static const ssl_cipher_table ssl_cipher_table_auth[] = {
159 { SSL_aRSA, NID_auth_rsa },
160 { SSL_aECDSA, NID_auth_ecdsa },
161 { SSL_aPSK, NID_auth_psk },
162 { SSL_aDSS, NID_auth_dss },
163 { SSL_aGOST01, NID_auth_gost01 },
164 { SSL_aGOST12, NID_auth_gost12 },
165 { SSL_aSRP, NID_auth_srp },
166 { SSL_aNULL, NID_auth_null }
169 /* Utility function for table lookup */
170 static int ssl_cipher_info_find(const ssl_cipher_table * table,
171 size_t table_cnt, uint32_t mask)
174 for (i = 0; i < table_cnt; i++, table++) {
175 if (table->mask == mask)
181 #define ssl_cipher_info_lookup(table, x) \
182 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
185 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
186 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
189 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
190 /* MD5, SHA, GOST94, MAC89 */
191 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
192 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
193 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
198 static int ssl_mac_secret_size[SSL_MD_NUM_IDX] = {
199 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
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, 0, 0, 0, 0, 0, 0, 0, 0, 0},
223 /* "COMPLEMENTOFALL" */
224 {0, SSL_TXT_CMPALL, 0, 0, 0, SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
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, 0, 0, 0},
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, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
239 {0, SSL_TXT_kEDH, 0, SSL_kDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
240 {0, SSL_TXT_kDHE, 0, SSL_kDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
241 {0, SSL_TXT_DH, 0, SSL_kDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
243 {0, SSL_TXT_kEECDH, 0, SSL_kECDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
244 {0, SSL_TXT_kECDHE, 0, SSL_kECDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
245 {0, SSL_TXT_ECDH, 0, SSL_kECDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
247 {0, SSL_TXT_kPSK, 0, SSL_kPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
248 {0, SSL_TXT_kRSAPSK, 0, SSL_kRSAPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
249 {0, SSL_TXT_kECDHEPSK, 0, SSL_kECDHEPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
250 {0, SSL_TXT_kDHEPSK, 0, SSL_kDHEPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
251 {0, SSL_TXT_kSRP, 0, SSL_kSRP, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
252 {0, SSL_TXT_kGOST, 0, SSL_kGOST, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
254 /* server authentication aliases */
255 {0, SSL_TXT_aRSA, 0, 0, SSL_aRSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
256 {0, SSL_TXT_aDSS, 0, 0, SSL_aDSS, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
257 {0, SSL_TXT_DSS, 0, 0, SSL_aDSS, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
258 {0, SSL_TXT_aNULL, 0, 0, SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
259 {0, SSL_TXT_aECDSA, 0, 0, SSL_aECDSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
260 {0, SSL_TXT_ECDSA, 0, 0, SSL_aECDSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
261 {0, SSL_TXT_aPSK, 0, 0, SSL_aPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
262 {0, SSL_TXT_aGOST01, 0, 0, SSL_aGOST01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
263 {0, SSL_TXT_aGOST12, 0, 0, SSL_aGOST12, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
264 {0, SSL_TXT_aGOST, 0, 0, SSL_aGOST01 | SSL_aGOST12, 0, 0, 0, 0, 0, 0,
266 {0, SSL_TXT_aSRP, 0, 0, SSL_aSRP, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
268 /* aliases combining key exchange and server authentication */
269 {0, SSL_TXT_EDH, 0, SSL_kDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
270 {0, SSL_TXT_DHE, 0, SSL_kDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
271 {0, SSL_TXT_EECDH, 0, SSL_kECDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
272 {0, SSL_TXT_ECDHE, 0, SSL_kECDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
273 {0, SSL_TXT_NULL, 0, 0, 0, SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
274 {0, SSL_TXT_RSA, 0, SSL_kRSA, SSL_aRSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
275 {0, SSL_TXT_ADH, 0, SSL_kDHE, SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
276 {0, SSL_TXT_AECDH, 0, SSL_kECDHE, SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
277 {0, SSL_TXT_PSK, 0, SSL_PSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
278 {0, SSL_TXT_SRP, 0, SSL_kSRP, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
280 /* symmetric encryption aliases */
281 {0, SSL_TXT_3DES, 0, 0, 0, SSL_3DES, 0, 0, 0, 0, 0, 0, 0, 0, 0},
282 {0, SSL_TXT_RC4, 0, 0, 0, SSL_RC4, 0, 0, 0, 0, 0, 0, 0, 0, 0},
283 {0, SSL_TXT_RC2, 0, 0, 0, SSL_RC2, 0, 0, 0, 0, 0, 0, 0, 0, 0},
284 {0, SSL_TXT_IDEA, 0, 0, 0, SSL_IDEA, 0, 0, 0, 0, 0, 0, 0, 0, 0},
285 {0, SSL_TXT_SEED, 0, 0, 0, SSL_SEED, 0, 0, 0, 0, 0, 0, 0, 0, 0},
286 {0, SSL_TXT_eNULL, 0, 0, 0, SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
287 {0, SSL_TXT_GOST, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12, 0,
288 0, 0, 0, 0, 0, 0, 0, 0},
289 {0, SSL_TXT_AES128, 0, 0, 0, SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8, 0,
290 0, 0, 0, 0, 0, 0, 0, 0},
291 {0, SSL_TXT_AES256, 0, 0, 0, SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8, 0,
292 0, 0, 0, 0, 0, 0, 0, 0},
293 {0, SSL_TXT_AES, 0, 0, 0, SSL_AES, 0, 0, 0, 0, 0, 0, 0, 0, 0},
294 {0, SSL_TXT_AES_GCM, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM, 0, 0, 0, 0,
296 {0, SSL_TXT_AES_CCM, 0, 0, 0,
297 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8, 0, 0, 0,
299 {0, SSL_TXT_AES_CCM_8, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8, 0, 0, 0, 0,
301 {0, SSL_TXT_CAMELLIA128, 0, 0, 0, SSL_CAMELLIA128, 0, 0, 0, 0, 0, 0, 0, 0,
303 {0, SSL_TXT_CAMELLIA256, 0, 0, 0, SSL_CAMELLIA256, 0, 0, 0, 0, 0, 0, 0, 0,
305 {0, SSL_TXT_CAMELLIA, 0, 0, 0, SSL_CAMELLIA, 0, 0, 0, 0, 0, 0, 0, 0, 0},
306 {0, SSL_TXT_CHACHA20, 0, 0, 0, SSL_CHACHA20, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
309 {0, SSL_TXT_MD5, 0, 0, 0, 0, SSL_MD5, 0, 0, 0, 0, 0, 0, 0, 0},
310 {0, SSL_TXT_SHA1, 0, 0, 0, 0, SSL_SHA1, 0, 0, 0, 0, 0, 0, 0, 0},
311 {0, SSL_TXT_SHA, 0, 0, 0, 0, SSL_SHA1, 0, 0, 0, 0, 0, 0, 0, 0},
312 {0, SSL_TXT_GOST94, 0, 0, 0, 0, SSL_GOST94, 0, 0, 0, 0, 0, 0, 0, 0},
313 {0, SSL_TXT_GOST89MAC, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12, 0, 0,
315 {0, SSL_TXT_SHA256, 0, 0, 0, 0, SSL_SHA256, 0, 0, 0, 0, 0, 0, 0, 0},
316 {0, SSL_TXT_SHA384, 0, 0, 0, 0, SSL_SHA384, 0, 0, 0, 0, 0, 0, 0, 0},
317 {0, SSL_TXT_GOST12, 0, 0, 0, 0, SSL_GOST12_256, 0, 0, 0, 0, 0, 0, 0, 0},
319 /* protocol version aliases */
320 {0, SSL_TXT_SSLV3, 0, 0, 0, 0, 0, SSL3_VERSION, 0, 0, 0, 0, 0, 0, 0},
321 {0, SSL_TXT_TLSV1, 0, 0, 0, 0, 0, TLS1_VERSION, 0, 0, 0, 0, 0, 0, 0},
322 {0, "TLSv1.0", 0, 0, 0, 0, 0, TLS1_VERSION, 0, 0, 0, 0, 0, 0, 0},
323 {0, SSL_TXT_TLSV1_2, 0, 0, 0, 0, 0, TLS1_2_VERSION, 0, 0, 0, 0, 0, 0, 0},
325 /* strength classes */
326 {0, SSL_TXT_LOW, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW, 0, 0, 0},
327 {0, SSL_TXT_MEDIUM, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM, 0, 0, 0},
328 {0, SSL_TXT_HIGH, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH, 0, 0, 0},
329 /* FIPS 140-2 approved ciphersuite */
330 {0, SSL_TXT_FIPS, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS, 0, 0, 0},
332 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
333 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, 0,
334 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0,
335 SSL_HIGH | SSL_FIPS, 0, 0, 0,},
336 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, 0,
337 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0,
338 SSL_HIGH | SSL_FIPS, 0, 0, 0,},
343 * Search for public key algorithm with given name and return its pkey_id if
344 * it is available. Otherwise return 0
346 #ifdef OPENSSL_NO_ENGINE
348 static int get_optional_pkey_id(const char *pkey_name)
350 const EVP_PKEY_ASN1_METHOD *ameth;
352 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
353 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
362 static int get_optional_pkey_id(const char *pkey_name)
364 const EVP_PKEY_ASN1_METHOD *ameth;
365 ENGINE *tmpeng = NULL;
367 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
369 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
373 ENGINE_finish(tmpeng);
379 /* masks of disabled algorithms */
380 static uint32_t disabled_enc_mask;
381 static uint32_t disabled_mac_mask;
382 static uint32_t disabled_mkey_mask;
383 static uint32_t disabled_auth_mask;
385 void ssl_load_ciphers(void)
388 const ssl_cipher_table *t;
390 disabled_enc_mask = 0;
391 ssl_sort_cipher_list();
392 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
393 if (t->nid == NID_undef) {
394 ssl_cipher_methods[i] = NULL;
396 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
397 ssl_cipher_methods[i] = cipher;
399 disabled_enc_mask |= t->mask;
402 #ifdef SSL_FORBID_ENULL
403 disabled_enc_mask |= SSL_eNULL;
405 disabled_mac_mask = 0;
406 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
407 const EVP_MD *md = EVP_get_digestbynid(t->nid);
408 ssl_digest_methods[i] = md;
410 disabled_mac_mask |= t->mask;
412 ssl_mac_secret_size[i] = EVP_MD_size(md);
413 OPENSSL_assert(ssl_mac_secret_size[i] >= 0);
416 /* Make sure we can access MD5 and SHA1 */
417 OPENSSL_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL);
418 OPENSSL_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL);
420 disabled_mkey_mask = 0;
421 disabled_auth_mask = 0;
423 #ifdef OPENSSL_NO_RSA
424 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
425 disabled_auth_mask |= SSL_aRSA;
427 #ifdef OPENSSL_NO_DSA
428 disabled_auth_mask |= SSL_aDSS;
431 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
434 disabled_mkey_mask |= SSL_kECDHEPSK;
435 disabled_auth_mask |= SSL_aECDSA;
437 #ifdef OPENSSL_NO_PSK
438 disabled_mkey_mask |= SSL_PSK;
439 disabled_auth_mask |= SSL_aPSK;
441 #ifdef OPENSSL_NO_SRP
442 disabled_mkey_mask |= SSL_kSRP;
446 * Check for presence of GOST 34.10 algorithms, and if they are not
447 * present, disable appropriate auth and key exchange
449 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
450 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX]) {
451 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
453 disabled_mac_mask |= SSL_GOST89MAC;
456 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] = get_optional_pkey_id("gost-mac-12");
457 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX]) {
458 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
460 disabled_mac_mask |= SSL_GOST89MAC12;
463 if (!get_optional_pkey_id("gost2001"))
464 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
465 if (!get_optional_pkey_id("gost2012_256"))
466 disabled_auth_mask |= SSL_aGOST12;
467 if (!get_optional_pkey_id("gost2012_512"))
468 disabled_auth_mask |= SSL_aGOST12;
470 * Disable GOST key exchange if no GOST signature algs are available *
472 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) == (SSL_aGOST01 | SSL_aGOST12))
473 disabled_mkey_mask |= SSL_kGOST;
476 #ifndef OPENSSL_NO_COMP
478 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
480 return ((*a)->id - (*b)->id);
483 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
485 SSL_COMP *comp = NULL;
486 COMP_METHOD *method = COMP_zlib();
488 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
489 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
491 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
492 comp = OPENSSL_malloc(sizeof(*comp));
494 comp->method = method;
495 comp->id = SSL_COMP_ZLIB_IDX;
496 comp->name = COMP_get_name(method);
497 sk_SSL_COMP_push(ssl_comp_methods, comp);
498 sk_SSL_COMP_sort(ssl_comp_methods);
501 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
505 static int load_builtin_compressions(void)
507 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
511 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
512 const EVP_MD **md, int *mac_pkey_type,
513 int *mac_secret_size, SSL_COMP **comp, int use_etm)
523 #ifndef OPENSSL_NO_COMP
524 if (!load_builtin_compressions()) {
526 * Currently don't care, since a failure only means that
527 * ssl_comp_methods is NULL, which is perfectly OK
532 ctmp.id = s->compress_meth;
533 if (ssl_comp_methods != NULL) {
534 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
536 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
540 /* If were only interested in comp then return success */
541 if ((enc == NULL) && (md == NULL))
545 if ((enc == NULL) || (md == NULL))
548 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
553 if (i == SSL_ENC_NULL_IDX)
554 *enc = EVP_enc_null();
556 *enc = ssl_cipher_methods[i];
559 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
562 if (mac_pkey_type != NULL)
563 *mac_pkey_type = NID_undef;
564 if (mac_secret_size != NULL)
565 *mac_secret_size = 0;
566 if (c->algorithm_mac == SSL_AEAD)
567 mac_pkey_type = NULL;
569 *md = ssl_digest_methods[i];
570 if (mac_pkey_type != NULL)
571 *mac_pkey_type = ssl_mac_pkey_id[i];
572 if (mac_secret_size != NULL)
573 *mac_secret_size = ssl_mac_secret_size[i];
576 if ((*enc != NULL) &&
577 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
578 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
579 const EVP_CIPHER *evp;
584 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
585 s->ssl_version < TLS1_VERSION)
591 if (c->algorithm_enc == SSL_RC4 &&
592 c->algorithm_mac == SSL_MD5 &&
593 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
594 *enc = evp, *md = NULL;
595 else if (c->algorithm_enc == SSL_AES128 &&
596 c->algorithm_mac == SSL_SHA1 &&
597 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
598 *enc = evp, *md = NULL;
599 else if (c->algorithm_enc == SSL_AES256 &&
600 c->algorithm_mac == SSL_SHA1 &&
601 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
602 *enc = evp, *md = NULL;
603 else if (c->algorithm_enc == SSL_AES128 &&
604 c->algorithm_mac == SSL_SHA256 &&
605 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
606 *enc = evp, *md = NULL;
607 else if (c->algorithm_enc == SSL_AES256 &&
608 c->algorithm_mac == SSL_SHA256 &&
609 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
610 *enc = evp, *md = NULL;
616 const EVP_MD *ssl_md(int idx)
618 idx &= SSL_HANDSHAKE_MAC_MASK;
619 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
621 return ssl_digest_methods[idx];
624 const EVP_MD *ssl_handshake_md(SSL *s)
626 return ssl_md(ssl_get_algorithm2(s));
629 const EVP_MD *ssl_prf_md(SSL *s)
631 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
634 #define ITEM_SEP(a) \
635 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
637 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
644 if (curr->prev != NULL)
645 curr->prev->next = curr->next;
646 if (curr->next != NULL)
647 curr->next->prev = curr->prev;
648 (*tail)->next = curr;
654 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
661 if (curr->next != NULL)
662 curr->next->prev = curr->prev;
663 if (curr->prev != NULL)
664 curr->prev->next = curr->next;
665 (*head)->prev = curr;
671 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
673 uint32_t disabled_mkey,
674 uint32_t disabled_auth,
675 uint32_t disabled_enc,
676 uint32_t disabled_mac,
677 CIPHER_ORDER *co_list,
678 CIPHER_ORDER **head_p,
679 CIPHER_ORDER **tail_p)
685 * We have num_of_ciphers descriptions compiled in, depending on the
686 * method selected (SSLv3, TLSv1 etc).
687 * These will later be sorted in a linked list with at most num
691 /* Get the initial list of ciphers */
692 co_list_num = 0; /* actual count of ciphers */
693 for (i = 0; i < num_of_ciphers; i++) {
694 c = ssl_method->get_cipher(i);
695 /* drop those that use any of that is not available */
696 if (c == NULL || !c->valid)
698 if (FIPS_mode() && (c->algo_strength & SSL_FIPS))
700 if ((c->algorithm_mkey & disabled_mkey) ||
701 (c->algorithm_auth & disabled_auth) ||
702 (c->algorithm_enc & disabled_enc) ||
703 (c->algorithm_mac & disabled_mac))
705 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
708 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
712 co_list[co_list_num].cipher = c;
713 co_list[co_list_num].next = NULL;
714 co_list[co_list_num].prev = NULL;
715 co_list[co_list_num].active = 0;
718 * if (!sk_push(ca_list,(char *)c)) goto err;
723 * Prepare linked list from list entries
725 if (co_list_num > 0) {
726 co_list[0].prev = NULL;
728 if (co_list_num > 1) {
729 co_list[0].next = &co_list[1];
731 for (i = 1; i < co_list_num - 1; i++) {
732 co_list[i].prev = &co_list[i - 1];
733 co_list[i].next = &co_list[i + 1];
736 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
739 co_list[co_list_num - 1].next = NULL;
741 *head_p = &co_list[0];
742 *tail_p = &co_list[co_list_num - 1];
746 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
747 int num_of_group_aliases,
748 uint32_t disabled_mkey,
749 uint32_t disabled_auth,
750 uint32_t disabled_enc,
751 uint32_t disabled_mac,
754 CIPHER_ORDER *ciph_curr;
755 const SSL_CIPHER **ca_curr;
757 uint32_t mask_mkey = ~disabled_mkey;
758 uint32_t mask_auth = ~disabled_auth;
759 uint32_t mask_enc = ~disabled_enc;
760 uint32_t mask_mac = ~disabled_mac;
763 * First, add the real ciphers as already collected
767 while (ciph_curr != NULL) {
768 *ca_curr = ciph_curr->cipher;
770 ciph_curr = ciph_curr->next;
774 * Now we add the available ones from the cipher_aliases[] table.
775 * They represent either one or more algorithms, some of which
776 * in any affected category must be supported (set in enabled_mask),
777 * or represent a cipher strength value (will be added in any case because algorithms=0).
779 for (i = 0; i < num_of_group_aliases; i++) {
780 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
781 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
782 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
783 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
786 if ((algorithm_mkey & mask_mkey) == 0)
790 if ((algorithm_auth & mask_auth) == 0)
794 if ((algorithm_enc & mask_enc) == 0)
798 if ((algorithm_mac & mask_mac) == 0)
801 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
805 *ca_curr = NULL; /* end of list */
808 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
809 uint32_t alg_auth, uint32_t alg_enc,
810 uint32_t alg_mac, int min_tls,
811 uint32_t algo_strength, int rule,
812 int32_t strength_bits, CIPHER_ORDER **head_p,
813 CIPHER_ORDER **tail_p)
815 CIPHER_ORDER *head, *tail, *curr, *next, *last;
816 const SSL_CIPHER *cp;
821 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
822 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
823 algo_strength, strength_bits);
826 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
827 reverse = 1; /* needed to maintain sorting between
828 * currently deleted ciphers */
851 next = reverse ? curr->prev : curr->next;
856 * Selection criteria is either the value of strength_bits
857 * or the algorithms used.
859 if (strength_bits >= 0) {
860 if (strength_bits != cp->strength_bits)
865 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
866 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
867 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
870 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
872 if (alg_auth && !(alg_auth & cp->algorithm_auth))
874 if (alg_enc && !(alg_enc & cp->algorithm_enc))
876 if (alg_mac && !(alg_mac & cp->algorithm_mac))
878 if (min_tls && (min_tls != cp->min_tls))
880 if ((algo_strength & SSL_STRONG_MASK)
881 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
883 if ((algo_strength & SSL_DEFAULT_MASK)
884 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
889 fprintf(stderr, "Action = %d\n", rule);
892 /* add the cipher if it has not been added yet. */
893 if (rule == CIPHER_ADD) {
896 ll_append_tail(&head, curr, &tail);
900 /* Move the added cipher to this location */
901 else if (rule == CIPHER_ORD) {
904 ll_append_tail(&head, curr, &tail);
906 } else if (rule == CIPHER_DEL) {
910 * most recently deleted ciphersuites get best positions for
911 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
912 * in reverse to maintain the order)
914 ll_append_head(&head, curr, &tail);
917 } else if (rule == CIPHER_BUMP) {
919 ll_append_head(&head, curr, &tail);
920 } else if (rule == CIPHER_KILL) {
925 curr->prev->next = curr->next;
929 if (curr->next != NULL)
930 curr->next->prev = curr->prev;
931 if (curr->prev != NULL)
932 curr->prev->next = curr->next;
942 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
943 CIPHER_ORDER **tail_p)
945 int32_t max_strength_bits;
950 * This routine sorts the ciphers with descending strength. The sorting
951 * must keep the pre-sorted sequence, so we apply the normal sorting
952 * routine as '+' movement to the end of the list.
954 max_strength_bits = 0;
956 while (curr != NULL) {
957 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
958 max_strength_bits = curr->cipher->strength_bits;
962 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
963 if (number_uses == NULL) {
964 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
969 * Now find the strength_bits values actually used
972 while (curr != NULL) {
974 number_uses[curr->cipher->strength_bits]++;
978 * Go through the list of used strength_bits values in descending
981 for (i = max_strength_bits; i >= 0; i--)
982 if (number_uses[i] > 0)
983 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
986 OPENSSL_free(number_uses);
990 static int ssl_cipher_process_rulestr(const char *rule_str,
991 CIPHER_ORDER **head_p,
992 CIPHER_ORDER **tail_p,
993 const SSL_CIPHER **ca_list, CERT *c)
995 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
998 int j, multi, found, rule, retval, ok, buflen;
999 uint32_t cipher_id = 0;
1012 } else if (ch == '+') {
1015 } else if (ch == '!') {
1018 } else if (ch == '@') {
1019 rule = CIPHER_SPECIAL;
1041 #ifndef CHARSET_EBCDIC
1042 while (((ch >= 'A') && (ch <= 'Z')) ||
1043 ((ch >= '0') && (ch <= '9')) ||
1044 ((ch >= 'a') && (ch <= 'z')) ||
1045 (ch == '-') || (ch == '.') || (ch == '='))
1047 while (isalnum(ch) || (ch == '-') || (ch == '.') || (ch == '='))
1056 * We hit something we cannot deal with,
1057 * it is no command or separator nor
1058 * alphanumeric, so we call this an error.
1060 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1061 SSL_R_INVALID_COMMAND);
1067 if (rule == CIPHER_SPECIAL) {
1068 found = 0; /* unused -- avoid compiler warning */
1069 break; /* special treatment */
1072 /* check for multi-part specification */
1080 * Now search for the cipher alias in the ca_list. Be careful
1081 * with the strncmp, because the "buflen" limitation
1082 * will make the rule "ADH:SOME" and the cipher
1083 * "ADH-MY-CIPHER" look like a match for buflen=3.
1084 * So additionally check whether the cipher name found
1085 * has the correct length. We can save a strlen() call:
1086 * just checking for the '\0' at the right place is
1087 * sufficient, we have to strncmp() anyway. (We cannot
1088 * use strcmp(), because buf is not '\0' terminated.)
1092 while (ca_list[j]) {
1093 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1094 && (ca_list[j]->name[buflen] == '\0')) {
1102 break; /* ignore this entry */
1104 if (ca_list[j]->algorithm_mkey) {
1106 alg_mkey &= ca_list[j]->algorithm_mkey;
1112 alg_mkey = ca_list[j]->algorithm_mkey;
1115 if (ca_list[j]->algorithm_auth) {
1117 alg_auth &= ca_list[j]->algorithm_auth;
1123 alg_auth = ca_list[j]->algorithm_auth;
1126 if (ca_list[j]->algorithm_enc) {
1128 alg_enc &= ca_list[j]->algorithm_enc;
1134 alg_enc = ca_list[j]->algorithm_enc;
1137 if (ca_list[j]->algorithm_mac) {
1139 alg_mac &= ca_list[j]->algorithm_mac;
1145 alg_mac = ca_list[j]->algorithm_mac;
1148 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1149 if (algo_strength & SSL_STRONG_MASK) {
1151 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1153 if (!(algo_strength & SSL_STRONG_MASK)) {
1158 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1161 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1162 if (algo_strength & SSL_DEFAULT_MASK) {
1164 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1166 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1172 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1175 if (ca_list[j]->valid) {
1177 * explicit ciphersuite found; its protocol version does not
1178 * become part of the search pattern!
1181 cipher_id = ca_list[j]->id;
1184 * not an explicit ciphersuite; only in this case, the
1185 * protocol version is considered part of the search pattern
1188 if (ca_list[j]->min_tls) {
1189 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1193 min_tls = ca_list[j]->min_tls;
1203 * Ok, we have the rule, now apply it
1205 if (rule == CIPHER_SPECIAL) { /* special command */
1207 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0)
1208 ok = ssl_cipher_strength_sort(head_p, tail_p);
1209 else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1210 int level = buf[9] - '0';
1211 if (level < 0 || level > 5) {
1212 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1213 SSL_R_INVALID_COMMAND);
1215 c->sec_level = level;
1219 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1220 SSL_R_INVALID_COMMAND);
1224 * We do not support any "multi" options
1225 * together with "@", so throw away the
1226 * rest of the command, if any left, until
1227 * end or ':' is found.
1229 while ((*l != '\0') && !ITEM_SEP(*l))
1232 ssl_cipher_apply_rule(cipher_id,
1233 alg_mkey, alg_auth, alg_enc, alg_mac,
1234 min_tls, algo_strength, rule, -1, head_p,
1237 while ((*l != '\0') && !ITEM_SEP(*l))
1247 #ifndef OPENSSL_NO_EC
1248 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1249 const char **prule_str)
1251 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1252 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1253 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1254 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1256 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1257 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1258 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1259 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1260 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1264 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1265 c->cert_flags |= suiteb_flags;
1267 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1271 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1273 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1274 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1275 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1278 # ifndef OPENSSL_NO_EC
1279 switch (suiteb_flags) {
1280 case SSL_CERT_FLAG_SUITEB_128_LOS:
1282 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1285 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1287 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1288 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1290 case SSL_CERT_FLAG_SUITEB_192_LOS:
1291 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1296 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1297 SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1303 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1304 **cipher_list, STACK_OF(SSL_CIPHER)
1305 **cipher_list_by_id,
1306 const char *rule_str, CERT *c)
1308 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1309 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1310 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1312 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1313 const SSL_CIPHER **ca_list = NULL;
1316 * Return with error if nothing to do.
1318 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1320 #ifndef OPENSSL_NO_EC
1321 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1326 * To reduce the work to do we only want to process the compiled
1327 * in algorithms, so we first get the mask of disabled ciphers.
1330 disabled_mkey = disabled_mkey_mask;
1331 disabled_auth = disabled_auth_mask;
1332 disabled_enc = disabled_enc_mask;
1333 disabled_mac = disabled_mac_mask;
1336 * Now we have to collect the available ciphers from the compiled
1337 * in ciphers. We cannot get more than the number compiled in, so
1338 * it is used for allocation.
1340 num_of_ciphers = ssl_method->num_ciphers();
1342 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1343 if (co_list == NULL) {
1344 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1345 return (NULL); /* Failure */
1348 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1349 disabled_mkey, disabled_auth, disabled_enc,
1350 disabled_mac, co_list, &head,
1353 /* Now arrange all ciphers by preference. */
1356 * Everything else being equal, prefer ephemeral ECDH over other key
1357 * exchange mechanisms.
1358 * For consistency, prefer ECDSA over RSA (though this only matters if the
1359 * server has both certificates, and is using the DEFAULT, or a client
1362 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1364 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1366 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1370 /* Within each strength group, we prefer GCM over CHACHA... */
1371 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1373 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1377 * ...and generally, our preferred cipher is AES.
1378 * Note that AEADs will be bumped to take preference after sorting by
1381 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1384 /* Temporarily enable everything else for sorting */
1385 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1387 /* Low priority for MD5 */
1388 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1392 * Move anonymous ciphers to the end. Usually, these will remain
1393 * disabled. (For applications that allow them, they aren't too bad, but
1394 * we prefer authenticated ciphers.)
1396 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1400 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1403 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1405 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1408 /* RC4 is sort-of broken -- move the the end */
1409 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1413 * Now sort by symmetric encryption strength. The above ordering remains
1414 * in force within each class
1416 if (!ssl_cipher_strength_sort(&head, &tail)) {
1417 OPENSSL_free(co_list);
1422 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1423 * TODO(openssl-team): is there an easier way to accomplish all this?
1425 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1429 * Irrespective of strength, enforce the following order:
1430 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1431 * Within each group, ciphers remain sorted by strength and previous
1436 * 4) TLS 1.2 > legacy
1438 * Because we now bump ciphers to the top of the list, we proceed in
1439 * reverse order of preference.
1441 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1443 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1444 CIPHER_BUMP, -1, &head, &tail);
1445 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1446 CIPHER_BUMP, -1, &head, &tail);
1448 /* Now disable everything (maintaining the ordering!) */
1449 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1452 * We also need cipher aliases for selecting based on the rule_str.
1453 * There might be two types of entries in the rule_str: 1) names
1454 * of ciphers themselves 2) aliases for groups of ciphers.
1455 * For 1) we need the available ciphers and for 2) the cipher
1456 * groups of cipher_aliases added together in one list (otherwise
1457 * we would be happy with just the cipher_aliases table).
1459 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1460 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1461 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1462 if (ca_list == NULL) {
1463 OPENSSL_free(co_list);
1464 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1465 return (NULL); /* Failure */
1467 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1468 disabled_mkey, disabled_auth, disabled_enc,
1469 disabled_mac, head);
1472 * If the rule_string begins with DEFAULT, apply the default rule
1473 * before using the (possibly available) additional rules.
1477 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1478 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1479 &head, &tail, ca_list, c);
1485 if (ok && (strlen(rule_p) > 0))
1486 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1488 OPENSSL_free(ca_list); /* Not needed anymore */
1490 if (!ok) { /* Rule processing failure */
1491 OPENSSL_free(co_list);
1496 * Allocate new "cipherstack" for the result, return with error
1497 * if we cannot get one.
1499 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1500 OPENSSL_free(co_list);
1505 * The cipher selection for the list is done. The ciphers are added
1506 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1508 for (curr = head; curr != NULL; curr = curr->next) {
1510 && (!FIPS_mode() || curr->cipher->algo_strength & SSL_FIPS)) {
1511 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1512 OPENSSL_free(co_list);
1513 sk_SSL_CIPHER_free(cipherstack);
1517 fprintf(stderr, "<%s>\n", curr->cipher->name);
1521 OPENSSL_free(co_list); /* Not needed any longer */
1523 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1524 if (tmp_cipher_list == NULL) {
1525 sk_SSL_CIPHER_free(cipherstack);
1528 sk_SSL_CIPHER_free(*cipher_list);
1529 *cipher_list = cipherstack;
1530 if (*cipher_list_by_id != NULL)
1531 sk_SSL_CIPHER_free(*cipher_list_by_id);
1532 *cipher_list_by_id = tmp_cipher_list;
1533 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id,
1534 ssl_cipher_ptr_id_cmp);
1536 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1537 return (cipherstack);
1540 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1543 const char *kx, *au, *enc, *mac;
1544 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1545 static const char *format =
1546 "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1550 buf = OPENSSL_malloc(len);
1553 } else if (len < 128)
1556 alg_mkey = cipher->algorithm_mkey;
1557 alg_auth = cipher->algorithm_auth;
1558 alg_enc = cipher->algorithm_enc;
1559 alg_mac = cipher->algorithm_mac;
1561 ver = ssl_protocol_to_string(cipher->min_tls);
1617 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1618 case (SSL_aGOST12 | SSL_aGOST01):
1652 enc = "AESGCM(128)";
1655 enc = "AESGCM(256)";
1658 enc = "AESCCM(128)";
1661 enc = "AESCCM(256)";
1663 case SSL_AES128CCM8:
1664 enc = "AESCCM8(128)";
1666 case SSL_AES256CCM8:
1667 enc = "AESCCM8(256)";
1669 case SSL_CAMELLIA128:
1670 enc = "Camellia(128)";
1672 case SSL_CAMELLIA256:
1673 enc = "Camellia(256)";
1678 case SSL_eGOST2814789CNT:
1679 case SSL_eGOST2814789CNT12:
1680 enc = "GOST89(256)";
1682 case SSL_CHACHA20POLY1305:
1683 enc = "CHACHA20/POLY1305(256)";
1707 case SSL_GOST89MAC12:
1713 case SSL_GOST12_256:
1714 case SSL_GOST12_512:
1722 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1727 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1733 * Backwards-compatibility crutch. In almost all contexts we report TLS
1734 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1736 if (c->min_tls == TLS1_VERSION)
1738 return ssl_protocol_to_string(c->min_tls);
1741 /* return the actual cipher being used */
1742 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1749 /* number of bits for symmetric cipher */
1750 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1755 if (alg_bits != NULL)
1756 *alg_bits = (int) c->alg_bits;
1757 ret = (int) c->strength_bits;
1762 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1767 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1772 if ((n == 0) || (sk == NULL))
1774 nn = sk_SSL_COMP_num(sk);
1775 for (i = 0; i < nn; i++) {
1776 ctmp = sk_SSL_COMP_value(sk, i);
1783 #ifdef OPENSSL_NO_COMP
1784 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1788 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1793 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1799 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1801 load_builtin_compressions();
1802 return (ssl_comp_methods);
1805 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1808 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1809 ssl_comp_methods = meths;
1813 static void cmeth_free(SSL_COMP *cm)
1818 void ssl_comp_free_compression_methods_int(void)
1820 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1821 ssl_comp_methods = NULL;
1822 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1825 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1829 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1833 * According to draft-ietf-tls-compression-04.txt, the
1834 * compression number ranges should be the following:
1836 * 0 to 63: methods defined by the IETF
1837 * 64 to 192: external party methods assigned by IANA
1838 * 193 to 255: reserved for private use
1840 if (id < 193 || id > 255) {
1841 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1842 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1846 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1847 comp = OPENSSL_malloc(sizeof(*comp));
1849 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1850 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1856 load_builtin_compressions();
1857 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1859 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1860 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1861 SSL_R_DUPLICATE_COMPRESSION_ID);
1864 if (ssl_comp_methods == NULL
1865 || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1867 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1868 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1871 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1876 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1878 #ifndef OPENSSL_NO_COMP
1879 return comp ? COMP_get_name(comp) : NULL;
1885 /* For a cipher return the index corresponding to the certificate type */
1886 int ssl_cipher_get_cert_index(const SSL_CIPHER *c)
1890 alg_a = c->algorithm_auth;
1892 if (alg_a & SSL_aECDSA)
1893 return SSL_PKEY_ECC;
1894 else if (alg_a & SSL_aDSS)
1895 return SSL_PKEY_DSA_SIGN;
1896 else if (alg_a & SSL_aRSA)
1897 return SSL_PKEY_RSA_ENC;
1898 else if (alg_a & SSL_aGOST12)
1899 return SSL_PKEY_GOST_EC;
1900 else if (alg_a & SSL_aGOST01)
1901 return SSL_PKEY_GOST01;
1906 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr)
1908 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
1910 if (c == NULL || c->valid == 0)
1915 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
1917 return ssl->method->get_cipher_by_char(ptr);
1920 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
1925 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
1928 return ssl_cipher_table_cipher[i].nid;
1931 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
1933 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
1937 return ssl_cipher_table_mac[i].nid;
1940 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
1942 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
1946 return ssl_cipher_table_kx[i].nid;
1949 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
1951 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
1955 return ssl_cipher_table_auth[i].nid;
1958 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
1960 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;