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