Remove some commented out code in libssl
[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
706     /*
707      * Prepare linked list from list entries
708      */
709     if (co_list_num > 0) {
710         co_list[0].prev = NULL;
711
712         if (co_list_num > 1) {
713             co_list[0].next = &co_list[1];
714
715             for (i = 1; i < co_list_num - 1; i++) {
716                 co_list[i].prev = &co_list[i - 1];
717                 co_list[i].next = &co_list[i + 1];
718             }
719
720             co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
721         }
722
723         co_list[co_list_num - 1].next = NULL;
724
725         *head_p = &co_list[0];
726         *tail_p = &co_list[co_list_num - 1];
727     }
728 }
729
730 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
731                                        int num_of_group_aliases,
732                                        uint32_t disabled_mkey,
733                                        uint32_t disabled_auth,
734                                        uint32_t disabled_enc,
735                                        uint32_t disabled_mac,
736                                        CIPHER_ORDER *head)
737 {
738     CIPHER_ORDER *ciph_curr;
739     const SSL_CIPHER **ca_curr;
740     int i;
741     uint32_t mask_mkey = ~disabled_mkey;
742     uint32_t mask_auth = ~disabled_auth;
743     uint32_t mask_enc = ~disabled_enc;
744     uint32_t mask_mac = ~disabled_mac;
745
746     /*
747      * First, add the real ciphers as already collected
748      */
749     ciph_curr = head;
750     ca_curr = ca_list;
751     while (ciph_curr != NULL) {
752         *ca_curr = ciph_curr->cipher;
753         ca_curr++;
754         ciph_curr = ciph_curr->next;
755     }
756
757     /*
758      * Now we add the available ones from the cipher_aliases[] table.
759      * They represent either one or more algorithms, some of which
760      * in any affected category must be supported (set in enabled_mask),
761      * or represent a cipher strength value (will be added in any case because algorithms=0).
762      */
763     for (i = 0; i < num_of_group_aliases; i++) {
764         uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
765         uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
766         uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
767         uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
768
769         if (algorithm_mkey)
770             if ((algorithm_mkey & mask_mkey) == 0)
771                 continue;
772
773         if (algorithm_auth)
774             if ((algorithm_auth & mask_auth) == 0)
775                 continue;
776
777         if (algorithm_enc)
778             if ((algorithm_enc & mask_enc) == 0)
779                 continue;
780
781         if (algorithm_mac)
782             if ((algorithm_mac & mask_mac) == 0)
783                 continue;
784
785         *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
786         ca_curr++;
787     }
788
789     *ca_curr = NULL;            /* end of list */
790 }
791
792 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
793                                   uint32_t alg_auth, uint32_t alg_enc,
794                                   uint32_t alg_mac, int min_tls,
795                                   uint32_t algo_strength, int rule,
796                                   int32_t strength_bits, CIPHER_ORDER **head_p,
797                                   CIPHER_ORDER **tail_p)
798 {
799     CIPHER_ORDER *head, *tail, *curr, *next, *last;
800     const SSL_CIPHER *cp;
801     int reverse = 0;
802
803 #ifdef CIPHER_DEBUG
804     fprintf(stderr,
805             "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
806             rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
807             algo_strength, strength_bits);
808 #endif
809
810     if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
811         reverse = 1;            /* needed to maintain sorting between currently
812                                  * deleted ciphers */
813
814     head = *head_p;
815     tail = *tail_p;
816
817     if (reverse) {
818         next = tail;
819         last = head;
820     } else {
821         next = head;
822         last = tail;
823     }
824
825     curr = NULL;
826     for (;;) {
827         if (curr == last)
828             break;
829
830         curr = next;
831
832         if (curr == NULL)
833             break;
834
835         next = reverse ? curr->prev : curr->next;
836
837         cp = curr->cipher;
838
839         /*
840          * Selection criteria is either the value of strength_bits
841          * or the algorithms used.
842          */
843         if (strength_bits >= 0) {
844             if (strength_bits != cp->strength_bits)
845                 continue;
846         } else {
847 #ifdef CIPHER_DEBUG
848             fprintf(stderr,
849                     "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
850                     cp->name, cp->algorithm_mkey, cp->algorithm_auth,
851                     cp->algorithm_enc, cp->algorithm_mac, cp->min_tls,
852                     cp->algo_strength);
853 #endif
854             if (cipher_id != 0 && (cipher_id != cp->id))
855                 continue;
856             if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
857                 continue;
858             if (alg_auth && !(alg_auth & cp->algorithm_auth))
859                 continue;
860             if (alg_enc && !(alg_enc & cp->algorithm_enc))
861                 continue;
862             if (alg_mac && !(alg_mac & cp->algorithm_mac))
863                 continue;
864             if (min_tls && (min_tls != cp->min_tls))
865                 continue;
866             if ((algo_strength & SSL_STRONG_MASK)
867                 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
868                 continue;
869             if ((algo_strength & SSL_DEFAULT_MASK)
870                 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
871                 continue;
872         }
873
874 #ifdef CIPHER_DEBUG
875         fprintf(stderr, "Action = %d\n", rule);
876 #endif
877
878         /* add the cipher if it has not been added yet. */
879         if (rule == CIPHER_ADD) {
880             /* reverse == 0 */
881             if (!curr->active) {
882                 ll_append_tail(&head, curr, &tail);
883                 curr->active = 1;
884             }
885         }
886         /* Move the added cipher to this location */
887         else if (rule == CIPHER_ORD) {
888             /* reverse == 0 */
889             if (curr->active) {
890                 ll_append_tail(&head, curr, &tail);
891             }
892         } else if (rule == CIPHER_DEL) {
893             /* reverse == 1 */
894             if (curr->active) {
895                 /*
896                  * most recently deleted ciphersuites get best positions for
897                  * any future CIPHER_ADD (note that the CIPHER_DEL loop works
898                  * in reverse to maintain the order)
899                  */
900                 ll_append_head(&head, curr, &tail);
901                 curr->active = 0;
902             }
903         } else if (rule == CIPHER_BUMP) {
904             if (curr->active)
905                 ll_append_head(&head, curr, &tail);
906         } else if (rule == CIPHER_KILL) {
907             /* reverse == 0 */
908             if (head == curr)
909                 head = curr->next;
910             else
911                 curr->prev->next = curr->next;
912             if (tail == curr)
913                 tail = curr->prev;
914             curr->active = 0;
915             if (curr->next != NULL)
916                 curr->next->prev = curr->prev;
917             if (curr->prev != NULL)
918                 curr->prev->next = curr->next;
919             curr->next = NULL;
920             curr->prev = NULL;
921         }
922     }
923
924     *head_p = head;
925     *tail_p = tail;
926 }
927
928 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
929                                     CIPHER_ORDER **tail_p)
930 {
931     int32_t max_strength_bits;
932     int i, *number_uses;
933     CIPHER_ORDER *curr;
934
935     /*
936      * This routine sorts the ciphers with descending strength. The sorting
937      * must keep the pre-sorted sequence, so we apply the normal sorting
938      * routine as '+' movement to the end of the list.
939      */
940     max_strength_bits = 0;
941     curr = *head_p;
942     while (curr != NULL) {
943         if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
944             max_strength_bits = curr->cipher->strength_bits;
945         curr = curr->next;
946     }
947
948     number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
949     if (number_uses == NULL) {
950         SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
951         return (0);
952     }
953
954     /*
955      * Now find the strength_bits values actually used
956      */
957     curr = *head_p;
958     while (curr != NULL) {
959         if (curr->active)
960             number_uses[curr->cipher->strength_bits]++;
961         curr = curr->next;
962     }
963     /*
964      * Go through the list of used strength_bits values in descending
965      * order.
966      */
967     for (i = max_strength_bits; i >= 0; i--)
968         if (number_uses[i] > 0)
969             ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
970                                   tail_p);
971
972     OPENSSL_free(number_uses);
973     return (1);
974 }
975
976 static int ssl_cipher_process_rulestr(const char *rule_str,
977                                       CIPHER_ORDER **head_p,
978                                       CIPHER_ORDER **tail_p,
979                                       const SSL_CIPHER **ca_list, CERT *c)
980 {
981     uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
982     int min_tls;
983     const char *l, *buf;
984     int j, multi, found, rule, retval, ok, buflen;
985     uint32_t cipher_id = 0;
986     char ch;
987
988     retval = 1;
989     l = rule_str;
990     for (;;) {
991         ch = *l;
992
993         if (ch == '\0')
994             break;              /* done */
995         if (ch == '-') {
996             rule = CIPHER_DEL;
997             l++;
998         } else if (ch == '+') {
999             rule = CIPHER_ORD;
1000             l++;
1001         } else if (ch == '!') {
1002             rule = CIPHER_KILL;
1003             l++;
1004         } else if (ch == '@') {
1005             rule = CIPHER_SPECIAL;
1006             l++;
1007         } else {
1008             rule = CIPHER_ADD;
1009         }
1010
1011         if (ITEM_SEP(ch)) {
1012             l++;
1013             continue;
1014         }
1015
1016         alg_mkey = 0;
1017         alg_auth = 0;
1018         alg_enc = 0;
1019         alg_mac = 0;
1020         min_tls = 0;
1021         algo_strength = 0;
1022
1023         for (;;) {
1024             ch = *l;
1025             buf = l;
1026             buflen = 0;
1027 #ifndef CHARSET_EBCDIC
1028             while (((ch >= 'A') && (ch <= 'Z')) ||
1029                    ((ch >= '0') && (ch <= '9')) ||
1030                    ((ch >= 'a') && (ch <= 'z')) ||
1031                    (ch == '-') || (ch == '.') || (ch == '='))
1032 #else
1033             while (isalnum(ch) || (ch == '-') || (ch == '.') || (ch == '='))
1034 #endif
1035             {
1036                 ch = *(++l);
1037                 buflen++;
1038             }
1039
1040             if (buflen == 0) {
1041                 /*
1042                  * We hit something we cannot deal with,
1043                  * it is no command or separator nor
1044                  * alphanumeric, so we call this an error.
1045                  */
1046                 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1047                 retval = found = 0;
1048                 l++;
1049                 break;
1050             }
1051
1052             if (rule == CIPHER_SPECIAL) {
1053                 found = 0;      /* unused -- avoid compiler warning */
1054                 break;          /* special treatment */
1055             }
1056
1057             /* check for multi-part specification */
1058             if (ch == '+') {
1059                 multi = 1;
1060                 l++;
1061             } else
1062                 multi = 0;
1063
1064             /*
1065              * Now search for the cipher alias in the ca_list. Be careful
1066              * with the strncmp, because the "buflen" limitation
1067              * will make the rule "ADH:SOME" and the cipher
1068              * "ADH-MY-CIPHER" look like a match for buflen=3.
1069              * So additionally check whether the cipher name found
1070              * has the correct length. We can save a strlen() call:
1071              * just checking for the '\0' at the right place is
1072              * sufficient, we have to strncmp() anyway. (We cannot
1073              * use strcmp(), because buf is not '\0' terminated.)
1074              */
1075             j = found = 0;
1076             cipher_id = 0;
1077             while (ca_list[j]) {
1078                 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1079                     && (ca_list[j]->name[buflen] == '\0')) {
1080                     found = 1;
1081                     break;
1082                 } else
1083                     j++;
1084             }
1085
1086             if (!found)
1087                 break;          /* ignore this entry */
1088
1089             if (ca_list[j]->algorithm_mkey) {
1090                 if (alg_mkey) {
1091                     alg_mkey &= ca_list[j]->algorithm_mkey;
1092                     if (!alg_mkey) {
1093                         found = 0;
1094                         break;
1095                     }
1096                 } else
1097                     alg_mkey = ca_list[j]->algorithm_mkey;
1098             }
1099
1100             if (ca_list[j]->algorithm_auth) {
1101                 if (alg_auth) {
1102                     alg_auth &= ca_list[j]->algorithm_auth;
1103                     if (!alg_auth) {
1104                         found = 0;
1105                         break;
1106                     }
1107                 } else
1108                     alg_auth = ca_list[j]->algorithm_auth;
1109             }
1110
1111             if (ca_list[j]->algorithm_enc) {
1112                 if (alg_enc) {
1113                     alg_enc &= ca_list[j]->algorithm_enc;
1114                     if (!alg_enc) {
1115                         found = 0;
1116                         break;
1117                     }
1118                 } else
1119                     alg_enc = ca_list[j]->algorithm_enc;
1120             }
1121
1122             if (ca_list[j]->algorithm_mac) {
1123                 if (alg_mac) {
1124                     alg_mac &= ca_list[j]->algorithm_mac;
1125                     if (!alg_mac) {
1126                         found = 0;
1127                         break;
1128                     }
1129                 } else
1130                     alg_mac = ca_list[j]->algorithm_mac;
1131             }
1132
1133             if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1134                 if (algo_strength & SSL_STRONG_MASK) {
1135                     algo_strength &=
1136                         (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1137                         ~SSL_STRONG_MASK;
1138                     if (!(algo_strength & SSL_STRONG_MASK)) {
1139                         found = 0;
1140                         break;
1141                     }
1142                 } else
1143                     algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1144             }
1145
1146             if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1147                 if (algo_strength & SSL_DEFAULT_MASK) {
1148                     algo_strength &=
1149                         (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1150                         ~SSL_DEFAULT_MASK;
1151                     if (!(algo_strength & SSL_DEFAULT_MASK)) {
1152                         found = 0;
1153                         break;
1154                     }
1155                 } else
1156                     algo_strength |=
1157                         ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1158             }
1159
1160             if (ca_list[j]->valid) {
1161                 /*
1162                  * explicit ciphersuite found; its protocol version does not
1163                  * become part of the search pattern!
1164                  */
1165
1166                 cipher_id = ca_list[j]->id;
1167             } else {
1168                 /*
1169                  * not an explicit ciphersuite; only in this case, the
1170                  * protocol version is considered part of the search pattern
1171                  */
1172
1173                 if (ca_list[j]->min_tls) {
1174                     if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1175                         found = 0;
1176                         break;
1177                     } else {
1178                         min_tls = ca_list[j]->min_tls;
1179                     }
1180                 }
1181             }
1182
1183             if (!multi)
1184                 break;
1185         }
1186
1187         /*
1188          * Ok, we have the rule, now apply it
1189          */
1190         if (rule == CIPHER_SPECIAL) { /* special command */
1191             ok = 0;
1192             if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0)
1193                 ok = ssl_cipher_strength_sort(head_p, tail_p);
1194             else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1195                 int level = buf[9] - '0';
1196                 if (level < 0 || level > 5) {
1197                     SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1198                            SSL_R_INVALID_COMMAND);
1199                 } else {
1200                     c->sec_level = level;
1201                     ok = 1;
1202                 }
1203             } else
1204                 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR, SSL_R_INVALID_COMMAND);
1205             if (ok == 0)
1206                 retval = 0;
1207             /*
1208              * We do not support any "multi" options
1209              * together with "@", so throw away the
1210              * rest of the command, if any left, until
1211              * end or ':' is found.
1212              */
1213             while ((*l != '\0') && !ITEM_SEP(*l))
1214                 l++;
1215         } else if (found) {
1216             ssl_cipher_apply_rule(cipher_id,
1217                                   alg_mkey, alg_auth, alg_enc, alg_mac,
1218                                   min_tls, algo_strength, rule, -1, head_p,
1219                                   tail_p);
1220         } else {
1221             while ((*l != '\0') && !ITEM_SEP(*l))
1222                 l++;
1223         }
1224         if (*l == '\0')
1225             break;              /* done */
1226     }
1227
1228     return (retval);
1229 }
1230
1231 #ifndef OPENSSL_NO_EC
1232 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1233                                     const char **prule_str)
1234 {
1235     unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1236     if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1237         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1238     } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1239         suiteb_comb2 = 1;
1240         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1241     } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1242         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1243     } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1244         suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1245     }
1246
1247     if (suiteb_flags) {
1248         c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1249         c->cert_flags |= suiteb_flags;
1250     } else
1251         suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1252
1253     if (!suiteb_flags)
1254         return 1;
1255     /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1256
1257     if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1258         SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1259                SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1260         return 0;
1261     }
1262 # ifndef OPENSSL_NO_EC
1263     switch (suiteb_flags) {
1264     case SSL_CERT_FLAG_SUITEB_128_LOS:
1265         if (suiteb_comb2)
1266             *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1267         else
1268             *prule_str =
1269                 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1270         break;
1271     case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1272         *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1273         break;
1274     case SSL_CERT_FLAG_SUITEB_192_LOS:
1275         *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1276         break;
1277     }
1278     return 1;
1279 # else
1280     SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST, SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1281     return 0;
1282 # endif
1283 }
1284 #endif
1285
1286 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1287                                              **cipher_list, STACK_OF(SSL_CIPHER)
1288                                              **cipher_list_by_id,
1289                                              const char *rule_str, CERT *c)
1290 {
1291     int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1292     uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1293     STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1294     const char *rule_p;
1295     CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1296     const SSL_CIPHER **ca_list = NULL;
1297
1298     /*
1299      * Return with error if nothing to do.
1300      */
1301     if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1302         return NULL;
1303 #ifndef OPENSSL_NO_EC
1304     if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1305         return NULL;
1306 #endif
1307
1308     /*
1309      * To reduce the work to do we only want to process the compiled
1310      * in algorithms, so we first get the mask of disabled ciphers.
1311      */
1312
1313     disabled_mkey = disabled_mkey_mask;
1314     disabled_auth = disabled_auth_mask;
1315     disabled_enc = disabled_enc_mask;
1316     disabled_mac = disabled_mac_mask;
1317
1318     /*
1319      * Now we have to collect the available ciphers from the compiled
1320      * in ciphers. We cannot get more than the number compiled in, so
1321      * it is used for allocation.
1322      */
1323     num_of_ciphers = ssl_method->num_ciphers();
1324
1325     co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1326     if (co_list == NULL) {
1327         SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1328         return (NULL);          /* Failure */
1329     }
1330
1331     ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1332                                disabled_mkey, disabled_auth, disabled_enc,
1333                                disabled_mac, co_list, &head, &tail);
1334
1335     /* Now arrange all ciphers by preference. */
1336
1337     /*
1338      * Everything else being equal, prefer ephemeral ECDH over other key
1339      * exchange mechanisms.
1340      * For consistency, prefer ECDSA over RSA (though this only matters if the
1341      * server has both certificates, and is using the DEFAULT, or a client
1342      * preference).
1343      */
1344     ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1345                           -1, &head, &tail);
1346     ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1347                           &tail);
1348     ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1349                           &tail);
1350
1351     /* Within each strength group, we prefer GCM over CHACHA... */
1352     ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1353                           &head, &tail);
1354     ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1355                           &head, &tail);
1356
1357     /*
1358      * ...and generally, our preferred cipher is AES.
1359      * Note that AEADs will be bumped to take preference after sorting by
1360      * strength.
1361      */
1362     ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1363                           -1, &head, &tail);
1364
1365     /* Temporarily enable everything else for sorting */
1366     ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1367
1368     /* Low priority for MD5 */
1369     ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1370                           &tail);
1371
1372     /*
1373      * Move anonymous ciphers to the end.  Usually, these will remain
1374      * disabled. (For applications that allow them, they aren't too bad, but
1375      * we prefer authenticated ciphers.)
1376      */
1377     ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1378                           &tail);
1379
1380     /*
1381      * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1382      * &head, &tail);
1383      */
1384     ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1385                           &tail);
1386     ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1387                           &tail);
1388
1389     /* RC4 is sort-of broken -- move the the end */
1390     ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1391                           &tail);
1392
1393     /*
1394      * Now sort by symmetric encryption strength.  The above ordering remains
1395      * in force within each class
1396      */
1397     if (!ssl_cipher_strength_sort(&head, &tail)) {
1398         OPENSSL_free(co_list);
1399         return NULL;
1400     }
1401
1402     /*
1403      * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1404      * TODO(openssl-team): is there an easier way to accomplish all this?
1405      */
1406     ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1407                           &head, &tail);
1408
1409     /*
1410      * Irrespective of strength, enforce the following order:
1411      * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1412      * Within each group, ciphers remain sorted by strength and previous
1413      * preference, i.e.,
1414      * 1) ECDHE > DHE
1415      * 2) GCM > CHACHA
1416      * 3) AES > rest
1417      * 4) TLS 1.2 > legacy
1418      *
1419      * Because we now bump ciphers to the top of the list, we proceed in
1420      * reverse order of preference.
1421      */
1422     ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1423                           &head, &tail);
1424     ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1425                           CIPHER_BUMP, -1, &head, &tail);
1426     ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1427                           CIPHER_BUMP, -1, &head, &tail);
1428
1429     /* Now disable everything (maintaining the ordering!) */
1430     ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1431
1432     /*
1433      * We also need cipher aliases for selecting based on the rule_str.
1434      * There might be two types of entries in the rule_str: 1) names
1435      * of ciphers themselves 2) aliases for groups of ciphers.
1436      * For 1) we need the available ciphers and for 2) the cipher
1437      * groups of cipher_aliases added together in one list (otherwise
1438      * we would be happy with just the cipher_aliases table).
1439      */
1440     num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1441     num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1442     ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1443     if (ca_list == NULL) {
1444         OPENSSL_free(co_list);
1445         SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1446         return (NULL);          /* Failure */
1447     }
1448     ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1449                                disabled_mkey, disabled_auth, disabled_enc,
1450                                disabled_mac, head);
1451
1452     /*
1453      * If the rule_string begins with DEFAULT, apply the default rule
1454      * before using the (possibly available) additional rules.
1455      */
1456     ok = 1;
1457     rule_p = rule_str;
1458     if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1459         ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1460                                         &head, &tail, ca_list, c);
1461         rule_p += 7;
1462         if (*rule_p == ':')
1463             rule_p++;
1464     }
1465
1466     if (ok && (strlen(rule_p) > 0))
1467         ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1468
1469     OPENSSL_free(ca_list);      /* Not needed anymore */
1470
1471     if (!ok) {                  /* Rule processing failure */
1472         OPENSSL_free(co_list);
1473         return (NULL);
1474     }
1475
1476     /*
1477      * Allocate new "cipherstack" for the result, return with error
1478      * if we cannot get one.
1479      */
1480     if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1481         OPENSSL_free(co_list);
1482         return (NULL);
1483     }
1484
1485     /*
1486      * The cipher selection for the list is done. The ciphers are added
1487      * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1488      */
1489     for (curr = head; curr != NULL; curr = curr->next) {
1490         if (curr->active) {
1491             if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1492                 OPENSSL_free(co_list);
1493                 sk_SSL_CIPHER_free(cipherstack);
1494                 return NULL;
1495             }
1496 #ifdef CIPHER_DEBUG
1497             fprintf(stderr, "<%s>\n", curr->cipher->name);
1498 #endif
1499         }
1500     }
1501     OPENSSL_free(co_list);      /* Not needed any longer */
1502
1503     tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1504     if (tmp_cipher_list == NULL) {
1505         sk_SSL_CIPHER_free(cipherstack);
1506         return NULL;
1507     }
1508     sk_SSL_CIPHER_free(*cipher_list);
1509     *cipher_list = cipherstack;
1510     if (*cipher_list_by_id != NULL)
1511         sk_SSL_CIPHER_free(*cipher_list_by_id);
1512     *cipher_list_by_id = tmp_cipher_list;
1513     (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1514
1515     sk_SSL_CIPHER_sort(*cipher_list_by_id);
1516     return (cipherstack);
1517 }
1518
1519 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1520 {
1521     const char *ver;
1522     const char *kx, *au, *enc, *mac;
1523     uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1524     static const char *format = "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1525
1526     if (buf == NULL) {
1527         len = 128;
1528         buf = OPENSSL_malloc(len);
1529         if (buf == NULL)
1530             return NULL;
1531     } else if (len < 128)
1532         return NULL;
1533
1534     alg_mkey = cipher->algorithm_mkey;
1535     alg_auth = cipher->algorithm_auth;
1536     alg_enc = cipher->algorithm_enc;
1537     alg_mac = cipher->algorithm_mac;
1538
1539     ver = ssl_protocol_to_string(cipher->min_tls);
1540
1541     switch (alg_mkey) {
1542     case SSL_kRSA:
1543         kx = "RSA";
1544         break;
1545     case SSL_kDHE:
1546         kx = "DH";
1547         break;
1548     case SSL_kECDHE:
1549         kx = "ECDH";
1550         break;
1551     case SSL_kPSK:
1552         kx = "PSK";
1553         break;
1554     case SSL_kRSAPSK:
1555         kx = "RSAPSK";
1556         break;
1557     case SSL_kECDHEPSK:
1558         kx = "ECDHEPSK";
1559         break;
1560     case SSL_kDHEPSK:
1561         kx = "DHEPSK";
1562         break;
1563     case SSL_kSRP:
1564         kx = "SRP";
1565         break;
1566     case SSL_kGOST:
1567         kx = "GOST";
1568         break;
1569     case SSL_kANY:
1570         kx = "any";
1571         break;
1572     default:
1573         kx = "unknown";
1574     }
1575
1576     switch (alg_auth) {
1577     case SSL_aRSA:
1578         au = "RSA";
1579         break;
1580     case SSL_aDSS:
1581         au = "DSS";
1582         break;
1583     case SSL_aNULL:
1584         au = "None";
1585         break;
1586     case SSL_aECDSA:
1587         au = "ECDSA";
1588         break;
1589     case SSL_aPSK:
1590         au = "PSK";
1591         break;
1592     case SSL_aSRP:
1593         au = "SRP";
1594         break;
1595     case SSL_aGOST01:
1596         au = "GOST01";
1597         break;
1598     /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1599     case (SSL_aGOST12 | SSL_aGOST01):
1600         au = "GOST12";
1601         break;
1602     case SSL_aANY:
1603         au = "any";
1604         break;
1605     default:
1606         au = "unknown";
1607         break;
1608     }
1609
1610     switch (alg_enc) {
1611     case SSL_DES:
1612         enc = "DES(56)";
1613         break;
1614     case SSL_3DES:
1615         enc = "3DES(168)";
1616         break;
1617     case SSL_RC4:
1618         enc = "RC4(128)";
1619         break;
1620     case SSL_RC2:
1621         enc = "RC2(128)";
1622         break;
1623     case SSL_IDEA:
1624         enc = "IDEA(128)";
1625         break;
1626     case SSL_eNULL:
1627         enc = "None";
1628         break;
1629     case SSL_AES128:
1630         enc = "AES(128)";
1631         break;
1632     case SSL_AES256:
1633         enc = "AES(256)";
1634         break;
1635     case SSL_AES128GCM:
1636         enc = "AESGCM(128)";
1637         break;
1638     case SSL_AES256GCM:
1639         enc = "AESGCM(256)";
1640         break;
1641     case SSL_AES128CCM:
1642         enc = "AESCCM(128)";
1643         break;
1644     case SSL_AES256CCM:
1645         enc = "AESCCM(256)";
1646         break;
1647     case SSL_AES128CCM8:
1648         enc = "AESCCM8(128)";
1649         break;
1650     case SSL_AES256CCM8:
1651         enc = "AESCCM8(256)";
1652         break;
1653     case SSL_CAMELLIA128:
1654         enc = "Camellia(128)";
1655         break;
1656     case SSL_CAMELLIA256:
1657         enc = "Camellia(256)";
1658         break;
1659     case SSL_SEED:
1660         enc = "SEED(128)";
1661         break;
1662     case SSL_eGOST2814789CNT:
1663     case SSL_eGOST2814789CNT12:
1664         enc = "GOST89(256)";
1665         break;
1666     case SSL_CHACHA20POLY1305:
1667         enc = "CHACHA20/POLY1305(256)";
1668         break;
1669     default:
1670         enc = "unknown";
1671         break;
1672     }
1673
1674     switch (alg_mac) {
1675     case SSL_MD5:
1676         mac = "MD5";
1677         break;
1678     case SSL_SHA1:
1679         mac = "SHA1";
1680         break;
1681     case SSL_SHA256:
1682         mac = "SHA256";
1683         break;
1684     case SSL_SHA384:
1685         mac = "SHA384";
1686         break;
1687     case SSL_AEAD:
1688         mac = "AEAD";
1689         break;
1690     case SSL_GOST89MAC:
1691     case SSL_GOST89MAC12:
1692         mac = "GOST89";
1693         break;
1694     case SSL_GOST94:
1695         mac = "GOST94";
1696         break;
1697     case SSL_GOST12_256:
1698     case SSL_GOST12_512:
1699         mac = "GOST2012";
1700         break;
1701     default:
1702         mac = "unknown";
1703         break;
1704     }
1705
1706     BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1707
1708     return (buf);
1709 }
1710
1711 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1712 {
1713     if (c == NULL)
1714         return "(NONE)";
1715
1716     /*
1717      * Backwards-compatibility crutch.  In almost all contexts we report TLS
1718      * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1719      */
1720     if (c->min_tls == TLS1_VERSION)
1721         return "TLSv1.0";
1722     return ssl_protocol_to_string(c->min_tls);
1723 }
1724
1725 /* return the actual cipher being used */
1726 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1727 {
1728     if (c != NULL)
1729         return (c->name);
1730     return ("(NONE)");
1731 }
1732
1733 /* number of bits for symmetric cipher */
1734 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1735 {
1736     int ret = 0;
1737
1738     if (c != NULL) {
1739         if (alg_bits != NULL)
1740             *alg_bits = (int)c->alg_bits;
1741         ret = (int)c->strength_bits;
1742     }
1743     return ret;
1744 }
1745
1746 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1747 {
1748     return c->id;
1749 }
1750
1751 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1752 {
1753     SSL_COMP *ctmp;
1754     int i, nn;
1755
1756     if ((n == 0) || (sk == NULL))
1757         return (NULL);
1758     nn = sk_SSL_COMP_num(sk);
1759     for (i = 0; i < nn; i++) {
1760         ctmp = sk_SSL_COMP_value(sk, i);
1761         if (ctmp->id == n)
1762             return (ctmp);
1763     }
1764     return (NULL);
1765 }
1766
1767 #ifdef OPENSSL_NO_COMP
1768 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1769 {
1770     return NULL;
1771 }
1772
1773 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1774                                                       *meths)
1775 {
1776     return meths;
1777 }
1778
1779 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1780 {
1781     return 1;
1782 }
1783
1784 #else
1785 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1786 {
1787     load_builtin_compressions();
1788     return (ssl_comp_methods);
1789 }
1790
1791 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1792                                                       *meths)
1793 {
1794     STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1795     ssl_comp_methods = meths;
1796     return old_meths;
1797 }
1798
1799 static void cmeth_free(SSL_COMP *cm)
1800 {
1801     OPENSSL_free(cm);
1802 }
1803
1804 void ssl_comp_free_compression_methods_int(void)
1805 {
1806     STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1807     ssl_comp_methods = NULL;
1808     sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1809 }
1810
1811 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1812 {
1813     SSL_COMP *comp;
1814
1815     if (cm == NULL || COMP_get_type(cm) == NID_undef)
1816         return 1;
1817
1818     /*-
1819      * According to draft-ietf-tls-compression-04.txt, the
1820      * compression number ranges should be the following:
1821      *
1822      *   0 to  63:  methods defined by the IETF
1823      *  64 to 192:  external party methods assigned by IANA
1824      * 193 to 255:  reserved for private use
1825      */
1826     if (id < 193 || id > 255) {
1827         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1828                SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1829         return 1;
1830     }
1831
1832     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1833     comp = OPENSSL_malloc(sizeof(*comp));
1834     if (comp == NULL) {
1835         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1836         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1837         return (1);
1838     }
1839
1840     comp->id = id;
1841     comp->method = cm;
1842     load_builtin_compressions();
1843     if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1844         OPENSSL_free(comp);
1845         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1846         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1847                SSL_R_DUPLICATE_COMPRESSION_ID);
1848         return (1);
1849     }
1850     if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1851         OPENSSL_free(comp);
1852         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1853         SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1854         return (1);
1855     }
1856     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1857     return (0);
1858 }
1859 #endif
1860
1861 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1862 {
1863 #ifndef OPENSSL_NO_COMP
1864     return comp ? COMP_get_name(comp) : NULL;
1865 #else
1866     return NULL;
1867 #endif
1868 }
1869
1870 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
1871 {
1872 #ifndef OPENSSL_NO_COMP
1873     return comp->name;
1874 #else
1875     return NULL;
1876 #endif
1877 }
1878
1879 int SSL_COMP_get_id(const SSL_COMP *comp)
1880 {
1881 #ifndef OPENSSL_NO_COMP
1882     return comp->id;
1883 #else
1884     return -1;
1885 #endif
1886 }
1887
1888 /* For a cipher return the index corresponding to the certificate type */
1889 int ssl_cipher_get_cert_index(const SSL_CIPHER *c)
1890 {
1891     uint32_t alg_a;
1892
1893     alg_a = c->algorithm_auth;
1894
1895     if (alg_a & SSL_aECDSA)
1896         return SSL_PKEY_ECC;
1897     else if (alg_a & SSL_aDSS)
1898         return SSL_PKEY_DSA_SIGN;
1899     else if (alg_a & SSL_aRSA)
1900         return SSL_PKEY_RSA;
1901     else if (alg_a & SSL_aGOST12)
1902         return SSL_PKEY_GOST_EC;
1903     else if (alg_a & SSL_aGOST01)
1904         return SSL_PKEY_GOST01;
1905
1906     return -1;
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 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
1963 {
1964     return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
1965 }
1966
1967 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1968                             size_t *int_overhead, size_t *blocksize,
1969                             size_t *ext_overhead)
1970 {
1971     size_t mac = 0, in = 0, blk = 0, out = 0;
1972
1973     /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
1974      * because there are no handy #defines for those. */
1975     if (c->algorithm_enc & SSL_AESGCM) {
1976         out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1977     } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
1978         out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
1979     } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
1980         out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
1981     } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
1982         out = 16;
1983     } else if (c->algorithm_mac & SSL_AEAD) {
1984         /* We're supposed to have handled all the AEAD modes above */
1985         return 0;
1986     } else {
1987         /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
1988         int digest_nid = SSL_CIPHER_get_digest_nid(c);
1989         const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
1990
1991         if (e_md == NULL)
1992             return 0;
1993
1994         mac = EVP_MD_size(e_md);
1995         if (c->algorithm_enc != SSL_eNULL) {
1996             int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
1997             const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
1998
1999             /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2000                known CBC cipher. */
2001             if (e_ciph == NULL ||
2002                 EVP_CIPHER_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2003                 return 0;
2004
2005             in = 1; /* padding length byte */
2006             out = EVP_CIPHER_iv_length(e_ciph);
2007             blk = EVP_CIPHER_block_size(e_ciph);
2008         }
2009     }
2010
2011     *mac_overhead = mac;
2012     *int_overhead = in;
2013     *blocksize = blk;
2014     *ext_overhead = out;
2015
2016     return 1;
2017 }