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 DEFINE_STACK_OF(SSL_COMP)
26 DEFINE_STACK_OF_CONST(SSL_CIPHER)
28 /* NB: make sure indices in these tables match values above */
35 /* Table of NIDs for each cipher */
36 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
37 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
38 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
39 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
40 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
41 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
42 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
43 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
44 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
45 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
46 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
47 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
48 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
49 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
50 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
51 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
52 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
53 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
54 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
55 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX 18 */
56 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305}, /* SSL_ENC_CHACHA_IDX 19 */
57 {SSL_ARIA128GCM, NID_aria_128_gcm}, /* SSL_ENC_ARIA128GCM_IDX 20 */
58 {SSL_ARIA256GCM, NID_aria_256_gcm}, /* SSL_ENC_ARIA256GCM_IDX 21 */
61 #define SSL_COMP_NULL_IDX 0
62 #define SSL_COMP_ZLIB_IDX 1
63 #define SSL_COMP_NUM_IDX 2
65 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
67 #ifndef OPENSSL_NO_COMP
68 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
71 /* NB: make sure indices in this table matches values above */
72 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
73 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
74 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
75 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
76 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
77 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
78 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
79 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
80 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
81 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
82 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
83 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
84 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
88 static const ssl_cipher_table ssl_cipher_table_kx[] = {
89 {SSL_kRSA, NID_kx_rsa},
90 {SSL_kECDHE, NID_kx_ecdhe},
91 {SSL_kDHE, NID_kx_dhe},
92 {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
93 {SSL_kDHEPSK, NID_kx_dhe_psk},
94 {SSL_kRSAPSK, NID_kx_rsa_psk},
95 {SSL_kPSK, NID_kx_psk},
96 {SSL_kSRP, NID_kx_srp},
97 {SSL_kGOST, NID_kx_gost},
98 {SSL_kANY, NID_kx_any}
101 static const ssl_cipher_table ssl_cipher_table_auth[] = {
102 {SSL_aRSA, NID_auth_rsa},
103 {SSL_aECDSA, NID_auth_ecdsa},
104 {SSL_aPSK, NID_auth_psk},
105 {SSL_aDSS, NID_auth_dss},
106 {SSL_aGOST01, NID_auth_gost01},
107 {SSL_aGOST12, NID_auth_gost12},
108 {SSL_aSRP, NID_auth_srp},
109 {SSL_aNULL, NID_auth_null},
110 {SSL_aANY, NID_auth_any}
114 /* Utility function for table lookup */
115 static int ssl_cipher_info_find(const ssl_cipher_table * table,
116 size_t table_cnt, uint32_t mask)
119 for (i = 0; i < table_cnt; i++, table++) {
120 if (table->mask == mask)
126 #define ssl_cipher_info_lookup(table, x) \
127 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
130 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
131 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
134 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
135 /* MD5, SHA, GOST94, MAC89 */
136 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
137 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
138 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
141 /* MD5/SHA1, SHA224, SHA512 */
142 NID_undef, NID_undef, NID_undef
146 #define CIPHER_KILL 2
149 #define CIPHER_SPECIAL 5
151 * Bump the ciphers to the top of the list.
152 * This rule isn't currently supported by the public cipherstring API.
154 #define CIPHER_BUMP 6
156 typedef struct cipher_order_st {
157 const SSL_CIPHER *cipher;
160 struct cipher_order_st *next, *prev;
163 static const SSL_CIPHER cipher_aliases[] = {
164 /* "ALL" doesn't include eNULL (must be specifically enabled) */
165 {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
166 /* "COMPLEMENTOFALL" */
167 {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
170 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
173 {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
176 * key exchange aliases (some of those using only a single bit here
177 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
178 * combines DHE_DSS and DHE_RSA)
180 {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
182 {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
183 {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
184 {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
186 {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
187 {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
188 {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
190 {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
191 {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
192 {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
193 {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
194 {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
195 {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
197 /* server authentication aliases */
198 {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
199 {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
200 {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
201 {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
202 {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
203 {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
204 {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
205 {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
206 {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
207 {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
208 {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
210 /* aliases combining key exchange and server authentication */
211 {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
212 {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
213 {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
214 {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
215 {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
216 {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
217 {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
218 {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
219 {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
220 {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
222 /* symmetric encryption aliases */
223 {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
224 {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
225 {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
226 {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
227 {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
228 {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
229 {0, SSL_TXT_GOST, NULL, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
230 {0, SSL_TXT_AES128, NULL, 0, 0, 0,
231 SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
232 {0, SSL_TXT_AES256, NULL, 0, 0, 0,
233 SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
234 {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
235 {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
236 {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
237 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
238 {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
239 {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
240 {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
241 {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
242 {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
243 {0, SSL_TXT_GOST2012_GOST8912_GOST8912, NULL, 0, 0, 0, SSL_eGOST2814789CNT12},
245 {0, SSL_TXT_ARIA, NULL, 0, 0, 0, SSL_ARIA},
246 {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
247 {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
248 {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
251 {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
252 {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
253 {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
254 {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
255 {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
256 {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
257 {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
258 {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
260 /* protocol version aliases */
261 {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
262 {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
263 {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
264 {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
266 /* strength classes */
267 {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
268 {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
269 {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
270 /* FIPS 140-2 approved ciphersuite */
271 {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
273 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
274 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
275 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
276 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
277 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
282 * Search for public key algorithm with given name and return its pkey_id if
283 * it is available. Otherwise return 0
285 #ifdef OPENSSL_NO_ENGINE
287 static int get_optional_pkey_id(const char *pkey_name)
289 const EVP_PKEY_ASN1_METHOD *ameth;
291 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
292 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
300 static int get_optional_pkey_id(const char *pkey_name)
302 const EVP_PKEY_ASN1_METHOD *ameth;
303 ENGINE *tmpeng = NULL;
305 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
307 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
311 ENGINE_finish(tmpeng);
317 /* masks of disabled algorithms */
318 static uint32_t disabled_enc_mask;
319 static uint32_t disabled_mac_mask;
320 static uint32_t disabled_mkey_mask;
321 static uint32_t disabled_auth_mask;
323 int ssl_load_ciphers(SSL_CTX *ctx)
326 const ssl_cipher_table *t;
328 disabled_enc_mask = 0;
329 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
330 if (t->nid != NID_undef) {
331 const EVP_CIPHER *cipher
332 = ssl_evp_cipher_fetch(ctx->libctx, t->nid, ctx->propq);
334 ctx->ssl_cipher_methods[i] = cipher;
336 disabled_enc_mask |= t->mask;
339 disabled_mac_mask = 0;
340 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
342 = ssl_evp_md_fetch(ctx->libctx, t->nid, ctx->propq);
344 ctx->ssl_digest_methods[i] = md;
346 disabled_mac_mask |= t->mask;
348 int tmpsize = EVP_MD_size(md);
349 if (!ossl_assert(tmpsize >= 0))
351 ctx->ssl_mac_secret_size[i] = tmpsize;
355 disabled_mkey_mask = 0;
356 disabled_auth_mask = 0;
358 #ifdef OPENSSL_NO_RSA
359 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
360 disabled_auth_mask |= SSL_aRSA;
362 #ifdef OPENSSL_NO_DSA
363 disabled_auth_mask |= SSL_aDSS;
366 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
369 disabled_mkey_mask |= SSL_kECDHE | SSL_kECDHEPSK;
370 disabled_auth_mask |= SSL_aECDSA;
372 #ifdef OPENSSL_NO_PSK
373 disabled_mkey_mask |= SSL_PSK;
374 disabled_auth_mask |= SSL_aPSK;
376 #ifdef OPENSSL_NO_SRP
377 disabled_mkey_mask |= SSL_kSRP;
381 * Check for presence of GOST 34.10 algorithms, and if they are not
382 * present, disable appropriate auth and key exchange
384 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
385 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
386 ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
388 disabled_mac_mask |= SSL_GOST89MAC;
390 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
391 get_optional_pkey_id("gost-mac-12");
392 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
393 ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
395 disabled_mac_mask |= SSL_GOST89MAC12;
397 if (!get_optional_pkey_id("gost2001"))
398 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
399 if (!get_optional_pkey_id("gost2012_256"))
400 disabled_auth_mask |= SSL_aGOST12;
401 if (!get_optional_pkey_id("gost2012_512"))
402 disabled_auth_mask |= SSL_aGOST12;
404 * Disable GOST key exchange if no GOST signature algs are available *
406 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
407 (SSL_aGOST01 | SSL_aGOST12))
408 disabled_mkey_mask |= SSL_kGOST;
413 #ifndef OPENSSL_NO_COMP
415 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
417 return ((*a)->id - (*b)->id);
420 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
422 SSL_COMP *comp = NULL;
423 COMP_METHOD *method = COMP_zlib();
425 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
427 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
428 comp = OPENSSL_malloc(sizeof(*comp));
430 comp->method = method;
431 comp->id = SSL_COMP_ZLIB_IDX;
432 comp->name = COMP_get_name(method);
433 sk_SSL_COMP_push(ssl_comp_methods, comp);
434 sk_SSL_COMP_sort(ssl_comp_methods);
440 static int load_builtin_compressions(void)
442 return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
446 int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
447 const EVP_CIPHER **enc)
449 int i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, sslc->algorithm_enc);
454 if (i == SSL_ENC_NULL_IDX) {
456 * We assume we don't care about this coming from an ENGINE so
457 * just do a normal EVP_CIPHER_fetch instead of
458 * ssl_evp_cipher_fetch()
460 *enc = EVP_CIPHER_fetch(ctx->libctx, "NULL", ctx->propq);
464 const EVP_CIPHER *cipher = ctx->ssl_cipher_methods[i];
467 || !ssl_evp_cipher_up_ref(cipher))
469 *enc = ctx->ssl_cipher_methods[i];
475 int ssl_cipher_get_evp(SSL_CTX *ctx, const SSL_SESSION *s,
476 const EVP_CIPHER **enc, const EVP_MD **md,
477 int *mac_pkey_type, size_t *mac_secret_size,
478 SSL_COMP **comp, int use_etm)
488 #ifndef OPENSSL_NO_COMP
489 if (!load_builtin_compressions()) {
491 * Currently don't care, since a failure only means that
492 * ssl_comp_methods is NULL, which is perfectly OK
497 ctmp.id = s->compress_meth;
498 if (ssl_comp_methods != NULL) {
499 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
500 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
502 /* If were only interested in comp then return success */
503 if ((enc == NULL) && (md == NULL))
507 if ((enc == NULL) || (md == NULL))
510 if (!ssl_cipher_get_evp_cipher(ctx, c, enc))
513 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
516 if (mac_pkey_type != NULL)
517 *mac_pkey_type = NID_undef;
518 if (mac_secret_size != NULL)
519 *mac_secret_size = 0;
520 if (c->algorithm_mac == SSL_AEAD)
521 mac_pkey_type = NULL;
523 if (!ssl_evp_md_up_ref(ctx->ssl_digest_methods[i])) {
524 ssl_evp_cipher_free(*enc);
527 *md = ctx->ssl_digest_methods[i];
528 if (mac_pkey_type != NULL)
529 *mac_pkey_type = ssl_mac_pkey_id[i];
530 if (mac_secret_size != NULL)
531 *mac_secret_size = ctx->ssl_mac_secret_size[i];
534 if ((*enc != NULL) &&
535 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
536 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
537 const EVP_CIPHER *evp = NULL;
540 || s->ssl_version >> 8 != TLS1_VERSION_MAJOR
541 || s->ssl_version < TLS1_VERSION)
544 if (c->algorithm_enc == SSL_RC4
545 && c->algorithm_mac == SSL_MD5)
546 evp = ssl_evp_cipher_fetch(ctx->libctx, NID_rc4_hmac_md5,
548 else if (c->algorithm_enc == SSL_AES128
549 && c->algorithm_mac == SSL_SHA1)
550 evp = ssl_evp_cipher_fetch(ctx->libctx,
551 NID_aes_128_cbc_hmac_sha1,
553 else if (c->algorithm_enc == SSL_AES256
554 && c->algorithm_mac == SSL_SHA1)
555 evp = ssl_evp_cipher_fetch(ctx->libctx,
556 NID_aes_256_cbc_hmac_sha1,
558 else if (c->algorithm_enc == SSL_AES128
559 && c->algorithm_mac == SSL_SHA256)
560 evp = ssl_evp_cipher_fetch(ctx->libctx,
561 NID_aes_128_cbc_hmac_sha256,
563 else if (c->algorithm_enc == SSL_AES256
564 && c->algorithm_mac == SSL_SHA256)
565 evp = ssl_evp_cipher_fetch(ctx->libctx,
566 NID_aes_256_cbc_hmac_sha256,
570 ssl_evp_cipher_free(*enc);
571 ssl_evp_md_free(*md);
581 const EVP_MD *ssl_md(SSL_CTX *ctx, int idx)
583 idx &= SSL_HANDSHAKE_MAC_MASK;
584 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
586 return ctx->ssl_digest_methods[idx];
589 const EVP_MD *ssl_handshake_md(SSL *s)
591 return ssl_md(s->ctx, ssl_get_algorithm2(s));
594 const EVP_MD *ssl_prf_md(SSL *s)
596 return ssl_md(s->ctx, ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
599 #define ITEM_SEP(a) \
600 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
602 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
609 if (curr->prev != NULL)
610 curr->prev->next = curr->next;
611 if (curr->next != NULL)
612 curr->next->prev = curr->prev;
613 (*tail)->next = curr;
619 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
626 if (curr->next != NULL)
627 curr->next->prev = curr->prev;
628 if (curr->prev != NULL)
629 curr->prev->next = curr->next;
630 (*head)->prev = curr;
636 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
638 uint32_t disabled_mkey,
639 uint32_t disabled_auth,
640 uint32_t disabled_enc,
641 uint32_t disabled_mac,
642 CIPHER_ORDER *co_list,
643 CIPHER_ORDER **head_p,
644 CIPHER_ORDER **tail_p)
650 * We have num_of_ciphers descriptions compiled in, depending on the
651 * method selected (SSLv3, TLSv1 etc).
652 * These will later be sorted in a linked list with at most num
656 /* Get the initial list of ciphers */
657 co_list_num = 0; /* actual count of ciphers */
658 for (i = 0; i < num_of_ciphers; i++) {
659 c = ssl_method->get_cipher(i);
660 /* drop those that use any of that is not available */
661 if (c == NULL || !c->valid)
663 if ((c->algorithm_mkey & disabled_mkey) ||
664 (c->algorithm_auth & disabled_auth) ||
665 (c->algorithm_enc & disabled_enc) ||
666 (c->algorithm_mac & disabled_mac))
668 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
671 if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
675 co_list[co_list_num].cipher = c;
676 co_list[co_list_num].next = NULL;
677 co_list[co_list_num].prev = NULL;
678 co_list[co_list_num].active = 0;
683 * Prepare linked list from list entries
685 if (co_list_num > 0) {
686 co_list[0].prev = NULL;
688 if (co_list_num > 1) {
689 co_list[0].next = &co_list[1];
691 for (i = 1; i < co_list_num - 1; i++) {
692 co_list[i].prev = &co_list[i - 1];
693 co_list[i].next = &co_list[i + 1];
696 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
699 co_list[co_list_num - 1].next = NULL;
701 *head_p = &co_list[0];
702 *tail_p = &co_list[co_list_num - 1];
706 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
707 int num_of_group_aliases,
708 uint32_t disabled_mkey,
709 uint32_t disabled_auth,
710 uint32_t disabled_enc,
711 uint32_t disabled_mac,
714 CIPHER_ORDER *ciph_curr;
715 const SSL_CIPHER **ca_curr;
717 uint32_t mask_mkey = ~disabled_mkey;
718 uint32_t mask_auth = ~disabled_auth;
719 uint32_t mask_enc = ~disabled_enc;
720 uint32_t mask_mac = ~disabled_mac;
723 * First, add the real ciphers as already collected
727 while (ciph_curr != NULL) {
728 *ca_curr = ciph_curr->cipher;
730 ciph_curr = ciph_curr->next;
734 * Now we add the available ones from the cipher_aliases[] table.
735 * They represent either one or more algorithms, some of which
736 * in any affected category must be supported (set in enabled_mask),
737 * or represent a cipher strength value (will be added in any case because algorithms=0).
739 for (i = 0; i < num_of_group_aliases; i++) {
740 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
741 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
742 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
743 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
746 if ((algorithm_mkey & mask_mkey) == 0)
750 if ((algorithm_auth & mask_auth) == 0)
754 if ((algorithm_enc & mask_enc) == 0)
758 if ((algorithm_mac & mask_mac) == 0)
761 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
765 *ca_curr = NULL; /* end of list */
768 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
769 uint32_t alg_auth, uint32_t alg_enc,
770 uint32_t alg_mac, int min_tls,
771 uint32_t algo_strength, int rule,
772 int32_t strength_bits, CIPHER_ORDER **head_p,
773 CIPHER_ORDER **tail_p)
775 CIPHER_ORDER *head, *tail, *curr, *next, *last;
776 const SSL_CIPHER *cp;
779 OSSL_TRACE_BEGIN(TLS_CIPHER){
781 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
782 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
783 algo_strength, strength_bits);
786 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
787 reverse = 1; /* needed to maintain sorting between currently
811 next = reverse ? curr->prev : curr->next;
816 * Selection criteria is either the value of strength_bits
817 * or the algorithms used.
819 if (strength_bits >= 0) {
820 if (strength_bits != cp->strength_bits)
823 if (trc_out != NULL) {
826 "\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
827 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
828 cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
831 if (cipher_id != 0 && (cipher_id != cp->id))
833 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
835 if (alg_auth && !(alg_auth & cp->algorithm_auth))
837 if (alg_enc && !(alg_enc & cp->algorithm_enc))
839 if (alg_mac && !(alg_mac & cp->algorithm_mac))
841 if (min_tls && (min_tls != cp->min_tls))
843 if ((algo_strength & SSL_STRONG_MASK)
844 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
846 if ((algo_strength & SSL_DEFAULT_MASK)
847 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
852 BIO_printf(trc_out, "Action = %d\n", rule);
854 /* add the cipher if it has not been added yet. */
855 if (rule == CIPHER_ADD) {
858 ll_append_tail(&head, curr, &tail);
862 /* Move the added cipher to this location */
863 else if (rule == CIPHER_ORD) {
866 ll_append_tail(&head, curr, &tail);
868 } else if (rule == CIPHER_DEL) {
872 * most recently deleted ciphersuites get best positions for
873 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
874 * in reverse to maintain the order)
876 ll_append_head(&head, curr, &tail);
879 } else if (rule == CIPHER_BUMP) {
881 ll_append_head(&head, curr, &tail);
882 } else if (rule == CIPHER_KILL) {
887 curr->prev->next = curr->next;
891 if (curr->next != NULL)
892 curr->next->prev = curr->prev;
893 if (curr->prev != NULL)
894 curr->prev->next = curr->next;
903 OSSL_TRACE_END(TLS_CIPHER);
906 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
907 CIPHER_ORDER **tail_p)
909 int32_t max_strength_bits;
914 * This routine sorts the ciphers with descending strength. The sorting
915 * must keep the pre-sorted sequence, so we apply the normal sorting
916 * routine as '+' movement to the end of the list.
918 max_strength_bits = 0;
920 while (curr != NULL) {
921 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
922 max_strength_bits = curr->cipher->strength_bits;
926 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
927 if (number_uses == NULL) {
928 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
933 * Now find the strength_bits values actually used
936 while (curr != NULL) {
938 number_uses[curr->cipher->strength_bits]++;
942 * Go through the list of used strength_bits values in descending
945 for (i = max_strength_bits; i >= 0; i--)
946 if (number_uses[i] > 0)
947 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
950 OPENSSL_free(number_uses);
954 static int ssl_cipher_process_rulestr(const char *rule_str,
955 CIPHER_ORDER **head_p,
956 CIPHER_ORDER **tail_p,
957 const SSL_CIPHER **ca_list, CERT *c)
959 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
962 int j, multi, found, rule, retval, ok, buflen;
963 uint32_t cipher_id = 0;
976 } else if (ch == '+') {
979 } else if (ch == '!') {
982 } else if (ch == '@') {
983 rule = CIPHER_SPECIAL;
1005 #ifndef CHARSET_EBCDIC
1006 while (((ch >= 'A') && (ch <= 'Z')) ||
1007 ((ch >= '0') && (ch <= '9')) ||
1008 ((ch >= 'a') && (ch <= 'z')) ||
1009 (ch == '-') || (ch == '.') || (ch == '='))
1011 while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1021 * We hit something we cannot deal with,
1022 * it is no command or separator nor
1023 * alphanumeric, so we call this an error.
1025 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1031 if (rule == CIPHER_SPECIAL) {
1032 found = 0; /* unused -- avoid compiler warning */
1033 break; /* special treatment */
1036 /* check for multi-part specification */
1045 * Now search for the cipher alias in the ca_list. Be careful
1046 * with the strncmp, because the "buflen" limitation
1047 * will make the rule "ADH:SOME" and the cipher
1048 * "ADH-MY-CIPHER" look like a match for buflen=3.
1049 * So additionally check whether the cipher name found
1050 * has the correct length. We can save a strlen() call:
1051 * just checking for the '\0' at the right place is
1052 * sufficient, we have to strncmp() anyway. (We cannot
1053 * use strcmp(), because buf is not '\0' terminated.)
1057 while (ca_list[j]) {
1058 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1059 && (ca_list[j]->name[buflen] == '\0')) {
1067 break; /* ignore this entry */
1069 if (ca_list[j]->algorithm_mkey) {
1071 alg_mkey &= ca_list[j]->algorithm_mkey;
1077 alg_mkey = ca_list[j]->algorithm_mkey;
1081 if (ca_list[j]->algorithm_auth) {
1083 alg_auth &= ca_list[j]->algorithm_auth;
1089 alg_auth = ca_list[j]->algorithm_auth;
1093 if (ca_list[j]->algorithm_enc) {
1095 alg_enc &= ca_list[j]->algorithm_enc;
1101 alg_enc = ca_list[j]->algorithm_enc;
1105 if (ca_list[j]->algorithm_mac) {
1107 alg_mac &= ca_list[j]->algorithm_mac;
1113 alg_mac = ca_list[j]->algorithm_mac;
1117 if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1118 if (algo_strength & SSL_STRONG_MASK) {
1120 (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1122 if (!(algo_strength & SSL_STRONG_MASK)) {
1127 algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1131 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1132 if (algo_strength & SSL_DEFAULT_MASK) {
1134 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1136 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1142 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1146 if (ca_list[j]->valid) {
1148 * explicit ciphersuite found; its protocol version does not
1149 * become part of the search pattern!
1152 cipher_id = ca_list[j]->id;
1155 * not an explicit ciphersuite; only in this case, the
1156 * protocol version is considered part of the search pattern
1159 if (ca_list[j]->min_tls) {
1160 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1164 min_tls = ca_list[j]->min_tls;
1174 * Ok, we have the rule, now apply it
1176 if (rule == CIPHER_SPECIAL) { /* special command */
1178 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1179 ok = ssl_cipher_strength_sort(head_p, tail_p);
1180 } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1181 int level = buf[9] - '0';
1182 if (level < 0 || level > 5) {
1183 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1184 SSL_R_INVALID_COMMAND);
1186 c->sec_level = level;
1190 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1195 * We do not support any "multi" options
1196 * together with "@", so throw away the
1197 * rest of the command, if any left, until
1198 * end or ':' is found.
1200 while ((*l != '\0') && !ITEM_SEP(*l))
1203 ssl_cipher_apply_rule(cipher_id,
1204 alg_mkey, alg_auth, alg_enc, alg_mac,
1205 min_tls, algo_strength, rule, -1, head_p,
1208 while ((*l != '\0') && !ITEM_SEP(*l))
1218 #ifndef OPENSSL_NO_EC
1219 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1220 const char **prule_str)
1222 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1223 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1224 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1225 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1227 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1228 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1229 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1230 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1231 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1235 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1236 c->cert_flags |= suiteb_flags;
1238 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1243 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1245 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1246 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1247 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1250 # ifndef OPENSSL_NO_EC
1251 switch (suiteb_flags) {
1252 case SSL_CERT_FLAG_SUITEB_128_LOS:
1254 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1257 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1259 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1260 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1262 case SSL_CERT_FLAG_SUITEB_192_LOS:
1263 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1268 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1274 static int ciphersuite_cb(const char *elem, int len, void *arg)
1276 STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
1277 const SSL_CIPHER *cipher;
1278 /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
1281 if (len > (int)(sizeof(name) - 1)) {
1282 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1286 memcpy(name, elem, len);
1289 cipher = ssl3_get_cipher_by_std_name(name);
1290 if (cipher == NULL) {
1291 SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1295 if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
1296 SSLerr(SSL_F_CIPHERSUITE_CB, ERR_R_INTERNAL_ERROR);
1303 static __owur int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
1305 STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
1307 if (newciphers == NULL)
1310 /* Parse the list. We explicitly allow an empty list */
1312 && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
1313 sk_SSL_CIPHER_free(newciphers);
1316 sk_SSL_CIPHER_free(*currciphers);
1317 *currciphers = newciphers;
1322 static int update_cipher_list_by_id(STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1323 STACK_OF(SSL_CIPHER) *cipherstack)
1325 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1327 if (tmp_cipher_list == NULL) {
1331 sk_SSL_CIPHER_free(*cipher_list_by_id);
1332 *cipher_list_by_id = tmp_cipher_list;
1334 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1335 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1340 static int update_cipher_list(STACK_OF(SSL_CIPHER) **cipher_list,
1341 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1342 STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
1345 STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(*cipher_list);
1347 if (tmp_cipher_list == NULL)
1351 * Delete any existing TLSv1.3 ciphersuites. These are always first in the
1354 while (sk_SSL_CIPHER_num(tmp_cipher_list) > 0
1355 && sk_SSL_CIPHER_value(tmp_cipher_list, 0)->min_tls
1357 sk_SSL_CIPHER_delete(tmp_cipher_list, 0);
1359 /* Insert the new TLSv1.3 ciphersuites */
1360 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
1361 sk_SSL_CIPHER_insert(tmp_cipher_list,
1362 sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
1364 if (!update_cipher_list_by_id(cipher_list_by_id, tmp_cipher_list))
1367 sk_SSL_CIPHER_free(*cipher_list);
1368 *cipher_list = tmp_cipher_list;
1373 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
1375 int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
1377 if (ret && ctx->cipher_list != NULL)
1378 return update_cipher_list(&ctx->cipher_list, &ctx->cipher_list_by_id,
1379 ctx->tls13_ciphersuites);
1384 int SSL_set_ciphersuites(SSL *s, const char *str)
1386 STACK_OF(SSL_CIPHER) *cipher_list;
1387 int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
1389 if (s->cipher_list == NULL) {
1390 if ((cipher_list = SSL_get_ciphers(s)) != NULL)
1391 s->cipher_list = sk_SSL_CIPHER_dup(cipher_list);
1393 if (ret && s->cipher_list != NULL)
1394 return update_cipher_list(&s->cipher_list, &s->cipher_list_by_id,
1395 s->tls13_ciphersuites);
1400 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
1401 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
1402 STACK_OF(SSL_CIPHER) **cipher_list,
1403 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1404 const char *rule_str,
1407 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases, i;
1408 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1409 STACK_OF(SSL_CIPHER) *cipherstack;
1411 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1412 const SSL_CIPHER **ca_list = NULL;
1415 * Return with error if nothing to do.
1417 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1419 #ifndef OPENSSL_NO_EC
1420 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1425 * To reduce the work to do we only want to process the compiled
1426 * in algorithms, so we first get the mask of disabled ciphers.
1429 disabled_mkey = disabled_mkey_mask;
1430 disabled_auth = disabled_auth_mask;
1431 disabled_enc = disabled_enc_mask;
1432 disabled_mac = disabled_mac_mask;
1435 * Now we have to collect the available ciphers from the compiled
1436 * in ciphers. We cannot get more than the number compiled in, so
1437 * it is used for allocation.
1439 num_of_ciphers = ssl_method->num_ciphers();
1441 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1442 if (co_list == NULL) {
1443 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1444 return NULL; /* Failure */
1447 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1448 disabled_mkey, disabled_auth, disabled_enc,
1449 disabled_mac, co_list, &head, &tail);
1451 /* Now arrange all ciphers by preference. */
1454 * Everything else being equal, prefer ephemeral ECDH over other key
1455 * exchange mechanisms.
1456 * For consistency, prefer ECDSA over RSA (though this only matters if the
1457 * server has both certificates, and is using the DEFAULT, or a client
1460 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1462 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1464 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1467 /* Within each strength group, we prefer GCM over CHACHA... */
1468 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1470 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1474 * ...and generally, our preferred cipher is AES.
1475 * Note that AEADs will be bumped to take preference after sorting by
1478 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1481 /* Temporarily enable everything else for sorting */
1482 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1484 /* Low priority for MD5 */
1485 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1489 * Move anonymous ciphers to the end. Usually, these will remain
1490 * disabled. (For applications that allow them, they aren't too bad, but
1491 * we prefer authenticated ciphers.)
1493 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1496 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1498 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1501 /* RC4 is sort-of broken -- move to the end */
1502 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1506 * Now sort by symmetric encryption strength. The above ordering remains
1507 * in force within each class
1509 if (!ssl_cipher_strength_sort(&head, &tail)) {
1510 OPENSSL_free(co_list);
1515 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1516 * TODO(openssl-team): is there an easier way to accomplish all this?
1518 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1522 * Irrespective of strength, enforce the following order:
1523 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1524 * Within each group, ciphers remain sorted by strength and previous
1529 * 4) TLS 1.2 > legacy
1531 * Because we now bump ciphers to the top of the list, we proceed in
1532 * reverse order of preference.
1534 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1536 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1537 CIPHER_BUMP, -1, &head, &tail);
1538 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1539 CIPHER_BUMP, -1, &head, &tail);
1541 /* Now disable everything (maintaining the ordering!) */
1542 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1545 * We also need cipher aliases for selecting based on the rule_str.
1546 * There might be two types of entries in the rule_str: 1) names
1547 * of ciphers themselves 2) aliases for groups of ciphers.
1548 * For 1) we need the available ciphers and for 2) the cipher
1549 * groups of cipher_aliases added together in one list (otherwise
1550 * we would be happy with just the cipher_aliases table).
1552 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1553 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1554 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1555 if (ca_list == NULL) {
1556 OPENSSL_free(co_list);
1557 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1558 return NULL; /* Failure */
1560 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1561 disabled_mkey, disabled_auth, disabled_enc,
1562 disabled_mac, head);
1565 * If the rule_string begins with DEFAULT, apply the default rule
1566 * before using the (possibly available) additional rules.
1570 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1571 ok = ssl_cipher_process_rulestr(OSSL_default_cipher_list(),
1572 &head, &tail, ca_list, c);
1578 if (ok && (rule_p[0] != '\0'))
1579 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1581 OPENSSL_free(ca_list); /* Not needed anymore */
1583 if (!ok) { /* Rule processing failure */
1584 OPENSSL_free(co_list);
1589 * Allocate new "cipherstack" for the result, return with error
1590 * if we cannot get one.
1592 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1593 OPENSSL_free(co_list);
1597 /* Add TLSv1.3 ciphers first - we always prefer those if possible */
1598 for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++) {
1599 if (!sk_SSL_CIPHER_push(cipherstack,
1600 sk_SSL_CIPHER_value(tls13_ciphersuites, i))) {
1601 sk_SSL_CIPHER_free(cipherstack);
1606 OSSL_TRACE_BEGIN(TLS_CIPHER) {
1607 BIO_printf(trc_out, "cipher selection:\n");
1610 * The cipher selection for the list is done. The ciphers are added
1611 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1613 for (curr = head; curr != NULL; curr = curr->next) {
1615 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1616 OPENSSL_free(co_list);
1617 sk_SSL_CIPHER_free(cipherstack);
1618 OSSL_TRACE_CANCEL(TLS_CIPHER);
1621 if (trc_out != NULL)
1622 BIO_printf(trc_out, "<%s>\n", curr->cipher->name);
1625 OPENSSL_free(co_list); /* Not needed any longer */
1626 OSSL_TRACE_END(TLS_CIPHER);
1628 if (!update_cipher_list_by_id(cipher_list_by_id, cipherstack)) {
1629 sk_SSL_CIPHER_free(cipherstack);
1632 sk_SSL_CIPHER_free(*cipher_list);
1633 *cipher_list = cipherstack;
1638 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1641 const char *kx, *au, *enc, *mac;
1642 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1643 static const char *format = "%-30s %-7s Kx=%-8s Au=%-5s Enc=%-9s Mac=%-4s\n";
1647 if ((buf = OPENSSL_malloc(len)) == NULL) {
1648 SSLerr(SSL_F_SSL_CIPHER_DESCRIPTION, ERR_R_MALLOC_FAILURE);
1651 } else if (len < 128) {
1655 alg_mkey = cipher->algorithm_mkey;
1656 alg_auth = cipher->algorithm_auth;
1657 alg_enc = cipher->algorithm_enc;
1658 alg_mac = cipher->algorithm_mac;
1660 ver = ssl_protocol_to_string(cipher->min_tls);
1719 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1720 case (SSL_aGOST12 | SSL_aGOST01):
1757 enc = "AESGCM(128)";
1760 enc = "AESGCM(256)";
1763 enc = "AESCCM(128)";
1766 enc = "AESCCM(256)";
1768 case SSL_AES128CCM8:
1769 enc = "AESCCM8(128)";
1771 case SSL_AES256CCM8:
1772 enc = "AESCCM8(256)";
1774 case SSL_CAMELLIA128:
1775 enc = "Camellia(128)";
1777 case SSL_CAMELLIA256:
1778 enc = "Camellia(256)";
1780 case SSL_ARIA128GCM:
1781 enc = "ARIAGCM(128)";
1783 case SSL_ARIA256GCM:
1784 enc = "ARIAGCM(256)";
1789 case SSL_eGOST2814789CNT:
1790 case SSL_eGOST2814789CNT12:
1791 enc = "GOST89(256)";
1793 case SSL_CHACHA20POLY1305:
1794 enc = "CHACHA20/POLY1305(256)";
1818 case SSL_GOST89MAC12:
1824 case SSL_GOST12_256:
1825 case SSL_GOST12_512:
1833 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1838 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1844 * Backwards-compatibility crutch. In almost all contexts we report TLS
1845 * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1847 if (c->min_tls == TLS1_VERSION)
1849 return ssl_protocol_to_string(c->min_tls);
1852 /* return the actual cipher being used */
1853 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1860 /* return the actual cipher being used in RFC standard name */
1861 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1868 /* return the OpenSSL name based on given RFC standard name */
1869 const char *OPENSSL_cipher_name(const char *stdname)
1871 const SSL_CIPHER *c;
1873 if (stdname == NULL)
1875 c = ssl3_get_cipher_by_std_name(stdname);
1876 return SSL_CIPHER_get_name(c);
1879 /* number of bits for symmetric cipher */
1880 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1885 if (alg_bits != NULL)
1886 *alg_bits = (int)c->alg_bits;
1887 ret = (int)c->strength_bits;
1892 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1897 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1899 return c->id & 0xFFFF;
1902 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1907 if ((n == 0) || (sk == NULL))
1909 nn = sk_SSL_COMP_num(sk);
1910 for (i = 0; i < nn; i++) {
1911 ctmp = sk_SSL_COMP_value(sk, i);
1918 #ifdef OPENSSL_NO_COMP
1919 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1924 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1930 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1936 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1938 load_builtin_compressions();
1939 return ssl_comp_methods;
1942 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1945 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1946 ssl_comp_methods = meths;
1950 static void cmeth_free(SSL_COMP *cm)
1955 void ssl_comp_free_compression_methods_int(void)
1957 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1958 ssl_comp_methods = NULL;
1959 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1962 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1966 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1970 * According to draft-ietf-tls-compression-04.txt, the
1971 * compression number ranges should be the following:
1973 * 0 to 63: methods defined by the IETF
1974 * 64 to 192: external party methods assigned by IANA
1975 * 193 to 255: reserved for private use
1977 if (id < 193 || id > 255) {
1978 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1979 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1983 comp = OPENSSL_malloc(sizeof(*comp));
1985 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1991 load_builtin_compressions();
1992 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1994 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1995 SSL_R_DUPLICATE_COMPRESSION_ID);
1998 if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
2000 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
2007 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
2009 #ifndef OPENSSL_NO_COMP
2010 return comp ? COMP_get_name(comp) : NULL;
2016 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
2018 #ifndef OPENSSL_NO_COMP
2025 int SSL_COMP_get_id(const SSL_COMP *comp)
2027 #ifndef OPENSSL_NO_COMP
2034 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
2037 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
2039 if (c == NULL || (!all && c->valid == 0))
2044 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
2046 return ssl->method->get_cipher_by_char(ptr);
2049 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2054 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2057 return ssl_cipher_table_cipher[i].nid;
2060 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2062 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2066 return ssl_cipher_table_mac[i].nid;
2069 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2071 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2075 return ssl_cipher_table_kx[i].nid;
2078 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2080 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2084 return ssl_cipher_table_auth[i].nid;
2087 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
2089 int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
2091 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
2093 return EVP_get_digestbynid(ssl_cipher_table_mac[idx].nid);
2096 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2098 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
2101 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2102 size_t *int_overhead, size_t *blocksize,
2103 size_t *ext_overhead)
2105 size_t mac = 0, in = 0, blk = 0, out = 0;
2107 /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
2108 * because there are no handy #defines for those. */
2109 if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
2110 out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
2111 } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
2112 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
2113 } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
2114 out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
2115 } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
2117 } else if (c->algorithm_mac & SSL_AEAD) {
2118 /* We're supposed to have handled all the AEAD modes above */
2121 /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
2122 int digest_nid = SSL_CIPHER_get_digest_nid(c);
2123 const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2128 mac = EVP_MD_size(e_md);
2129 if (c->algorithm_enc != SSL_eNULL) {
2130 int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2131 const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2133 /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2134 known CBC cipher. */
2135 if (e_ciph == NULL ||
2136 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2139 in = 1; /* padding length byte */
2140 out = EVP_CIPHER_iv_length(e_ciph);
2141 blk = EVP_CIPHER_block_size(e_ciph);
2145 *mac_overhead = mac;
2148 *ext_overhead = out;
2153 int ssl_cert_is_disabled(size_t idx)
2155 const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2157 if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)
2163 * Default list of TLSv1.2 (and earlier) ciphers
2164 * SSL_DEFAULT_CIPHER_LIST deprecated in 3.0.0
2165 * Update both macro and function simultaneously
2167 const char *OSSL_default_cipher_list(void)
2169 return "ALL:!COMPLEMENTOFDEFAULT:!eNULL";
2173 * Default list of TLSv1.3 (and later) ciphers
2174 * TLS_DEFAULT_CIPHERSUITES deprecated in 3.0.0
2175 * Update both macro and function simultaneously
2177 const char *OSSL_default_ciphersuites(void)
2179 return "TLS_AES_256_GCM_SHA384:"
2180 #if !defined(OPENSSL_NO_CHACHA) && !defined(OPENSSL_NO_POLY1305)
2181 "TLS_CHACHA20_POLY1305_SHA256:"
2183 "TLS_AES_128_GCM_SHA256";