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