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