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