2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the OpenSSL license (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
14 #include <openssl/objects.h>
15 #include <openssl/comp.h>
16 #include <openssl/engine.h>
17 #include <openssl/crypto.h>
19 #include "internal/thread_once.h"
21 #define SSL_ENC_DES_IDX 0
22 #define SSL_ENC_3DES_IDX 1
23 #define SSL_ENC_RC4_IDX 2
24 #define SSL_ENC_RC2_IDX 3
25 #define SSL_ENC_IDEA_IDX 4
26 #define SSL_ENC_NULL_IDX 5
27 #define SSL_ENC_AES128_IDX 6
28 #define SSL_ENC_AES256_IDX 7
29 #define SSL_ENC_CAMELLIA128_IDX 8
30 #define SSL_ENC_CAMELLIA256_IDX 9
31 #define SSL_ENC_GOST89_IDX 10
32 #define SSL_ENC_SEED_IDX 11
33 #define SSL_ENC_AES128GCM_IDX 12
34 #define SSL_ENC_AES256GCM_IDX 13
35 #define SSL_ENC_AES128CCM_IDX 14
36 #define SSL_ENC_AES256CCM_IDX 15
37 #define SSL_ENC_AES128CCM8_IDX 16
38 #define SSL_ENC_AES256CCM8_IDX 17
39 #define SSL_ENC_GOST8912_IDX 18
40 #define SSL_ENC_CHACHA_IDX 19
41 #define SSL_ENC_NUM_IDX 20
43 /* NB: make sure indices in these tables match values above */
50 /* Table of NIDs for each cipher */
51 static const ssl_cipher_table ssl_cipher_table_cipher
[SSL_ENC_NUM_IDX
] = {
52 {SSL_DES
, NID_des_cbc
}, /* SSL_ENC_DES_IDX 0 */
53 {SSL_3DES
, NID_des_ede3_cbc
}, /* SSL_ENC_3DES_IDX 1 */
54 {SSL_RC4
, NID_rc4
}, /* SSL_ENC_RC4_IDX 2 */
55 {SSL_RC2
, NID_rc2_cbc
}, /* SSL_ENC_RC2_IDX 3 */
56 {SSL_IDEA
, NID_idea_cbc
}, /* SSL_ENC_IDEA_IDX 4 */
57 {SSL_eNULL
, NID_undef
}, /* SSL_ENC_NULL_IDX 5 */
58 {SSL_AES128
, NID_aes_128_cbc
}, /* SSL_ENC_AES128_IDX 6 */
59 {SSL_AES256
, NID_aes_256_cbc
}, /* SSL_ENC_AES256_IDX 7 */
60 {SSL_CAMELLIA128
, NID_camellia_128_cbc
}, /* SSL_ENC_CAMELLIA128_IDX 8 */
61 {SSL_CAMELLIA256
, NID_camellia_256_cbc
}, /* SSL_ENC_CAMELLIA256_IDX 9 */
62 {SSL_eGOST2814789CNT
, NID_gost89_cnt
}, /* SSL_ENC_GOST89_IDX 10 */
63 {SSL_SEED
, NID_seed_cbc
}, /* SSL_ENC_SEED_IDX 11 */
64 {SSL_AES128GCM
, NID_aes_128_gcm
}, /* SSL_ENC_AES128GCM_IDX 12 */
65 {SSL_AES256GCM
, NID_aes_256_gcm
}, /* SSL_ENC_AES256GCM_IDX 13 */
66 {SSL_AES128CCM
, NID_aes_128_ccm
}, /* SSL_ENC_AES128CCM_IDX 14 */
67 {SSL_AES256CCM
, NID_aes_256_ccm
}, /* SSL_ENC_AES256CCM_IDX 15 */
68 {SSL_AES128CCM8
, NID_aes_128_ccm
}, /* SSL_ENC_AES128CCM8_IDX 16 */
69 {SSL_AES256CCM8
, NID_aes_256_ccm
}, /* SSL_ENC_AES256CCM8_IDX 17 */
70 {SSL_eGOST2814789CNT12
, NID_gost89_cnt_12
}, /* SSL_ENC_GOST8912_IDX */
71 {SSL_CHACHA20POLY1305
, NID_chacha20_poly1305
},
74 static const EVP_CIPHER
*ssl_cipher_methods
[SSL_ENC_NUM_IDX
];
76 #define SSL_COMP_NULL_IDX 0
77 #define SSL_COMP_ZLIB_IDX 1
78 #define SSL_COMP_NUM_IDX 2
80 static STACK_OF(SSL_COMP
) *ssl_comp_methods
= NULL
;
82 #ifndef OPENSSL_NO_COMP
83 static CRYPTO_ONCE ssl_load_builtin_comp_once
= CRYPTO_ONCE_STATIC_INIT
;
87 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
91 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
93 /* NB: make sure indices in this table matches values above */
94 static const ssl_cipher_table ssl_cipher_table_mac
[SSL_MD_NUM_IDX
] = {
95 {SSL_MD5
, NID_md5
}, /* SSL_MD_MD5_IDX 0 */
96 {SSL_SHA1
, NID_sha1
}, /* SSL_MD_SHA1_IDX 1 */
97 {SSL_GOST94
, NID_id_GostR3411_94
}, /* SSL_MD_GOST94_IDX 2 */
98 {SSL_GOST89MAC
, NID_id_Gost28147_89_MAC
}, /* SSL_MD_GOST89MAC_IDX 3 */
99 {SSL_SHA256
, NID_sha256
}, /* SSL_MD_SHA256_IDX 4 */
100 {SSL_SHA384
, NID_sha384
}, /* SSL_MD_SHA384_IDX 5 */
101 {SSL_GOST12_256
, NID_id_GostR3411_2012_256
}, /* SSL_MD_GOST12_256_IDX 6 */
102 {SSL_GOST89MAC12
, NID_gost_mac_12
}, /* SSL_MD_GOST89MAC12_IDX 7 */
103 {SSL_GOST12_512
, NID_id_GostR3411_2012_512
}, /* SSL_MD_GOST12_512_IDX 8 */
104 {0, NID_md5_sha1
}, /* SSL_MD_MD5_SHA1_IDX 9 */
105 {0, NID_sha224
}, /* SSL_MD_SHA224_IDX 10 */
106 {0, NID_sha512
} /* SSL_MD_SHA512_IDX 11 */
109 static const EVP_MD
*ssl_digest_methods
[SSL_MD_NUM_IDX
] = {
110 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
114 static const ssl_cipher_table ssl_cipher_table_kx
[] = {
115 {SSL_kRSA
, NID_kx_rsa
},
116 {SSL_kECDHE
, NID_kx_ecdhe
},
117 {SSL_kDHE
, NID_kx_dhe
},
118 {SSL_kECDHEPSK
, NID_kx_ecdhe_psk
},
119 {SSL_kDHEPSK
, NID_kx_dhe_psk
},
120 {SSL_kRSAPSK
, NID_kx_rsa_psk
},
121 {SSL_kPSK
, NID_kx_psk
},
122 {SSL_kSRP
, NID_kx_srp
},
123 {SSL_kGOST
, NID_kx_gost
},
124 {SSL_kANY
, NID_kx_any
}
127 static const ssl_cipher_table ssl_cipher_table_auth
[] = {
128 {SSL_aRSA
, NID_auth_rsa
},
129 {SSL_aECDSA
, NID_auth_ecdsa
},
130 {SSL_aPSK
, NID_auth_psk
},
131 {SSL_aDSS
, NID_auth_dss
},
132 {SSL_aGOST01
, NID_auth_gost01
},
133 {SSL_aGOST12
, NID_auth_gost12
},
134 {SSL_aSRP
, NID_auth_srp
},
135 {SSL_aNULL
, NID_auth_null
},
136 {SSL_aANY
, NID_auth_any
}
140 /* Utility function for table lookup */
141 static int ssl_cipher_info_find(const ssl_cipher_table
* table
,
142 size_t table_cnt
, uint32_t mask
)
145 for (i
= 0; i
< table_cnt
; i
++, table
++) {
146 if (table
->mask
== mask
)
152 #define ssl_cipher_info_lookup(table, x) \
153 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
156 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
157 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
160 static int ssl_mac_pkey_id
[SSL_MD_NUM_IDX
] = {
161 /* MD5, SHA, GOST94, MAC89 */
162 EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, NID_undef
,
163 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
164 EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, EVP_PKEY_HMAC
, NID_undef
,
169 static size_t ssl_mac_secret_size
[SSL_MD_NUM_IDX
];
172 #define CIPHER_KILL 2
175 #define CIPHER_SPECIAL 5
177 * Bump the ciphers to the top of the list.
178 * This rule isn't currently supported by the public cipherstring API.
180 #define CIPHER_BUMP 6
182 typedef struct cipher_order_st
{
183 const SSL_CIPHER
*cipher
;
186 struct cipher_order_st
*next
, *prev
;
189 static const SSL_CIPHER cipher_aliases
[] = {
190 /* "ALL" doesn't include eNULL (must be specifically enabled) */
191 {0, SSL_TXT_ALL
, 0, 0, 0, ~SSL_eNULL
},
192 /* "COMPLEMENTOFALL" */
193 {0, SSL_TXT_CMPALL
, 0, 0, 0, SSL_eNULL
},
196 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
199 {0, SSL_TXT_CMPDEF
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT
},
202 * key exchange aliases (some of those using only a single bit here
203 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
204 * combines DHE_DSS and DHE_RSA)
206 {0, SSL_TXT_kRSA
, 0, SSL_kRSA
},
208 {0, SSL_TXT_kEDH
, 0, SSL_kDHE
},
209 {0, SSL_TXT_kDHE
, 0, SSL_kDHE
},
210 {0, SSL_TXT_DH
, 0, SSL_kDHE
},
212 {0, SSL_TXT_kEECDH
, 0, SSL_kECDHE
},
213 {0, SSL_TXT_kECDHE
, 0, SSL_kECDHE
},
214 {0, SSL_TXT_ECDH
, 0, SSL_kECDHE
},
216 {0, SSL_TXT_kPSK
, 0, SSL_kPSK
},
217 {0, SSL_TXT_kRSAPSK
, 0, SSL_kRSAPSK
},
218 {0, SSL_TXT_kECDHEPSK
, 0, SSL_kECDHEPSK
},
219 {0, SSL_TXT_kDHEPSK
, 0, SSL_kDHEPSK
},
220 {0, SSL_TXT_kSRP
, 0, SSL_kSRP
},
221 {0, SSL_TXT_kGOST
, 0, SSL_kGOST
},
223 /* server authentication aliases */
224 {0, SSL_TXT_aRSA
, 0, 0, SSL_aRSA
},
225 {0, SSL_TXT_aDSS
, 0, 0, SSL_aDSS
},
226 {0, SSL_TXT_DSS
, 0, 0, SSL_aDSS
},
227 {0, SSL_TXT_aNULL
, 0, 0, SSL_aNULL
},
228 {0, SSL_TXT_aECDSA
, 0, 0, SSL_aECDSA
},
229 {0, SSL_TXT_ECDSA
, 0, 0, SSL_aECDSA
},
230 {0, SSL_TXT_aPSK
, 0, 0, SSL_aPSK
},
231 {0, SSL_TXT_aGOST01
, 0, 0, SSL_aGOST01
},
232 {0, SSL_TXT_aGOST12
, 0, 0, SSL_aGOST12
},
233 {0, SSL_TXT_aGOST
, 0, 0, SSL_aGOST01
| SSL_aGOST12
},
234 {0, SSL_TXT_aSRP
, 0, 0, SSL_aSRP
},
236 /* aliases combining key exchange and server authentication */
237 {0, SSL_TXT_EDH
, 0, SSL_kDHE
, ~SSL_aNULL
},
238 {0, SSL_TXT_DHE
, 0, SSL_kDHE
, ~SSL_aNULL
},
239 {0, SSL_TXT_EECDH
, 0, SSL_kECDHE
, ~SSL_aNULL
},
240 {0, SSL_TXT_ECDHE
, 0, SSL_kECDHE
, ~SSL_aNULL
},
241 {0, SSL_TXT_NULL
, 0, 0, 0, SSL_eNULL
},
242 {0, SSL_TXT_RSA
, 0, SSL_kRSA
, SSL_aRSA
},
243 {0, SSL_TXT_ADH
, 0, SSL_kDHE
, SSL_aNULL
},
244 {0, SSL_TXT_AECDH
, 0, SSL_kECDHE
, SSL_aNULL
},
245 {0, SSL_TXT_PSK
, 0, SSL_PSK
},
246 {0, SSL_TXT_SRP
, 0, SSL_kSRP
},
248 /* symmetric encryption aliases */
249 {0, SSL_TXT_3DES
, 0, 0, 0, SSL_3DES
},
250 {0, SSL_TXT_RC4
, 0, 0, 0, SSL_RC4
},
251 {0, SSL_TXT_RC2
, 0, 0, 0, SSL_RC2
},
252 {0, SSL_TXT_IDEA
, 0, 0, 0, SSL_IDEA
},
253 {0, SSL_TXT_SEED
, 0, 0, 0, SSL_SEED
},
254 {0, SSL_TXT_eNULL
, 0, 0, 0, SSL_eNULL
},
255 {0, SSL_TXT_GOST
, 0, 0, 0, SSL_eGOST2814789CNT
| SSL_eGOST2814789CNT12
},
256 {0, SSL_TXT_AES128
, 0, 0, 0,
257 SSL_AES128
| SSL_AES128GCM
| SSL_AES128CCM
| SSL_AES128CCM8
},
258 {0, SSL_TXT_AES256
, 0, 0, 0,
259 SSL_AES256
| SSL_AES256GCM
| SSL_AES256CCM
| SSL_AES256CCM8
},
260 {0, SSL_TXT_AES
, 0, 0, 0, SSL_AES
},
261 {0, SSL_TXT_AES_GCM
, 0, 0, 0, SSL_AES128GCM
| SSL_AES256GCM
},
262 {0, SSL_TXT_AES_CCM
, 0, 0, 0,
263 SSL_AES128CCM
| SSL_AES256CCM
| SSL_AES128CCM8
| SSL_AES256CCM8
},
264 {0, SSL_TXT_AES_CCM_8
, 0, 0, 0, SSL_AES128CCM8
| SSL_AES256CCM8
},
265 {0, SSL_TXT_CAMELLIA128
, 0, 0, 0, SSL_CAMELLIA128
},
266 {0, SSL_TXT_CAMELLIA256
, 0, 0, 0, SSL_CAMELLIA256
},
267 {0, SSL_TXT_CAMELLIA
, 0, 0, 0, SSL_CAMELLIA
},
268 {0, SSL_TXT_CHACHA20
, 0, 0, 0, SSL_CHACHA20
},
271 {0, SSL_TXT_MD5
, 0, 0, 0, 0, SSL_MD5
},
272 {0, SSL_TXT_SHA1
, 0, 0, 0, 0, SSL_SHA1
},
273 {0, SSL_TXT_SHA
, 0, 0, 0, 0, SSL_SHA1
},
274 {0, SSL_TXT_GOST94
, 0, 0, 0, 0, SSL_GOST94
},
275 {0, SSL_TXT_GOST89MAC
, 0, 0, 0, 0, SSL_GOST89MAC
| SSL_GOST89MAC12
},
276 {0, SSL_TXT_SHA256
, 0, 0, 0, 0, SSL_SHA256
},
277 {0, SSL_TXT_SHA384
, 0, 0, 0, 0, SSL_SHA384
},
278 {0, SSL_TXT_GOST12
, 0, 0, 0, 0, SSL_GOST12_256
},
280 /* protocol version aliases */
281 {0, SSL_TXT_SSLV3
, 0, 0, 0, 0, 0, SSL3_VERSION
},
282 {0, SSL_TXT_TLSV1
, 0, 0, 0, 0, 0, TLS1_VERSION
},
283 {0, "TLSv1.0", 0, 0, 0, 0, 0, TLS1_VERSION
},
284 {0, SSL_TXT_TLSV1_2
, 0, 0, 0, 0, 0, TLS1_2_VERSION
},
286 /* strength classes */
287 {0, SSL_TXT_LOW
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW
},
288 {0, SSL_TXT_MEDIUM
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM
},
289 {0, SSL_TXT_HIGH
, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH
},
290 /* FIPS 140-2 approved ciphersuite */
291 {0, SSL_TXT_FIPS
, 0, 0, 0, ~SSL_eNULL
, 0, 0, 0, 0, 0, SSL_FIPS
},
293 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
294 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA
, 0,
295 SSL_kDHE
, SSL_aDSS
, SSL_3DES
, SSL_SHA1
, 0, 0, 0, 0, SSL_HIGH
| SSL_FIPS
},
296 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA
, 0,
297 SSL_kDHE
, SSL_aRSA
, SSL_3DES
, SSL_SHA1
, 0, 0, 0, 0, SSL_HIGH
| SSL_FIPS
},
302 * Search for public key algorithm with given name and return its pkey_id if
303 * it is available. Otherwise return 0
305 #ifdef OPENSSL_NO_ENGINE
307 static int get_optional_pkey_id(const char *pkey_name
)
309 const EVP_PKEY_ASN1_METHOD
*ameth
;
311 ameth
= EVP_PKEY_asn1_find_str(NULL
, pkey_name
, -1);
312 if (ameth
&& EVP_PKEY_asn1_get0_info(&pkey_id
, NULL
, NULL
, NULL
, NULL
,
321 static int get_optional_pkey_id(const char *pkey_name
)
323 const EVP_PKEY_ASN1_METHOD
*ameth
;
324 ENGINE
*tmpeng
= NULL
;
326 ameth
= EVP_PKEY_asn1_find_str(&tmpeng
, pkey_name
, -1);
328 if (EVP_PKEY_asn1_get0_info(&pkey_id
, NULL
, NULL
, NULL
, NULL
,
332 ENGINE_finish(tmpeng
);
338 /* masks of disabled algorithms */
339 static uint32_t disabled_enc_mask
;
340 static uint32_t disabled_mac_mask
;
341 static uint32_t disabled_mkey_mask
;
342 static uint32_t disabled_auth_mask
;
344 int ssl_load_ciphers(void)
347 const ssl_cipher_table
*t
;
349 disabled_enc_mask
= 0;
350 ssl_sort_cipher_list();
351 for (i
= 0, t
= ssl_cipher_table_cipher
; i
< SSL_ENC_NUM_IDX
; i
++, t
++) {
352 if (t
->nid
== NID_undef
) {
353 ssl_cipher_methods
[i
] = NULL
;
355 const EVP_CIPHER
*cipher
= EVP_get_cipherbynid(t
->nid
);
356 ssl_cipher_methods
[i
] = cipher
;
358 disabled_enc_mask
|= t
->mask
;
361 disabled_mac_mask
= 0;
362 for (i
= 0, t
= ssl_cipher_table_mac
; i
< SSL_MD_NUM_IDX
; i
++, t
++) {
363 const EVP_MD
*md
= EVP_get_digestbynid(t
->nid
);
364 ssl_digest_methods
[i
] = md
;
366 disabled_mac_mask
|= t
->mask
;
368 int tmpsize
= EVP_MD_size(md
);
369 if (!ossl_assert(tmpsize
>= 0))
371 ssl_mac_secret_size
[i
] = tmpsize
;
374 /* Make sure we can access MD5 and SHA1 */
375 if (!ossl_assert(ssl_digest_methods
[SSL_MD_MD5_IDX
] != NULL
))
377 if (!ossl_assert(ssl_digest_methods
[SSL_MD_SHA1_IDX
] != NULL
))
380 disabled_mkey_mask
= 0;
381 disabled_auth_mask
= 0;
383 #ifdef OPENSSL_NO_RSA
384 disabled_mkey_mask
|= SSL_kRSA
| SSL_kRSAPSK
;
385 disabled_auth_mask
|= SSL_aRSA
;
387 #ifdef OPENSSL_NO_DSA
388 disabled_auth_mask
|= SSL_aDSS
;
391 disabled_mkey_mask
|= SSL_kDHE
| SSL_kDHEPSK
;
394 disabled_mkey_mask
|= SSL_kECDHEPSK
;
395 disabled_auth_mask
|= SSL_aECDSA
;
397 #ifdef OPENSSL_NO_PSK
398 disabled_mkey_mask
|= SSL_PSK
;
399 disabled_auth_mask
|= SSL_aPSK
;
401 #ifdef OPENSSL_NO_SRP
402 disabled_mkey_mask
|= SSL_kSRP
;
406 * Check for presence of GOST 34.10 algorithms, and if they are not
407 * present, disable appropriate auth and key exchange
409 ssl_mac_pkey_id
[SSL_MD_GOST89MAC_IDX
] = get_optional_pkey_id("gost-mac");
410 if (ssl_mac_pkey_id
[SSL_MD_GOST89MAC_IDX
]) {
411 ssl_mac_secret_size
[SSL_MD_GOST89MAC_IDX
] = 32;
413 disabled_mac_mask
|= SSL_GOST89MAC
;
416 ssl_mac_pkey_id
[SSL_MD_GOST89MAC12_IDX
] =
417 get_optional_pkey_id("gost-mac-12");
418 if (ssl_mac_pkey_id
[SSL_MD_GOST89MAC12_IDX
]) {
419 ssl_mac_secret_size
[SSL_MD_GOST89MAC12_IDX
] = 32;
421 disabled_mac_mask
|= SSL_GOST89MAC12
;
424 if (!get_optional_pkey_id("gost2001"))
425 disabled_auth_mask
|= SSL_aGOST01
| SSL_aGOST12
;
426 if (!get_optional_pkey_id("gost2012_256"))
427 disabled_auth_mask
|= SSL_aGOST12
;
428 if (!get_optional_pkey_id("gost2012_512"))
429 disabled_auth_mask
|= SSL_aGOST12
;
431 * Disable GOST key exchange if no GOST signature algs are available *
433 if ((disabled_auth_mask
& (SSL_aGOST01
| SSL_aGOST12
)) ==
434 (SSL_aGOST01
| SSL_aGOST12
))
435 disabled_mkey_mask
|= SSL_kGOST
;
440 #ifndef OPENSSL_NO_COMP
442 static int sk_comp_cmp(const SSL_COMP
*const *a
, const SSL_COMP
*const *b
)
444 return ((*a
)->id
- (*b
)->id
);
447 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions
)
449 SSL_COMP
*comp
= NULL
;
450 COMP_METHOD
*method
= COMP_zlib();
452 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE
);
453 ssl_comp_methods
= sk_SSL_COMP_new(sk_comp_cmp
);
455 if (COMP_get_type(method
) != NID_undef
&& ssl_comp_methods
!= NULL
) {
456 comp
= OPENSSL_malloc(sizeof(*comp
));
458 comp
->method
= method
;
459 comp
->id
= SSL_COMP_ZLIB_IDX
;
460 comp
->name
= COMP_get_name(method
);
461 sk_SSL_COMP_push(ssl_comp_methods
, comp
);
462 sk_SSL_COMP_sort(ssl_comp_methods
);
465 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
469 static int load_builtin_compressions(void)
471 return RUN_ONCE(&ssl_load_builtin_comp_once
, do_load_builtin_compressions
);
475 int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
476 const EVP_MD
**md
, int *mac_pkey_type
,
477 size_t *mac_secret_size
, SSL_COMP
**comp
, int use_etm
)
487 #ifndef OPENSSL_NO_COMP
488 if (!load_builtin_compressions()) {
490 * Currently don't care, since a failure only means that
491 * ssl_comp_methods is NULL, which is perfectly OK
496 ctmp
.id
= s
->compress_meth
;
497 if (ssl_comp_methods
!= NULL
) {
498 i
= sk_SSL_COMP_find(ssl_comp_methods
, &ctmp
);
500 *comp
= sk_SSL_COMP_value(ssl_comp_methods
, i
);
504 /* If were only interested in comp then return success */
505 if ((enc
== NULL
) && (md
== NULL
))
509 if ((enc
== NULL
) || (md
== NULL
))
512 i
= ssl_cipher_info_lookup(ssl_cipher_table_cipher
, c
->algorithm_enc
);
517 if (i
== SSL_ENC_NULL_IDX
)
518 *enc
= EVP_enc_null();
520 *enc
= ssl_cipher_methods
[i
];
523 i
= ssl_cipher_info_lookup(ssl_cipher_table_mac
, c
->algorithm_mac
);
526 if (mac_pkey_type
!= NULL
)
527 *mac_pkey_type
= NID_undef
;
528 if (mac_secret_size
!= NULL
)
529 *mac_secret_size
= 0;
530 if (c
->algorithm_mac
== SSL_AEAD
)
531 mac_pkey_type
= NULL
;
533 *md
= ssl_digest_methods
[i
];
534 if (mac_pkey_type
!= NULL
)
535 *mac_pkey_type
= ssl_mac_pkey_id
[i
];
536 if (mac_secret_size
!= NULL
)
537 *mac_secret_size
= ssl_mac_secret_size
[i
];
540 if ((*enc
!= NULL
) &&
541 (*md
!= NULL
|| (EVP_CIPHER_flags(*enc
) & EVP_CIPH_FLAG_AEAD_CIPHER
))
542 && (!mac_pkey_type
|| *mac_pkey_type
!= NID_undef
)) {
543 const EVP_CIPHER
*evp
;
548 if (s
->ssl_version
>> 8 != TLS1_VERSION_MAJOR
||
549 s
->ssl_version
< TLS1_VERSION
)
552 if (c
->algorithm_enc
== SSL_RC4
&&
553 c
->algorithm_mac
== SSL_MD5
&&
554 (evp
= EVP_get_cipherbyname("RC4-HMAC-MD5")))
555 *enc
= evp
, *md
= NULL
;
556 else if (c
->algorithm_enc
== SSL_AES128
&&
557 c
->algorithm_mac
== SSL_SHA1
&&
558 (evp
= EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
559 *enc
= evp
, *md
= NULL
;
560 else if (c
->algorithm_enc
== SSL_AES256
&&
561 c
->algorithm_mac
== SSL_SHA1
&&
562 (evp
= EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
563 *enc
= evp
, *md
= NULL
;
564 else if (c
->algorithm_enc
== SSL_AES128
&&
565 c
->algorithm_mac
== SSL_SHA256
&&
566 (evp
= EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
567 *enc
= evp
, *md
= NULL
;
568 else if (c
->algorithm_enc
== SSL_AES256
&&
569 c
->algorithm_mac
== SSL_SHA256
&&
570 (evp
= EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
571 *enc
= evp
, *md
= NULL
;
577 const EVP_MD
*ssl_md(int idx
)
579 idx
&= SSL_HANDSHAKE_MAC_MASK
;
580 if (idx
< 0 || idx
>= SSL_MD_NUM_IDX
)
582 return ssl_digest_methods
[idx
];
585 const EVP_MD
*ssl_handshake_md(SSL
*s
)
587 return ssl_md(ssl_get_algorithm2(s
));
590 const EVP_MD
*ssl_prf_md(SSL
*s
)
592 return ssl_md(ssl_get_algorithm2(s
) >> TLS1_PRF_DGST_SHIFT
);
595 #define ITEM_SEP(a) \
596 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
598 static void ll_append_tail(CIPHER_ORDER
**head
, CIPHER_ORDER
*curr
,
605 if (curr
->prev
!= NULL
)
606 curr
->prev
->next
= curr
->next
;
607 if (curr
->next
!= NULL
)
608 curr
->next
->prev
= curr
->prev
;
609 (*tail
)->next
= curr
;
615 static void ll_append_head(CIPHER_ORDER
**head
, CIPHER_ORDER
*curr
,
622 if (curr
->next
!= NULL
)
623 curr
->next
->prev
= curr
->prev
;
624 if (curr
->prev
!= NULL
)
625 curr
->prev
->next
= curr
->next
;
626 (*head
)->prev
= curr
;
632 static void ssl_cipher_collect_ciphers(const SSL_METHOD
*ssl_method
,
634 uint32_t disabled_mkey
,
635 uint32_t disabled_auth
,
636 uint32_t disabled_enc
,
637 uint32_t disabled_mac
,
638 CIPHER_ORDER
*co_list
,
639 CIPHER_ORDER
**head_p
,
640 CIPHER_ORDER
**tail_p
)
646 * We have num_of_ciphers descriptions compiled in, depending on the
647 * method selected (SSLv3, TLSv1 etc).
648 * These will later be sorted in a linked list with at most num
652 /* Get the initial list of ciphers */
653 co_list_num
= 0; /* actual count of ciphers */
654 for (i
= 0; i
< num_of_ciphers
; i
++) {
655 c
= ssl_method
->get_cipher(i
);
656 /* drop those that use any of that is not available */
657 if (c
== NULL
|| !c
->valid
)
659 if ((c
->algorithm_mkey
& disabled_mkey
) ||
660 (c
->algorithm_auth
& disabled_auth
) ||
661 (c
->algorithm_enc
& disabled_enc
) ||
662 (c
->algorithm_mac
& disabled_mac
))
664 if (((ssl_method
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
) == 0) &&
667 if (((ssl_method
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_DTLS
) != 0) &&
671 co_list
[co_list_num
].cipher
= c
;
672 co_list
[co_list_num
].next
= NULL
;
673 co_list
[co_list_num
].prev
= NULL
;
674 co_list
[co_list_num
].active
= 0;
679 * Prepare linked list from list entries
681 if (co_list_num
> 0) {
682 co_list
[0].prev
= NULL
;
684 if (co_list_num
> 1) {
685 co_list
[0].next
= &co_list
[1];
687 for (i
= 1; i
< co_list_num
- 1; i
++) {
688 co_list
[i
].prev
= &co_list
[i
- 1];
689 co_list
[i
].next
= &co_list
[i
+ 1];
692 co_list
[co_list_num
- 1].prev
= &co_list
[co_list_num
- 2];
695 co_list
[co_list_num
- 1].next
= NULL
;
697 *head_p
= &co_list
[0];
698 *tail_p
= &co_list
[co_list_num
- 1];
702 static void ssl_cipher_collect_aliases(const SSL_CIPHER
**ca_list
,
703 int num_of_group_aliases
,
704 uint32_t disabled_mkey
,
705 uint32_t disabled_auth
,
706 uint32_t disabled_enc
,
707 uint32_t disabled_mac
,
710 CIPHER_ORDER
*ciph_curr
;
711 const SSL_CIPHER
**ca_curr
;
713 uint32_t mask_mkey
= ~disabled_mkey
;
714 uint32_t mask_auth
= ~disabled_auth
;
715 uint32_t mask_enc
= ~disabled_enc
;
716 uint32_t mask_mac
= ~disabled_mac
;
719 * First, add the real ciphers as already collected
723 while (ciph_curr
!= NULL
) {
724 *ca_curr
= ciph_curr
->cipher
;
726 ciph_curr
= ciph_curr
->next
;
730 * Now we add the available ones from the cipher_aliases[] table.
731 * They represent either one or more algorithms, some of which
732 * in any affected category must be supported (set in enabled_mask),
733 * or represent a cipher strength value (will be added in any case because algorithms=0).
735 for (i
= 0; i
< num_of_group_aliases
; i
++) {
736 uint32_t algorithm_mkey
= cipher_aliases
[i
].algorithm_mkey
;
737 uint32_t algorithm_auth
= cipher_aliases
[i
].algorithm_auth
;
738 uint32_t algorithm_enc
= cipher_aliases
[i
].algorithm_enc
;
739 uint32_t algorithm_mac
= cipher_aliases
[i
].algorithm_mac
;
742 if ((algorithm_mkey
& mask_mkey
) == 0)
746 if ((algorithm_auth
& mask_auth
) == 0)
750 if ((algorithm_enc
& mask_enc
) == 0)
754 if ((algorithm_mac
& mask_mac
) == 0)
757 *ca_curr
= (SSL_CIPHER
*)(cipher_aliases
+ i
);
761 *ca_curr
= NULL
; /* end of list */
764 static void ssl_cipher_apply_rule(uint32_t cipher_id
, uint32_t alg_mkey
,
765 uint32_t alg_auth
, uint32_t alg_enc
,
766 uint32_t alg_mac
, int min_tls
,
767 uint32_t algo_strength
, int rule
,
768 int32_t strength_bits
, CIPHER_ORDER
**head_p
,
769 CIPHER_ORDER
**tail_p
)
771 CIPHER_ORDER
*head
, *tail
, *curr
, *next
, *last
;
772 const SSL_CIPHER
*cp
;
777 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
778 rule
, alg_mkey
, alg_auth
, alg_enc
, alg_mac
, min_tls
,
779 algo_strength
, strength_bits
);
782 if (rule
== CIPHER_DEL
|| rule
== CIPHER_BUMP
)
783 reverse
= 1; /* needed to maintain sorting between currently
807 next
= reverse
? curr
->prev
: curr
->next
;
812 * Selection criteria is either the value of strength_bits
813 * or the algorithms used.
815 if (strength_bits
>= 0) {
816 if (strength_bits
!= cp
->strength_bits
)
821 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
822 cp
->name
, cp
->algorithm_mkey
, cp
->algorithm_auth
,
823 cp
->algorithm_enc
, cp
->algorithm_mac
, cp
->min_tls
,
826 if (cipher_id
!= 0 && (cipher_id
!= cp
->id
))
828 if (alg_mkey
&& !(alg_mkey
& cp
->algorithm_mkey
))
830 if (alg_auth
&& !(alg_auth
& cp
->algorithm_auth
))
832 if (alg_enc
&& !(alg_enc
& cp
->algorithm_enc
))
834 if (alg_mac
&& !(alg_mac
& cp
->algorithm_mac
))
836 if (min_tls
&& (min_tls
!= cp
->min_tls
))
838 if ((algo_strength
& SSL_STRONG_MASK
)
839 && !(algo_strength
& SSL_STRONG_MASK
& cp
->algo_strength
))
841 if ((algo_strength
& SSL_DEFAULT_MASK
)
842 && !(algo_strength
& SSL_DEFAULT_MASK
& cp
->algo_strength
))
847 fprintf(stderr
, "Action = %d\n", rule
);
850 /* add the cipher if it has not been added yet. */
851 if (rule
== CIPHER_ADD
) {
854 ll_append_tail(&head
, curr
, &tail
);
858 /* Move the added cipher to this location */
859 else if (rule
== CIPHER_ORD
) {
862 ll_append_tail(&head
, curr
, &tail
);
864 } else if (rule
== CIPHER_DEL
) {
868 * most recently deleted ciphersuites get best positions for
869 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
870 * in reverse to maintain the order)
872 ll_append_head(&head
, curr
, &tail
);
875 } else if (rule
== CIPHER_BUMP
) {
877 ll_append_head(&head
, curr
, &tail
);
878 } else if (rule
== CIPHER_KILL
) {
883 curr
->prev
->next
= curr
->next
;
887 if (curr
->next
!= NULL
)
888 curr
->next
->prev
= curr
->prev
;
889 if (curr
->prev
!= NULL
)
890 curr
->prev
->next
= curr
->next
;
900 static int ssl_cipher_strength_sort(CIPHER_ORDER
**head_p
,
901 CIPHER_ORDER
**tail_p
)
903 int32_t max_strength_bits
;
908 * This routine sorts the ciphers with descending strength. The sorting
909 * must keep the pre-sorted sequence, so we apply the normal sorting
910 * routine as '+' movement to the end of the list.
912 max_strength_bits
= 0;
914 while (curr
!= NULL
) {
915 if (curr
->active
&& (curr
->cipher
->strength_bits
> max_strength_bits
))
916 max_strength_bits
= curr
->cipher
->strength_bits
;
920 number_uses
= OPENSSL_zalloc(sizeof(int) * (max_strength_bits
+ 1));
921 if (number_uses
== NULL
) {
922 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT
, ERR_R_MALLOC_FAILURE
);
927 * Now find the strength_bits values actually used
930 while (curr
!= NULL
) {
932 number_uses
[curr
->cipher
->strength_bits
]++;
936 * Go through the list of used strength_bits values in descending
939 for (i
= max_strength_bits
; i
>= 0; i
--)
940 if (number_uses
[i
] > 0)
941 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD
, i
, head_p
,
944 OPENSSL_free(number_uses
);
948 static int ssl_cipher_process_rulestr(const char *rule_str
,
949 CIPHER_ORDER
**head_p
,
950 CIPHER_ORDER
**tail_p
,
951 const SSL_CIPHER
**ca_list
, CERT
*c
)
953 uint32_t alg_mkey
, alg_auth
, alg_enc
, alg_mac
, algo_strength
;
956 int j
, multi
, found
, rule
, retval
, ok
, buflen
;
957 uint32_t cipher_id
= 0;
970 } else if (ch
== '+') {
973 } else if (ch
== '!') {
976 } else if (ch
== '@') {
977 rule
= CIPHER_SPECIAL
;
999 #ifndef CHARSET_EBCDIC
1000 while (((ch
>= 'A') && (ch
<= 'Z')) ||
1001 ((ch
>= '0') && (ch
<= '9')) ||
1002 ((ch
>= 'a') && (ch
<= 'z')) ||
1003 (ch
== '-') || (ch
== '.') || (ch
== '='))
1005 while (isalnum(ch
) || (ch
== '-') || (ch
== '.') || (ch
== '='))
1014 * We hit something we cannot deal with,
1015 * it is no command or separator nor
1016 * alphanumeric, so we call this an error.
1018 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR
, SSL_R_INVALID_COMMAND
);
1024 if (rule
== CIPHER_SPECIAL
) {
1025 found
= 0; /* unused -- avoid compiler warning */
1026 break; /* special treatment */
1029 /* check for multi-part specification */
1037 * Now search for the cipher alias in the ca_list. Be careful
1038 * with the strncmp, because the "buflen" limitation
1039 * will make the rule "ADH:SOME" and the cipher
1040 * "ADH-MY-CIPHER" look like a match for buflen=3.
1041 * So additionally check whether the cipher name found
1042 * has the correct length. We can save a strlen() call:
1043 * just checking for the '\0' at the right place is
1044 * sufficient, we have to strncmp() anyway. (We cannot
1045 * use strcmp(), because buf is not '\0' terminated.)
1049 while (ca_list
[j
]) {
1050 if (strncmp(buf
, ca_list
[j
]->name
, buflen
) == 0
1051 && (ca_list
[j
]->name
[buflen
] == '\0')) {
1059 break; /* ignore this entry */
1061 if (ca_list
[j
]->algorithm_mkey
) {
1063 alg_mkey
&= ca_list
[j
]->algorithm_mkey
;
1069 alg_mkey
= ca_list
[j
]->algorithm_mkey
;
1072 if (ca_list
[j
]->algorithm_auth
) {
1074 alg_auth
&= ca_list
[j
]->algorithm_auth
;
1080 alg_auth
= ca_list
[j
]->algorithm_auth
;
1083 if (ca_list
[j
]->algorithm_enc
) {
1085 alg_enc
&= ca_list
[j
]->algorithm_enc
;
1091 alg_enc
= ca_list
[j
]->algorithm_enc
;
1094 if (ca_list
[j
]->algorithm_mac
) {
1096 alg_mac
&= ca_list
[j
]->algorithm_mac
;
1102 alg_mac
= ca_list
[j
]->algorithm_mac
;
1105 if (ca_list
[j
]->algo_strength
& SSL_STRONG_MASK
) {
1106 if (algo_strength
& SSL_STRONG_MASK
) {
1108 (ca_list
[j
]->algo_strength
& SSL_STRONG_MASK
) |
1110 if (!(algo_strength
& SSL_STRONG_MASK
)) {
1115 algo_strength
= ca_list
[j
]->algo_strength
& SSL_STRONG_MASK
;
1118 if (ca_list
[j
]->algo_strength
& SSL_DEFAULT_MASK
) {
1119 if (algo_strength
& SSL_DEFAULT_MASK
) {
1121 (ca_list
[j
]->algo_strength
& SSL_DEFAULT_MASK
) |
1123 if (!(algo_strength
& SSL_DEFAULT_MASK
)) {
1129 ca_list
[j
]->algo_strength
& SSL_DEFAULT_MASK
;
1132 if (ca_list
[j
]->valid
) {
1134 * explicit ciphersuite found; its protocol version does not
1135 * become part of the search pattern!
1138 cipher_id
= ca_list
[j
]->id
;
1141 * not an explicit ciphersuite; only in this case, the
1142 * protocol version is considered part of the search pattern
1145 if (ca_list
[j
]->min_tls
) {
1146 if (min_tls
!= 0 && min_tls
!= ca_list
[j
]->min_tls
) {
1150 min_tls
= ca_list
[j
]->min_tls
;
1160 * Ok, we have the rule, now apply it
1162 if (rule
== CIPHER_SPECIAL
) { /* special command */
1164 if ((buflen
== 8) && strncmp(buf
, "STRENGTH", 8) == 0)
1165 ok
= ssl_cipher_strength_sort(head_p
, tail_p
);
1166 else if (buflen
== 10 && strncmp(buf
, "SECLEVEL=", 9) == 0) {
1167 int level
= buf
[9] - '0';
1168 if (level
< 0 || level
> 5) {
1169 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR
,
1170 SSL_R_INVALID_COMMAND
);
1172 c
->sec_level
= level
;
1176 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR
, SSL_R_INVALID_COMMAND
);
1180 * We do not support any "multi" options
1181 * together with "@", so throw away the
1182 * rest of the command, if any left, until
1183 * end or ':' is found.
1185 while ((*l
!= '\0') && !ITEM_SEP(*l
))
1188 ssl_cipher_apply_rule(cipher_id
,
1189 alg_mkey
, alg_auth
, alg_enc
, alg_mac
,
1190 min_tls
, algo_strength
, rule
, -1, head_p
,
1193 while ((*l
!= '\0') && !ITEM_SEP(*l
))
1203 #ifndef OPENSSL_NO_EC
1204 static int check_suiteb_cipher_list(const SSL_METHOD
*meth
, CERT
*c
,
1205 const char **prule_str
)
1207 unsigned int suiteb_flags
= 0, suiteb_comb2
= 0;
1208 if (strncmp(*prule_str
, "SUITEB128ONLY", 13) == 0) {
1209 suiteb_flags
= SSL_CERT_FLAG_SUITEB_128_LOS_ONLY
;
1210 } else if (strncmp(*prule_str
, "SUITEB128C2", 11) == 0) {
1212 suiteb_flags
= SSL_CERT_FLAG_SUITEB_128_LOS
;
1213 } else if (strncmp(*prule_str
, "SUITEB128", 9) == 0) {
1214 suiteb_flags
= SSL_CERT_FLAG_SUITEB_128_LOS
;
1215 } else if (strncmp(*prule_str
, "SUITEB192", 9) == 0) {
1216 suiteb_flags
= SSL_CERT_FLAG_SUITEB_192_LOS
;
1220 c
->cert_flags
&= ~SSL_CERT_FLAG_SUITEB_128_LOS
;
1221 c
->cert_flags
|= suiteb_flags
;
1223 suiteb_flags
= c
->cert_flags
& SSL_CERT_FLAG_SUITEB_128_LOS
;
1227 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1229 if (!(meth
->ssl3_enc
->enc_flags
& SSL_ENC_FLAG_TLS1_2_CIPHERS
)) {
1230 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST
,
1231 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE
);
1234 # ifndef OPENSSL_NO_EC
1235 switch (suiteb_flags
) {
1236 case SSL_CERT_FLAG_SUITEB_128_LOS
:
1238 *prule_str
= "ECDHE-ECDSA-AES256-GCM-SHA384";
1241 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1243 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY
:
1244 *prule_str
= "ECDHE-ECDSA-AES128-GCM-SHA256";
1246 case SSL_CERT_FLAG_SUITEB_192_LOS
:
1247 *prule_str
= "ECDHE-ECDSA-AES256-GCM-SHA384";
1252 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST
, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE
);
1258 STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*ssl_method
, STACK_OF(SSL_CIPHER
)
1259 **cipher_list
, STACK_OF(SSL_CIPHER
)
1260 **cipher_list_by_id
,
1261 const char *rule_str
, CERT
*c
)
1263 int ok
, num_of_ciphers
, num_of_alias_max
, num_of_group_aliases
;
1264 uint32_t disabled_mkey
, disabled_auth
, disabled_enc
, disabled_mac
;
1265 STACK_OF(SSL_CIPHER
) *cipherstack
, *tmp_cipher_list
;
1267 CIPHER_ORDER
*co_list
= NULL
, *head
= NULL
, *tail
= NULL
, *curr
;
1268 const SSL_CIPHER
**ca_list
= NULL
;
1271 * Return with error if nothing to do.
1273 if (rule_str
== NULL
|| cipher_list
== NULL
|| cipher_list_by_id
== NULL
)
1275 #ifndef OPENSSL_NO_EC
1276 if (!check_suiteb_cipher_list(ssl_method
, c
, &rule_str
))
1281 * To reduce the work to do we only want to process the compiled
1282 * in algorithms, so we first get the mask of disabled ciphers.
1285 disabled_mkey
= disabled_mkey_mask
;
1286 disabled_auth
= disabled_auth_mask
;
1287 disabled_enc
= disabled_enc_mask
;
1288 disabled_mac
= disabled_mac_mask
;
1291 * Now we have to collect the available ciphers from the compiled
1292 * in ciphers. We cannot get more than the number compiled in, so
1293 * it is used for allocation.
1295 num_of_ciphers
= ssl_method
->num_ciphers();
1297 co_list
= OPENSSL_malloc(sizeof(*co_list
) * num_of_ciphers
);
1298 if (co_list
== NULL
) {
1299 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
1300 return (NULL
); /* Failure */
1303 ssl_cipher_collect_ciphers(ssl_method
, num_of_ciphers
,
1304 disabled_mkey
, disabled_auth
, disabled_enc
,
1305 disabled_mac
, co_list
, &head
, &tail
);
1307 /* Now arrange all ciphers by preference. */
1310 * Everything else being equal, prefer ephemeral ECDH over other key
1311 * exchange mechanisms.
1312 * For consistency, prefer ECDSA over RSA (though this only matters if the
1313 * server has both certificates, and is using the DEFAULT, or a client
1316 ssl_cipher_apply_rule(0, SSL_kECDHE
, SSL_aECDSA
, 0, 0, 0, 0, CIPHER_ADD
,
1318 ssl_cipher_apply_rule(0, SSL_kECDHE
, 0, 0, 0, 0, 0, CIPHER_ADD
, -1, &head
,
1320 ssl_cipher_apply_rule(0, SSL_kECDHE
, 0, 0, 0, 0, 0, CIPHER_DEL
, -1, &head
,
1323 /* Within each strength group, we prefer GCM over CHACHA... */
1324 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM
, 0, 0, 0, CIPHER_ADD
, -1,
1326 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20
, 0, 0, 0, CIPHER_ADD
, -1,
1330 * ...and generally, our preferred cipher is AES.
1331 * Note that AEADs will be bumped to take preference after sorting by
1334 ssl_cipher_apply_rule(0, 0, 0, SSL_AES
^ SSL_AESGCM
, 0, 0, 0, CIPHER_ADD
,
1337 /* Temporarily enable everything else for sorting */
1338 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD
, -1, &head
, &tail
);
1340 /* Low priority for MD5 */
1341 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5
, 0, 0, CIPHER_ORD
, -1, &head
,
1345 * Move anonymous ciphers to the end. Usually, these will remain
1346 * disabled. (For applications that allow them, they aren't too bad, but
1347 * we prefer authenticated ciphers.)
1349 ssl_cipher_apply_rule(0, 0, SSL_aNULL
, 0, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1353 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1356 ssl_cipher_apply_rule(0, SSL_kRSA
, 0, 0, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1358 ssl_cipher_apply_rule(0, SSL_kPSK
, 0, 0, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1361 /* RC4 is sort-of broken -- move the the end */
1362 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4
, 0, 0, 0, CIPHER_ORD
, -1, &head
,
1366 * Now sort by symmetric encryption strength. The above ordering remains
1367 * in force within each class
1369 if (!ssl_cipher_strength_sort(&head
, &tail
)) {
1370 OPENSSL_free(co_list
);
1375 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1376 * TODO(openssl-team): is there an easier way to accomplish all this?
1378 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION
, 0, CIPHER_BUMP
, -1,
1382 * Irrespective of strength, enforce the following order:
1383 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1384 * Within each group, ciphers remain sorted by strength and previous
1389 * 4) TLS 1.2 > legacy
1391 * Because we now bump ciphers to the top of the list, we proceed in
1392 * reverse order of preference.
1394 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD
, 0, 0, CIPHER_BUMP
, -1,
1396 ssl_cipher_apply_rule(0, SSL_kDHE
| SSL_kECDHE
, 0, 0, 0, 0, 0,
1397 CIPHER_BUMP
, -1, &head
, &tail
);
1398 ssl_cipher_apply_rule(0, SSL_kDHE
| SSL_kECDHE
, 0, 0, SSL_AEAD
, 0, 0,
1399 CIPHER_BUMP
, -1, &head
, &tail
);
1401 /* Now disable everything (maintaining the ordering!) */
1402 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL
, -1, &head
, &tail
);
1405 * We also need cipher aliases for selecting based on the rule_str.
1406 * There might be two types of entries in the rule_str: 1) names
1407 * of ciphers themselves 2) aliases for groups of ciphers.
1408 * For 1) we need the available ciphers and for 2) the cipher
1409 * groups of cipher_aliases added together in one list (otherwise
1410 * we would be happy with just the cipher_aliases table).
1412 num_of_group_aliases
= OSSL_NELEM(cipher_aliases
);
1413 num_of_alias_max
= num_of_ciphers
+ num_of_group_aliases
+ 1;
1414 ca_list
= OPENSSL_malloc(sizeof(*ca_list
) * num_of_alias_max
);
1415 if (ca_list
== NULL
) {
1416 OPENSSL_free(co_list
);
1417 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST
, ERR_R_MALLOC_FAILURE
);
1418 return (NULL
); /* Failure */
1420 ssl_cipher_collect_aliases(ca_list
, num_of_group_aliases
,
1421 disabled_mkey
, disabled_auth
, disabled_enc
,
1422 disabled_mac
, head
);
1425 * If the rule_string begins with DEFAULT, apply the default rule
1426 * before using the (possibly available) additional rules.
1430 if (strncmp(rule_str
, "DEFAULT", 7) == 0) {
1431 ok
= ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST
,
1432 &head
, &tail
, ca_list
, c
);
1438 if (ok
&& (strlen(rule_p
) > 0))
1439 ok
= ssl_cipher_process_rulestr(rule_p
, &head
, &tail
, ca_list
, c
);
1441 OPENSSL_free(ca_list
); /* Not needed anymore */
1443 if (!ok
) { /* Rule processing failure */
1444 OPENSSL_free(co_list
);
1449 * Allocate new "cipherstack" for the result, return with error
1450 * if we cannot get one.
1452 if ((cipherstack
= sk_SSL_CIPHER_new_null()) == NULL
) {
1453 OPENSSL_free(co_list
);
1458 * The cipher selection for the list is done. The ciphers are added
1459 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1461 for (curr
= head
; curr
!= NULL
; curr
= curr
->next
) {
1463 if (!sk_SSL_CIPHER_push(cipherstack
, curr
->cipher
)) {
1464 OPENSSL_free(co_list
);
1465 sk_SSL_CIPHER_free(cipherstack
);
1469 fprintf(stderr
, "<%s>\n", curr
->cipher
->name
);
1473 OPENSSL_free(co_list
); /* Not needed any longer */
1475 tmp_cipher_list
= sk_SSL_CIPHER_dup(cipherstack
);
1476 if (tmp_cipher_list
== NULL
) {
1477 sk_SSL_CIPHER_free(cipherstack
);
1480 sk_SSL_CIPHER_free(*cipher_list
);
1481 *cipher_list
= cipherstack
;
1482 if (*cipher_list_by_id
!= NULL
)
1483 sk_SSL_CIPHER_free(*cipher_list_by_id
);
1484 *cipher_list_by_id
= tmp_cipher_list
;
1485 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id
, ssl_cipher_ptr_id_cmp
);
1487 sk_SSL_CIPHER_sort(*cipher_list_by_id
);
1488 return (cipherstack
);
1491 char *SSL_CIPHER_description(const SSL_CIPHER
*cipher
, char *buf
, int len
)
1494 const char *kx
, *au
, *enc
, *mac
;
1495 uint32_t alg_mkey
, alg_auth
, alg_enc
, alg_mac
;
1496 static const char *format
= "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1500 buf
= OPENSSL_malloc(len
);
1503 } else if (len
< 128)
1506 alg_mkey
= cipher
->algorithm_mkey
;
1507 alg_auth
= cipher
->algorithm_auth
;
1508 alg_enc
= cipher
->algorithm_enc
;
1509 alg_mac
= cipher
->algorithm_mac
;
1511 ver
= ssl_protocol_to_string(cipher
->min_tls
);
1570 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1571 case (SSL_aGOST12
| SSL_aGOST01
):
1608 enc
= "AESGCM(128)";
1611 enc
= "AESGCM(256)";
1614 enc
= "AESCCM(128)";
1617 enc
= "AESCCM(256)";
1619 case SSL_AES128CCM8
:
1620 enc
= "AESCCM8(128)";
1622 case SSL_AES256CCM8
:
1623 enc
= "AESCCM8(256)";
1625 case SSL_CAMELLIA128
:
1626 enc
= "Camellia(128)";
1628 case SSL_CAMELLIA256
:
1629 enc
= "Camellia(256)";
1634 case SSL_eGOST2814789CNT
:
1635 case SSL_eGOST2814789CNT12
:
1636 enc
= "GOST89(256)";
1638 case SSL_CHACHA20POLY1305
:
1639 enc
= "CHACHA20/POLY1305(256)";
1663 case SSL_GOST89MAC12
:
1669 case SSL_GOST12_256
:
1670 case SSL_GOST12_512
:
1678 BIO_snprintf(buf
, len
, format
, cipher
->name
, ver
, kx
, au
, enc
, mac
);
1683 const char *SSL_CIPHER_get_version(const SSL_CIPHER
*c
)
1689 * Backwards-compatibility crutch. In almost all contexts we report TLS
1690 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1692 if (c
->min_tls
== TLS1_VERSION
)
1694 return ssl_protocol_to_string(c
->min_tls
);
1697 /* return the actual cipher being used */
1698 const char *SSL_CIPHER_get_name(const SSL_CIPHER
*c
)
1705 /* number of bits for symmetric cipher */
1706 int SSL_CIPHER_get_bits(const SSL_CIPHER
*c
, int *alg_bits
)
1711 if (alg_bits
!= NULL
)
1712 *alg_bits
= (int)c
->alg_bits
;
1713 ret
= (int)c
->strength_bits
;
1718 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER
*c
)
1723 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
)
1728 if ((n
== 0) || (sk
== NULL
))
1730 nn
= sk_SSL_COMP_num(sk
);
1731 for (i
= 0; i
< nn
; i
++) {
1732 ctmp
= sk_SSL_COMP_value(sk
, i
);
1739 #ifdef OPENSSL_NO_COMP
1740 STACK_OF(SSL_COMP
) *SSL_COMP_get_compression_methods(void)
1745 STACK_OF(SSL_COMP
) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP
)
1751 int SSL_COMP_add_compression_method(int id
, COMP_METHOD
*cm
)
1757 STACK_OF(SSL_COMP
) *SSL_COMP_get_compression_methods(void)
1759 load_builtin_compressions();
1760 return (ssl_comp_methods
);
1763 STACK_OF(SSL_COMP
) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP
)
1766 STACK_OF(SSL_COMP
) *old_meths
= ssl_comp_methods
;
1767 ssl_comp_methods
= meths
;
1771 static void cmeth_free(SSL_COMP
*cm
)
1776 void ssl_comp_free_compression_methods_int(void)
1778 STACK_OF(SSL_COMP
) *old_meths
= ssl_comp_methods
;
1779 ssl_comp_methods
= NULL
;
1780 sk_SSL_COMP_pop_free(old_meths
, cmeth_free
);
1783 int SSL_COMP_add_compression_method(int id
, COMP_METHOD
*cm
)
1787 if (cm
== NULL
|| COMP_get_type(cm
) == NID_undef
)
1791 * According to draft-ietf-tls-compression-04.txt, the
1792 * compression number ranges should be the following:
1794 * 0 to 63: methods defined by the IETF
1795 * 64 to 192: external party methods assigned by IANA
1796 * 193 to 255: reserved for private use
1798 if (id
< 193 || id
> 255) {
1799 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
,
1800 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE
);
1804 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE
);
1805 comp
= OPENSSL_malloc(sizeof(*comp
));
1807 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1808 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
, ERR_R_MALLOC_FAILURE
);
1814 load_builtin_compressions();
1815 if (ssl_comp_methods
&& sk_SSL_COMP_find(ssl_comp_methods
, comp
) >= 0) {
1817 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1818 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
,
1819 SSL_R_DUPLICATE_COMPRESSION_ID
);
1822 if (ssl_comp_methods
== NULL
|| !sk_SSL_COMP_push(ssl_comp_methods
, comp
)) {
1824 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1825 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD
, ERR_R_MALLOC_FAILURE
);
1828 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE
);
1833 const char *SSL_COMP_get_name(const COMP_METHOD
*comp
)
1835 #ifndef OPENSSL_NO_COMP
1836 return comp
? COMP_get_name(comp
) : NULL
;
1842 const char *SSL_COMP_get0_name(const SSL_COMP
*comp
)
1844 #ifndef OPENSSL_NO_COMP
1851 int SSL_COMP_get_id(const SSL_COMP
*comp
)
1853 #ifndef OPENSSL_NO_COMP
1860 /* For a cipher return the index corresponding to the certificate type */
1861 int ssl_cipher_get_cert_index(const SSL_CIPHER
*c
)
1865 alg_a
= c
->algorithm_auth
;
1867 if (alg_a
& SSL_aECDSA
)
1868 return SSL_PKEY_ECC
;
1869 else if (alg_a
& SSL_aDSS
)
1870 return SSL_PKEY_DSA_SIGN
;
1871 else if (alg_a
& SSL_aRSA
)
1872 return SSL_PKEY_RSA
;
1873 else if (alg_a
& SSL_aGOST12
)
1874 return SSL_PKEY_GOST_EC
;
1875 else if (alg_a
& SSL_aGOST01
)
1876 return SSL_PKEY_GOST01
;
1881 const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
, const unsigned char *ptr
,
1884 const SSL_CIPHER
*c
= ssl
->method
->get_cipher_by_char(ptr
);
1886 if (c
== NULL
|| (!all
&& c
->valid
== 0))
1891 const SSL_CIPHER
*SSL_CIPHER_find(SSL
*ssl
, const unsigned char *ptr
)
1893 return ssl
->method
->get_cipher_by_char(ptr
);
1896 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER
*c
)
1901 i
= ssl_cipher_info_lookup(ssl_cipher_table_cipher
, c
->algorithm_enc
);
1904 return ssl_cipher_table_cipher
[i
].nid
;
1907 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER
*c
)
1909 int i
= ssl_cipher_info_lookup(ssl_cipher_table_mac
, c
->algorithm_mac
);
1913 return ssl_cipher_table_mac
[i
].nid
;
1916 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER
*c
)
1918 int i
= ssl_cipher_info_lookup(ssl_cipher_table_kx
, c
->algorithm_mkey
);
1922 return ssl_cipher_table_kx
[i
].nid
;
1925 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER
*c
)
1927 int i
= ssl_cipher_info_lookup(ssl_cipher_table_auth
, c
->algorithm_auth
);
1931 return ssl_cipher_table_auth
[i
].nid
;
1934 const EVP_MD
*SSL_CIPHER_get_handshake_digest(const SSL_CIPHER
*c
)
1936 int idx
= c
->algorithm2
;
1938 idx
&= SSL_HANDSHAKE_MAC_MASK
;
1939 if (idx
< 0 || idx
>= SSL_MD_NUM_IDX
)
1941 return ssl_digest_methods
[idx
];
1944 int SSL_CIPHER_is_aead(const SSL_CIPHER
*c
)
1946 return (c
->algorithm_mac
& SSL_AEAD
) ? 1 : 0;
1949 int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
1950 size_t *int_overhead
, size_t *blocksize
,
1951 size_t *ext_overhead
)
1953 size_t mac
= 0, in
= 0, blk
= 0, out
= 0;
1955 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1956 * because there are no handy #defines for those. */
1957 if (c
->algorithm_enc
& SSL_AESGCM
) {
1958 out
= EVP_GCM_TLS_EXPLICIT_IV_LEN
+ EVP_GCM_TLS_TAG_LEN
;
1959 } else if (c
->algorithm_enc
& (SSL_AES128CCM
| SSL_AES256CCM
)) {
1960 out
= EVP_CCM_TLS_EXPLICIT_IV_LEN
+ 16;
1961 } else if (c
->algorithm_enc
& (SSL_AES128CCM8
| SSL_AES256CCM8
)) {
1962 out
= EVP_CCM_TLS_EXPLICIT_IV_LEN
+ 8;
1963 } else if (c
->algorithm_enc
& SSL_CHACHA20POLY1305
) {
1965 } else if (c
->algorithm_mac
& SSL_AEAD
) {
1966 /* We're supposed to have handled all the AEAD modes above */
1969 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1970 int digest_nid
= SSL_CIPHER_get_digest_nid(c
);
1971 const EVP_MD
*e_md
= EVP_get_digestbynid(digest_nid
);
1976 mac
= EVP_MD_size(e_md
);
1977 if (c
->algorithm_enc
!= SSL_eNULL
) {
1978 int cipher_nid
= SSL_CIPHER_get_cipher_nid(c
);
1979 const EVP_CIPHER
*e_ciph
= EVP_get_cipherbynid(cipher_nid
);
1981 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
1982 known CBC cipher. */
1983 if (e_ciph
== NULL
||
1984 EVP_CIPHER_mode(e_ciph
) != EVP_CIPH_CBC_MODE
)
1987 in
= 1; /* padding length byte */
1988 out
= EVP_CIPHER_iv_length(e_ciph
);
1989 blk
= EVP_CIPHER_block_size(e_ciph
);
1993 *mac_overhead
= mac
;
1996 *ext_overhead
= out
;