Use a fetched cipher for the TLSv1.3 early secret
[openssl.git] / ssl / ssl_ciph.c
1 /*
2  * Copyright 1995-2018 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.
5  *
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
10  */
11
12 #include <stdio.h>
13 #include <ctype.h>
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"
24
25 /* NB: make sure indices in these tables match values above */
26
27 typedef struct {
28     uint32_t mask;
29     int nid;
30 } ssl_cipher_table;
31
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 };
57
58 #define SSL_COMP_NULL_IDX       0
59 #define SSL_COMP_ZLIB_IDX       1
60 #define SSL_COMP_NUM_IDX        2
61
62 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
63
64 #ifndef OPENSSL_NO_COMP
65 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
66 #endif
67
68 /* NB: make sure indices in this table matches values above */
69 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
70     {SSL_MD5, NID_md5},         /* SSL_MD_MD5_IDX 0 */
71     {SSL_SHA1, NID_sha1},       /* SSL_MD_SHA1_IDX 1 */
72     {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
73     {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
74     {SSL_SHA256, NID_sha256},   /* SSL_MD_SHA256_IDX 4 */
75     {SSL_SHA384, NID_sha384},   /* SSL_MD_SHA384_IDX 5 */
76     {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
77     {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
78     {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
79     {0, NID_md5_sha1},          /* SSL_MD_MD5_SHA1_IDX 9 */
80     {0, NID_sha224},            /* SSL_MD_SHA224_IDX 10 */
81     {0, NID_sha512}             /* SSL_MD_SHA512_IDX 11 */
82 };
83
84 /* *INDENT-OFF* */
85 static const ssl_cipher_table ssl_cipher_table_kx[] = {
86     {SSL_kRSA,      NID_kx_rsa},
87     {SSL_kECDHE,    NID_kx_ecdhe},
88     {SSL_kDHE,      NID_kx_dhe},
89     {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
90     {SSL_kDHEPSK,   NID_kx_dhe_psk},
91     {SSL_kRSAPSK,   NID_kx_rsa_psk},
92     {SSL_kPSK,      NID_kx_psk},
93     {SSL_kSRP,      NID_kx_srp},
94     {SSL_kGOST,     NID_kx_gost},
95     {SSL_kANY,      NID_kx_any}
96 };
97
98 static const ssl_cipher_table ssl_cipher_table_auth[] = {
99     {SSL_aRSA,    NID_auth_rsa},
100     {SSL_aECDSA,  NID_auth_ecdsa},
101     {SSL_aPSK,    NID_auth_psk},
102     {SSL_aDSS,    NID_auth_dss},
103     {SSL_aGOST01, NID_auth_gost01},
104     {SSL_aGOST12, NID_auth_gost12},
105     {SSL_aSRP,    NID_auth_srp},
106     {SSL_aNULL,   NID_auth_null},
107     {SSL_aANY,    NID_auth_any}
108 };
109 /* *INDENT-ON* */
110
111 /* Utility function for table lookup */
112 static int ssl_cipher_info_find(const ssl_cipher_table * table,
113                                 size_t table_cnt, uint32_t mask)
114 {
115     size_t i;
116     for (i = 0; i < table_cnt; i++, table++) {
117         if (table->mask == mask)
118             return (int)i;
119     }
120     return -1;
121 }
122
123 #define ssl_cipher_info_lookup(table, x) \
124     ssl_cipher_info_find(table, OSSL_NELEM(table), x)
125
126 /*
127  * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
128  * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
129  * found
130  */
131 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
132     /* MD5, SHA, GOST94, MAC89 */
133     EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
134     /* SHA256, SHA384, GOST2012_256, MAC89-12 */
135     EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
136     /* GOST2012_512 */
137     EVP_PKEY_HMAC,
138     /* MD5/SHA1, SHA224, SHA512 */
139     NID_undef, NID_undef, NID_undef
140 };
141
142 #define CIPHER_ADD      1
143 #define CIPHER_KILL     2
144 #define CIPHER_DEL      3
145 #define CIPHER_ORD      4
146 #define CIPHER_SPECIAL  5
147 /*
148  * Bump the ciphers to the top of the list.
149  * This rule isn't currently supported by the public cipherstring API.
150  */
151 #define CIPHER_BUMP     6
152
153 typedef struct cipher_order_st {
154     const SSL_CIPHER *cipher;
155     int active;
156     int dead;
157     struct cipher_order_st *next, *prev;
158 } CIPHER_ORDER;
159
160 static const SSL_CIPHER cipher_aliases[] = {
161     /* "ALL" doesn't include eNULL (must be specifically enabled) */
162     {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
163     /* "COMPLEMENTOFALL" */
164     {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
165
166     /*
167      * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
168      * ALL!)
169      */
170     {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
171
172     /*
173      * key exchange aliases (some of those using only a single bit here
174      * combine multiple key exchange algs according to the RFCs, e.g. kDHE
175      * combines DHE_DSS and DHE_RSA)
176      */
177     {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
178
179     {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
180     {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
181     {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
182
183     {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
184     {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
185     {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
186
187     {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
188     {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
189     {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
190     {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
191     {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
192     {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
193
194     /* server authentication aliases */
195     {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
196     {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
197     {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
198     {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
199     {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
200     {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
201     {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
202     {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
203     {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
204     {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
205     {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
206
207     /* aliases combining key exchange and server authentication */
208     {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
209     {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
210     {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
211     {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
212     {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
213     {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
214     {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
215     {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
216     {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
217     {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
218
219     /* symmetric encryption aliases */
220     {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
221     {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
222     {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
223     {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
224     {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
225     {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
226     {0, SSL_TXT_GOST, NULL, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12},
227     {0, SSL_TXT_AES128, NULL, 0, 0, 0,
228      SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
229     {0, SSL_TXT_AES256, NULL, 0, 0, 0,
230      SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
231     {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
232     {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
233     {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
234      SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
235     {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
236     {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
237     {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
238     {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
239     {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
240
241     {0, SSL_TXT_ARIA, NULL, 0, 0, 0, SSL_ARIA},
242     {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
243     {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
244     {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
245
246     /* MAC aliases */
247     {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
248     {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
249     {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
250     {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
251     {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
252     {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
253     {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
254     {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
255
256     /* protocol version aliases */
257     {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
258     {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
259     {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
260     {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
261
262     /* strength classes */
263     {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
264     {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
265     {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
266     /* FIPS 140-2 approved ciphersuite */
267     {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
268
269     /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
270     {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
271      SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
272     {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
273      SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
274
275 };
276
277 /*
278  * Search for public key algorithm with given name and return its pkey_id if
279  * it is available. Otherwise return 0
280  */
281 #ifdef OPENSSL_NO_ENGINE
282
283 static int get_optional_pkey_id(const char *pkey_name)
284 {
285     const EVP_PKEY_ASN1_METHOD *ameth;
286     int pkey_id = 0;
287     ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
288     if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
289                                          ameth) > 0)
290         return pkey_id;
291     return 0;
292 }
293
294 #else
295
296 static int get_optional_pkey_id(const char *pkey_name)
297 {
298     const EVP_PKEY_ASN1_METHOD *ameth;
299     ENGINE *tmpeng = NULL;
300     int pkey_id = 0;
301     ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
302     if (ameth) {
303         if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
304                                     ameth) <= 0)
305             pkey_id = 0;
306     }
307     ENGINE_finish(tmpeng);
308     return pkey_id;
309 }
310
311 #endif
312
313 /* masks of disabled algorithms */
314 static uint32_t disabled_enc_mask;
315 static uint32_t disabled_mac_mask;
316 static uint32_t disabled_mkey_mask;
317 static uint32_t disabled_auth_mask;
318
319 int ssl_load_ciphers(SSL_CTX *ctx)
320 {
321     size_t i;
322     const ssl_cipher_table *t;
323
324     disabled_enc_mask = 0;
325     for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
326         if (t->nid != NID_undef) {
327             const EVP_CIPHER *cipher
328                 = ssl_evp_cipher_fetch(ctx->libctx, t->nid, ctx->propq);
329
330             ctx->ssl_cipher_methods[i] = cipher;
331             if (cipher == NULL)
332                 disabled_enc_mask |= t->mask;
333         }
334     }
335     disabled_mac_mask = 0;
336     for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
337         const EVP_MD *md
338             = ssl_evp_md_fetch(ctx->libctx, t->nid, ctx->propq);
339
340         ctx->ssl_digest_methods[i] = md;
341         if (md == NULL) {
342             disabled_mac_mask |= t->mask;
343         } else {
344             int tmpsize = EVP_MD_size(md);
345             if (!ossl_assert(tmpsize >= 0))
346                 return 0;
347             ctx->ssl_mac_secret_size[i] = tmpsize;
348         }
349     }
350
351     disabled_mkey_mask = 0;
352     disabled_auth_mask = 0;
353
354 #ifdef OPENSSL_NO_RSA
355     disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
356     disabled_auth_mask |= SSL_aRSA;
357 #endif
358 #ifdef OPENSSL_NO_DSA
359     disabled_auth_mask |= SSL_aDSS;
360 #endif
361 #ifdef OPENSSL_NO_DH
362     disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
363 #endif
364 #ifdef OPENSSL_NO_EC
365     disabled_mkey_mask |= SSL_kECDHE | SSL_kECDHEPSK;
366     disabled_auth_mask |= SSL_aECDSA;
367 #endif
368 #ifdef OPENSSL_NO_PSK
369     disabled_mkey_mask |= SSL_PSK;
370     disabled_auth_mask |= SSL_aPSK;
371 #endif
372 #ifdef OPENSSL_NO_SRP
373     disabled_mkey_mask |= SSL_kSRP;
374 #endif
375
376     /*
377      * Check for presence of GOST 34.10 algorithms, and if they are not
378      * present, disable appropriate auth and key exchange
379      */
380     ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
381     if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
382         ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
383     else
384         disabled_mac_mask |= SSL_GOST89MAC;
385
386     ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
387         get_optional_pkey_id("gost-mac-12");
388     if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
389         ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
390     else
391         disabled_mac_mask |= SSL_GOST89MAC12;
392
393     if (!get_optional_pkey_id("gost2001"))
394         disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
395     if (!get_optional_pkey_id("gost2012_256"))
396         disabled_auth_mask |= SSL_aGOST12;
397     if (!get_optional_pkey_id("gost2012_512"))
398         disabled_auth_mask |= SSL_aGOST12;
399     /*
400      * Disable GOST key exchange if no GOST signature algs are available *
401      */
402     if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
403         (SSL_aGOST01 | SSL_aGOST12))
404         disabled_mkey_mask |= SSL_kGOST;
405
406     return 1;
407 }
408
409 #ifndef OPENSSL_NO_COMP
410
411 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
412 {
413     return ((*a)->id - (*b)->id);
414 }
415
416 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
417 {
418     SSL_COMP *comp = NULL;
419     COMP_METHOD *method = COMP_zlib();
420
421     ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
422
423     if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
424         comp = OPENSSL_malloc(sizeof(*comp));
425         if (comp != NULL) {
426             comp->method = method;
427             comp->id = SSL_COMP_ZLIB_IDX;
428             comp->name = COMP_get_name(method);
429             sk_SSL_COMP_push(ssl_comp_methods, comp);
430             sk_SSL_COMP_sort(ssl_comp_methods);
431         }
432     }
433     return 1;
434 }
435
436 static int load_builtin_compressions(void)
437 {
438     return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
439 }
440 #endif
441
442 int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
443                               const EVP_CIPHER **enc)
444 {
445     int i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, sslc->algorithm_enc);
446
447     if (i == -1) {
448         *enc = NULL;
449     } else {
450         if (i == SSL_ENC_NULL_IDX) {
451             /*
452              * We assume we don't care about this coming from an ENGINE so
453              * just do a normal EVP_CIPHER_fetch instead of
454              * ssl_evp_cipher_fetch()
455              */
456             *enc = EVP_CIPHER_fetch(ctx->libctx, "NULL", ctx->propq);
457             if (*enc == NULL)
458                 return 0;
459         } else {
460             if (!ssl_evp_cipher_up_ref(ctx->ssl_cipher_methods[i]))
461                 return 0;
462             *enc = ctx->ssl_cipher_methods[i];
463         }
464     }
465     return 1;
466 }
467
468 int ssl_cipher_get_evp(SSL_CTX *ctx, const SSL_SESSION *s,
469                        const EVP_CIPHER **enc, const EVP_MD **md,
470                        int *mac_pkey_type, size_t *mac_secret_size,
471                        SSL_COMP **comp, int use_etm)
472 {
473     int i;
474     const SSL_CIPHER *c;
475
476     c = s->cipher;
477     if (c == NULL)
478         return 0;
479     if (comp != NULL) {
480         SSL_COMP ctmp;
481 #ifndef OPENSSL_NO_COMP
482         if (!load_builtin_compressions()) {
483             /*
484              * Currently don't care, since a failure only means that
485              * ssl_comp_methods is NULL, which is perfectly OK
486              */
487         }
488 #endif
489         *comp = NULL;
490         ctmp.id = s->compress_meth;
491         if (ssl_comp_methods != NULL) {
492             i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
493             *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
494         }
495         /* If were only interested in comp then return success */
496         if ((enc == NULL) && (md == NULL))
497             return 1;
498     }
499
500     if ((enc == NULL) || (md == NULL))
501         return 0;
502
503     if (!ssl_cipher_get_evp_cipher(ctx, c, enc))
504         return 0;
505
506     i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
507     if (i == -1) {
508         *md = NULL;
509         if (mac_pkey_type != NULL)
510             *mac_pkey_type = NID_undef;
511         if (mac_secret_size != NULL)
512             *mac_secret_size = 0;
513         if (c->algorithm_mac == SSL_AEAD)
514             mac_pkey_type = NULL;
515     } else {
516         if (!ssl_evp_md_up_ref(ctx->ssl_digest_methods[i])) {
517             ssl_evp_cipher_free(*enc);
518             return 0;
519         }
520         *md = ctx->ssl_digest_methods[i];
521         if (mac_pkey_type != NULL)
522             *mac_pkey_type = ssl_mac_pkey_id[i];
523         if (mac_secret_size != NULL)
524             *mac_secret_size = ctx->ssl_mac_secret_size[i];
525     }
526
527     if ((*enc != NULL) &&
528         (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
529         && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
530         const EVP_CIPHER *evp = NULL;
531
532         if (use_etm
533                 || s->ssl_version >> 8 != TLS1_VERSION_MAJOR
534                 || s->ssl_version < TLS1_VERSION)
535             return 1;
536
537         if (c->algorithm_enc == SSL_RC4
538                 && c->algorithm_mac == SSL_MD5)
539             evp = ssl_evp_cipher_fetch(ctx->libctx, NID_rc4_hmac_md5,
540                                        ctx->propq);
541         else if (c->algorithm_enc == SSL_AES128
542                     && c->algorithm_mac == SSL_SHA1)
543             evp = ssl_evp_cipher_fetch(ctx->libctx,
544                                        NID_aes_128_cbc_hmac_sha1,
545                                        ctx->propq);
546         else if (c->algorithm_enc == SSL_AES256
547                     && c->algorithm_mac == SSL_SHA1)
548              evp = ssl_evp_cipher_fetch(ctx->libctx,
549                                         NID_aes_256_cbc_hmac_sha1,
550                                         ctx->propq);
551         else if (c->algorithm_enc == SSL_AES128
552                     && c->algorithm_mac == SSL_SHA256)
553             evp = ssl_evp_cipher_fetch(ctx->libctx,
554                                        NID_aes_128_cbc_hmac_sha256,
555                                        ctx->propq);
556         else if (c->algorithm_enc == SSL_AES256
557                     && c->algorithm_mac == SSL_SHA256)
558             evp = ssl_evp_cipher_fetch(ctx->libctx,
559                                        NID_aes_256_cbc_hmac_sha256,
560                                        ctx->propq);
561
562         if (evp != NULL) {
563             ssl_evp_cipher_free(*enc);
564             ssl_evp_md_free(*md);
565             *enc = evp;
566             *md = NULL;
567         }
568         return 1;
569     }
570
571     return 0;
572 }
573
574 const EVP_MD *ssl_md(SSL_CTX *ctx, int idx)
575 {
576     idx &= SSL_HANDSHAKE_MAC_MASK;
577     if (idx < 0 || idx >= SSL_MD_NUM_IDX)
578         return NULL;
579     return ctx->ssl_digest_methods[idx];
580 }
581
582 const EVP_MD *ssl_handshake_md(SSL *s)
583 {
584     return ssl_md(s->ctx, ssl_get_algorithm2(s));
585 }
586
587 const EVP_MD *ssl_prf_md(SSL *s)
588 {
589     return ssl_md(s->ctx, ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
590 }
591
592 #define ITEM_SEP(a) \
593         (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
594
595 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
596                            CIPHER_ORDER **tail)
597 {
598     if (curr == *tail)
599         return;
600     if (curr == *head)
601         *head = curr->next;
602     if (curr->prev != NULL)
603         curr->prev->next = curr->next;
604     if (curr->next != NULL)
605         curr->next->prev = curr->prev;
606     (*tail)->next = curr;
607     curr->prev = *tail;
608     curr->next = NULL;
609     *tail = curr;
610 }
611
612 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
613                            CIPHER_ORDER **tail)
614 {
615     if (curr == *head)
616         return;
617     if (curr == *tail)
618         *tail = curr->prev;
619     if (curr->next != NULL)
620         curr->next->prev = curr->prev;
621     if (curr->prev != NULL)
622         curr->prev->next = curr->next;
623     (*head)->prev = curr;
624     curr->next = *head;
625     curr->prev = NULL;
626     *head = curr;
627 }
628
629 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
630                                        int num_of_ciphers,
631                                        uint32_t disabled_mkey,
632                                        uint32_t disabled_auth,
633                                        uint32_t disabled_enc,
634                                        uint32_t disabled_mac,
635                                        CIPHER_ORDER *co_list,
636                                        CIPHER_ORDER **head_p,
637                                        CIPHER_ORDER **tail_p)
638 {
639     int i, co_list_num;
640     const SSL_CIPHER *c;
641
642     /*
643      * We have num_of_ciphers descriptions compiled in, depending on the
644      * method selected (SSLv3, TLSv1 etc).
645      * These will later be sorted in a linked list with at most num
646      * entries.
647      */
648
649     /* Get the initial list of ciphers */
650     co_list_num = 0;            /* actual count of ciphers */
651     for (i = 0; i < num_of_ciphers; i++) {
652         c = ssl_method->get_cipher(i);
653         /* drop those that use any of that is not available */
654         if (c == NULL || !c->valid)
655             continue;
656         if ((c->algorithm_mkey & disabled_mkey) ||
657             (c->algorithm_auth & disabled_auth) ||
658             (c->algorithm_enc & disabled_enc) ||
659             (c->algorithm_mac & disabled_mac))
660             continue;
661         if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
662             c->min_tls == 0)
663             continue;
664         if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
665             c->min_dtls == 0)
666             continue;
667
668         co_list[co_list_num].cipher = c;
669         co_list[co_list_num].next = NULL;
670         co_list[co_list_num].prev = NULL;
671         co_list[co_list_num].active = 0;
672         co_list_num++;
673     }
674
675     /*
676      * Prepare linked list from list entries
677      */
678     if (co_list_num > 0) {
679         co_list[0].prev = NULL;
680
681         if (co_list_num > 1) {
682             co_list[0].next = &co_list[1];
683
684             for (i = 1; i < co_list_num - 1; i++) {
685                 co_list[i].prev = &co_list[i - 1];
686                 co_list[i].next = &co_list[i + 1];
687             }
688
689             co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
690         }
691
692         co_list[co_list_num - 1].next = NULL;
693
694         *head_p = &co_list[0];
695         *tail_p = &co_list[co_list_num - 1];
696     }
697 }
698
699 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
700                                        int num_of_group_aliases,
701                                        uint32_t disabled_mkey,
702                                        uint32_t disabled_auth,
703                                        uint32_t disabled_enc,
704                                        uint32_t disabled_mac,
705                                        CIPHER_ORDER *head)
706 {
707     CIPHER_ORDER *ciph_curr;
708     const SSL_CIPHER **ca_curr;
709     int i;
710     uint32_t mask_mkey = ~disabled_mkey;
711     uint32_t mask_auth = ~disabled_auth;
712     uint32_t mask_enc = ~disabled_enc;
713     uint32_t mask_mac = ~disabled_mac;
714
715     /*
716      * First, add the real ciphers as already collected
717      */
718     ciph_curr = head;
719     ca_curr = ca_list;
720     while (ciph_curr != NULL) {
721         *ca_curr = ciph_curr->cipher;
722         ca_curr++;
723         ciph_curr = ciph_curr->next;
724     }
725
726     /*
727      * Now we add the available ones from the cipher_aliases[] table.
728      * They represent either one or more algorithms, some of which
729      * in any affected category must be supported (set in enabled_mask),
730      * or represent a cipher strength value (will be added in any case because algorithms=0).
731      */
732     for (i = 0; i < num_of_group_aliases; i++) {
733         uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
734         uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
735         uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
736         uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
737
738         if (algorithm_mkey)
739             if ((algorithm_mkey & mask_mkey) == 0)
740                 continue;
741
742         if (algorithm_auth)
743             if ((algorithm_auth & mask_auth) == 0)
744                 continue;
745
746         if (algorithm_enc)
747             if ((algorithm_enc & mask_enc) == 0)
748                 continue;
749
750         if (algorithm_mac)
751             if ((algorithm_mac & mask_mac) == 0)
752                 continue;
753
754         *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
755         ca_curr++;
756     }
757
758     *ca_curr = NULL;            /* end of list */
759 }
760
761 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
762                                   uint32_t alg_auth, uint32_t alg_enc,
763                                   uint32_t alg_mac, int min_tls,
764                                   uint32_t algo_strength, int rule,
765                                   int32_t strength_bits, CIPHER_ORDER **head_p,
766                                   CIPHER_ORDER **tail_p)
767 {
768     CIPHER_ORDER *head, *tail, *curr, *next, *last;
769     const SSL_CIPHER *cp;
770     int reverse = 0;
771
772     OSSL_TRACE_BEGIN(TLS_CIPHER){
773         BIO_printf(trc_out,
774                    "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
775                    rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
776                    algo_strength, strength_bits);
777     }
778
779     if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
780         reverse = 1;            /* needed to maintain sorting between currently
781                                  * deleted ciphers */
782
783     head = *head_p;
784     tail = *tail_p;
785
786     if (reverse) {
787         next = tail;
788         last = head;
789     } else {
790         next = head;
791         last = tail;
792     }
793
794     curr = NULL;
795     for (;;) {
796         if (curr == last)
797             break;
798
799         curr = next;
800
801         if (curr == NULL)
802             break;
803
804         next = reverse ? curr->prev : curr->next;
805
806         cp = curr->cipher;
807
808         /*
809          * Selection criteria is either the value of strength_bits
810          * or the algorithms used.
811          */
812         if (strength_bits >= 0) {
813             if (strength_bits != cp->strength_bits)
814                 continue;
815         } else {
816             if (trc_out != NULL) {
817                 BIO_printf(trc_out,
818                            "\nName: %s:"
819                            "\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
820                            cp->name, cp->algorithm_mkey, cp->algorithm_auth,
821                            cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
822                            cp->algo_strength);
823             }
824             if (cipher_id != 0 && (cipher_id != cp->id))
825                 continue;
826             if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
827                 continue;
828             if (alg_auth && !(alg_auth & cp->algorithm_auth))
829                 continue;
830             if (alg_enc && !(alg_enc & cp->algorithm_enc))
831                 continue;
832             if (alg_mac && !(alg_mac & cp->algorithm_mac))
833                 continue;
834             if (min_tls && (min_tls != cp->min_tls))
835                 continue;
836             if ((algo_strength & SSL_STRONG_MASK)
837                 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
838                 continue;
839             if ((algo_strength & SSL_DEFAULT_MASK)
840                 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
841                 continue;
842         }
843
844         if (trc_out != NULL)
845             BIO_printf(trc_out, "Action = %d\n", rule);
846
847         /* add the cipher if it has not been added yet. */
848         if (rule == CIPHER_ADD) {
849             /* reverse == 0 */
850             if (!curr->active) {
851                 ll_append_tail(&head, curr, &tail);
852                 curr->active = 1;
853             }
854         }
855         /* Move the added cipher to this location */
856         else if (rule == CIPHER_ORD) {
857             /* reverse == 0 */
858             if (curr->active) {
859                 ll_append_tail(&head, curr, &tail);
860             }
861         } else if (rule == CIPHER_DEL) {
862             /* reverse == 1 */
863             if (curr->active) {
864                 /*
865                  * most recently deleted ciphersuites get best positions for
866                  * any future CIPHER_ADD (note that the CIPHER_DEL loop works
867                  * in reverse to maintain the order)
868                  */
869                 ll_append_head(&head, curr, &tail);
870                 curr->active = 0;
871             }
872         } else if (rule == CIPHER_BUMP) {
873             if (curr->active)
874                 ll_append_head(&head, curr, &tail);
875         } else if (rule == CIPHER_KILL) {
876             /* reverse == 0 */
877             if (head == curr)
878                 head = curr->next;
879             else
880                 curr->prev->next = curr->next;
881             if (tail == curr)
882                 tail = curr->prev;
883             curr->active = 0;
884             if (curr->next != NULL)
885                 curr->next->prev = curr->prev;
886             if (curr->prev != NULL)
887                 curr->prev->next = curr->next;
888             curr->next = NULL;
889             curr->prev = NULL;
890         }
891     }
892
893     *head_p = head;
894     *tail_p = tail;
895
896     OSSL_TRACE_END(TLS_CIPHER);
897 }
898
899 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
900                                     CIPHER_ORDER **tail_p)
901 {
902     int32_t max_strength_bits;
903     int i, *number_uses;
904     CIPHER_ORDER *curr;
905
906     /*
907      * This routine sorts the ciphers with descending strength. The sorting
908      * must keep the pre-sorted sequence, so we apply the normal sorting
909      * routine as '+' movement to the end of the list.
910      */
911     max_strength_bits = 0;
912     curr = *head_p;
913     while (curr != NULL) {
914         if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
915             max_strength_bits = curr->cipher->strength_bits;
916         curr = curr->next;
917     }
918
919     number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
920     if (number_uses == NULL) {
921         SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
922         return 0;
923     }
924
925     /*
926      * Now find the strength_bits values actually used
927      */
928     curr = *head_p;
929     while (curr != NULL) {
930         if (curr->active)
931             number_uses[curr->cipher->strength_bits]++;
932         curr = curr->next;
933     }
934     /*
935      * Go through the list of used strength_bits values in descending
936      * order.
937      */
938     for (i = max_strength_bits; i >= 0; i--)
939         if (number_uses[i] > 0)
940             ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
941                                   tail_p);
942
943     OPENSSL_free(number_uses);
944     return 1;
945 }
946
947 static int ssl_cipher_process_rulestr(const char *rule_str,
948                                       CIPHER_ORDER **head_p,
949                                       CIPHER_ORDER **tail_p,
950                                       const SSL_CIPHER **ca_list, CERT *c)
951 {
952     uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
953     int min_tls;
954     const char *l, *buf;
955     int j, multi, found, rule, retval, ok, buflen;
956     uint32_t cipher_id = 0;
957     char ch;
958
959     retval = 1;
960     l = rule_str;
961     for ( ; ; ) {
962         ch = *l;
963
964         if (ch == '\0')
965             break;              /* done */
966         if (ch == '-') {
967             rule = CIPHER_DEL;
968             l++;
969         } else if (ch == '+') {
970             rule = CIPHER_ORD;
971             l++;
972         } else if (ch == '!') {
973             rule = CIPHER_KILL;
974             l++;
975         } else if (ch == '@') {
976             rule = CIPHER_SPECIAL;
977             l++;
978         } else {
979             rule = CIPHER_ADD;
980         }
981
982         if (ITEM_SEP(ch)) {
983             l++;
984             continue;
985         }
986
987         alg_mkey = 0;
988         alg_auth = 0;
989         alg_enc = 0;
990         alg_mac = 0;
991         min_tls = 0;
992         algo_strength = 0;
993
994         for (;;) {
995             ch = *l;
996             buf = l;
997             buflen = 0;
998 #ifndef CHARSET_EBCDIC
999             while (((ch >= 'A') && (ch <= 'Z')) ||
1000                    ((ch >= '0') && (ch <= '9')) ||
1001                    ((ch >= 'a') && (ch <= 'z')) ||
1002                    (ch == '-') || (ch == '.') || (ch == '='))
1003 #else
1004             while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1005                    || (ch == '='))
1006 #endif
1007             {
1008                 ch = *(++l);
1009                 buflen++;
1010             }
1011
1012             if (buflen == 0) {
1013                 /*
1014                  * We hit something we cannot deal with,
1015                  * it is no command or separator nor
1016                  * alphanumeric, so we call this an error.
1017                  */
1018                 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1019                 retval = found = 0;
1020                 l++;
1021                 break;
1022             }
1023
1024             if (rule == CIPHER_SPECIAL) {
1025                 found = 0;      /* unused -- avoid compiler warning */
1026                 break;          /* special treatment */
1027             }
1028
1029             /* check for multi-part specification */
1030             if (ch == '+') {
1031                 multi = 1;
1032                 l++;
1033             } else {
1034                 multi = 0;
1035             }
1036
1037             /*
1038              * Now search for the cipher alias in the ca_list. Be careful
1039              * with the strncmp, because the "buflen" limitation
1040              * will make the rule "ADH:SOME" and the cipher
1041              * "ADH-MY-CIPHER" look like a match for buflen=3.
1042              * So additionally check whether the cipher name found
1043              * has the correct length. We can save a strlen() call:
1044              * just checking for the '\0' at the right place is
1045              * sufficient, we have to strncmp() anyway. (We cannot
1046              * use strcmp(), because buf is not '\0' terminated.)
1047              */
1048             j = found = 0;
1049             cipher_id = 0;
1050             while (ca_list[j]) {
1051                 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1052                     && (ca_list[j]->name[buflen] == '\0')) {
1053                     found = 1;
1054                     break;
1055                 } else
1056                     j++;
1057             }
1058
1059             if (!found)
1060                 break;          /* ignore this entry */
1061
1062             if (ca_list[j]->algorithm_mkey) {
1063                 if (alg_mkey) {
1064                     alg_mkey &= ca_list[j]->algorithm_mkey;
1065                     if (!alg_mkey) {
1066                         found = 0;
1067                         break;
1068                     }
1069                 } else {
1070                     alg_mkey = ca_list[j]->algorithm_mkey;
1071                 }
1072             }
1073
1074             if (ca_list[j]->algorithm_auth) {
1075                 if (alg_auth) {
1076                     alg_auth &= ca_list[j]->algorithm_auth;
1077                     if (!alg_auth) {
1078                         found = 0;
1079                         break;
1080                     }
1081                 } else {
1082                     alg_auth = ca_list[j]->algorithm_auth;
1083                 }
1084             }
1085
1086             if (ca_list[j]->algorithm_enc) {
1087                 if (alg_enc) {
1088                     alg_enc &= ca_list[j]->algorithm_enc;
1089                     if (!alg_enc) {
1090                         found = 0;
1091                         break;
1092                     }
1093                 } else {
1094                     alg_enc = ca_list[j]->algorithm_enc;
1095                 }
1096             }
1097
1098             if (ca_list[j]->algorithm_mac) {
1099                 if (alg_mac) {
1100                     alg_mac &= ca_list[j]->algorithm_mac;
1101                     if (!alg_mac) {
1102                         found = 0;
1103                         break;
1104                     }
1105                 } else {
1106                     alg_mac = ca_list[j]->algorithm_mac;
1107                 }
1108             }
1109
1110             if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1111                 if (algo_strength & SSL_STRONG_MASK) {
1112                     algo_strength &=
1113                         (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1114                         ~SSL_STRONG_MASK;
1115                     if (!(algo_strength & SSL_STRONG_MASK)) {
1116                         found = 0;
1117                         break;
1118                     }
1119                 } else {
1120                     algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1121                 }
1122             }
1123
1124             if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1125                 if (algo_strength & SSL_DEFAULT_MASK) {
1126                     algo_strength &=
1127                         (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1128                         ~SSL_DEFAULT_MASK;
1129                     if (!(algo_strength & SSL_DEFAULT_MASK)) {
1130                         found = 0;
1131                         break;
1132                     }
1133                 } else {
1134                     algo_strength |=
1135                         ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1136                 }
1137             }
1138
1139             if (ca_list[j]->valid) {
1140                 /*
1141                  * explicit ciphersuite found; its protocol version does not
1142                  * become part of the search pattern!
1143                  */
1144
1145                 cipher_id = ca_list[j]->id;
1146             } else {
1147                 /*
1148                  * not an explicit ciphersuite; only in this case, the
1149                  * protocol version is considered part of the search pattern
1150                  */
1151
1152                 if (ca_list[j]->min_tls) {
1153                     if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1154                         found = 0;
1155                         break;
1156                     } else {
1157                         min_tls = ca_list[j]->min_tls;
1158                     }
1159                 }
1160             }
1161
1162             if (!multi)
1163                 break;
1164         }
1165
1166         /*
1167          * Ok, we have the rule, now apply it
1168          */
1169         if (rule == CIPHER_SPECIAL) { /* special command */
1170             ok = 0;
1171             if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1172                 ok = ssl_cipher_strength_sort(head_p, tail_p);
1173             } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1174                 int level = buf[9] - '0';
1175                 if (level < 0 || level > 5) {
1176                     SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1177                            SSL_R_INVALID_COMMAND);
1178                 } else {
1179                     c->sec_level = level;
1180                     ok = 1;
1181                 }
1182             } else {
1183                 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1184             }
1185             if (ok == 0)
1186                 retval = 0;
1187             /*
1188              * We do not support any "multi" options
1189              * together with "@", so throw away the
1190              * rest of the command, if any left, until
1191              * end or ':' is found.
1192              */
1193             while ((*l != '\0') && !ITEM_SEP(*l))
1194                 l++;
1195         } else if (found) {
1196             ssl_cipher_apply_rule(cipher_id,
1197                                   alg_mkey, alg_auth, alg_enc, alg_mac,
1198                                   min_tls, algo_strength, rule, -1, head_p,
1199                                   tail_p);
1200         } else {
1201             while ((*l != '\0') && !ITEM_SEP(*l))
1202                 l++;
1203         }
1204         if (*l == '\0')
1205             break;              /* done */
1206     }
1207
1208     return retval;
1209 }
1210
1211 #ifndef OPENSSL_NO_EC
1212 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1213                                     const char **prule_str)
1214 {
1215     unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1216     if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1217         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1218     } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1219         suiteb_comb2 = 1;
1220         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1221     } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1222         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1223     } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1224         suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1225     }
1226
1227     if (suiteb_flags) {
1228         c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1229         c->cert_flags |= suiteb_flags;
1230     } else {
1231         suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1232     }
1233
1234     if (!suiteb_flags)
1235         return 1;
1236     /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1237
1238     if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1239         SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1240                SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1241         return 0;
1242     }
1243 # ifndef OPENSSL_NO_EC
1244     switch (suiteb_flags) {
1245     case SSL_CERT_FLAG_SUITEB_128_LOS:
1246         if (suiteb_comb2)
1247             *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1248         else
1249             *prule_str =
1250                 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1251         break;
1252     case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1253         *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1254         break;
1255     case SSL_CERT_FLAG_SUITEB_192_LOS:
1256         *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1257         break;
1258     }
1259     return 1;
1260 # else
1261     SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1262     return 0;
1263 # endif
1264 }
1265 #endif
1266
1267 static int ciphersuite_cb(const char *elem, int len, void *arg)
1268 {
1269     STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
1270     const SSL_CIPHER *cipher;
1271     /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
1272     char name[80];
1273
1274     if (len > (int)(sizeof(name) - 1)) {
1275         SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1276         return 0;
1277     }
1278
1279     memcpy(name, elem, len);
1280     name[len] = '\0';
1281
1282     cipher = ssl3_get_cipher_by_std_name(name);
1283     if (cipher == NULL) {
1284         SSLerr(SSL_F_CIPHERSUITE_CB, SSL_R_NO_CIPHER_MATCH);
1285         return 0;
1286     }
1287
1288     if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
1289         SSLerr(SSL_F_CIPHERSUITE_CB, ERR_R_INTERNAL_ERROR);
1290         return 0;
1291     }
1292
1293     return 1;
1294 }
1295
1296 static __owur int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
1297 {
1298     STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
1299
1300     if (newciphers == NULL)
1301         return 0;
1302
1303     /* Parse the list. We explicitly allow an empty list */
1304     if (*str != '\0'
1305             && !CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers)) {
1306         sk_SSL_CIPHER_free(newciphers);
1307         return 0;
1308     }
1309     sk_SSL_CIPHER_free(*currciphers);
1310     *currciphers = newciphers;
1311
1312     return 1;
1313 }
1314
1315 static int update_cipher_list_by_id(STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1316                                     STACK_OF(SSL_CIPHER) *cipherstack)
1317 {
1318     STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1319
1320     if (tmp_cipher_list == NULL) {
1321         return 0;
1322     }
1323
1324     sk_SSL_CIPHER_free(*cipher_list_by_id);
1325     *cipher_list_by_id = tmp_cipher_list;
1326
1327     (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1328     sk_SSL_CIPHER_sort(*cipher_list_by_id);
1329
1330     return 1;
1331 }
1332
1333 static int update_cipher_list(STACK_OF(SSL_CIPHER) **cipher_list,
1334                               STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1335                               STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
1336 {
1337     int i;
1338     STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(*cipher_list);
1339
1340     if (tmp_cipher_list == NULL)
1341         return 0;
1342
1343     /*
1344      * Delete any existing TLSv1.3 ciphersuites. These are always first in the
1345      * list.
1346      */
1347     while (sk_SSL_CIPHER_num(tmp_cipher_list) > 0
1348            && sk_SSL_CIPHER_value(tmp_cipher_list, 0)->min_tls
1349               == TLS1_3_VERSION)
1350         sk_SSL_CIPHER_delete(tmp_cipher_list, 0);
1351
1352     /* Insert the new TLSv1.3 ciphersuites */
1353     for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++)
1354         sk_SSL_CIPHER_insert(tmp_cipher_list,
1355                              sk_SSL_CIPHER_value(tls13_ciphersuites, i), i);
1356
1357     if (!update_cipher_list_by_id(cipher_list_by_id, tmp_cipher_list))
1358         return 0;
1359
1360     sk_SSL_CIPHER_free(*cipher_list);
1361     *cipher_list = tmp_cipher_list;
1362
1363     return 1;
1364 }
1365
1366 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
1367 {
1368     int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
1369
1370     if (ret && ctx->cipher_list != NULL)
1371         return update_cipher_list(&ctx->cipher_list, &ctx->cipher_list_by_id,
1372                                   ctx->tls13_ciphersuites);
1373
1374     return ret;
1375 }
1376
1377 int SSL_set_ciphersuites(SSL *s, const char *str)
1378 {
1379     STACK_OF(SSL_CIPHER) *cipher_list;
1380     int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
1381
1382     if (s->cipher_list == NULL) {
1383         if ((cipher_list = SSL_get_ciphers(s)) != NULL)
1384             s->cipher_list = sk_SSL_CIPHER_dup(cipher_list);
1385     }
1386     if (ret && s->cipher_list != NULL)
1387         return update_cipher_list(&s->cipher_list, &s->cipher_list_by_id,
1388                                   s->tls13_ciphersuites);
1389
1390     return ret;
1391 }
1392
1393 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
1394                                              STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
1395                                              STACK_OF(SSL_CIPHER) **cipher_list,
1396                                              STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1397                                              const char *rule_str,
1398                                              CERT *c)
1399 {
1400     int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases, i;
1401     uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1402     STACK_OF(SSL_CIPHER) *cipherstack;
1403     const char *rule_p;
1404     CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1405     const SSL_CIPHER **ca_list = NULL;
1406
1407     /*
1408      * Return with error if nothing to do.
1409      */
1410     if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1411         return NULL;
1412 #ifndef OPENSSL_NO_EC
1413     if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1414         return NULL;
1415 #endif
1416
1417     /*
1418      * To reduce the work to do we only want to process the compiled
1419      * in algorithms, so we first get the mask of disabled ciphers.
1420      */
1421
1422     disabled_mkey = disabled_mkey_mask;
1423     disabled_auth = disabled_auth_mask;
1424     disabled_enc = disabled_enc_mask;
1425     disabled_mac = disabled_mac_mask;
1426
1427     /*
1428      * Now we have to collect the available ciphers from the compiled
1429      * in ciphers. We cannot get more than the number compiled in, so
1430      * it is used for allocation.
1431      */
1432     num_of_ciphers = ssl_method->num_ciphers();
1433
1434     co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1435     if (co_list == NULL) {
1436         SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1437         return NULL;          /* Failure */
1438     }
1439
1440     ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1441                                disabled_mkey, disabled_auth, disabled_enc,
1442                                disabled_mac, co_list, &head, &tail);
1443
1444     /* Now arrange all ciphers by preference. */
1445
1446     /*
1447      * Everything else being equal, prefer ephemeral ECDH over other key
1448      * exchange mechanisms.
1449      * For consistency, prefer ECDSA over RSA (though this only matters if the
1450      * server has both certificates, and is using the DEFAULT, or a client
1451      * preference).
1452      */
1453     ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1454                           -1, &head, &tail);
1455     ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1456                           &tail);
1457     ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1458                           &tail);
1459
1460     /* Within each strength group, we prefer GCM over CHACHA... */
1461     ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1462                           &head, &tail);
1463     ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1464                           &head, &tail);
1465
1466     /*
1467      * ...and generally, our preferred cipher is AES.
1468      * Note that AEADs will be bumped to take preference after sorting by
1469      * strength.
1470      */
1471     ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1472                           -1, &head, &tail);
1473
1474     /* Temporarily enable everything else for sorting */
1475     ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1476
1477     /* Low priority for MD5 */
1478     ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1479                           &tail);
1480
1481     /*
1482      * Move anonymous ciphers to the end.  Usually, these will remain
1483      * disabled. (For applications that allow them, they aren't too bad, but
1484      * we prefer authenticated ciphers.)
1485      */
1486     ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1487                           &tail);
1488
1489     ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1490                           &tail);
1491     ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1492                           &tail);
1493
1494     /* RC4 is sort-of broken -- move to the end */
1495     ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1496                           &tail);
1497
1498     /*
1499      * Now sort by symmetric encryption strength.  The above ordering remains
1500      * in force within each class
1501      */
1502     if (!ssl_cipher_strength_sort(&head, &tail)) {
1503         OPENSSL_free(co_list);
1504         return NULL;
1505     }
1506
1507     /*
1508      * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1509      * TODO(openssl-team): is there an easier way to accomplish all this?
1510      */
1511     ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1512                           &head, &tail);
1513
1514     /*
1515      * Irrespective of strength, enforce the following order:
1516      * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1517      * Within each group, ciphers remain sorted by strength and previous
1518      * preference, i.e.,
1519      * 1) ECDHE > DHE
1520      * 2) GCM > CHACHA
1521      * 3) AES > rest
1522      * 4) TLS 1.2 > legacy
1523      *
1524      * Because we now bump ciphers to the top of the list, we proceed in
1525      * reverse order of preference.
1526      */
1527     ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1528                           &head, &tail);
1529     ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1530                           CIPHER_BUMP, -1, &head, &tail);
1531     ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1532                           CIPHER_BUMP, -1, &head, &tail);
1533
1534     /* Now disable everything (maintaining the ordering!) */
1535     ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1536
1537     /*
1538      * We also need cipher aliases for selecting based on the rule_str.
1539      * There might be two types of entries in the rule_str: 1) names
1540      * of ciphers themselves 2) aliases for groups of ciphers.
1541      * For 1) we need the available ciphers and for 2) the cipher
1542      * groups of cipher_aliases added together in one list (otherwise
1543      * we would be happy with just the cipher_aliases table).
1544      */
1545     num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1546     num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1547     ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1548     if (ca_list == NULL) {
1549         OPENSSL_free(co_list);
1550         SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1551         return NULL;          /* Failure */
1552     }
1553     ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1554                                disabled_mkey, disabled_auth, disabled_enc,
1555                                disabled_mac, head);
1556
1557     /*
1558      * If the rule_string begins with DEFAULT, apply the default rule
1559      * before using the (possibly available) additional rules.
1560      */
1561     ok = 1;
1562     rule_p = rule_str;
1563     if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1564         ok = ssl_cipher_process_rulestr(OSSL_default_cipher_list(),
1565                                         &head, &tail, ca_list, c);
1566         rule_p += 7;
1567         if (*rule_p == ':')
1568             rule_p++;
1569     }
1570
1571     if (ok && (rule_p[0] != '\0'))
1572         ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1573
1574     OPENSSL_free(ca_list);      /* Not needed anymore */
1575
1576     if (!ok) {                  /* Rule processing failure */
1577         OPENSSL_free(co_list);
1578         return NULL;
1579     }
1580
1581     /*
1582      * Allocate new "cipherstack" for the result, return with error
1583      * if we cannot get one.
1584      */
1585     if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1586         OPENSSL_free(co_list);
1587         return NULL;
1588     }
1589
1590     /* Add TLSv1.3 ciphers first - we always prefer those if possible */
1591     for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++) {
1592         if (!sk_SSL_CIPHER_push(cipherstack,
1593                                 sk_SSL_CIPHER_value(tls13_ciphersuites, i))) {
1594             sk_SSL_CIPHER_free(cipherstack);
1595             return NULL;
1596         }
1597     }
1598
1599     OSSL_TRACE_BEGIN(TLS_CIPHER) {
1600         BIO_printf(trc_out, "cipher selection:\n");
1601     }
1602     /*
1603      * The cipher selection for the list is done. The ciphers are added
1604      * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1605      */
1606     for (curr = head; curr != NULL; curr = curr->next) {
1607         if (curr->active) {
1608             if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1609                 OPENSSL_free(co_list);
1610                 sk_SSL_CIPHER_free(cipherstack);
1611                 OSSL_TRACE_CANCEL(TLS_CIPHER);
1612                 return NULL;
1613             }
1614             if (trc_out != NULL)
1615                 BIO_printf(trc_out, "<%s>\n", curr->cipher->name);
1616         }
1617     }
1618     OPENSSL_free(co_list);      /* Not needed any longer */
1619     OSSL_TRACE_END(TLS_CIPHER);
1620
1621     if (!update_cipher_list_by_id(cipher_list_by_id, cipherstack)) {
1622         sk_SSL_CIPHER_free(cipherstack);
1623         return NULL;
1624     }
1625     sk_SSL_CIPHER_free(*cipher_list);
1626     *cipher_list = cipherstack;
1627
1628     return cipherstack;
1629 }
1630
1631 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1632 {
1633     const char *ver;
1634     const char *kx, *au, *enc, *mac;
1635     uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1636     static const char *format = "%-30s %-7s Kx=%-8s Au=%-5s Enc=%-9s Mac=%-4s\n";
1637
1638     if (buf == NULL) {
1639         len = 128;
1640         if ((buf = OPENSSL_malloc(len)) == NULL) {
1641             SSLerr(SSL_F_SSL_CIPHER_DESCRIPTION, ERR_R_MALLOC_FAILURE);
1642             return NULL;
1643         }
1644     } else if (len < 128) {
1645         return NULL;
1646     }
1647
1648     alg_mkey = cipher->algorithm_mkey;
1649     alg_auth = cipher->algorithm_auth;
1650     alg_enc = cipher->algorithm_enc;
1651     alg_mac = cipher->algorithm_mac;
1652
1653     ver = ssl_protocol_to_string(cipher->min_tls);
1654
1655     switch (alg_mkey) {
1656     case SSL_kRSA:
1657         kx = "RSA";
1658         break;
1659     case SSL_kDHE:
1660         kx = "DH";
1661         break;
1662     case SSL_kECDHE:
1663         kx = "ECDH";
1664         break;
1665     case SSL_kPSK:
1666         kx = "PSK";
1667         break;
1668     case SSL_kRSAPSK:
1669         kx = "RSAPSK";
1670         break;
1671     case SSL_kECDHEPSK:
1672         kx = "ECDHEPSK";
1673         break;
1674     case SSL_kDHEPSK:
1675         kx = "DHEPSK";
1676         break;
1677     case SSL_kSRP:
1678         kx = "SRP";
1679         break;
1680     case SSL_kGOST:
1681         kx = "GOST";
1682         break;
1683     case SSL_kANY:
1684         kx = "any";
1685         break;
1686     default:
1687         kx = "unknown";
1688     }
1689
1690     switch (alg_auth) {
1691     case SSL_aRSA:
1692         au = "RSA";
1693         break;
1694     case SSL_aDSS:
1695         au = "DSS";
1696         break;
1697     case SSL_aNULL:
1698         au = "None";
1699         break;
1700     case SSL_aECDSA:
1701         au = "ECDSA";
1702         break;
1703     case SSL_aPSK:
1704         au = "PSK";
1705         break;
1706     case SSL_aSRP:
1707         au = "SRP";
1708         break;
1709     case SSL_aGOST01:
1710         au = "GOST01";
1711         break;
1712     /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1713     case (SSL_aGOST12 | SSL_aGOST01):
1714         au = "GOST12";
1715         break;
1716     case SSL_aANY:
1717         au = "any";
1718         break;
1719     default:
1720         au = "unknown";
1721         break;
1722     }
1723
1724     switch (alg_enc) {
1725     case SSL_DES:
1726         enc = "DES(56)";
1727         break;
1728     case SSL_3DES:
1729         enc = "3DES(168)";
1730         break;
1731     case SSL_RC4:
1732         enc = "RC4(128)";
1733         break;
1734     case SSL_RC2:
1735         enc = "RC2(128)";
1736         break;
1737     case SSL_IDEA:
1738         enc = "IDEA(128)";
1739         break;
1740     case SSL_eNULL:
1741         enc = "None";
1742         break;
1743     case SSL_AES128:
1744         enc = "AES(128)";
1745         break;
1746     case SSL_AES256:
1747         enc = "AES(256)";
1748         break;
1749     case SSL_AES128GCM:
1750         enc = "AESGCM(128)";
1751         break;
1752     case SSL_AES256GCM:
1753         enc = "AESGCM(256)";
1754         break;
1755     case SSL_AES128CCM:
1756         enc = "AESCCM(128)";
1757         break;
1758     case SSL_AES256CCM:
1759         enc = "AESCCM(256)";
1760         break;
1761     case SSL_AES128CCM8:
1762         enc = "AESCCM8(128)";
1763         break;
1764     case SSL_AES256CCM8:
1765         enc = "AESCCM8(256)";
1766         break;
1767     case SSL_CAMELLIA128:
1768         enc = "Camellia(128)";
1769         break;
1770     case SSL_CAMELLIA256:
1771         enc = "Camellia(256)";
1772         break;
1773     case SSL_ARIA128GCM:
1774         enc = "ARIAGCM(128)";
1775         break;
1776     case SSL_ARIA256GCM:
1777         enc = "ARIAGCM(256)";
1778         break;
1779     case SSL_SEED:
1780         enc = "SEED(128)";
1781         break;
1782     case SSL_eGOST2814789CNT:
1783     case SSL_eGOST2814789CNT12:
1784         enc = "GOST89(256)";
1785         break;
1786     case SSL_CHACHA20POLY1305:
1787         enc = "CHACHA20/POLY1305(256)";
1788         break;
1789     default:
1790         enc = "unknown";
1791         break;
1792     }
1793
1794     switch (alg_mac) {
1795     case SSL_MD5:
1796         mac = "MD5";
1797         break;
1798     case SSL_SHA1:
1799         mac = "SHA1";
1800         break;
1801     case SSL_SHA256:
1802         mac = "SHA256";
1803         break;
1804     case SSL_SHA384:
1805         mac = "SHA384";
1806         break;
1807     case SSL_AEAD:
1808         mac = "AEAD";
1809         break;
1810     case SSL_GOST89MAC:
1811     case SSL_GOST89MAC12:
1812         mac = "GOST89";
1813         break;
1814     case SSL_GOST94:
1815         mac = "GOST94";
1816         break;
1817     case SSL_GOST12_256:
1818     case SSL_GOST12_512:
1819         mac = "GOST2012";
1820         break;
1821     default:
1822         mac = "unknown";
1823         break;
1824     }
1825
1826     BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1827
1828     return buf;
1829 }
1830
1831 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1832 {
1833     if (c == NULL)
1834         return "(NONE)";
1835
1836     /*
1837      * Backwards-compatibility crutch.  In almost all contexts we report TLS
1838      * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1839      */
1840     if (c->min_tls == TLS1_VERSION)
1841         return "TLSv1.0";
1842     return ssl_protocol_to_string(c->min_tls);
1843 }
1844
1845 /* return the actual cipher being used */
1846 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1847 {
1848     if (c != NULL)
1849         return c->name;
1850     return "(NONE)";
1851 }
1852
1853 /* return the actual cipher being used in RFC standard name */
1854 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1855 {
1856     if (c != NULL)
1857         return c->stdname;
1858     return "(NONE)";
1859 }
1860
1861 /* return the OpenSSL name based on given RFC standard name */
1862 const char *OPENSSL_cipher_name(const char *stdname)
1863 {
1864     const SSL_CIPHER *c;
1865
1866     if (stdname == NULL)
1867         return "(NONE)";
1868     c = ssl3_get_cipher_by_std_name(stdname);
1869     return SSL_CIPHER_get_name(c);
1870 }
1871
1872 /* number of bits for symmetric cipher */
1873 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1874 {
1875     int ret = 0;
1876
1877     if (c != NULL) {
1878         if (alg_bits != NULL)
1879             *alg_bits = (int)c->alg_bits;
1880         ret = (int)c->strength_bits;
1881     }
1882     return ret;
1883 }
1884
1885 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1886 {
1887     return c->id;
1888 }
1889
1890 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1891 {
1892     return c->id & 0xFFFF;
1893 }
1894
1895 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1896 {
1897     SSL_COMP *ctmp;
1898     int i, nn;
1899
1900     if ((n == 0) || (sk == NULL))
1901         return NULL;
1902     nn = sk_SSL_COMP_num(sk);
1903     for (i = 0; i < nn; i++) {
1904         ctmp = sk_SSL_COMP_value(sk, i);
1905         if (ctmp->id == n)
1906             return ctmp;
1907     }
1908     return NULL;
1909 }
1910
1911 #ifdef OPENSSL_NO_COMP
1912 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1913 {
1914     return NULL;
1915 }
1916
1917 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1918                                                       *meths)
1919 {
1920     return meths;
1921 }
1922
1923 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1924 {
1925     return 1;
1926 }
1927
1928 #else
1929 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1930 {
1931     load_builtin_compressions();
1932     return ssl_comp_methods;
1933 }
1934
1935 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1936                                                       *meths)
1937 {
1938     STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1939     ssl_comp_methods = meths;
1940     return old_meths;
1941 }
1942
1943 static void cmeth_free(SSL_COMP *cm)
1944 {
1945     OPENSSL_free(cm);
1946 }
1947
1948 void ssl_comp_free_compression_methods_int(void)
1949 {
1950     STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1951     ssl_comp_methods = NULL;
1952     sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1953 }
1954
1955 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1956 {
1957     SSL_COMP *comp;
1958
1959     if (cm == NULL || COMP_get_type(cm) == NID_undef)
1960         return 1;
1961
1962     /*-
1963      * According to draft-ietf-tls-compression-04.txt, the
1964      * compression number ranges should be the following:
1965      *
1966      *   0 to  63:  methods defined by the IETF
1967      *  64 to 192:  external party methods assigned by IANA
1968      * 193 to 255:  reserved for private use
1969      */
1970     if (id < 193 || id > 255) {
1971         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1972                SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1973         return 1;
1974     }
1975
1976     comp = OPENSSL_malloc(sizeof(*comp));
1977     if (comp == NULL) {
1978         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1979         return 1;
1980     }
1981
1982     comp->id = id;
1983     comp->method = cm;
1984     load_builtin_compressions();
1985     if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1986         OPENSSL_free(comp);
1987         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1988                SSL_R_DUPLICATE_COMPRESSION_ID);
1989         return 1;
1990     }
1991     if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1992         OPENSSL_free(comp);
1993         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1994         return 1;
1995     }
1996     return 0;
1997 }
1998 #endif
1999
2000 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
2001 {
2002 #ifndef OPENSSL_NO_COMP
2003     return comp ? COMP_get_name(comp) : NULL;
2004 #else
2005     return NULL;
2006 #endif
2007 }
2008
2009 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
2010 {
2011 #ifndef OPENSSL_NO_COMP
2012     return comp->name;
2013 #else
2014     return NULL;
2015 #endif
2016 }
2017
2018 int SSL_COMP_get_id(const SSL_COMP *comp)
2019 {
2020 #ifndef OPENSSL_NO_COMP
2021     return comp->id;
2022 #else
2023     return -1;
2024 #endif
2025 }
2026
2027 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
2028                                          int all)
2029 {
2030     const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
2031
2032     if (c == NULL || (!all && c->valid == 0))
2033         return NULL;
2034     return c;
2035 }
2036
2037 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
2038 {
2039     return ssl->method->get_cipher_by_char(ptr);
2040 }
2041
2042 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2043 {
2044     int i;
2045     if (c == NULL)
2046         return NID_undef;
2047     i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2048     if (i == -1)
2049         return NID_undef;
2050     return ssl_cipher_table_cipher[i].nid;
2051 }
2052
2053 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2054 {
2055     int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2056
2057     if (i == -1)
2058         return NID_undef;
2059     return ssl_cipher_table_mac[i].nid;
2060 }
2061
2062 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2063 {
2064     int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2065
2066     if (i == -1)
2067         return NID_undef;
2068     return ssl_cipher_table_kx[i].nid;
2069 }
2070
2071 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2072 {
2073     int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2074
2075     if (i == -1)
2076         return NID_undef;
2077     return ssl_cipher_table_auth[i].nid;
2078 }
2079
2080 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
2081 {
2082     int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
2083
2084     if (idx < 0 || idx >= SSL_MD_NUM_IDX)
2085         return NULL;
2086     return EVP_get_digestbynid(ssl_cipher_table_mac[idx].nid);
2087 }
2088
2089 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2090 {
2091     return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
2092 }
2093
2094 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2095                             size_t *int_overhead, size_t *blocksize,
2096                             size_t *ext_overhead)
2097 {
2098     size_t mac = 0, in = 0, blk = 0, out = 0;
2099
2100     /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
2101      * because there are no handy #defines for those. */
2102     if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
2103         out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
2104     } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
2105         out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
2106     } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
2107         out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
2108     } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
2109         out = 16;
2110     } else if (c->algorithm_mac & SSL_AEAD) {
2111         /* We're supposed to have handled all the AEAD modes above */
2112         return 0;
2113     } else {
2114         /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
2115         int digest_nid = SSL_CIPHER_get_digest_nid(c);
2116         const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2117
2118         if (e_md == NULL)
2119             return 0;
2120
2121         mac = EVP_MD_size(e_md);
2122         if (c->algorithm_enc != SSL_eNULL) {
2123             int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2124             const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2125
2126             /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2127                known CBC cipher. */
2128             if (e_ciph == NULL ||
2129                 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2130                 return 0;
2131
2132             in = 1; /* padding length byte */
2133             out = EVP_CIPHER_iv_length(e_ciph);
2134             blk = EVP_CIPHER_block_size(e_ciph);
2135         }
2136     }
2137
2138     *mac_overhead = mac;
2139     *int_overhead = in;
2140     *blocksize = blk;
2141     *ext_overhead = out;
2142
2143     return 1;
2144 }
2145
2146 int ssl_cert_is_disabled(size_t idx)
2147 {
2148     const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2149
2150     if (cl == NULL || (cl->amask & disabled_auth_mask) != 0)
2151         return 1;
2152     return 0;
2153 }
2154
2155 /*
2156  * Default list of TLSv1.2 (and earlier) ciphers
2157  * SSL_DEFAULT_CIPHER_LIST deprecated in 3.0.0
2158  * Update both macro and function simultaneously
2159  */
2160 const char *OSSL_default_cipher_list(void)
2161 {
2162     return "ALL:!COMPLEMENTOFDEFAULT:!eNULL";
2163 }
2164
2165 /*
2166  * Default list of TLSv1.3 (and later) ciphers
2167  * TLS_DEFAULT_CIPHERSUITES deprecated in 3.0.0
2168  * Update both macro and function simultaneously
2169  */
2170 const char *OSSL_default_ciphersuites(void)
2171 {
2172     return "TLS_AES_256_GCM_SHA384:"
2173 #if !defined(OPENSSL_NO_CHACHA) && !defined(OPENSSL_NO_POLY1305)
2174            "TLS_CHACHA20_POLY1305_SHA256:"
2175 #endif
2176            "TLS_AES_128_GCM_SHA256";
2177 }