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