2 * Copyright 1995-2020 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 Apache License 2.0 (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>
18 #include <openssl/conf.h>
19 #include <openssl/trace.h>
20 #include "internal/nelem.h"
21 #include "ssl_local.h"
22 #include "internal/thread_once.h"
23 #include "internal/cryptlib.h"
25 /* NB: make sure indices in these tables match values above */
32 /* Table of NIDs for each cipher */
33 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
34 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
35 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
36 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
37 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
38 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
39 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
40 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
41 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
42 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
43 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
44 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
45 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
46 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
47 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
48 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
49 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
50 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
51 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
52 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX 18 */
53 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305}, /* SSL_ENC_CHACHA_IDX 19 */
54 {SSL_ARIA128GCM, NID_aria_128_gcm}, /* SSL_ENC_ARIA128GCM_IDX 20 */
55 {SSL_ARIA256GCM, NID_aria_256_gcm}, /* SSL_ENC_ARIA256GCM_IDX 21 */
56 {SSL_MAGMA, NID_magma_ctr_acpkm}, /* SSL_ENC_MAGMA_IDX */
57 {SSL_KUZNYECHIK, NID_kuznyechik_ctr_acpkm}, /* SSL_ENC_KUZNYECHIK_IDX */
60 #define SSL_COMP_NULL_IDX 0
61 #define SSL_COMP_ZLIB_IDX 1
62 #define SSL_COMP_NUM_IDX 2
64 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
66 #ifndef OPENSSL_NO_COMP
67 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
70 /* NB: make sure indices in this table matches values above */
71 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
72 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
73 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
74 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
75 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
76 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
77 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
78 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
79 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
80 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
81 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
82 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
83 {0, NID_sha512}, /* SSL_MD_SHA512_IDX 11 */
84 {SSL_MAGMAOMAC, NID_magma_mac}, /* sSL_MD_MAGMAOMAC_IDX */
85 {SSL_KUZNYECHIKOMAC, NID_kuznyechik_mac} /* SSL_MD_KUZNYECHIKOMAC_IDX */
89 static const ssl_cipher_table ssl_cipher_table_kx[] = {
90 {SSL_kRSA, NID_kx_rsa},
91 {SSL_kECDHE, NID_kx_ecdhe},
92 {SSL_kDHE, NID_kx_dhe},
93 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
94 {SSL_kDHEPSK, NID_kx_dhe_psk},
95 {SSL_kRSAPSK, NID_kx_rsa_psk},
96 {SSL_kPSK, NID_kx_psk},
97 {SSL_kSRP, NID_kx_srp},
98 {SSL_kGOST, NID_kx_gost},
99 {SSL_kGOST18, NID_kx_gost18},
100 {SSL_kANY, NID_kx_any}
103 static const ssl_cipher_table ssl_cipher_table_auth[] = {
104 {SSL_aRSA, NID_auth_rsa},
105 {SSL_aECDSA, NID_auth_ecdsa},
106 {SSL_aPSK, NID_auth_psk},
107 {SSL_aDSS, NID_auth_dss},
108 {SSL_aGOST01, NID_auth_gost01},
109 {SSL_aGOST12, NID_auth_gost12},
110 {SSL_aSRP, NID_auth_srp},
111 {SSL_aNULL, NID_auth_null},
112 {SSL_aANY, NID_auth_any}
116 /* Utility function for table lookup */
117 static int ssl_cipher_info_find(const ssl_cipher_table * table,
118 size_t table_cnt, uint32_t mask)
121 for (i = 0; i < table_cnt; i++, table++) {
122 if (table->mask == mask)
128 #define ssl_cipher_info_lookup(table, x) \
129 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
132 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
133 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
136 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
137 /* MD5, SHA, GOST94, MAC89 */
138 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
139 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
140 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
143 /* MD5/SHA1, SHA224, SHA512, MAGMAOMAC, KUZNYECHIKOMAC */
144 NID_undef, NID_undef, NID_undef, NID_undef, NID_undef
148 #define CIPHER_KILL 2
151 #define CIPHER_SPECIAL 5
153 * Bump the ciphers to the top of the list.
154 * This rule isn't currently supported by the public cipherstring API.
156 #define CIPHER_BUMP 6
158 typedef struct cipher_order_st {
159 const SSL_CIPHER *cipher;
162 struct cipher_order_st *next, *prev;
165 static const SSL_CIPHER cipher_aliases[] = {
166 /* "ALL" doesn't include eNULL (must be specifically enabled) */
167 {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
168 /* "COMPLEMENTOFALL" */
169 {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
172 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
175 {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
178 * key exchange aliases (some of those using only a single bit here
179 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
180 * combines DHE_DSS and DHE_RSA)
182 {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
184 {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
185 {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
186 {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
188 {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
189 {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
190 {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
192 {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
193 {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
194 {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
195 {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
196 {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
197 {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
198 {0, SSL_TXT_kGOST18, NULL, 0, SSL_kGOST18},
200 /* server authentication aliases */
201 {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
202 {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
203 {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
204 {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
205 {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
206 {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
207 {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
208 {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
209 {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
210 {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
211 {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
213 /* aliases combining key exchange and server authentication */
214 {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
215 {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
216 {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
217 {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
218 {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
219 {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
220 {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
221 {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
222 {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
223 {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
225 /* symmetric encryption aliases */
226 {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
227 {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
228 {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
229 {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
230 {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
231 {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
232 {0, SSL_TXT_GOST, NULL, 0, 0, 0,
233 SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12 | SSL_MAGMA | SSL_KUZNYECHIK},
234 {0, SSL_TXT_AES128, NULL, 0, 0, 0,
235 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
236 {0, SSL_TXT_AES256, NULL, 0, 0, 0,
237 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
238 {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
239 {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
240 {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
241 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
242 {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
243 {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
244 {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
245 {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
246 {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
247 {0, SSL_TXT_GOST2012_GOST8912_GOST8912, NULL, 0, 0, 0, SSL_eGOST2814789CNT12},
249 {0, SSL_TXT_ARIA, NULL, 0, 0, 0, SSL_ARIA},
250 {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
251 {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
252 {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
253 {0, SSL_TXT_CBC, NULL, 0, 0, 0, SSL_CBC},
256 {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
257 {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
258 {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
259 {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
260 {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
261 {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
262 {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
263 {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
265 /* protocol version aliases */
266 {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
267 {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
268 {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
269 {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
271 /* strength classes */
272 {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
273 {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
274 {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
275 /* FIPS 140-2 approved ciphersuite */
276 {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
278 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
279 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
280 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
281 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
282 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
287 * Search for public key algorithm with given name and return its pkey_id if
288 * it is available. Otherwise return 0
290 #ifdef OPENSSL_NO_ENGINE
292 static int get_optional_pkey_id(const char *pkey_name)
294 const EVP_PKEY_ASN1_METHOD *ameth;
296 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
297 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
305 static int get_optional_pkey_id(const char *pkey_name)
307 const EVP_PKEY_ASN1_METHOD *ameth;
308 ENGINE *tmpeng = NULL;
310 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
312 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
316 tls_engine_finish(tmpeng);
322 /* masks of disabled algorithms */
323 static uint32_t disabled_enc_mask;
324 static uint32_t disabled_mac_mask;
325 static uint32_t disabled_mkey_mask;
326 static uint32_t disabled_auth_mask;
328 int ssl_load_ciphers(SSL_CTX *ctx)
331 const ssl_cipher_table *t;
333 disabled_enc_mask = 0;
334 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
335 if (t->nid != NID_undef) {
336 const EVP_CIPHER *cipher
337 = ssl_evp_cipher_fetch(ctx->libctx, t->nid, ctx->propq);
339 ctx->ssl_cipher_methods[i] = cipher;
341 disabled_enc_mask |= t->mask;
344 disabled_mac_mask = 0;
345 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
347 = ssl_evp_md_fetch(ctx->libctx, t->nid, ctx->propq);
349 ctx->ssl_digest_methods[i] = md;
351 disabled_mac_mask |= t->mask;
353 int tmpsize = EVP_MD_size(md);
354 if (!ossl_assert(tmpsize >= 0))
356 ctx->ssl_mac_secret_size[i] = tmpsize;
360 disabled_mkey_mask = 0;
361 disabled_auth_mask = 0;
363 #ifdef OPENSSL_NO_RSA
364 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
365 disabled_auth_mask |= SSL_aRSA;
367 #ifdef OPENSSL_NO_DSA
368 disabled_auth_mask |= SSL_aDSS;
371 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
374 disabled_mkey_mask |= SSL_kECDHE | SSL_kECDHEPSK;
375 disabled_auth_mask |= SSL_aECDSA;
377 #ifdef OPENSSL_NO_PSK
378 disabled_mkey_mask |= SSL_PSK;
379 disabled_auth_mask |= SSL_aPSK;
381 #ifdef OPENSSL_NO_SRP
382 disabled_mkey_mask |= SSL_kSRP;
386 * Check for presence of GOST 34.10 algorithms, and if they are not
387 * present, disable appropriate auth and key exchange
389 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id(SN_id_Gost28147_89_MAC);
390 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
391 ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
393 disabled_mac_mask |= SSL_GOST89MAC;
395 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
396 get_optional_pkey_id(SN_gost_mac_12);
397 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
398 ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
400 disabled_mac_mask |= SSL_GOST89MAC12;
402 ssl_mac_pkey_id[SSL_MD_MAGMAOMAC_IDX] =
403 get_optional_pkey_id(SN_magma_mac);
404 if (ssl_mac_pkey_id[SSL_MD_MAGMAOMAC_IDX])
405 ctx->ssl_mac_secret_size[SSL_MD_MAGMAOMAC_IDX] = 32;
407 disabled_mac_mask |= SSL_MAGMAOMAC;
409 ssl_mac_pkey_id[SSL_MD_KUZNYECHIKOMAC_IDX] =
410 get_optional_pkey_id(SN_kuznyechik_mac);
411 if (ssl_mac_pkey_id[SSL_MD_KUZNYECHIKOMAC_IDX])
412 ctx->ssl_mac_secret_size[SSL_MD_KUZNYECHIKOMAC_IDX] = 32;
414 disabled_mac_mask |= SSL_KUZNYECHIKOMAC;
416 if (!get_optional_pkey_id(SN_id_GostR3410_2001))
417 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
418 if (!get_optional_pkey_id(SN_id_GostR3410_2012_256))
419 disabled_auth_mask |= SSL_aGOST12;
420 if (!get_optional_pkey_id(SN_id_GostR3410_2012_512))
421 disabled_auth_mask |= SSL_aGOST12;
423 * Disable GOST key exchange if no GOST signature algs are available *
425 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
426 (SSL_aGOST01 | SSL_aGOST12))
427 disabled_mkey_mask |= SSL_kGOST;
429 if ((disabled_auth_mask & SSL_aGOST12) == SSL_aGOST12)
430 disabled_mkey_mask |= SSL_kGOST18;
435 #ifndef OPENSSL_NO_COMP
437 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
439 return ((*a)->id - (*b)->id);
442 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
444 SSL_COMP *comp = NULL;
445 COMP_METHOD *method = COMP_zlib();
447 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
449 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
450 comp = OPENSSL_malloc(sizeof(*comp));
452 comp->method = method;
453 comp->id = SSL_COMP_ZLIB_IDX;
454 comp->name = COMP_get_name(method);
455 sk_SSL_COMP_push(ssl_comp_methods, comp);
456 sk_SSL_COMP_sort(ssl_comp_methods);
462 static int load_builtin_compressions(void)
464 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
468 int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
469 const EVP_CIPHER **enc)
471 int i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, sslc->algorithm_enc);
476 if (i == SSL_ENC_NULL_IDX) {
478 * We assume we don't care about this coming from an ENGINE so
479 * just do a normal EVP_CIPHER_fetch instead of
480 * ssl_evp_cipher_fetch()
482 *enc = EVP_CIPHER_fetch(ctx->libctx, "NULL", ctx->propq);
486 const EVP_CIPHER *cipher = ctx->ssl_cipher_methods[i];
489 || !ssl_evp_cipher_up_ref(cipher))
491 *enc = ctx->ssl_cipher_methods[i];
497 int ssl_cipher_get_evp(SSL_CTX *ctx, const SSL_SESSION *s,
498 const EVP_CIPHER **enc, const EVP_MD **md,
499 int *mac_pkey_type, size_t *mac_secret_size,
500 SSL_COMP **comp, int use_etm)
510 #ifndef OPENSSL_NO_COMP
511 if (!load_builtin_compressions()) {
513 * Currently don't care, since a failure only means that
514 * ssl_comp_methods is NULL, which is perfectly OK
519 ctmp.id = s->compress_meth;
520 if (ssl_comp_methods != NULL) {
521 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
522 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
524 /* If were only interested in comp then return success */
525 if ((enc == NULL) && (md == NULL))
529 if ((enc == NULL) || (md == NULL))
532 if (!ssl_cipher_get_evp_cipher(ctx, c, enc))
535 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
538 if (mac_pkey_type != NULL)
539 *mac_pkey_type = NID_undef;
540 if (mac_secret_size != NULL)
541 *mac_secret_size = 0;
542 if (c->algorithm_mac == SSL_AEAD)
543 mac_pkey_type = NULL;
545 if (!ssl_evp_md_up_ref(ctx->ssl_digest_methods[i])) {
546 ssl_evp_cipher_free(*enc);
549 *md = ctx->ssl_digest_methods[i];
550 if (mac_pkey_type != NULL)
551 *mac_pkey_type = ssl_mac_pkey_id[i];
552 if (mac_secret_size != NULL)
553 *mac_secret_size = ctx->ssl_mac_secret_size[i];
556 if ((*enc != NULL) &&
557 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
558 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
559 const EVP_CIPHER *evp = NULL;
562 || s->ssl_version >> 8 != TLS1_VERSION_MAJOR
563 || s->ssl_version < TLS1_VERSION)
566 if (c->algorithm_enc == SSL_RC4
567 && c->algorithm_mac == SSL_MD5)
568 evp = ssl_evp_cipher_fetch(ctx->libctx, NID_rc4_hmac_md5,
570 else if (c->algorithm_enc == SSL_AES128
571 && c->algorithm_mac == SSL_SHA1)
572 evp = ssl_evp_cipher_fetch(ctx->libctx,
573 NID_aes_128_cbc_hmac_sha1,
575 else if (c->algorithm_enc == SSL_AES256
576 && c->algorithm_mac == SSL_SHA1)
577 evp = ssl_evp_cipher_fetch(ctx->libctx,
578 NID_aes_256_cbc_hmac_sha1,
580 else if (c->algorithm_enc == SSL_AES128
581 && c->algorithm_mac == SSL_SHA256)
582 evp = ssl_evp_cipher_fetch(ctx->libctx,
583 NID_aes_128_cbc_hmac_sha256,
585 else if (c->algorithm_enc == SSL_AES256
586 && c->algorithm_mac == SSL_SHA256)
587 evp = ssl_evp_cipher_fetch(ctx->libctx,
588 NID_aes_256_cbc_hmac_sha256,
592 ssl_evp_cipher_free(*enc);
593 ssl_evp_md_free(*md);
603 const EVP_MD *ssl_md(SSL_CTX *ctx, int idx)
605 idx &= SSL_HANDSHAKE_MAC_MASK;
606 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
608 return ctx->ssl_digest_methods[idx];
611 const EVP_MD *ssl_handshake_md(SSL *s)
613 return ssl_md(s->ctx, ssl_get_algorithm2(s));
616 const EVP_MD *ssl_prf_md(SSL *s)
618 return ssl_md(s->ctx, ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
621 #define ITEM_SEP(a) \
622 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
624 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
631 if (curr->prev != NULL)
632 curr->prev->next = curr->next;
633 if (curr->next != NULL)
634 curr->next->prev = curr->prev;
635 (*tail)->next = curr;
641 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
648 if (curr->next != NULL)
649 curr->next->prev = curr->prev;
650 if (curr->prev != NULL)
651 curr->prev->next = curr->next;
652 (*head)->prev = curr;
658 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
660 uint32_t disabled_mkey,
661 uint32_t disabled_auth,
662 uint32_t disabled_enc,
663 uint32_t disabled_mac,
664 CIPHER_ORDER *co_list,
665 CIPHER_ORDER **head_p,
666 CIPHER_ORDER **tail_p)
672 * We have num_of_ciphers descriptions compiled in, depending on the
673 * method selected (SSLv3, TLSv1 etc).
674 * These will later be sorted in a linked list with at most num
678 /* Get the initial list of ciphers */
679 co_list_num = 0; /* actual count of ciphers */
680 for (i = 0; i < num_of_ciphers; i++) {
681 c = ssl_method->get_cipher(i);
682 /* drop those that use any of that is not available */
683 if (c == NULL || !c->valid)
685 if ((c->algorithm_mkey & disabled_mkey) ||
686 (c->algorithm_auth & disabled_auth) ||
687 (c->algorithm_enc & disabled_enc) ||
688 (c->algorithm_mac & disabled_mac))
690 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
693 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
697 co_list[co_list_num].cipher = c;
698 co_list[co_list_num].next = NULL;
699 co_list[co_list_num].prev = NULL;
700 co_list[co_list_num].active = 0;
705 * Prepare linked list from list entries
707 if (co_list_num > 0) {
708 co_list[0].prev = NULL;
710 if (co_list_num > 1) {
711 co_list[0].next = &co_list[1];
713 for (i = 1; i < co_list_num - 1; i++) {
714 co_list[i].prev = &co_list[i - 1];
715 co_list[i].next = &co_list[i + 1];
718 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
721 co_list[co_list_num - 1].next = NULL;
723 *head_p = &co_list[0];
724 *tail_p = &co_list[co_list_num - 1];
728 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
729 int num_of_group_aliases,
730 uint32_t disabled_mkey,
731 uint32_t disabled_auth,
732 uint32_t disabled_enc,
733 uint32_t disabled_mac,
736 CIPHER_ORDER *ciph_curr;
737 const SSL_CIPHER **ca_curr;
739 uint32_t mask_mkey = ~disabled_mkey;
740 uint32_t mask_auth = ~disabled_auth;
741 uint32_t mask_enc = ~disabled_enc;
742 uint32_t mask_mac = ~disabled_mac;
745 * First, add the real ciphers as already collected
749 while (ciph_curr != NULL) {
750 *ca_curr = ciph_curr->cipher;
752 ciph_curr = ciph_curr->next;
756 * Now we add the available ones from the cipher_aliases[] table.
757 * They represent either one or more algorithms, some of which
758 * in any affected category must be supported (set in enabled_mask),
759 * or represent a cipher strength value (will be added in any case because algorithms=0).
761 for (i = 0; i < num_of_group_aliases; i++) {
762 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
763 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
764 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
765 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
768 if ((algorithm_mkey & mask_mkey) == 0)
772 if ((algorithm_auth & mask_auth) == 0)
776 if ((algorithm_enc & mask_enc) == 0)
780 if ((algorithm_mac & mask_mac) == 0)
783 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
787 *ca_curr = NULL; /* end of list */
790 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
791 uint32_t alg_auth, uint32_t alg_enc,
792 uint32_t alg_mac, int min_tls,
793 uint32_t algo_strength, int rule,
794 int32_t strength_bits, CIPHER_ORDER **head_p,
795 CIPHER_ORDER **tail_p)
797 CIPHER_ORDER *head, *tail, *curr, *next, *last;
798 const SSL_CIPHER *cp;
801 OSSL_TRACE_BEGIN(TLS_CIPHER){
803 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
804 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
805 algo_strength, strength_bits);
808 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
809 reverse = 1; /* needed to maintain sorting between currently
833 next = reverse ? curr->prev : curr->next;
838 * Selection criteria is either the value of strength_bits
839 * or the algorithms used.
841 if (strength_bits >= 0) {
842 if (strength_bits != cp->strength_bits)
845 if (trc_out != NULL) {
848 "\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
849 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
850 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
853 if (cipher_id != 0 && (cipher_id != cp->id))
855 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
857 if (alg_auth && !(alg_auth & cp->algorithm_auth))
859 if (alg_enc && !(alg_enc & cp->algorithm_enc))
861 if (alg_mac && !(alg_mac & cp->algorithm_mac))
863 if (min_tls && (min_tls != cp->min_tls))
865 if ((algo_strength & SSL_STRONG_MASK)
866 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
868 if ((algo_strength & SSL_DEFAULT_MASK)
869 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
874 BIO_printf(trc_out, "Action = %d\n", rule);
876 /* add the cipher if it has not been added yet. */
877 if (rule == CIPHER_ADD) {
880 ll_append_tail(&head, curr, &tail);
884 /* Move the added cipher to this location */
885 else if (rule == CIPHER_ORD) {
888 ll_append_tail(&head, curr, &tail);
890 } else if (rule == CIPHER_DEL) {
894 * most recently deleted ciphersuites get best positions for
895 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
896 * in reverse to maintain the order)
898 ll_append_head(&head, curr, &tail);
901 } else if (rule == CIPHER_BUMP) {
903 ll_append_head(&head, curr, &tail);
904 } else if (rule == CIPHER_KILL) {
909 curr->prev->next = curr->next;
913 if (curr->next != NULL)
914 curr->next->prev = curr->prev;
915 if (curr->prev != NULL)
916 curr->prev->next = curr->next;
925 OSSL_TRACE_END(TLS_CIPHER);
928 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
929 CIPHER_ORDER **tail_p)
931 int32_t max_strength_bits;
936 * This routine sorts the ciphers with descending strength. The sorting
937 * must keep the pre-sorted sequence, so we apply the normal sorting
938 * routine as '+' movement to the end of the list.
940 max_strength_bits = 0;
942 while (curr != NULL) {
943 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
944 max_strength_bits = curr->cipher->strength_bits;
948 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
949 if (number_uses == NULL) {
950 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
955 * Now find the strength_bits values actually used
958 while (curr != NULL) {
960 number_uses[curr->cipher->strength_bits]++;
964 * Go through the list of used strength_bits values in descending
967 for (i = max_strength_bits; i >= 0; i--)
968 if (number_uses[i] > 0)
969 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
972 OPENSSL_free(number_uses);
976 static int ssl_cipher_process_rulestr(const char *rule_str,
977 CIPHER_ORDER **head_p,
978 CIPHER_ORDER **tail_p,
979 const SSL_CIPHER **ca_list, CERT *c)
981 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
984 int j, multi, found, rule, retval, ok, buflen;
985 uint32_t cipher_id = 0;
998 } else if (ch == '+') {
1001 } else if (ch == '!') {
1004 } else if (ch == '@') {
1005 rule = CIPHER_SPECIAL;
1027 #ifndef CHARSET_EBCDIC
1028 while (((ch >= 'A') && (ch <= 'Z')) ||
1029 ((ch >= '0') && (ch <= '9')) ||
1030 ((ch >= 'a') && (ch <= 'z')) ||
1031 (ch == '-') || (ch == '.') || (ch == '='))
1033 while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1043 * We hit something we cannot deal with,
1044 * it is no command or separator nor
1045 * alphanumeric, so we call this an error.
1047 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_COMMAND);
1053 if (rule == CIPHER_SPECIAL) {
1054 found = 0; /* unused -- avoid compiler warning */
1055 break; /* special treatment */
1058 /* check for multi-part specification */
1067 * Now search for the cipher alias in the ca_list. Be careful
1068 * with the strncmp, because the "buflen" limitation
1069 * will make the rule "ADH:SOME" and the cipher
1070 * "ADH-MY-CIPHER" look like a match for buflen=3.
1071 * So additionally check whether the cipher name found
1072 * has the correct length. We can save a strlen() call:
1073 * just checking for the '\0' at the right place is
1074 * sufficient, we have to strncmp() anyway. (We cannot
1075 * use strcmp(), because buf is not '\0' terminated.)
1079 while (ca_list[j]) {
1080 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1081 && (ca_list[j]->name[buflen] == '\0')) {
1089 break; /* ignore this entry */
1091 if (ca_list[j]->algorithm_mkey) {
1093 alg_mkey &= ca_list[j]->algorithm_mkey;
1099 alg_mkey = ca_list[j]->algorithm_mkey;
1103 if (ca_list[j]->algorithm_auth) {
1105 alg_auth &= ca_list[j]->algorithm_auth;
1111 alg_auth = ca_list[j]->algorithm_auth;
1115 if (ca_list[j]->algorithm_enc) {
1117 alg_enc &= ca_list[j]->algorithm_enc;
1123 alg_enc = ca_list[j]->algorithm_enc;
1127 if (ca_list[j]->algorithm_mac) {
1129 alg_mac &= ca_list[j]->algorithm_mac;
1135 alg_mac = ca_list[j]->algorithm_mac;
1139 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1140 if (algo_strength & SSL_STRONG_MASK) {
1142 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1144 if (!(algo_strength & SSL_STRONG_MASK)) {
1149 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1153 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1154 if (algo_strength & SSL_DEFAULT_MASK) {
1156 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1158 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1164 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 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_COMMAND);
1207 c->sec_level = level;
1211 ERR_raise(ERR_LIB_SSL, 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;
1264 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1266 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1267 ERR_raise(ERR_LIB_SSL, 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 ERR_raise(ERR_LIB_SSL, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1294 static int ciphersuite_cb(const char *elem, int len, void *arg)
1296 STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
1297 const SSL_CIPHER *cipher;
1298 /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
1301 if (len > (int)(sizeof(name) - 1)) {
1302 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CIPHER_MATCH);
1306 memcpy(name, elem, len);
1309 cipher = ssl3_get_cipher_by_std_name(name);
1310 if (cipher == NULL) {
1311 ERR_raise(ERR_LIB_SSL, SSL_R_NO_CIPHER_MATCH);
1315 if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
1316 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
1323 static __owur int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
1325 STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
1327 if (newciphers == NULL)
1330 /* Parse the list. We explicitly allow an empty list */
1332 && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
1333 sk_SSL_CIPHER_free(newciphers);
1336 sk_SSL_CIPHER_free(*currciphers);
1337 *currciphers = newciphers;
1342 static int update_cipher_list_by_id(STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1343 STACK_OF(SSL_CIPHER) *cipherstack)
1345 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1347 if (tmp_cipher_list == NULL) {
1351 sk_SSL_CIPHER_free(*cipher_list_by_id);
1352 *cipher_list_by_id = tmp_cipher_list;
1354 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1355 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1360 static int update_cipher_list(STACK_OF(SSL_CIPHER) **cipher_list,
1361 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1362 STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
1365 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(*cipher_list);
1367 if (tmp_cipher_list == NULL)
1371 * Delete any existing TLSv1.3 ciphersuites. These are always first in the
1374 while (sk_SSL_CIPHER_num(tmp_cipher_list) > 0
1375 && sk_SSL_CIPHER_value(tmp_cipher_list, 0)->min_tls
1377 (void)sk_SSL_CIPHER_delete(tmp_cipher_list, 0);
1379 /* Insert the new TLSv1.3 ciphersuites */
1380 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
1381 sk_SSL_CIPHER_insert(tmp_cipher_list,
1382 sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
1384 if (!update_cipher_list_by_id(cipher_list_by_id, tmp_cipher_list))
1387 sk_SSL_CIPHER_free(*cipher_list);
1388 *cipher_list = tmp_cipher_list;
1393 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
1395 int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
1397 if (ret && ctx->cipher_list != NULL)
1398 return update_cipher_list(&ctx->cipher_list, &ctx->cipher_list_by_id,
1399 ctx->tls13_ciphersuites);
1404 int SSL_set_ciphersuites(SSL *s, const char *str)
1406 STACK_OF(SSL_CIPHER) *cipher_list;
1407 int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
1409 if (s->cipher_list == NULL) {
1410 if ((cipher_list = SSL_get_ciphers(s)) != NULL)
1411 s->cipher_list = sk_SSL_CIPHER_dup(cipher_list);
1413 if (ret && s->cipher_list != NULL)
1414 return update_cipher_list(&s->cipher_list, &s->cipher_list_by_id,
1415 s->tls13_ciphersuites);
1420 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
1421 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
1422 STACK_OF(SSL_CIPHER) **cipher_list,
1423 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1424 const char *rule_str,
1427 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases, i;
1428 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1429 STACK_OF(SSL_CIPHER) *cipherstack;
1431 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1432 const SSL_CIPHER **ca_list = NULL;
1435 * Return with error if nothing to do.
1437 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1439 #ifndef OPENSSL_NO_EC
1440 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1445 * To reduce the work to do we only want to process the compiled
1446 * in algorithms, so we first get the mask of disabled ciphers.
1449 disabled_mkey = disabled_mkey_mask;
1450 disabled_auth = disabled_auth_mask;
1451 disabled_enc = disabled_enc_mask;
1452 disabled_mac = disabled_mac_mask;
1455 * Now we have to collect the available ciphers from the compiled
1456 * in ciphers. We cannot get more than the number compiled in, so
1457 * it is used for allocation.
1459 num_of_ciphers = ssl_method->num_ciphers();
1461 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1462 if (co_list == NULL) {
1463 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1464 return NULL; /* Failure */
1467 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1468 disabled_mkey, disabled_auth, disabled_enc,
1469 disabled_mac, co_list, &head, &tail);
1471 /* Now arrange all ciphers by preference. */
1474 * Everything else being equal, prefer ephemeral ECDH over other key
1475 * exchange mechanisms.
1476 * For consistency, prefer ECDSA over RSA (though this only matters if the
1477 * server has both certificates, and is using the DEFAULT, or a client
1480 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1482 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1484 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1487 /* Within each strength group, we prefer GCM over CHACHA... */
1488 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1490 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1494 * ...and generally, our preferred cipher is AES.
1495 * Note that AEADs will be bumped to take preference after sorting by
1498 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1501 /* Temporarily enable everything else for sorting */
1502 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1504 /* Low priority for MD5 */
1505 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1509 * Move anonymous ciphers to the end. Usually, these will remain
1510 * disabled. (For applications that allow them, they aren't too bad, but
1511 * we prefer authenticated ciphers.)
1513 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1516 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1518 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1521 /* RC4 is sort-of broken -- move to the end */
1522 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1526 * Now sort by symmetric encryption strength. The above ordering remains
1527 * in force within each class
1529 if (!ssl_cipher_strength_sort(&head, &tail)) {
1530 OPENSSL_free(co_list);
1535 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1536 * TODO(openssl-team): is there an easier way to accomplish all this?
1538 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1542 * Irrespective of strength, enforce the following order:
1543 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1544 * Within each group, ciphers remain sorted by strength and previous
1549 * 4) TLS 1.2 > legacy
1551 * Because we now bump ciphers to the top of the list, we proceed in
1552 * reverse order of preference.
1554 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1556 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1557 CIPHER_BUMP, -1, &head, &tail);
1558 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1559 CIPHER_BUMP, -1, &head, &tail);
1561 /* Now disable everything (maintaining the ordering!) */
1562 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1565 * We also need cipher aliases for selecting based on the rule_str.
1566 * There might be two types of entries in the rule_str: 1) names
1567 * of ciphers themselves 2) aliases for groups of ciphers.
1568 * For 1) we need the available ciphers and for 2) the cipher
1569 * groups of cipher_aliases added together in one list (otherwise
1570 * we would be happy with just the cipher_aliases table).
1572 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1573 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1574 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1575 if (ca_list == NULL) {
1576 OPENSSL_free(co_list);
1577 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1578 return NULL; /* Failure */
1580 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1581 disabled_mkey, disabled_auth, disabled_enc,
1582 disabled_mac, head);
1585 * If the rule_string begins with DEFAULT, apply the default rule
1586 * before using the (possibly available) additional rules.
1590 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1591 ok = ssl_cipher_process_rulestr(OSSL_default_cipher_list(),
1592 &head, &tail, ca_list, c);
1598 if (ok && (rule_p[0] != '\0'))
1599 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1601 OPENSSL_free(ca_list); /* Not needed anymore */
1603 if (!ok) { /* Rule processing failure */
1604 OPENSSL_free(co_list);
1609 * Allocate new "cipherstack" for the result, return with error
1610 * if we cannot get one.
1612 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1613 OPENSSL_free(co_list);
1617 /* Add TLSv1.3 ciphers first - we always prefer those if possible */
1618 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++) {
1619 const SSL_CIPHER *sslc = sk_SSL_CIPHER_value(tls13_ciphersuites, i);
1621 /* Don't include any TLSv1.3 ciphers that are disabled */
1622 if ((sslc->algorithm_enc & disabled_enc) != 0
1623 || (ssl_cipher_table_mac[sslc->algorithm2
1624 & SSL_HANDSHAKE_MAC_MASK].mask
1625 & disabled_mac_mask) != 0)
1628 if (!sk_SSL_CIPHER_push(cipherstack, sslc)) {
1629 sk_SSL_CIPHER_free(cipherstack);
1634 OSSL_TRACE_BEGIN(TLS_CIPHER) {
1635 BIO_printf(trc_out, "cipher selection:\n");
1638 * The cipher selection for the list is done. The ciphers are added
1639 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1641 for (curr = head; curr != NULL; curr = curr->next) {
1643 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1644 OPENSSL_free(co_list);
1645 sk_SSL_CIPHER_free(cipherstack);
1646 OSSL_TRACE_CANCEL(TLS_CIPHER);
1649 if (trc_out != NULL)
1650 BIO_printf(trc_out, "<%s>\n", curr->cipher->name);
1653 OPENSSL_free(co_list); /* Not needed any longer */
1654 OSSL_TRACE_END(TLS_CIPHER);
1656 if (!update_cipher_list_by_id(cipher_list_by_id, cipherstack)) {
1657 sk_SSL_CIPHER_free(cipherstack);
1660 sk_SSL_CIPHER_free(*cipher_list);
1661 *cipher_list = cipherstack;
1666 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1669 const char *kx, *au, *enc, *mac;
1670 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1671 static const char *format = "%-30s %-7s Kx=%-8s Au=%-5s Enc=%-9s Mac=%-4s\n";
1675 if ((buf = OPENSSL_malloc(len)) == NULL) {
1676 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1679 } else if (len < 128) {
1683 alg_mkey = cipher->algorithm_mkey;
1684 alg_auth = cipher->algorithm_auth;
1685 alg_enc = cipher->algorithm_enc;
1686 alg_mac = cipher->algorithm_mac;
1688 ver = ssl_protocol_to_string(cipher->min_tls);
1750 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1751 case (SSL_aGOST12 | SSL_aGOST01):
1788 enc = "AESGCM(128)";
1791 enc = "AESGCM(256)";
1794 enc = "AESCCM(128)";
1797 enc = "AESCCM(256)";
1799 case SSL_AES128CCM8:
1800 enc = "AESCCM8(128)";
1802 case SSL_AES256CCM8:
1803 enc = "AESCCM8(256)";
1805 case SSL_CAMELLIA128:
1806 enc = "Camellia(128)";
1808 case SSL_CAMELLIA256:
1809 enc = "Camellia(256)";
1811 case SSL_ARIA128GCM:
1812 enc = "ARIAGCM(128)";
1814 case SSL_ARIA256GCM:
1815 enc = "ARIAGCM(256)";
1820 case SSL_eGOST2814789CNT:
1821 case SSL_eGOST2814789CNT12:
1822 enc = "GOST89(256)";
1827 case SSL_KUZNYECHIK:
1830 case SSL_CHACHA20POLY1305:
1831 enc = "CHACHA20/POLY1305(256)";
1855 case SSL_GOST89MAC12:
1861 case SSL_GOST12_256:
1862 case SSL_GOST12_512:
1870 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1875 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1881 * Backwards-compatibility crutch. In almost all contexts we report TLS
1882 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1884 if (c->min_tls == TLS1_VERSION)
1886 return ssl_protocol_to_string(c->min_tls);
1889 /* return the actual cipher being used */
1890 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1897 /* return the actual cipher being used in RFC standard name */
1898 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1905 /* return the OpenSSL name based on given RFC standard name */
1906 const char *OPENSSL_cipher_name(const char *stdname)
1908 const SSL_CIPHER *c;
1910 if (stdname == NULL)
1912 c = ssl3_get_cipher_by_std_name(stdname);
1913 return SSL_CIPHER_get_name(c);
1916 /* number of bits for symmetric cipher */
1917 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1922 if (alg_bits != NULL)
1923 *alg_bits = (int)c->alg_bits;
1924 ret = (int)c->strength_bits;
1929 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1934 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1936 return c->id & 0xFFFF;
1939 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1944 if ((n == 0) || (sk == NULL))
1946 nn = sk_SSL_COMP_num(sk);
1947 for (i = 0; i < nn; i++) {
1948 ctmp = sk_SSL_COMP_value(sk, i);
1955 #ifdef OPENSSL_NO_COMP
1956 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1961 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1967 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1973 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1975 load_builtin_compressions();
1976 return ssl_comp_methods;
1979 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1982 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1983 ssl_comp_methods = meths;
1987 static void cmeth_free(SSL_COMP *cm)
1992 void ssl_comp_free_compression_methods_int(void)
1994 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1995 ssl_comp_methods = NULL;
1996 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1999 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
2003 if (cm == NULL || COMP_get_type(cm) == NID_undef)
2007 * According to draft-ietf-tls-compression-04.txt, the
2008 * compression number ranges should be the following:
2010 * 0 to 63: methods defined by the IETF
2011 * 64 to 192: external party methods assigned by IANA
2012 * 193 to 255: reserved for private use
2014 if (id < 193 || id > 255) {
2015 ERR_raise(ERR_LIB_SSL, SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
2019 comp = OPENSSL_malloc(sizeof(*comp));
2021 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
2027 load_builtin_compressions();
2028 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
2030 ERR_raise(ERR_LIB_SSL, SSL_R_DUPLICATE_COMPRESSION_ID);
2033 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
2035 ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
2042 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
2044 #ifndef OPENSSL_NO_COMP
2045 return comp ? COMP_get_name(comp) : NULL;
2051 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
2053 #ifndef OPENSSL_NO_COMP
2060 int SSL_COMP_get_id(const SSL_COMP *comp)
2062 #ifndef OPENSSL_NO_COMP
2069 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
2072 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
2074 if (c == NULL || (!all && c->valid == 0))
2079 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
2081 return ssl->method->get_cipher_by_char(ptr);
2084 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2089 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2092 return ssl_cipher_table_cipher[i].nid;
2095 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2097 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2101 return ssl_cipher_table_mac[i].nid;
2104 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2106 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2110 return ssl_cipher_table_kx[i].nid;
2113 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2115 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2119 return ssl_cipher_table_auth[i].nid;
2122 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
2124 int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
2126 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
2128 return EVP_get_digestbynid(ssl_cipher_table_mac[idx].nid);
2131 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2133 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
2136 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2137 size_t *int_overhead, size_t *blocksize,
2138 size_t *ext_overhead)
2140 size_t mac = 0, in = 0, blk = 0, out = 0;
2142 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
2143 * because there are no handy #defines for those. */
2144 if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
2145 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
2146 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
2147 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
2148 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
2149 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
2150 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
2152 } else if (c->algorithm_mac & SSL_AEAD) {
2153 /* We're supposed to have handled all the AEAD modes above */
2156 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
2157 int digest_nid = SSL_CIPHER_get_digest_nid(c);
2158 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2163 mac = EVP_MD_size(e_md);
2164 if (c->algorithm_enc != SSL_eNULL) {
2165 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2166 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2168 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2169 known CBC cipher. */
2170 if (e_ciph == NULL ||
2171 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2174 in = 1; /* padding length byte */
2175 out = EVP_CIPHER_iv_length(e_ciph);
2176 blk = EVP_CIPHER_block_size(e_ciph);
2180 *mac_overhead = mac;
2183 *ext_overhead = out;
2188 int ssl_cert_is_disabled(size_t idx)
2190 const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2192 if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)
2198 * Default list of TLSv1.2 (and earlier) ciphers
2199 * SSL_DEFAULT_CIPHER_LIST deprecated in 3.0.0
2200 * Update both macro and function simultaneously
2202 const char *OSSL_default_cipher_list(void)
2204 return "ALL:!COMPLEMENTOFDEFAULT:!eNULL";
2208 * Default list of TLSv1.3 (and later) ciphers
2209 * TLS_DEFAULT_CIPHERSUITES deprecated in 3.0.0
2210 * Update both macro and function simultaneously
2212 const char *OSSL_default_ciphersuites(void)
2214 return "TLS_AES_256_GCM_SHA384:"
2215 #if !defined(OPENSSL_NO_CHACHA) && !defined(OPENSSL_NO_POLY1305)
2216 "TLS_CHACHA20_POLY1305_SHA256:"
2218 "TLS_AES_128_GCM_SHA256";