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