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