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