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