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
];
106 #define SSL_COMP_NULL_IDX 0
107 #define SSL_COMP_ZLIB_IDX 1
108 #define SSL_COMP_NUM_IDX 2
110 static STACK_OF(SSL_COMP
) *ssl_comp_methods
= NULL
;
112 #ifndef OPENSSL_NO_COMP
113 static CRYPTO_ONCE ssl_load_builtin_comp_once
= CRYPTO_ONCE_STATIC_INIT
;
117 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
121 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
123 /* NB: make sure indices in this table matches values above */
124 static const ssl_cipher_table ssl_cipher_table_mac
[SSL_MD_NUM_IDX
] = {
125 {SSL_MD5
, NID_md5
}, /* SSL_MD_MD5_IDX 0 */
126 {SSL_SHA1
, NID_sha1
}, /* SSL_MD_SHA1_IDX 1 */
127 {SSL_GOST94
, NID_id_GostR3411_94
}, /* SSL_MD_GOST94_IDX 2 */
128 {SSL_GOST89MAC
, NID_id_Gost28147_89_MAC
}, /* SSL_MD_GOST89MAC_IDX 3 */
129 {SSL_SHA256
, NID_sha256
}, /* SSL_MD_SHA256_IDX 4 */
130 {SSL_SHA384
, NID_sha384
}, /* SSL_MD_SHA384_IDX 5 */
131 {SSL_GOST12_256
, NID_id_GostR3411_2012_256
}, /* SSL_MD_GOST12_256_IDX 6 */
132 {SSL_GOST89MAC12
, NID_gost_mac_12
}, /* SSL_MD_GOST89MAC12_IDX 7 */
133 {SSL_GOST12_512
, NID_id_GostR3411_2012_512
}, /* SSL_MD_GOST12_512_IDX 8 */
134 {0, NID_md5_sha1
}, /* SSL_MD_MD5_SHA1_IDX 9 */
135 {0, NID_sha224
}, /* SSL_MD_SHA224_IDX 10 */
136 {0, NID_sha512
} /* SSL_MD_SHA512_IDX 11 */
139 static const EVP_MD
*ssl_digest_methods
[SSL_MD_NUM_IDX
] = {
140 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
144 static const ssl_cipher_table ssl_cipher_table_kx
[] = {
145 {SSL_kRSA
, NID_kx_rsa
},
146 {SSL_kECDHE
, NID_kx_ecdhe
},
147 {SSL_kDHE
, NID_kx_dhe
},
148 {SSL_kECDHEPSK
, NID_kx_ecdhe_psk
},
149 {SSL_kDHEPSK
, NID_kx_dhe_psk
},
150 {SSL_kRSAPSK
, NID_kx_rsa_psk
},
151 {SSL_kPSK
, NID_kx_psk
},
152 {SSL_kSRP
, NID_kx_srp
},
153 {SSL_kGOST
, NID_kx_gost
},
154 {SSL_kANY
, NID_kx_any
}
157 static const ssl_cipher_table ssl_cipher_table_auth
[] = {
158 {SSL_aRSA
, NID_auth_rsa
},
159 {SSL_aECDSA
, NID_auth_ecdsa
},
160 {SSL_aPSK
, NID_auth_psk
},
161 {SSL_aDSS
, NID_auth_dss
},
162 {SSL_aGOST01
, NID_auth_gost01
},
163 {SSL_aGOST12
, NID_auth_gost12
},
164 {SSL_aSRP
, NID_auth_srp
},
165 {SSL_aNULL
, NID_auth_null
},
166 {SSL_aANY
, NID_auth_any
}
170 /* Utility function for table lookup */
171 static int ssl_cipher_info_find(const ssl_cipher_table
* table
,
172 size_t table_cnt
, uint32_t mask
)
175 for (i
= 0; i
< table_cnt
; i
++, table
++) {
176 if (table
->mask
== mask
)
182 #define ssl_cipher_info_lookup(table, x) \
183 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
186 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
187 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
190 static int ssl_mac_pkey_id
[SSL_MD_NUM_IDX
] = {
191 /* MD5, SHA, GOST94, MAC89 */
192 EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, NID_undef
,
193 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
194 EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, NID_undef
,
199 static size_t ssl_mac_secret_size
[SSL_MD_NUM_IDX
];
202 #define CIPHER_KILL 2
205 #define CIPHER_SPECIAL 5
207 * Bump the ciphers to the top of the list.
208 * This rule isn't currently supported by the public cipherstring API.
210 #define CIPHER_BUMP 6
212 typedef struct cipher_order_st
{
213 const SSL_CIPHER
*cipher
;
216 struct cipher_order_st
*next
, *prev
;
219 static const SSL_CIPHER cipher_aliases
[] = {
220 /* "ALL" doesn't include eNULL (must be specifically enabled) */
221 {0, SSL_TXT_ALL
, 0, 0, 0, ~SSL_eNULL
},
222 /* "COMPLEMENTOFALL" */
223 {0, SSL_TXT_CMPALL
, 0, 0, 0, SSL_eNULL
},
226 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
229 {0, SSL_TXT_CMPDEF
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT
},
232 * key exchange aliases (some of those using only a single bit here
233 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
234 * combines DHE_DSS and DHE_RSA)
236 {0, SSL_TXT_kRSA
, 0, SSL_kRSA
},
238 {0, SSL_TXT_kEDH
, 0, SSL_kDHE
},
239 {0, SSL_TXT_kDHE
, 0, SSL_kDHE
},
240 {0, SSL_TXT_DH
, 0, SSL_kDHE
},
242 {0, SSL_TXT_kEECDH
, 0, SSL_kECDHE
},
243 {0, SSL_TXT_kECDHE
, 0, SSL_kECDHE
},
244 {0, SSL_TXT_ECDH
, 0, SSL_kECDHE
},
246 {0, SSL_TXT_kPSK
, 0, SSL_kPSK
},
247 {0, SSL_TXT_kRSAPSK
, 0, SSL_kRSAPSK
},
248 {0, SSL_TXT_kECDHEPSK
, 0, SSL_kECDHEPSK
},
249 {0, SSL_TXT_kDHEPSK
, 0, SSL_kDHEPSK
},
250 {0, SSL_TXT_kSRP
, 0, SSL_kSRP
},
251 {0, SSL_TXT_kGOST
, 0, SSL_kGOST
},
253 /* server authentication aliases */
254 {0, SSL_TXT_aRSA
, 0, 0, SSL_aRSA
},
255 {0, SSL_TXT_aDSS
, 0, 0, SSL_aDSS
},
256 {0, SSL_TXT_DSS
, 0, 0, SSL_aDSS
},
257 {0, SSL_TXT_aNULL
, 0, 0, SSL_aNULL
},
258 {0, SSL_TXT_aECDSA
, 0, 0, SSL_aECDSA
},
259 {0, SSL_TXT_ECDSA
, 0, 0, SSL_aECDSA
},
260 {0, SSL_TXT_aPSK
, 0, 0, SSL_aPSK
},
261 {0, SSL_TXT_aGOST01
, 0, 0, SSL_aGOST01
},
262 {0, SSL_TXT_aGOST12
, 0, 0, SSL_aGOST12
},
263 {0, SSL_TXT_aGOST
, 0, 0, SSL_aGOST01
| SSL_aGOST12
},
264 {0, SSL_TXT_aSRP
, 0, 0, SSL_aSRP
},
266 /* aliases combining key exchange and server authentication */
267 {0, SSL_TXT_EDH
, 0, SSL_kDHE
, ~SSL_aNULL
},
268 {0, SSL_TXT_DHE
, 0, SSL_kDHE
, ~SSL_aNULL
},
269 {0, SSL_TXT_EECDH
, 0, SSL_kECDHE
, ~SSL_aNULL
},
270 {0, SSL_TXT_ECDHE
, 0, SSL_kECDHE
, ~SSL_aNULL
},
271 {0, SSL_TXT_NULL
, 0, 0, 0, SSL_eNULL
},
272 {0, SSL_TXT_RSA
, 0, SSL_kRSA
, SSL_aRSA
},
273 {0, SSL_TXT_ADH
, 0, SSL_kDHE
, SSL_aNULL
},
274 {0, SSL_TXT_AECDH
, 0, SSL_kECDHE
, SSL_aNULL
},
275 {0, SSL_TXT_PSK
, 0, SSL_PSK
},
276 {0, SSL_TXT_SRP
, 0, SSL_kSRP
},
278 /* symmetric encryption aliases */
279 {0, SSL_TXT_3DES
, 0, 0, 0, SSL_3DES
},
280 {0, SSL_TXT_RC4
, 0, 0, 0, SSL_RC4
},
281 {0, SSL_TXT_RC2
, 0, 0, 0, SSL_RC2
},
282 {0, SSL_TXT_IDEA
, 0, 0, 0, SSL_IDEA
},
283 {0, SSL_TXT_SEED
, 0, 0, 0, SSL_SEED
},
284 {0, SSL_TXT_eNULL
, 0, 0, 0, SSL_eNULL
},
285 {0, SSL_TXT_GOST
, 0, 0, 0, SSL_eGOST2814789CNT
| SSL_eGOST2814789CNT12
},
286 {0, SSL_TXT_AES128
, 0, 0, 0,
287 SSL_AES128
| SSL_AES128GCM
| SSL_AES128CCM
| SSL_AES128CCM8
},
288 {0, SSL_TXT_AES256
, 0, 0, 0,
289 SSL_AES256
| SSL_AES256GCM
| SSL_AES256CCM
| SSL_AES256CCM8
},
290 {0, SSL_TXT_AES
, 0, 0, 0, SSL_AES
},
291 {0, SSL_TXT_AES_GCM
, 0, 0, 0, SSL_AES128GCM
| SSL_AES256GCM
},
292 {0, SSL_TXT_AES_CCM
, 0, 0, 0,
293 SSL_AES128CCM
| SSL_AES256CCM
| SSL_AES128CCM8
| SSL_AES256CCM8
},
294 {0, SSL_TXT_AES_CCM_8
, 0, 0, 0, SSL_AES128CCM8
| SSL_AES256CCM8
},
295 {0, SSL_TXT_CAMELLIA128
, 0, 0, 0, SSL_CAMELLIA128
},
296 {0, SSL_TXT_CAMELLIA256
, 0, 0, 0, SSL_CAMELLIA256
},
297 {0, SSL_TXT_CAMELLIA
, 0, 0, 0, SSL_CAMELLIA
},
298 {0, SSL_TXT_CHACHA20
, 0, 0, 0, SSL_CHACHA20
},
301 {0, SSL_TXT_MD5
, 0, 0, 0, 0, SSL_MD5
},
302 {0, SSL_TXT_SHA1
, 0, 0, 0, 0, SSL_SHA1
},
303 {0, SSL_TXT_SHA
, 0, 0, 0, 0, SSL_SHA1
},
304 {0, SSL_TXT_GOST94
, 0, 0, 0, 0, SSL_GOST94
},
305 {0, SSL_TXT_GOST89MAC
, 0, 0, 0, 0, SSL_GOST89MAC
| SSL_GOST89MAC12
},
306 {0, SSL_TXT_SHA256
, 0, 0, 0, 0, SSL_SHA256
},
307 {0, SSL_TXT_SHA384
, 0, 0, 0, 0, SSL_SHA384
},
308 {0, SSL_TXT_GOST12
, 0, 0, 0, 0, SSL_GOST12_256
},
310 /* protocol version aliases */
311 {0, SSL_TXT_SSLV3
, 0, 0, 0, 0, 0, SSL3_VERSION
},
312 {0, SSL_TXT_TLSV1
, 0, 0, 0, 0, 0, TLS1_VERSION
},
313 {0, "TLSv1.0", 0, 0, 0, 0, 0, TLS1_VERSION
},
314 {0, SSL_TXT_TLSV1_2
, 0, 0, 0, 0, 0, TLS1_2_VERSION
},
316 /* strength classes */
317 {0, SSL_TXT_LOW
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW
},
318 {0, SSL_TXT_MEDIUM
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM
},
319 {0, SSL_TXT_HIGH
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH
},
320 /* FIPS 140-2 approved ciphersuite */
321 {0, SSL_TXT_FIPS
, 0, 0, 0, ~SSL_eNULL
, 0, 0, 0, 0, 0, SSL_FIPS
},
323 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
324 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA
, 0,
325 SSL_kDHE
, SSL_aDSS
, SSL_3DES
, SSL_SHA1
, 0, 0, 0, 0, SSL_HIGH
| SSL_FIPS
},
326 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA
, 0,
327 SSL_kDHE
, SSL_aRSA
, SSL_3DES
, SSL_SHA1
, 0, 0, 0, 0, SSL_HIGH
| SSL_FIPS
},
332 * Search for public key algorithm with given name and return its pkey_id if
333 * it is available. Otherwise return 0
335 #ifdef OPENSSL_NO_ENGINE
337 static int get_optional_pkey_id(const char *pkey_name
)
339 const EVP_PKEY_ASN1_METHOD
*ameth
;
341 ameth
= EVP_PKEY_asn1_find_str(NULL
, pkey_name
, -1);
342 if (ameth
&& EVP_PKEY_asn1_get0_info(&pkey_id
, NULL
, NULL
, NULL
, NULL
,
351 static int get_optional_pkey_id(const char *pkey_name
)
353 const EVP_PKEY_ASN1_METHOD
*ameth
;
354 ENGINE
*tmpeng
= NULL
;
356 ameth
= EVP_PKEY_asn1_find_str(&tmpeng
, pkey_name
, -1);
358 if (EVP_PKEY_asn1_get0_info(&pkey_id
, NULL
, NULL
, NULL
, NULL
,
362 ENGINE_finish(tmpeng
);
368 /* masks of disabled algorithms */
369 static uint32_t disabled_enc_mask
;
370 static uint32_t disabled_mac_mask
;
371 static uint32_t disabled_mkey_mask
;
372 static uint32_t disabled_auth_mask
;
374 void ssl_load_ciphers(void)
377 const ssl_cipher_table
*t
;
379 disabled_enc_mask
= 0;
380 ssl_sort_cipher_list();
381 for (i
= 0, t
= ssl_cipher_table_cipher
; i
< SSL_ENC_NUM_IDX
; i
++, t
++) {
382 if (t
->nid
== NID_undef
) {
383 ssl_cipher_methods
[i
] = NULL
;
385 const EVP_CIPHER
*cipher
= EVP_get_cipherbynid(t
->nid
);
386 ssl_cipher_methods
[i
] = cipher
;
388 disabled_enc_mask
|= t
->mask
;
391 #ifdef SSL_FORBID_ENULL
392 disabled_enc_mask
|= SSL_eNULL
;
394 disabled_mac_mask
= 0;
395 for (i
= 0, t
= ssl_cipher_table_mac
; i
< SSL_MD_NUM_IDX
; i
++, t
++) {
396 const EVP_MD
*md
= EVP_get_digestbynid(t
->nid
);
397 ssl_digest_methods
[i
] = md
;
399 disabled_mac_mask
|= t
->mask
;
401 int tmpsize
= EVP_MD_size(md
);
402 OPENSSL_assert(tmpsize
>= 0);
403 ssl_mac_secret_size
[i
] = tmpsize
;
406 /* Make sure we can access MD5 and SHA1 */
407 OPENSSL_assert(ssl_digest_methods
[SSL_MD_MD5_IDX
] != NULL
);
408 OPENSSL_assert(ssl_digest_methods
[SSL_MD_SHA1_IDX
] != NULL
);
410 disabled_mkey_mask
= 0;
411 disabled_auth_mask
= 0;
413 #ifdef OPENSSL_NO_RSA
414 disabled_mkey_mask
|= SSL_kRSA
| SSL_kRSAPSK
;
415 disabled_auth_mask
|= SSL_aRSA
;
417 #ifdef OPENSSL_NO_DSA
418 disabled_auth_mask
|= SSL_aDSS
;
421 disabled_mkey_mask
|= SSL_kDHE
| SSL_kDHEPSK
;
424 disabled_mkey_mask
|= SSL_kECDHEPSK
;
425 disabled_auth_mask
|= SSL_aECDSA
;
427 #ifdef OPENSSL_NO_PSK
428 disabled_mkey_mask
|= SSL_PSK
;
429 disabled_auth_mask
|= SSL_aPSK
;
431 #ifdef OPENSSL_NO_SRP
432 disabled_mkey_mask
|= SSL_kSRP
;
436 * Check for presence of GOST 34.10 algorithms, and if they are not
437 * present, disable appropriate auth and key exchange
439 ssl_mac_pkey_id
[SSL_MD_GOST89MAC_IDX
] = get_optional_pkey_id("gost-mac");
440 if (ssl_mac_pkey_id
[SSL_MD_GOST89MAC_IDX
]) {
441 ssl_mac_secret_size
[SSL_MD_GOST89MAC_IDX
] = 32;
443 disabled_mac_mask
|= SSL_GOST89MAC
;
446 ssl_mac_pkey_id
[SSL_MD_GOST89MAC12_IDX
] =
447 get_optional_pkey_id("gost-mac-12");
448 if (ssl_mac_pkey_id
[SSL_MD_GOST89MAC12_IDX
]) {
449 ssl_mac_secret_size
[SSL_MD_GOST89MAC12_IDX
] = 32;
451 disabled_mac_mask
|= SSL_GOST89MAC12
;
454 if (!get_optional_pkey_id("gost2001"))
455 disabled_auth_mask
|= SSL_aGOST01
| SSL_aGOST12
;
456 if (!get_optional_pkey_id("gost2012_256"))
457 disabled_auth_mask
|= SSL_aGOST12
;
458 if (!get_optional_pkey_id("gost2012_512"))
459 disabled_auth_mask
|= SSL_aGOST12
;
461 * Disable GOST key exchange if no GOST signature algs are available *
463 if ((disabled_auth_mask
& (SSL_aGOST01
| SSL_aGOST12
)) ==
464 (SSL_aGOST01
| SSL_aGOST12
))
465 disabled_mkey_mask
|= SSL_kGOST
;
468 #ifndef OPENSSL_NO_COMP
470 static int sk_comp_cmp(const SSL_COMP
*const *a
, const SSL_COMP
*const *b
)
472 return ((*a
)->id
- (*b
)->id
);
475 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions
)
477 SSL_COMP
*comp
= NULL
;
478 COMP_METHOD
*method
= COMP_zlib();
480 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE
);
481 ssl_comp_methods
= sk_SSL_COMP_new(sk_comp_cmp
);
483 if (COMP_get_type(method
) != NID_undef
&& ssl_comp_methods
!= NULL
) {
484 comp
= OPENSSL_malloc(sizeof(*comp
));
486 comp
->method
= method
;
487 comp
->id
= SSL_COMP_ZLIB_IDX
;
488 comp
->name
= COMP_get_name(method
);
489 sk_SSL_COMP_push(ssl_comp_methods
, comp
);
490 sk_SSL_COMP_sort(ssl_comp_methods
);
493 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
497 static int load_builtin_compressions(void)
499 return RUN_ONCE(&ssl_load_builtin_comp_once
, do_load_builtin_compressions
);
503 int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
504 const EVP_MD
**md
, int *mac_pkey_type
,
505 size_t *mac_secret_size
, SSL_COMP
**comp
, int use_etm
)
515 #ifndef OPENSSL_NO_COMP
516 if (!load_builtin_compressions()) {
518 * Currently don't care, since a failure only means that
519 * ssl_comp_methods is NULL, which is perfectly OK
524 ctmp
.id
= s
->compress_meth
;
525 if (ssl_comp_methods
!= NULL
) {
526 i
= sk_SSL_COMP_find(ssl_comp_methods
, &ctmp
);
528 *comp
= sk_SSL_COMP_value(ssl_comp_methods
, i
);
532 /* If were only interested in comp then return success */
533 if ((enc
== NULL
) && (md
== NULL
))
537 if ((enc
== NULL
) || (md
== NULL
))
540 i
= ssl_cipher_info_lookup(ssl_cipher_table_cipher
, c
->algorithm_enc
);
545 if (i
== SSL_ENC_NULL_IDX
)
546 *enc
= EVP_enc_null();
548 *enc
= ssl_cipher_methods
[i
];
551 i
= ssl_cipher_info_lookup(ssl_cipher_table_mac
, c
->algorithm_mac
);
554 if (mac_pkey_type
!= NULL
)
555 *mac_pkey_type
= NID_undef
;
556 if (mac_secret_size
!= NULL
)
557 *mac_secret_size
= 0;
558 if (c
->algorithm_mac
== SSL_AEAD
)
559 mac_pkey_type
= NULL
;
561 *md
= ssl_digest_methods
[i
];
562 if (mac_pkey_type
!= NULL
)
563 *mac_pkey_type
= ssl_mac_pkey_id
[i
];
564 if (mac_secret_size
!= NULL
)
565 *mac_secret_size
= ssl_mac_secret_size
[i
];
568 if ((*enc
!= NULL
) &&
569 (*md
!= NULL
|| (EVP_CIPHER_flags(*enc
) & EVP_CIPH_FLAG_AEAD_CIPHER
))
570 && (!mac_pkey_type
|| *mac_pkey_type
!= NID_undef
)) {
571 const EVP_CIPHER
*evp
;
576 if (s
->ssl_version
>> 8 != TLS1_VERSION_MAJOR
||
577 s
->ssl_version
< TLS1_VERSION
)
583 if (c
->algorithm_enc
== SSL_RC4
&&
584 c
->algorithm_mac
== SSL_MD5
&&
585 (evp
= EVP_get_cipherbyname("RC4-HMAC-MD5")))
586 *enc
= evp
, *md
= NULL
;
587 else if (c
->algorithm_enc
== SSL_AES128
&&
588 c
->algorithm_mac
== SSL_SHA1
&&
589 (evp
= EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
590 *enc
= evp
, *md
= NULL
;
591 else if (c
->algorithm_enc
== SSL_AES256
&&
592 c
->algorithm_mac
== SSL_SHA1
&&
593 (evp
= EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
594 *enc
= evp
, *md
= NULL
;
595 else if (c
->algorithm_enc
== SSL_AES128
&&
596 c
->algorithm_mac
== SSL_SHA256
&&
597 (evp
= EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
598 *enc
= evp
, *md
= NULL
;
599 else if (c
->algorithm_enc
== SSL_AES256
&&
600 c
->algorithm_mac
== SSL_SHA256
&&
601 (evp
= EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
602 *enc
= evp
, *md
= NULL
;
608 const EVP_MD
*ssl_md(int idx
)
610 idx
&= SSL_HANDSHAKE_MAC_MASK
;
611 if (idx
< 0 || idx
>= SSL_MD_NUM_IDX
)
613 return ssl_digest_methods
[idx
];
616 const EVP_MD
*ssl_handshake_md(SSL
*s
)
618 return ssl_md(ssl_get_algorithm2(s
));
621 const EVP_MD
*ssl_prf_md(SSL
*s
)
623 return ssl_md(ssl_get_algorithm2(s
) >> TLS1_PRF_DGST_SHIFT
);
626 #define ITEM_SEP(a) \
627 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
629 static void ll_append_tail(CIPHER_ORDER
**head
, CIPHER_ORDER
*curr
,
636 if (curr
->prev
!= NULL
)
637 curr
->prev
->next
= curr
->next
;
638 if (curr
->next
!= NULL
)
639 curr
->next
->prev
= curr
->prev
;
640 (*tail
)->next
= curr
;
646 static void ll_append_head(CIPHER_ORDER
**head
, CIPHER_ORDER
*curr
,
653 if (curr
->next
!= NULL
)
654 curr
->next
->prev
= curr
->prev
;
655 if (curr
->prev
!= NULL
)
656 curr
->prev
->next
= curr
->next
;
657 (*head
)->prev
= curr
;
663 static void ssl_cipher_collect_ciphers(const SSL_METHOD
*ssl_method
,
665 uint32_t disabled_mkey
,
666 uint32_t disabled_auth
,
667 uint32_t disabled_enc
,
668 uint32_t disabled_mac
,
669 CIPHER_ORDER
*co_list
,
670 CIPHER_ORDER
**head_p
,
671 CIPHER_ORDER
**tail_p
)
677 * We have num_of_ciphers descriptions compiled in, depending on the
678 * method selected (SSLv3, TLSv1 etc).
679 * These will later be sorted in a linked list with at most num
683 /* Get the initial list of ciphers */
684 co_list_num
= 0; /* actual count of ciphers */
685 for (i
= 0; i
< num_of_ciphers
; i
++) {
686 c
= ssl_method
->get_cipher(i
);
687 /* drop those that use any of that is not available */
688 if (c
== NULL
|| !c
->valid
)
690 if (FIPS_mode() && (c
->algo_strength
& SSL_FIPS
))
692 if ((c
->algorithm_mkey
& disabled_mkey
) ||
693 (c
->algorithm_auth
& disabled_auth
) ||
694 (c
->algorithm_enc
& disabled_enc
) ||
695 (c
->algorithm_mac
& disabled_mac
))
697 if (((ssl_method
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
) == 0) &&
700 if (((ssl_method
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
) != 0) &&
704 co_list
[co_list_num
].cipher
= c
;
705 co_list
[co_list_num
].next
= NULL
;
706 co_list
[co_list_num
].prev
= NULL
;
707 co_list
[co_list_num
].active
= 0;
710 * if (!sk_push(ca_list,(char *)c)) goto err;
715 * Prepare linked list from list entries
717 if (co_list_num
> 0) {
718 co_list
[0].prev
= NULL
;
720 if (co_list_num
> 1) {
721 co_list
[0].next
= &co_list
[1];
723 for (i
= 1; i
< co_list_num
- 1; i
++) {
724 co_list
[i
].prev
= &co_list
[i
- 1];
725 co_list
[i
].next
= &co_list
[i
+ 1];
728 co_list
[co_list_num
- 1].prev
= &co_list
[co_list_num
- 2];
731 co_list
[co_list_num
- 1].next
= NULL
;
733 *head_p
= &co_list
[0];
734 *tail_p
= &co_list
[co_list_num
- 1];
738 static void ssl_cipher_collect_aliases(const SSL_CIPHER
**ca_list
,
739 int num_of_group_aliases
,
740 uint32_t disabled_mkey
,
741 uint32_t disabled_auth
,
742 uint32_t disabled_enc
,
743 uint32_t disabled_mac
,
746 CIPHER_ORDER
*ciph_curr
;
747 const SSL_CIPHER
**ca_curr
;
749 uint32_t mask_mkey
= ~disabled_mkey
;
750 uint32_t mask_auth
= ~disabled_auth
;
751 uint32_t mask_enc
= ~disabled_enc
;
752 uint32_t mask_mac
= ~disabled_mac
;
755 * First, add the real ciphers as already collected
759 while (ciph_curr
!= NULL
) {
760 *ca_curr
= ciph_curr
->cipher
;
762 ciph_curr
= ciph_curr
->next
;
766 * Now we add the available ones from the cipher_aliases[] table.
767 * They represent either one or more algorithms, some of which
768 * in any affected category must be supported (set in enabled_mask),
769 * or represent a cipher strength value (will be added in any case because algorithms=0).
771 for (i
= 0; i
< num_of_group_aliases
; i
++) {
772 uint32_t algorithm_mkey
= cipher_aliases
[i
].algorithm_mkey
;
773 uint32_t algorithm_auth
= cipher_aliases
[i
].algorithm_auth
;
774 uint32_t algorithm_enc
= cipher_aliases
[i
].algorithm_enc
;
775 uint32_t algorithm_mac
= cipher_aliases
[i
].algorithm_mac
;
778 if ((algorithm_mkey
& mask_mkey
) == 0)
782 if ((algorithm_auth
& mask_auth
) == 0)
786 if ((algorithm_enc
& mask_enc
) == 0)
790 if ((algorithm_mac
& mask_mac
) == 0)
793 *ca_curr
= (SSL_CIPHER
*)(cipher_aliases
+ i
);
797 *ca_curr
= NULL
; /* end of list */
800 static void ssl_cipher_apply_rule(uint32_t cipher_id
, uint32_t alg_mkey
,
801 uint32_t alg_auth
, uint32_t alg_enc
,
802 uint32_t alg_mac
, int min_tls
,
803 uint32_t algo_strength
, int rule
,
804 int32_t strength_bits
, CIPHER_ORDER
**head_p
,
805 CIPHER_ORDER
**tail_p
)
807 CIPHER_ORDER
*head
, *tail
, *curr
, *next
, *last
;
808 const SSL_CIPHER
*cp
;
813 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
814 rule
, alg_mkey
, alg_auth
, alg_enc
, alg_mac
, min_tls
,
815 algo_strength
, strength_bits
);
818 if (rule
== CIPHER_DEL
|| rule
== CIPHER_BUMP
)
819 reverse
= 1; /* needed to maintain sorting between currently
843 next
= reverse
? curr
->prev
: curr
->next
;
848 * Selection criteria is either the value of strength_bits
849 * or the algorithms used.
851 if (strength_bits
>= 0) {
852 if (strength_bits
!= cp
->strength_bits
)
857 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
858 cp
->name
, cp
->algorithm_mkey
, cp
->algorithm_auth
,
859 cp
->algorithm_enc
, cp
->algorithm_mac
, cp
->min_tls
,
862 if (cipher_id
!= 0 && (cipher_id
!= cp
->id
))
864 if (alg_mkey
&& !(alg_mkey
& cp
->algorithm_mkey
))
866 if (alg_auth
&& !(alg_auth
& cp
->algorithm_auth
))
868 if (alg_enc
&& !(alg_enc
& cp
->algorithm_enc
))
870 if (alg_mac
&& !(alg_mac
& cp
->algorithm_mac
))
872 if (min_tls
&& (min_tls
!= cp
->min_tls
))
874 if ((algo_strength
& SSL_STRONG_MASK
)
875 && !(algo_strength
& SSL_STRONG_MASK
& cp
->algo_strength
))
877 if ((algo_strength
& SSL_DEFAULT_MASK
)
878 && !(algo_strength
& SSL_DEFAULT_MASK
& cp
->algo_strength
))
883 fprintf(stderr
, "Action = %d\n", rule
);
886 /* add the cipher if it has not been added yet. */
887 if (rule
== CIPHER_ADD
) {
890 ll_append_tail(&head
, curr
, &tail
);
894 /* Move the added cipher to this location */
895 else if (rule
== CIPHER_ORD
) {
898 ll_append_tail(&head
, curr
, &tail
);
900 } else if (rule
== CIPHER_DEL
) {
904 * most recently deleted ciphersuites get best positions for
905 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
906 * in reverse to maintain the order)
908 ll_append_head(&head
, curr
, &tail
);
911 } else if (rule
== CIPHER_BUMP
) {
913 ll_append_head(&head
, curr
, &tail
);
914 } else if (rule
== CIPHER_KILL
) {
919 curr
->prev
->next
= curr
->next
;
923 if (curr
->next
!= NULL
)
924 curr
->next
->prev
= curr
->prev
;
925 if (curr
->prev
!= NULL
)
926 curr
->prev
->next
= curr
->next
;
936 static int ssl_cipher_strength_sort(CIPHER_ORDER
**head_p
,
937 CIPHER_ORDER
**tail_p
)
939 int32_t max_strength_bits
;
944 * This routine sorts the ciphers with descending strength. The sorting
945 * must keep the pre-sorted sequence, so we apply the normal sorting
946 * routine as '+' movement to the end of the list.
948 max_strength_bits
= 0;
950 while (curr
!= NULL
) {
951 if (curr
->active
&& (curr
->cipher
->strength_bits
> max_strength_bits
))
952 max_strength_bits
= curr
->cipher
->strength_bits
;
956 number_uses
= OPENSSL_zalloc(sizeof(int) * (max_strength_bits
+ 1));
957 if (number_uses
== NULL
) {
958 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT
, ERR_R_MALLOC_FAILURE
);
963 * Now find the strength_bits values actually used
966 while (curr
!= NULL
) {
968 number_uses
[curr
->cipher
->strength_bits
]++;
972 * Go through the list of used strength_bits values in descending
975 for (i
= max_strength_bits
; i
>= 0; i
--)
976 if (number_uses
[i
] > 0)
977 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD
, i
, head_p
,
980 OPENSSL_free(number_uses
);
984 static int ssl_cipher_process_rulestr(const char *rule_str
,
985 CIPHER_ORDER
**head_p
,
986 CIPHER_ORDER
**tail_p
,
987 const SSL_CIPHER
**ca_list
, CERT
*c
)
989 uint32_t alg_mkey
, alg_auth
, alg_enc
, alg_mac
, algo_strength
;
992 int j
, multi
, found
, rule
, retval
, ok
, buflen
;
993 uint32_t cipher_id
= 0;
1006 } else if (ch
== '+') {
1009 } else if (ch
== '!') {
1012 } else if (ch
== '@') {
1013 rule
= CIPHER_SPECIAL
;
1035 #ifndef CHARSET_EBCDIC
1036 while (((ch
>= 'A') && (ch
<= 'Z')) ||
1037 ((ch
>= '0') && (ch
<= '9')) ||
1038 ((ch
>= 'a') && (ch
<= 'z')) ||
1039 (ch
== '-') || (ch
== '.') || (ch
== '='))
1041 while (isalnum(ch
) || (ch
== '-') || (ch
== '.') || (ch
== '='))
1050 * We hit something we cannot deal with,
1051 * it is no command or separator nor
1052 * alphanumeric, so we call this an error.
1054 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR
, SSL_R_INVALID_COMMAND
);
1060 if (rule
== CIPHER_SPECIAL
) {
1061 found
= 0; /* unused -- avoid compiler warning */
1062 break; /* special treatment */
1065 /* check for multi-part specification */
1073 * Now search for the cipher alias in the ca_list. Be careful
1074 * with the strncmp, because the "buflen" limitation
1075 * will make the rule "ADH:SOME" and the cipher
1076 * "ADH-MY-CIPHER" look like a match for buflen=3.
1077 * So additionally check whether the cipher name found
1078 * has the correct length. We can save a strlen() call:
1079 * just checking for the '\0' at the right place is
1080 * sufficient, we have to strncmp() anyway. (We cannot
1081 * use strcmp(), because buf is not '\0' terminated.)
1085 while (ca_list
[j
]) {
1086 if (strncmp(buf
, ca_list
[j
]->name
, buflen
) == 0
1087 && (ca_list
[j
]->name
[buflen
] == '\0')) {
1095 break; /* ignore this entry */
1097 if (ca_list
[j
]->algorithm_mkey
) {
1099 alg_mkey
&= ca_list
[j
]->algorithm_mkey
;
1105 alg_mkey
= ca_list
[j
]->algorithm_mkey
;
1108 if (ca_list
[j
]->algorithm_auth
) {
1110 alg_auth
&= ca_list
[j
]->algorithm_auth
;
1116 alg_auth
= ca_list
[j
]->algorithm_auth
;
1119 if (ca_list
[j
]->algorithm_enc
) {
1121 alg_enc
&= ca_list
[j
]->algorithm_enc
;
1127 alg_enc
= ca_list
[j
]->algorithm_enc
;
1130 if (ca_list
[j
]->algorithm_mac
) {
1132 alg_mac
&= ca_list
[j
]->algorithm_mac
;
1138 alg_mac
= ca_list
[j
]->algorithm_mac
;
1141 if (ca_list
[j
]->algo_strength
& SSL_STRONG_MASK
) {
1142 if (algo_strength
& SSL_STRONG_MASK
) {
1144 (ca_list
[j
]->algo_strength
& SSL_STRONG_MASK
) |
1146 if (!(algo_strength
& SSL_STRONG_MASK
)) {
1151 algo_strength
= ca_list
[j
]->algo_strength
& SSL_STRONG_MASK
;
1154 if (ca_list
[j
]->algo_strength
& SSL_DEFAULT_MASK
) {
1155 if (algo_strength
& SSL_DEFAULT_MASK
) {
1157 (ca_list
[j
]->algo_strength
& SSL_DEFAULT_MASK
) |
1159 if (!(algo_strength
& SSL_DEFAULT_MASK
)) {
1165 ca_list
[j
]->algo_strength
& SSL_DEFAULT_MASK
;
1168 if (ca_list
[j
]->valid
) {
1170 * explicit ciphersuite found; its protocol version does not
1171 * become part of the search pattern!
1174 cipher_id
= ca_list
[j
]->id
;
1177 * not an explicit ciphersuite; only in this case, the
1178 * protocol version is considered part of the search pattern
1181 if (ca_list
[j
]->min_tls
) {
1182 if (min_tls
!= 0 && min_tls
!= ca_list
[j
]->min_tls
) {
1186 min_tls
= ca_list
[j
]->min_tls
;
1196 * Ok, we have the rule, now apply it
1198 if (rule
== CIPHER_SPECIAL
) { /* special command */
1200 if ((buflen
== 8) && strncmp(buf
, "STRENGTH", 8) == 0)
1201 ok
= ssl_cipher_strength_sort(head_p
, tail_p
);
1202 else if (buflen
== 10 && strncmp(buf
, "SECLEVEL=", 9) == 0) {
1203 int level
= buf
[9] - '0';
1204 if (level
< 0 || level
> 5) {
1205 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR
,
1206 SSL_R_INVALID_COMMAND
);
1208 c
->sec_level
= level
;
1212 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR
, SSL_R_INVALID_COMMAND
);
1216 * We do not support any "multi" options
1217 * together with "@", so throw away the
1218 * rest of the command, if any left, until
1219 * end or ':' is found.
1221 while ((*l
!= '\0') && !ITEM_SEP(*l
))
1224 ssl_cipher_apply_rule(cipher_id
,
1225 alg_mkey
, alg_auth
, alg_enc
, alg_mac
,
1226 min_tls
, algo_strength
, rule
, -1, head_p
,
1229 while ((*l
!= '\0') && !ITEM_SEP(*l
))
1239 #ifndef OPENSSL_NO_EC
1240 static int check_suiteb_cipher_list(const SSL_METHOD
*meth
, CERT
*c
,
1241 const char **prule_str
)
1243 unsigned int suiteb_flags
= 0, suiteb_comb2
= 0;
1244 if (strncmp(*prule_str
, "SUITEB128ONLY", 13) == 0) {
1245 suiteb_flags
= SSL_CERT_FLAG_SUITEB_128_LOS_ONLY
;
1246 } else if (strncmp(*prule_str
, "SUITEB128C2", 11) == 0) {
1248 suiteb_flags
= SSL_CERT_FLAG_SUITEB_128_LOS
;
1249 } else if (strncmp(*prule_str
, "SUITEB128", 9) == 0) {
1250 suiteb_flags
= SSL_CERT_FLAG_SUITEB_128_LOS
;
1251 } else if (strncmp(*prule_str
, "SUITEB192", 9) == 0) {
1252 suiteb_flags
= SSL_CERT_FLAG_SUITEB_192_LOS
;
1256 c
->cert_flags
&= ~SSL_CERT_FLAG_SUITEB_128_LOS
;
1257 c
->cert_flags
|= suiteb_flags
;
1259 suiteb_flags
= c
->cert_flags
& SSL_CERT_FLAG_SUITEB_128_LOS
;
1263 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1265 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_TLS1_2_CIPHERS
)) {
1266 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST
,
1267 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE
);
1270 # ifndef OPENSSL_NO_EC
1271 switch (suiteb_flags
) {
1272 case SSL_CERT_FLAG_SUITEB_128_LOS
:
1274 *prule_str
= "ECDHE-ECDSA-AES256-GCM-SHA384";
1277 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1279 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY
:
1280 *prule_str
= "ECDHE-ECDSA-AES128-GCM-SHA256";
1282 case SSL_CERT_FLAG_SUITEB_192_LOS
:
1283 *prule_str
= "ECDHE-ECDSA-AES256-GCM-SHA384";
1288 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST
, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE
);
1294 STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*ssl_method
, STACK_OF(SSL_CIPHER
)
1295 **cipher_list
, STACK_OF(SSL_CIPHER
)
1296 **cipher_list_by_id
,
1297 const char *rule_str
, CERT
*c
)
1299 int ok
, num_of_ciphers
, num_of_alias_max
, num_of_group_aliases
;
1300 uint32_t disabled_mkey
, disabled_auth
, disabled_enc
, disabled_mac
;
1301 STACK_OF(SSL_CIPHER
) *cipherstack
, *tmp_cipher_list
;
1303 CIPHER_ORDER
*co_list
= NULL
, *head
= NULL
, *tail
= NULL
, *curr
;
1304 const SSL_CIPHER
**ca_list
= NULL
;
1307 * Return with error if nothing to do.
1309 if (rule_str
== NULL
|| cipher_list
== NULL
|| cipher_list_by_id
== NULL
)
1311 #ifndef OPENSSL_NO_EC
1312 if (!check_suiteb_cipher_list(ssl_method
, c
, &rule_str
))
1317 * To reduce the work to do we only want to process the compiled
1318 * in algorithms, so we first get the mask of disabled ciphers.
1321 disabled_mkey
= disabled_mkey_mask
;
1322 disabled_auth
= disabled_auth_mask
;
1323 disabled_enc
= disabled_enc_mask
;
1324 disabled_mac
= disabled_mac_mask
;
1327 * Now we have to collect the available ciphers from the compiled
1328 * in ciphers. We cannot get more than the number compiled in, so
1329 * it is used for allocation.
1331 num_of_ciphers
= ssl_method
->num_ciphers();
1333 co_list
= OPENSSL_malloc(sizeof(*co_list
) * num_of_ciphers
);
1334 if (co_list
== NULL
) {
1335 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
1336 return (NULL
); /* Failure */
1339 ssl_cipher_collect_ciphers(ssl_method
, num_of_ciphers
,
1340 disabled_mkey
, disabled_auth
, disabled_enc
,
1341 disabled_mac
, co_list
, &head
, &tail
);
1343 /* Now arrange all ciphers by preference. */
1346 * Everything else being equal, prefer ephemeral ECDH over other key
1347 * exchange mechanisms.
1348 * For consistency, prefer ECDSA over RSA (though this only matters if the
1349 * server has both certificates, and is using the DEFAULT, or a client
1352 ssl_cipher_apply_rule(0, SSL_kECDHE
, SSL_aECDSA
, 0, 0, 0, 0, CIPHER_ADD
,
1354 ssl_cipher_apply_rule(0, SSL_kECDHE
, 0, 0, 0, 0, 0, CIPHER_ADD
, -1, &head
,
1356 ssl_cipher_apply_rule(0, SSL_kECDHE
, 0, 0, 0, 0, 0, CIPHER_DEL
, -1, &head
,
1359 /* Within each strength group, we prefer GCM over CHACHA... */
1360 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM
, 0, 0, 0, CIPHER_ADD
, -1,
1362 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20
, 0, 0, 0, CIPHER_ADD
, -1,
1366 * ...and generally, our preferred cipher is AES.
1367 * Note that AEADs will be bumped to take preference after sorting by
1370 ssl_cipher_apply_rule(0, 0, 0, SSL_AES
^ SSL_AESGCM
, 0, 0, 0, CIPHER_ADD
,
1373 /* Temporarily enable everything else for sorting */
1374 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD
, -1, &head
, &tail
);
1376 /* Low priority for MD5 */
1377 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5
, 0, 0, CIPHER_ORD
, -1, &head
,
1381 * Move anonymous ciphers to the end. Usually, these will remain
1382 * disabled. (For applications that allow them, they aren't too bad, but
1383 * we prefer authenticated ciphers.)
1385 ssl_cipher_apply_rule(0, 0, SSL_aNULL
, 0, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1389 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1392 ssl_cipher_apply_rule(0, SSL_kRSA
, 0, 0, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1394 ssl_cipher_apply_rule(0, SSL_kPSK
, 0, 0, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1397 /* RC4 is sort-of broken -- move the the end */
1398 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4
, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1402 * Now sort by symmetric encryption strength. The above ordering remains
1403 * in force within each class
1405 if (!ssl_cipher_strength_sort(&head
, &tail
)) {
1406 OPENSSL_free(co_list
);
1411 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1412 * TODO(openssl-team): is there an easier way to accomplish all this?
1414 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION
, 0, CIPHER_BUMP
, -1,
1418 * Irrespective of strength, enforce the following order:
1419 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1420 * Within each group, ciphers remain sorted by strength and previous
1425 * 4) TLS 1.2 > legacy
1427 * Because we now bump ciphers to the top of the list, we proceed in
1428 * reverse order of preference.
1430 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD
, 0, 0, CIPHER_BUMP
, -1,
1432 ssl_cipher_apply_rule(0, SSL_kDHE
| SSL_kECDHE
, 0, 0, 0, 0, 0,
1433 CIPHER_BUMP
, -1, &head
, &tail
);
1434 ssl_cipher_apply_rule(0, SSL_kDHE
| SSL_kECDHE
, 0, 0, SSL_AEAD
, 0, 0,
1435 CIPHER_BUMP
, -1, &head
, &tail
);
1437 /* Now disable everything (maintaining the ordering!) */
1438 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL
, -1, &head
, &tail
);
1441 * We also need cipher aliases for selecting based on the rule_str.
1442 * There might be two types of entries in the rule_str: 1) names
1443 * of ciphers themselves 2) aliases for groups of ciphers.
1444 * For 1) we need the available ciphers and for 2) the cipher
1445 * groups of cipher_aliases added together in one list (otherwise
1446 * we would be happy with just the cipher_aliases table).
1448 num_of_group_aliases
= OSSL_NELEM(cipher_aliases
);
1449 num_of_alias_max
= num_of_ciphers
+ num_of_group_aliases
+ 1;
1450 ca_list
= OPENSSL_malloc(sizeof(*ca_list
) * num_of_alias_max
);
1451 if (ca_list
== NULL
) {
1452 OPENSSL_free(co_list
);
1453 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
1454 return (NULL
); /* Failure */
1456 ssl_cipher_collect_aliases(ca_list
, num_of_group_aliases
,
1457 disabled_mkey
, disabled_auth
, disabled_enc
,
1458 disabled_mac
, head
);
1461 * If the rule_string begins with DEFAULT, apply the default rule
1462 * before using the (possibly available) additional rules.
1466 if (strncmp(rule_str
, "DEFAULT", 7) == 0) {
1467 ok
= ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST
,
1468 &head
, &tail
, ca_list
, c
);
1474 if (ok
&& (strlen(rule_p
) > 0))
1475 ok
= ssl_cipher_process_rulestr(rule_p
, &head
, &tail
, ca_list
, c
);
1477 OPENSSL_free(ca_list
); /* Not needed anymore */
1479 if (!ok
) { /* Rule processing failure */
1480 OPENSSL_free(co_list
);
1485 * Allocate new "cipherstack" for the result, return with error
1486 * if we cannot get one.
1488 if ((cipherstack
= sk_SSL_CIPHER_new_null()) == NULL
) {
1489 OPENSSL_free(co_list
);
1494 * The cipher selection for the list is done. The ciphers are added
1495 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1497 for (curr
= head
; curr
!= NULL
; curr
= curr
->next
) {
1499 && (!FIPS_mode() || curr
->cipher
->algo_strength
& SSL_FIPS
)) {
1500 if (!sk_SSL_CIPHER_push(cipherstack
, curr
->cipher
)) {
1501 OPENSSL_free(co_list
);
1502 sk_SSL_CIPHER_free(cipherstack
);
1506 fprintf(stderr
, "<%s>\n", curr
->cipher
->name
);
1510 OPENSSL_free(co_list
); /* Not needed any longer */
1512 tmp_cipher_list
= sk_SSL_CIPHER_dup(cipherstack
);
1513 if (tmp_cipher_list
== NULL
) {
1514 sk_SSL_CIPHER_free(cipherstack
);
1517 sk_SSL_CIPHER_free(*cipher_list
);
1518 *cipher_list
= cipherstack
;
1519 if (*cipher_list_by_id
!= NULL
)
1520 sk_SSL_CIPHER_free(*cipher_list_by_id
);
1521 *cipher_list_by_id
= tmp_cipher_list
;
1522 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id
, ssl_cipher_ptr_id_cmp
);
1524 sk_SSL_CIPHER_sort(*cipher_list_by_id
);
1525 return (cipherstack
);
1528 char *SSL_CIPHER_description(const SSL_CIPHER
*cipher
, char *buf
, int len
)
1531 const char *kx
, *au
, *enc
, *mac
;
1532 uint32_t alg_mkey
, alg_auth
, alg_enc
, alg_mac
;
1533 static const char *format
= "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1537 buf
= OPENSSL_malloc(len
);
1540 } else if (len
< 128)
1543 alg_mkey
= cipher
->algorithm_mkey
;
1544 alg_auth
= cipher
->algorithm_auth
;
1545 alg_enc
= cipher
->algorithm_enc
;
1546 alg_mac
= cipher
->algorithm_mac
;
1548 ver
= ssl_protocol_to_string(cipher
->min_tls
);
1607 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1608 case (SSL_aGOST12
| SSL_aGOST01
):
1645 enc
= "AESGCM(128)";
1648 enc
= "AESGCM(256)";
1651 enc
= "AESCCM(128)";
1654 enc
= "AESCCM(256)";
1656 case SSL_AES128CCM8
:
1657 enc
= "AESCCM8(128)";
1659 case SSL_AES256CCM8
:
1660 enc
= "AESCCM8(256)";
1662 case SSL_CAMELLIA128
:
1663 enc
= "Camellia(128)";
1665 case SSL_CAMELLIA256
:
1666 enc
= "Camellia(256)";
1671 case SSL_eGOST2814789CNT
:
1672 case SSL_eGOST2814789CNT12
:
1673 enc
= "GOST89(256)";
1675 case SSL_CHACHA20POLY1305
:
1676 enc
= "CHACHA20/POLY1305(256)";
1700 case SSL_GOST89MAC12
:
1706 case SSL_GOST12_256
:
1707 case SSL_GOST12_512
:
1715 BIO_snprintf(buf
, len
, format
, cipher
->name
, ver
, kx
, au
, enc
, mac
);
1720 const char *SSL_CIPHER_get_version(const SSL_CIPHER
*c
)
1726 * Backwards-compatibility crutch. In almost all contexts we report TLS
1727 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1729 if (c
->min_tls
== TLS1_VERSION
)
1731 return ssl_protocol_to_string(c
->min_tls
);
1734 /* return the actual cipher being used */
1735 const char *SSL_CIPHER_get_name(const SSL_CIPHER
*c
)
1742 /* number of bits for symmetric cipher */
1743 int SSL_CIPHER_get_bits(const SSL_CIPHER
*c
, int *alg_bits
)
1748 if (alg_bits
!= NULL
)
1749 *alg_bits
= (int)c
->alg_bits
;
1750 ret
= (int)c
->strength_bits
;
1755 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER
*c
)
1760 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
)
1765 if ((n
== 0) || (sk
== NULL
))
1767 nn
= sk_SSL_COMP_num(sk
);
1768 for (i
= 0; i
< nn
; i
++) {
1769 ctmp
= sk_SSL_COMP_value(sk
, i
);
1776 #ifdef OPENSSL_NO_COMP
1777 STACK_OF(SSL_COMP
) *SSL_COMP_get_compression_methods(void)
1782 STACK_OF(SSL_COMP
) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP
)
1788 int SSL_COMP_add_compression_method(int id
, COMP_METHOD
*cm
)
1794 STACK_OF(SSL_COMP
) *SSL_COMP_get_compression_methods(void)
1796 load_builtin_compressions();
1797 return (ssl_comp_methods
);
1800 STACK_OF(SSL_COMP
) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP
)
1803 STACK_OF(SSL_COMP
) *old_meths
= ssl_comp_methods
;
1804 ssl_comp_methods
= meths
;
1808 static void cmeth_free(SSL_COMP
*cm
)
1813 void ssl_comp_free_compression_methods_int(void)
1815 STACK_OF(SSL_COMP
) *old_meths
= ssl_comp_methods
;
1816 ssl_comp_methods
= NULL
;
1817 sk_SSL_COMP_pop_free(old_meths
, cmeth_free
);
1820 int SSL_COMP_add_compression_method(int id
, COMP_METHOD
*cm
)
1824 if (cm
== NULL
|| COMP_get_type(cm
) == NID_undef
)
1828 * According to draft-ietf-tls-compression-04.txt, the
1829 * compression number ranges should be the following:
1831 * 0 to 63: methods defined by the IETF
1832 * 64 to 192: external party methods assigned by IANA
1833 * 193 to 255: reserved for private use
1835 if (id
< 193 || id
> 255) {
1836 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
,
1837 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE
);
1841 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE
);
1842 comp
= OPENSSL_malloc(sizeof(*comp
));
1844 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1845 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
, ERR_R_MALLOC_FAILURE
);
1851 load_builtin_compressions();
1852 if (ssl_comp_methods
&& sk_SSL_COMP_find(ssl_comp_methods
, comp
) >= 0) {
1854 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1855 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
,
1856 SSL_R_DUPLICATE_COMPRESSION_ID
);
1859 if (ssl_comp_methods
== NULL
|| !sk_SSL_COMP_push(ssl_comp_methods
, comp
)) {
1861 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1862 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
, ERR_R_MALLOC_FAILURE
);
1865 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1870 const char *SSL_COMP_get_name(const COMP_METHOD
*comp
)
1872 #ifndef OPENSSL_NO_COMP
1873 return comp
? COMP_get_name(comp
) : NULL
;
1879 const char *SSL_COMP_get0_name(const SSL_COMP
*comp
)
1881 #ifndef OPENSSL_NO_COMP
1888 int SSL_COMP_get_id(const SSL_COMP
*comp
)
1890 #ifndef OPENSSL_NO_COMP
1897 /* For a cipher return the index corresponding to the certificate type */
1898 int ssl_cipher_get_cert_index(const SSL_CIPHER
*c
)
1902 alg_a
= c
->algorithm_auth
;
1904 if (alg_a
& SSL_aECDSA
)
1905 return SSL_PKEY_ECC
;
1906 else if (alg_a
& SSL_aDSS
)
1907 return SSL_PKEY_DSA_SIGN
;
1908 else if (alg_a
& SSL_aRSA
)
1909 return SSL_PKEY_RSA
;
1910 else if (alg_a
& SSL_aGOST12
)
1911 return SSL_PKEY_GOST_EC
;
1912 else if (alg_a
& SSL_aGOST01
)
1913 return SSL_PKEY_GOST01
;
1918 const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
, const unsigned char *ptr
,
1921 const SSL_CIPHER
*c
= ssl
->method
->get_cipher_by_char(ptr
);
1923 if (c
== NULL
|| (!all
&& c
->valid
== 0))
1928 const SSL_CIPHER
*SSL_CIPHER_find(SSL
*ssl
, const unsigned char *ptr
)
1930 return ssl
->method
->get_cipher_by_char(ptr
);
1933 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER
*c
)
1938 i
= ssl_cipher_info_lookup(ssl_cipher_table_cipher
, c
->algorithm_enc
);
1941 return ssl_cipher_table_cipher
[i
].nid
;
1944 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER
*c
)
1946 int i
= ssl_cipher_info_lookup(ssl_cipher_table_mac
, c
->algorithm_mac
);
1950 return ssl_cipher_table_mac
[i
].nid
;
1953 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER
*c
)
1955 int i
= ssl_cipher_info_lookup(ssl_cipher_table_kx
, c
->algorithm_mkey
);
1959 return ssl_cipher_table_kx
[i
].nid
;
1962 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER
*c
)
1964 int i
= ssl_cipher_info_lookup(ssl_cipher_table_auth
, c
->algorithm_auth
);
1968 return ssl_cipher_table_auth
[i
].nid
;
1971 int SSL_CIPHER_is_aead(const SSL_CIPHER
*c
)
1973 return (c
->algorithm_mac
& SSL_AEAD
) ? 1 : 0;
1976 int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
1977 size_t *int_overhead
, size_t *blocksize
,
1978 size_t *ext_overhead
)
1980 size_t mac
= 0, in
= 0, blk
= 0, out
= 0;
1982 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1983 * because there are no handy #defines for those. */
1984 if (c
->algorithm_enc
& SSL_AESGCM
) {
1985 out
= EVP_GCM_TLS_EXPLICIT_IV_LEN
+ EVP_GCM_TLS_TAG_LEN
;
1986 } else if (c
->algorithm_enc
& (SSL_AES128CCM
| SSL_AES256CCM
)) {
1987 out
= EVP_CCM_TLS_EXPLICIT_IV_LEN
+ 16;
1988 } else if (c
->algorithm_enc
& (SSL_AES128CCM8
| SSL_AES256CCM8
)) {
1989 out
= EVP_CCM_TLS_EXPLICIT_IV_LEN
+ 8;
1990 } else if (c
->algorithm_enc
& SSL_CHACHA20POLY1305
) {
1992 } else if (c
->algorithm_mac
& SSL_AEAD
) {
1993 /* We're supposed to have handled all the AEAD modes above */
1996 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1997 int digest_nid
= SSL_CIPHER_get_digest_nid(c
);
1998 const EVP_MD
*e_md
= EVP_get_digestbynid(digest_nid
);
2003 mac
= EVP_MD_size(e_md
);
2004 if (c
->algorithm_enc
!= SSL_eNULL
) {
2005 int cipher_nid
= SSL_CIPHER_get_cipher_nid(c
);
2006 const EVP_CIPHER
*e_ciph
= EVP_get_cipherbynid(cipher_nid
);
2008 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2009 known CBC cipher. */
2010 if (e_ciph
== NULL
||
2011 EVP_CIPHER_mode(e_ciph
) != EVP_CIPH_CBC_MODE
)
2014 in
= 1; /* padding length byte */
2015 out
= EVP_CIPHER_iv_length(e_ciph
);
2016 blk
= EVP_CIPHER_block_size(e_ciph
);
2020 *mac_overhead
= mac
;
2023 *ext_overhead
= out
;