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