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