1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
57 /* ====================================================================
58 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
86 * 6. Redistributions of any form whatsoever must retain the following
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
110 /* ====================================================================
111 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
112 * ECC cipher suite support in OpenSSL originally developed by
113 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 /* ====================================================================
116 * Copyright 2005 Nokia. All rights reserved.
118 * The portions of the attached software ("Contribution") is developed by
119 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
122 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
123 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
124 * support (see RFC 4279) to OpenSSL.
126 * No patent licenses or other rights except those expressly stated in
127 * the OpenSSL open source license shall be deemed granted or received
128 * expressly, by implication, estoppel, or otherwise.
130 * No assurances are provided by Nokia that the Contribution does not
131 * infringe the patent or other intellectual property rights of any third
132 * party or that the license provides you with all the necessary rights
133 * to make use of the Contribution.
135 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
136 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
137 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
138 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
143 #include <openssl/objects.h>
144 #ifndef OPENSSL_NO_COMP
145 # include <openssl/comp.h>
147 #ifndef OPENSSL_NO_ENGINE
148 # include <openssl/engine.h>
150 #include "internal/threads.h"
151 #include "ssl_locl.h"
153 #define SSL_ENC_DES_IDX 0
154 #define SSL_ENC_3DES_IDX 1
155 #define SSL_ENC_RC4_IDX 2
156 #define SSL_ENC_RC2_IDX 3
157 #define SSL_ENC_IDEA_IDX 4
158 #define SSL_ENC_NULL_IDX 5
159 #define SSL_ENC_AES128_IDX 6
160 #define SSL_ENC_AES256_IDX 7
161 #define SSL_ENC_CAMELLIA128_IDX 8
162 #define SSL_ENC_CAMELLIA256_IDX 9
163 #define SSL_ENC_GOST89_IDX 10
164 #define SSL_ENC_SEED_IDX 11
165 #define SSL_ENC_AES128GCM_IDX 12
166 #define SSL_ENC_AES256GCM_IDX 13
167 #define SSL_ENC_AES128CCM_IDX 14
168 #define SSL_ENC_AES256CCM_IDX 15
169 #define SSL_ENC_AES128CCM8_IDX 16
170 #define SSL_ENC_AES256CCM8_IDX 17
171 #define SSL_ENC_GOST8912_IDX 18
172 #define SSL_ENC_CHACHA_IDX 19
173 #define SSL_ENC_NUM_IDX 20
175 /* NB: make sure indices in these tables match values above */
182 /* Table of NIDs for each cipher */
183 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
184 {SSL_DES, NID_des_cbc}, /* SSL_ENC_DES_IDX 0 */
185 {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
186 {SSL_RC4, NID_rc4}, /* SSL_ENC_RC4_IDX 2 */
187 {SSL_RC2, NID_rc2_cbc}, /* SSL_ENC_RC2_IDX 3 */
188 {SSL_IDEA, NID_idea_cbc}, /* SSL_ENC_IDEA_IDX 4 */
189 {SSL_eNULL, NID_undef}, /* SSL_ENC_NULL_IDX 5 */
190 {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
191 {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
192 {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
193 {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
194 {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
195 {SSL_SEED, NID_seed_cbc}, /* SSL_ENC_SEED_IDX 11 */
196 {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
197 {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
198 {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
199 {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
200 {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
201 {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
202 {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX */
203 {SSL_CHACHA20POLY1305, NID_chacha20_poly1305},
206 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX] = {
207 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
211 #define SSL_COMP_NULL_IDX 0
212 #define SSL_COMP_ZLIB_IDX 1
213 #define SSL_COMP_NUM_IDX 2
215 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
217 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
220 * Constant SSL_MAX_DIGEST equal to size of digests array should be defined
224 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
226 /* NB: make sure indices in this table matches values above */
227 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
228 {SSL_MD5, NID_md5}, /* SSL_MD_MD5_IDX 0 */
229 {SSL_SHA1, NID_sha1}, /* SSL_MD_SHA1_IDX 1 */
230 {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
231 {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
232 {SSL_SHA256, NID_sha256}, /* SSL_MD_SHA256_IDX 4 */
233 {SSL_SHA384, NID_sha384}, /* SSL_MD_SHA384_IDX 5 */
234 {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
235 {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
236 {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
237 {0, NID_md5_sha1}, /* SSL_MD_MD5_SHA1_IDX 9 */
238 {0, NID_sha224}, /* SSL_MD_SHA224_IDX 10 */
239 {0, NID_sha512} /* SSL_MD_SHA512_IDX 11 */
242 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX] = {
243 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
246 static const ssl_cipher_table ssl_cipher_table_kx[] = {
247 { SSL_kRSA, NID_kx_rsa },
248 { SSL_kECDHE, NID_kx_ecdhe },
249 { SSL_kDHE, NID_kx_dhe },
250 { SSL_kECDHEPSK, NID_kx_ecdhe_psk },
251 { SSL_kDHEPSK, NID_kx_dhe_psk },
252 { SSL_kRSAPSK, NID_kx_rsa_psk },
253 { SSL_kPSK, NID_kx_psk },
254 { SSL_kSRP, NID_kx_srp },
255 { SSL_kGOST, NID_kx_gost }
258 static const ssl_cipher_table ssl_cipher_table_auth[] = {
259 { SSL_aRSA, NID_auth_rsa },
260 { SSL_aECDSA, NID_auth_ecdsa },
261 { SSL_aPSK, NID_auth_psk },
262 { SSL_aDSS, NID_auth_dss },
263 { SSL_aGOST01, NID_auth_gost01 },
264 { SSL_aGOST12, NID_auth_gost12 },
265 { SSL_aSRP, NID_auth_srp },
266 { SSL_aNULL, NID_auth_null }
269 /* Utility function for table lookup */
270 static int ssl_cipher_info_find(const ssl_cipher_table * table,
271 size_t table_cnt, uint32_t mask)
274 for (i = 0; i < table_cnt; i++, table++) {
275 if (table->mask == mask)
281 #define ssl_cipher_info_lookup(table, x) \
282 ssl_cipher_info_find(table, OSSL_NELEM(table), x)
285 * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
286 * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
289 static int ssl_mac_pkey_id[SSL_MD_NUM_IDX] = {
290 /* MD5, SHA, GOST94, MAC89 */
291 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
292 /* SHA256, SHA384, GOST2012_256, MAC89-12 */
293 EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
298 static int ssl_mac_secret_size[SSL_MD_NUM_IDX] = {
299 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
303 #define CIPHER_KILL 2
306 #define CIPHER_SPECIAL 5
308 * Bump the ciphers to the top of the list.
309 * This rule isn't currently supported by the public cipherstring API.
311 #define CIPHER_BUMP 6
313 typedef struct cipher_order_st {
314 const SSL_CIPHER *cipher;
317 struct cipher_order_st *next, *prev;
320 static const SSL_CIPHER cipher_aliases[] = {
321 /* "ALL" doesn't include eNULL (must be specifically enabled) */
322 {0, SSL_TXT_ALL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
323 /* "COMPLEMENTOFALL" */
324 {0, SSL_TXT_CMPALL, 0, 0, 0, SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
327 * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
330 {0, SSL_TXT_CMPDEF, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT, 0, 0, 0},
333 * key exchange aliases (some of those using only a single bit here
334 * combine multiple key exchange algs according to the RFCs, e.g. kDHE
335 * combines DHE_DSS and DHE_RSA)
337 {0, SSL_TXT_kRSA, 0, SSL_kRSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
339 {0, SSL_TXT_kEDH, 0, SSL_kDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
340 {0, SSL_TXT_kDHE, 0, SSL_kDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
341 {0, SSL_TXT_DH, 0, SSL_kDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
343 {0, SSL_TXT_kEECDH, 0, SSL_kECDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
344 {0, SSL_TXT_kECDHE, 0, SSL_kECDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
345 {0, SSL_TXT_ECDH, 0, SSL_kECDHE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
347 {0, SSL_TXT_kPSK, 0, SSL_kPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
348 {0, SSL_TXT_kRSAPSK, 0, SSL_kRSAPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
349 {0, SSL_TXT_kECDHEPSK, 0, SSL_kECDHEPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
350 {0, SSL_TXT_kDHEPSK, 0, SSL_kDHEPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
351 {0, SSL_TXT_kSRP, 0, SSL_kSRP, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
352 {0, SSL_TXT_kGOST, 0, SSL_kGOST, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
354 /* server authentication aliases */
355 {0, SSL_TXT_aRSA, 0, 0, SSL_aRSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
356 {0, SSL_TXT_aDSS, 0, 0, SSL_aDSS, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
357 {0, SSL_TXT_DSS, 0, 0, SSL_aDSS, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
358 {0, SSL_TXT_aNULL, 0, 0, SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
359 {0, SSL_TXT_aECDSA, 0, 0, SSL_aECDSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
360 {0, SSL_TXT_ECDSA, 0, 0, SSL_aECDSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
361 {0, SSL_TXT_aPSK, 0, 0, SSL_aPSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
362 {0, SSL_TXT_aGOST01, 0, 0, SSL_aGOST01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
363 {0, SSL_TXT_aGOST12, 0, 0, SSL_aGOST12, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
364 {0, SSL_TXT_aGOST, 0, 0, SSL_aGOST01 | SSL_aGOST12, 0, 0, 0, 0, 0, 0,
366 {0, SSL_TXT_aSRP, 0, 0, SSL_aSRP, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
368 /* aliases combining key exchange and server authentication */
369 {0, SSL_TXT_EDH, 0, SSL_kDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
370 {0, SSL_TXT_DHE, 0, SSL_kDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
371 {0, SSL_TXT_EECDH, 0, SSL_kECDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
372 {0, SSL_TXT_ECDHE, 0, SSL_kECDHE, ~SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
373 {0, SSL_TXT_NULL, 0, 0, 0, SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
374 {0, SSL_TXT_RSA, 0, SSL_kRSA, SSL_aRSA, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
375 {0, SSL_TXT_ADH, 0, SSL_kDHE, SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
376 {0, SSL_TXT_AECDH, 0, SSL_kECDHE, SSL_aNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
377 {0, SSL_TXT_PSK, 0, SSL_PSK, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
378 {0, SSL_TXT_SRP, 0, SSL_kSRP, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
380 /* symmetric encryption aliases */
381 {0, SSL_TXT_3DES, 0, 0, 0, SSL_3DES, 0, 0, 0, 0, 0, 0, 0, 0, 0},
382 {0, SSL_TXT_RC4, 0, 0, 0, SSL_RC4, 0, 0, 0, 0, 0, 0, 0, 0, 0},
383 {0, SSL_TXT_RC2, 0, 0, 0, SSL_RC2, 0, 0, 0, 0, 0, 0, 0, 0, 0},
384 {0, SSL_TXT_IDEA, 0, 0, 0, SSL_IDEA, 0, 0, 0, 0, 0, 0, 0, 0, 0},
385 {0, SSL_TXT_SEED, 0, 0, 0, SSL_SEED, 0, 0, 0, 0, 0, 0, 0, 0, 0},
386 {0, SSL_TXT_eNULL, 0, 0, 0, SSL_eNULL, 0, 0, 0, 0, 0, 0, 0, 0, 0},
387 {0, SSL_TXT_GOST, 0, 0, 0, SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12, 0,
388 0, 0, 0, 0, 0, 0, 0, 0},
389 {0, SSL_TXT_AES128, 0, 0, 0, SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8, 0,
390 0, 0, 0, 0, 0, 0, 0, 0},
391 {0, SSL_TXT_AES256, 0, 0, 0, SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8, 0,
392 0, 0, 0, 0, 0, 0, 0, 0},
393 {0, SSL_TXT_AES, 0, 0, 0, SSL_AES, 0, 0, 0, 0, 0, 0, 0, 0, 0},
394 {0, SSL_TXT_AES_GCM, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM, 0, 0, 0, 0,
396 {0, SSL_TXT_AES_CCM, 0, 0, 0,
397 SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8, 0, 0, 0,
399 {0, SSL_TXT_AES_CCM_8, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8, 0, 0, 0, 0,
401 {0, SSL_TXT_CAMELLIA128, 0, 0, 0, SSL_CAMELLIA128, 0, 0, 0, 0, 0, 0, 0, 0,
403 {0, SSL_TXT_CAMELLIA256, 0, 0, 0, SSL_CAMELLIA256, 0, 0, 0, 0, 0, 0, 0, 0,
405 {0, SSL_TXT_CAMELLIA, 0, 0, 0, SSL_CAMELLIA, 0, 0, 0, 0, 0, 0, 0, 0, 0},
406 {0, SSL_TXT_CHACHA20, 0, 0, 0, SSL_CHACHA20, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
409 {0, SSL_TXT_MD5, 0, 0, 0, 0, SSL_MD5, 0, 0, 0, 0, 0, 0, 0, 0},
410 {0, SSL_TXT_SHA1, 0, 0, 0, 0, SSL_SHA1, 0, 0, 0, 0, 0, 0, 0, 0},
411 {0, SSL_TXT_SHA, 0, 0, 0, 0, SSL_SHA1, 0, 0, 0, 0, 0, 0, 0, 0},
412 {0, SSL_TXT_GOST94, 0, 0, 0, 0, SSL_GOST94, 0, 0, 0, 0, 0, 0, 0, 0},
413 {0, SSL_TXT_GOST89MAC, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12, 0, 0,
415 {0, SSL_TXT_SHA256, 0, 0, 0, 0, SSL_SHA256, 0, 0, 0, 0, 0, 0, 0, 0},
416 {0, SSL_TXT_SHA384, 0, 0, 0, 0, SSL_SHA384, 0, 0, 0, 0, 0, 0, 0, 0},
417 {0, SSL_TXT_GOST12, 0, 0, 0, 0, SSL_GOST12_256, 0, 0, 0, 0, 0, 0, 0, 0},
419 /* protocol version aliases */
420 {0, SSL_TXT_SSLV3, 0, 0, 0, 0, 0, SSL3_VERSION, 0, 0, 0, 0, 0, 0, 0},
421 {0, SSL_TXT_TLSV1, 0, 0, 0, 0, 0, TLS1_VERSION, 0, 0, 0, 0, 0, 0, 0},
422 {0, "TLSv1.0", 0, 0, 0, 0, 0, TLS1_VERSION, 0, 0, 0, 0, 0, 0, 0},
423 {0, SSL_TXT_TLSV1_2, 0, 0, 0, 0, 0, TLS1_2_VERSION, 0, 0, 0, 0, 0, 0, 0},
425 /* strength classes */
426 {0, SSL_TXT_LOW, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW, 0, 0, 0},
427 {0, SSL_TXT_MEDIUM, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM, 0, 0, 0},
428 {0, SSL_TXT_HIGH, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH, 0, 0, 0},
429 /* FIPS 140-2 approved ciphersuite */
430 {0, SSL_TXT_FIPS, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS, 0, 0, 0},
432 /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
433 {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, 0,
434 SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0,
435 SSL_HIGH | SSL_FIPS, 0, 0, 0,},
436 {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, 0,
437 SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0,
438 SSL_HIGH | SSL_FIPS, 0, 0, 0,},
443 * Search for public key algorithm with given name and return its pkey_id if
444 * it is available. Otherwise return 0
446 #ifdef OPENSSL_NO_ENGINE
448 static int get_optional_pkey_id(const char *pkey_name)
450 const EVP_PKEY_ASN1_METHOD *ameth;
452 ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
453 if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
462 static int get_optional_pkey_id(const char *pkey_name)
464 const EVP_PKEY_ASN1_METHOD *ameth;
465 ENGINE *tmpeng = NULL;
467 ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
469 if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
473 ENGINE_finish(tmpeng);
479 /* masks of disabled algorithms */
480 static uint32_t disabled_enc_mask;
481 static uint32_t disabled_mac_mask;
482 static uint32_t disabled_mkey_mask;
483 static uint32_t disabled_auth_mask;
485 void ssl_load_ciphers(void)
488 const ssl_cipher_table *t;
489 disabled_enc_mask = 0;
490 for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
491 if (t->nid == NID_undef) {
492 ssl_cipher_methods[i] = NULL;
494 const EVP_CIPHER *cipher = EVP_get_cipherbynid(t->nid);
495 ssl_cipher_methods[i] = cipher;
497 disabled_enc_mask |= t->mask;
500 #ifdef SSL_FORBID_ENULL
501 disabled_enc_mask |= SSL_eNULL;
503 disabled_mac_mask = 0;
504 for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
505 const EVP_MD *md = EVP_get_digestbynid(t->nid);
506 ssl_digest_methods[i] = md;
508 disabled_mac_mask |= t->mask;
510 ssl_mac_secret_size[i] = EVP_MD_size(md);
511 OPENSSL_assert(ssl_mac_secret_size[i] >= 0);
514 /* Make sure we can access MD5 and SHA1 */
515 OPENSSL_assert(ssl_digest_methods[SSL_MD_MD5_IDX] != NULL);
516 OPENSSL_assert(ssl_digest_methods[SSL_MD_SHA1_IDX] != NULL);
518 disabled_mkey_mask = 0;
519 disabled_auth_mask = 0;
521 #ifdef OPENSSL_NO_RSA
522 disabled_mkey_mask |= SSL_kRSA | SSL_kRSAPSK;
523 disabled_auth_mask |= SSL_aRSA;
525 #ifdef OPENSSL_NO_DSA
526 disabled_auth_mask |= SSL_aDSS;
529 disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
532 disabled_mkey_mask |= SSL_kECDHEPSK;
533 disabled_auth_mask |= SSL_aECDSA;
535 #ifdef OPENSSL_NO_PSK
536 disabled_mkey_mask |= SSL_PSK;
537 disabled_auth_mask |= SSL_aPSK;
539 #ifdef OPENSSL_NO_SRP
540 disabled_mkey_mask |= SSL_kSRP;
544 * Check for presence of GOST 34.10 algorithms, and if they are not
545 * present, disable appropriate auth and key exchange
547 ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] = get_optional_pkey_id("gost-mac");
548 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX]) {
549 ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
551 disabled_mac_mask |= SSL_GOST89MAC;
554 ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] = get_optional_pkey_id("gost-mac-12");
555 if (ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX]) {
556 ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
558 disabled_mac_mask |= SSL_GOST89MAC12;
561 if (!get_optional_pkey_id("gost2001"))
562 disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
563 if (!get_optional_pkey_id("gost2012_256"))
564 disabled_auth_mask |= SSL_aGOST12;
565 if (!get_optional_pkey_id("gost2012_512"))
566 disabled_auth_mask |= SSL_aGOST12;
568 * Disable GOST key exchange if no GOST signature algs are available *
570 if ((disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) == (SSL_aGOST01 | SSL_aGOST12))
571 disabled_mkey_mask |= SSL_kGOST;
574 #ifndef OPENSSL_NO_COMP
576 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
578 return ((*a)->id - (*b)->id);
581 static void do_load_builtin_compressions(void)
583 SSL_COMP *comp = NULL;
584 COMP_METHOD *method = COMP_zlib();
586 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
587 ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
589 if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
590 comp = OPENSSL_malloc(sizeof(*comp));
592 comp->method = method;
593 comp->id = SSL_COMP_ZLIB_IDX;
594 comp->name = COMP_get_name(method);
595 sk_SSL_COMP_push(ssl_comp_methods, comp);
596 sk_SSL_COMP_sort(ssl_comp_methods);
599 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
602 static void load_builtin_compressions(void)
604 CRYPTO_THREAD_run_once(&ssl_load_builtin_comp_once,
605 do_load_builtin_compressions);
609 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
610 const EVP_MD **md, int *mac_pkey_type,
611 int *mac_secret_size, SSL_COMP **comp, int use_etm)
621 #ifndef OPENSSL_NO_COMP
622 load_builtin_compressions();
626 ctmp.id = s->compress_meth;
627 if (ssl_comp_methods != NULL) {
628 i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
630 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
634 /* If were only interested in comp then return success */
635 if ((enc == NULL) && (md == NULL))
639 if ((enc == NULL) || (md == NULL))
642 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
647 if (i == SSL_ENC_NULL_IDX)
648 *enc = EVP_enc_null();
650 *enc = ssl_cipher_methods[i];
653 i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
656 if (mac_pkey_type != NULL)
657 *mac_pkey_type = NID_undef;
658 if (mac_secret_size != NULL)
659 *mac_secret_size = 0;
660 if (c->algorithm_mac == SSL_AEAD)
661 mac_pkey_type = NULL;
663 *md = ssl_digest_methods[i];
664 if (mac_pkey_type != NULL)
665 *mac_pkey_type = ssl_mac_pkey_id[i];
666 if (mac_secret_size != NULL)
667 *mac_secret_size = ssl_mac_secret_size[i];
670 if ((*enc != NULL) &&
671 (*md != NULL || (EVP_CIPHER_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
672 && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
673 const EVP_CIPHER *evp;
678 if (s->ssl_version >> 8 != TLS1_VERSION_MAJOR ||
679 s->ssl_version < TLS1_VERSION)
685 if (c->algorithm_enc == SSL_RC4 &&
686 c->algorithm_mac == SSL_MD5 &&
687 (evp = EVP_get_cipherbyname("RC4-HMAC-MD5")))
688 *enc = evp, *md = NULL;
689 else if (c->algorithm_enc == SSL_AES128 &&
690 c->algorithm_mac == SSL_SHA1 &&
691 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA1")))
692 *enc = evp, *md = NULL;
693 else if (c->algorithm_enc == SSL_AES256 &&
694 c->algorithm_mac == SSL_SHA1 &&
695 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA1")))
696 *enc = evp, *md = NULL;
697 else if (c->algorithm_enc == SSL_AES128 &&
698 c->algorithm_mac == SSL_SHA256 &&
699 (evp = EVP_get_cipherbyname("AES-128-CBC-HMAC-SHA256")))
700 *enc = evp, *md = NULL;
701 else if (c->algorithm_enc == SSL_AES256 &&
702 c->algorithm_mac == SSL_SHA256 &&
703 (evp = EVP_get_cipherbyname("AES-256-CBC-HMAC-SHA256")))
704 *enc = evp, *md = NULL;
710 const EVP_MD *ssl_md(int idx)
712 idx &= SSL_HANDSHAKE_MAC_MASK;
713 if (idx < 0 || idx >= SSL_MD_NUM_IDX)
715 return ssl_digest_methods[idx];
718 const EVP_MD *ssl_handshake_md(SSL *s)
720 return ssl_md(ssl_get_algorithm2(s));
723 const EVP_MD *ssl_prf_md(SSL *s)
725 return ssl_md(ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
728 #define ITEM_SEP(a) \
729 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
731 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
738 if (curr->prev != NULL)
739 curr->prev->next = curr->next;
740 if (curr->next != NULL)
741 curr->next->prev = curr->prev;
742 (*tail)->next = curr;
748 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
755 if (curr->next != NULL)
756 curr->next->prev = curr->prev;
757 if (curr->prev != NULL)
758 curr->prev->next = curr->next;
759 (*head)->prev = curr;
765 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
767 uint32_t disabled_mkey,
768 uint32_t disabled_auth,
769 uint32_t disabled_enc,
770 uint32_t disabled_mac,
771 CIPHER_ORDER *co_list,
772 CIPHER_ORDER **head_p,
773 CIPHER_ORDER **tail_p)
779 * We have num_of_ciphers descriptions compiled in, depending on the
780 * method selected (SSLv3, TLSv1 etc).
781 * These will later be sorted in a linked list with at most num
785 /* Get the initial list of ciphers */
786 co_list_num = 0; /* actual count of ciphers */
787 for (i = 0; i < num_of_ciphers; i++) {
788 c = ssl_method->get_cipher(i);
789 /* drop those that use any of that is not available */
790 if ((c != NULL) && c->valid &&
791 (!FIPS_mode() || (c->algo_strength & SSL_FIPS)) &&
792 !(c->algorithm_mkey & disabled_mkey) &&
793 !(c->algorithm_auth & disabled_auth) &&
794 !(c->algorithm_enc & disabled_enc) &&
795 !(c->algorithm_mac & disabled_mac)) {
796 co_list[co_list_num].cipher = c;
797 co_list[co_list_num].next = NULL;
798 co_list[co_list_num].prev = NULL;
799 co_list[co_list_num].active = 0;
802 * if (!sk_push(ca_list,(char *)c)) goto err;
808 * Prepare linked list from list entries
810 if (co_list_num > 0) {
811 co_list[0].prev = NULL;
813 if (co_list_num > 1) {
814 co_list[0].next = &co_list[1];
816 for (i = 1; i < co_list_num - 1; i++) {
817 co_list[i].prev = &co_list[i - 1];
818 co_list[i].next = &co_list[i + 1];
821 co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
824 co_list[co_list_num - 1].next = NULL;
826 *head_p = &co_list[0];
827 *tail_p = &co_list[co_list_num - 1];
831 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
832 int num_of_group_aliases,
833 uint32_t disabled_mkey,
834 uint32_t disabled_auth,
835 uint32_t disabled_enc,
836 uint32_t disabled_mac,
839 CIPHER_ORDER *ciph_curr;
840 const SSL_CIPHER **ca_curr;
842 uint32_t mask_mkey = ~disabled_mkey;
843 uint32_t mask_auth = ~disabled_auth;
844 uint32_t mask_enc = ~disabled_enc;
845 uint32_t mask_mac = ~disabled_mac;
848 * First, add the real ciphers as already collected
852 while (ciph_curr != NULL) {
853 *ca_curr = ciph_curr->cipher;
855 ciph_curr = ciph_curr->next;
859 * Now we add the available ones from the cipher_aliases[] table.
860 * They represent either one or more algorithms, some of which
861 * in any affected category must be supported (set in enabled_mask),
862 * or represent a cipher strength value (will be added in any case because algorithms=0).
864 for (i = 0; i < num_of_group_aliases; i++) {
865 uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
866 uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
867 uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
868 uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
871 if ((algorithm_mkey & mask_mkey) == 0)
875 if ((algorithm_auth & mask_auth) == 0)
879 if ((algorithm_enc & mask_enc) == 0)
883 if ((algorithm_mac & mask_mac) == 0)
886 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
890 *ca_curr = NULL; /* end of list */
893 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
894 uint32_t alg_auth, uint32_t alg_enc,
895 uint32_t alg_mac, int min_tls,
896 uint32_t algo_strength, int rule,
897 int32_t strength_bits, CIPHER_ORDER **head_p,
898 CIPHER_ORDER **tail_p)
900 CIPHER_ORDER *head, *tail, *curr, *next, *last;
901 const SSL_CIPHER *cp;
906 "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
907 rule, alg_mkey, alg_auth, alg_enc, alg_mac, min_tls,
908 algo_strength, strength_bits);
911 if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
912 reverse = 1; /* needed to maintain sorting between
913 * currently deleted ciphers */
936 next = reverse ? curr->prev : curr->next;
941 * Selection criteria is either the value of strength_bits
942 * or the algorithms used.
944 if (strength_bits >= 0) {
945 if (strength_bits != cp->strength_bits)
950 "\nName: %s:\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
951 cp->name, cp->algorithm_mkey, cp->algorithm_auth,
952 cp->algorithm_enc, cp->algorithm_mac, cp->algorithm_ssl,
955 if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
957 if (alg_auth && !(alg_auth & cp->algorithm_auth))
959 if (alg_enc && !(alg_enc & cp->algorithm_enc))
961 if (alg_mac && !(alg_mac & cp->algorithm_mac))
963 if (min_tls && (min_tls != cp->min_tls))
965 if (algo_strength && !(algo_strength & cp->algo_strength))
967 if ((algo_strength & SSL_DEFAULT_MASK)
968 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
973 fprintf(stderr, "Action = %d\n", rule);
976 /* add the cipher if it has not been added yet. */
977 if (rule == CIPHER_ADD) {
980 ll_append_tail(&head, curr, &tail);
984 /* Move the added cipher to this location */
985 else if (rule == CIPHER_ORD) {
988 ll_append_tail(&head, curr, &tail);
990 } else if (rule == CIPHER_DEL) {
994 * most recently deleted ciphersuites get best positions for
995 * any future CIPHER_ADD (note that the CIPHER_DEL loop works
996 * in reverse to maintain the order)
998 ll_append_head(&head, curr, &tail);
1001 } else if (rule == CIPHER_BUMP) {
1003 ll_append_head(&head, curr, &tail);
1004 } else if (rule == CIPHER_KILL) {
1009 curr->prev->next = curr->next;
1013 if (curr->next != NULL)
1014 curr->next->prev = curr->prev;
1015 if (curr->prev != NULL)
1016 curr->prev->next = curr->next;
1026 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
1027 CIPHER_ORDER **tail_p)
1029 int32_t max_strength_bits;
1030 int i, *number_uses;
1034 * This routine sorts the ciphers with descending strength. The sorting
1035 * must keep the pre-sorted sequence, so we apply the normal sorting
1036 * routine as '+' movement to the end of the list.
1038 max_strength_bits = 0;
1040 while (curr != NULL) {
1041 if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
1042 max_strength_bits = curr->cipher->strength_bits;
1046 number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
1047 if (number_uses == NULL) {
1048 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT, ERR_R_MALLOC_FAILURE);
1053 * Now find the strength_bits values actually used
1056 while (curr != NULL) {
1058 number_uses[curr->cipher->strength_bits]++;
1062 * Go through the list of used strength_bits values in descending
1065 for (i = max_strength_bits; i >= 0; i--)
1066 if (number_uses[i] > 0)
1067 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
1070 OPENSSL_free(number_uses);
1074 static int ssl_cipher_process_rulestr(const char *rule_str,
1075 CIPHER_ORDER **head_p,
1076 CIPHER_ORDER **tail_p,
1077 const SSL_CIPHER **ca_list, CERT *c)
1079 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
1081 const char *l, *buf;
1082 int j, multi, found, rule, retval, ok, buflen;
1083 uint32_t cipher_id = 0;
1096 } else if (ch == '+') {
1099 } else if (ch == '!') {
1102 } else if (ch == '@') {
1103 rule = CIPHER_SPECIAL;
1125 #ifndef CHARSET_EBCDIC
1126 while (((ch >= 'A') && (ch <= 'Z')) ||
1127 ((ch >= '0') && (ch <= '9')) ||
1128 ((ch >= 'a') && (ch <= 'z')) ||
1129 (ch == '-') || (ch == '.') || (ch == '='))
1131 while (isalnum(ch) || (ch == '-') || (ch == '.') || (ch == '='))
1140 * We hit something we cannot deal with,
1141 * it is no command or separator nor
1142 * alphanumeric, so we call this an error.
1144 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1145 SSL_R_INVALID_COMMAND);
1151 if (rule == CIPHER_SPECIAL) {
1152 found = 0; /* unused -- avoid compiler warning */
1153 break; /* special treatment */
1156 /* check for multi-part specification */
1164 * Now search for the cipher alias in the ca_list. Be careful
1165 * with the strncmp, because the "buflen" limitation
1166 * will make the rule "ADH:SOME" and the cipher
1167 * "ADH-MY-CIPHER" look like a match for buflen=3.
1168 * So additionally check whether the cipher name found
1169 * has the correct length. We can save a strlen() call:
1170 * just checking for the '\0' at the right place is
1171 * sufficient, we have to strncmp() anyway. (We cannot
1172 * use strcmp(), because buf is not '\0' terminated.)
1176 while (ca_list[j]) {
1177 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1178 && (ca_list[j]->name[buflen] == '\0')) {
1186 break; /* ignore this entry */
1188 if (ca_list[j]->algorithm_mkey) {
1190 alg_mkey &= ca_list[j]->algorithm_mkey;
1196 alg_mkey = ca_list[j]->algorithm_mkey;
1199 if (ca_list[j]->algorithm_auth) {
1201 alg_auth &= ca_list[j]->algorithm_auth;
1207 alg_auth = ca_list[j]->algorithm_auth;
1210 if (ca_list[j]->algorithm_enc) {
1212 alg_enc &= ca_list[j]->algorithm_enc;
1218 alg_enc = ca_list[j]->algorithm_enc;
1221 if (ca_list[j]->algorithm_mac) {
1223 alg_mac &= ca_list[j]->algorithm_mac;
1229 alg_mac = ca_list[j]->algorithm_mac;
1232 if (ca_list[j]->algo_strength) {
1233 if (algo_strength) {
1234 algo_strength &= ca_list[j]->algo_strength;
1235 if (!algo_strength) {
1240 algo_strength = ca_list[j]->algo_strength;
1243 if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1244 if (algo_strength & SSL_DEFAULT_MASK) {
1246 (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1248 if (!(algo_strength & SSL_DEFAULT_MASK)) {
1254 ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1257 if (ca_list[j]->valid) {
1259 * explicit ciphersuite found; its protocol version does not
1260 * become part of the search pattern!
1263 cipher_id = ca_list[j]->id;
1266 * not an explicit ciphersuite; only in this case, the
1267 * protocol version is considered part of the search pattern
1270 if (ca_list[j]->min_tls) {
1271 if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1275 min_tls = ca_list[j]->min_tls;
1285 * Ok, we have the rule, now apply it
1287 if (rule == CIPHER_SPECIAL) { /* special command */
1289 if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0)
1290 ok = ssl_cipher_strength_sort(head_p, tail_p);
1291 else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1292 int level = buf[9] - '0';
1293 if (level < 0 || level > 5) {
1294 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1295 SSL_R_INVALID_COMMAND);
1297 c->sec_level = level;
1301 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
1302 SSL_R_INVALID_COMMAND);
1306 * We do not support any "multi" options
1307 * together with "@", so throw away the
1308 * rest of the command, if any left, until
1309 * end or ':' is found.
1311 while ((*l != '\0') && !ITEM_SEP(*l))
1314 ssl_cipher_apply_rule(cipher_id,
1315 alg_mkey, alg_auth, alg_enc, alg_mac,
1316 min_tls, algo_strength, rule, -1, head_p,
1319 while ((*l != '\0') && !ITEM_SEP(*l))
1329 #ifndef OPENSSL_NO_EC
1330 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1331 const char **prule_str)
1333 unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1334 if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1335 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1336 } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1338 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1339 } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1340 suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1341 } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1342 suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1346 c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1347 c->cert_flags |= suiteb_flags;
1349 suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1353 /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1355 if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1356 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1357 SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1360 # ifndef OPENSSL_NO_EC
1361 switch (suiteb_flags) {
1362 case SSL_CERT_FLAG_SUITEB_128_LOS:
1364 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1367 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1369 case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1370 *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1372 case SSL_CERT_FLAG_SUITEB_192_LOS:
1373 *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1378 SSLerr(SSL_F_CHECK_SUITEB_CIPHER_LIST,
1379 SSL_R_ECDH_REQUIRED_FOR_SUITEB_MODE);
1385 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method, STACK_OF(SSL_CIPHER)
1386 **cipher_list, STACK_OF(SSL_CIPHER)
1387 **cipher_list_by_id,
1388 const char *rule_str, CERT *c)
1390 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
1391 uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1392 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
1394 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1395 const SSL_CIPHER **ca_list = NULL;
1398 * Return with error if nothing to do.
1400 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1402 #ifndef OPENSSL_NO_EC
1403 if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1408 * To reduce the work to do we only want to process the compiled
1409 * in algorithms, so we first get the mask of disabled ciphers.
1412 disabled_mkey = disabled_mkey_mask;
1413 disabled_auth = disabled_auth_mask;
1414 disabled_enc = disabled_enc_mask;
1415 disabled_mac = disabled_mac_mask;
1418 * Now we have to collect the available ciphers from the compiled
1419 * in ciphers. We cannot get more than the number compiled in, so
1420 * it is used for allocation.
1422 num_of_ciphers = ssl_method->num_ciphers();
1424 co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1425 if (co_list == NULL) {
1426 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1427 return (NULL); /* Failure */
1430 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1431 disabled_mkey, disabled_auth, disabled_enc,
1432 disabled_mac, co_list, &head,
1435 /* Now arrange all ciphers by preference. */
1438 * Everything else being equal, prefer ephemeral ECDH over other key
1439 * exchange mechanisms.
1440 * For consistency, prefer ECDSA over RSA (though this only matters if the
1441 * server has both certificates, and is using the DEFAULT, or a client
1444 ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1446 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1448 ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1452 /* Within each strength group, we prefer GCM over CHACHA... */
1453 ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1455 ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1459 * ...and generally, our preferred cipher is AES.
1460 * Note that AEADs will be bumped to take preference after sorting by
1463 ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1466 /* Temporarily enable everything else for sorting */
1467 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1469 /* Low priority for MD5 */
1470 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1474 * Move anonymous ciphers to the end. Usually, these will remain
1475 * disabled. (For applications that allow them, they aren't too bad, but
1476 * we prefer authenticated ciphers.)
1478 ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1482 * ssl_cipher_apply_rule(0, 0, SSL_aDH, 0, 0, 0, 0, CIPHER_ORD, -1,
1485 ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1487 ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1490 /* RC4 is sort-of broken -- move the the end */
1491 ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1495 * Now sort by symmetric encryption strength. The above ordering remains
1496 * in force within each class
1498 if (!ssl_cipher_strength_sort(&head, &tail)) {
1499 OPENSSL_free(co_list);
1504 * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1505 * TODO(openssl-team): is there an easier way to accomplish all this?
1507 ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1511 * Irrespective of strength, enforce the following order:
1512 * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1513 * Within each group, ciphers remain sorted by strength and previous
1518 * 4) TLS 1.2 > legacy
1520 * Because we now bump ciphers to the top of the list, we proceed in
1521 * reverse order of preference.
1523 ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1525 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1526 CIPHER_BUMP, -1, &head, &tail);
1527 ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1528 CIPHER_BUMP, -1, &head, &tail);
1530 /* Now disable everything (maintaining the ordering!) */
1531 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1534 * We also need cipher aliases for selecting based on the rule_str.
1535 * There might be two types of entries in the rule_str: 1) names
1536 * of ciphers themselves 2) aliases for groups of ciphers.
1537 * For 1) we need the available ciphers and for 2) the cipher
1538 * groups of cipher_aliases added together in one list (otherwise
1539 * we would be happy with just the cipher_aliases table).
1541 num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1542 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1543 ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1544 if (ca_list == NULL) {
1545 OPENSSL_free(co_list);
1546 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST, ERR_R_MALLOC_FAILURE);
1547 return (NULL); /* Failure */
1549 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1550 disabled_mkey, disabled_auth, disabled_enc,
1551 disabled_mac, head);
1554 * If the rule_string begins with DEFAULT, apply the default rule
1555 * before using the (possibly available) additional rules.
1559 if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1560 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
1561 &head, &tail, ca_list, c);
1567 if (ok && (strlen(rule_p) > 0))
1568 ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1570 OPENSSL_free(ca_list); /* Not needed anymore */
1572 if (!ok) { /* Rule processing failure */
1573 OPENSSL_free(co_list);
1578 * Allocate new "cipherstack" for the result, return with error
1579 * if we cannot get one.
1581 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1582 OPENSSL_free(co_list);
1587 * The cipher selection for the list is done. The ciphers are added
1588 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1590 for (curr = head; curr != NULL; curr = curr->next) {
1592 && (!FIPS_mode() || curr->cipher->algo_strength & SSL_FIPS)) {
1593 if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1594 OPENSSL_free(co_list);
1595 sk_SSL_CIPHER_free(cipherstack);
1599 fprintf(stderr, "<%s>\n", curr->cipher->name);
1603 OPENSSL_free(co_list); /* Not needed any longer */
1605 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1606 if (tmp_cipher_list == NULL) {
1607 sk_SSL_CIPHER_free(cipherstack);
1610 sk_SSL_CIPHER_free(*cipher_list);
1611 *cipher_list = cipherstack;
1612 if (*cipher_list_by_id != NULL)
1613 sk_SSL_CIPHER_free(*cipher_list_by_id);
1614 *cipher_list_by_id = tmp_cipher_list;
1615 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id,
1616 ssl_cipher_ptr_id_cmp);
1618 sk_SSL_CIPHER_sort(*cipher_list_by_id);
1619 return (cipherstack);
1622 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1625 const char *kx, *au, *enc, *mac;
1626 uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1627 static const char *format =
1628 "%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s\n";
1632 buf = OPENSSL_malloc(len);
1635 } else if (len < 128)
1638 alg_mkey = cipher->algorithm_mkey;
1639 alg_auth = cipher->algorithm_auth;
1640 alg_enc = cipher->algorithm_enc;
1641 alg_mac = cipher->algorithm_mac;
1643 ver = ssl_protocol_to_string(cipher->min_tls);
1699 /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1700 case (SSL_aGOST12 | SSL_aGOST01):
1734 enc = "AESGCM(128)";
1737 enc = "AESGCM(256)";
1740 enc = "AESCCM(128)";
1743 enc = "AESCCM(256)";
1745 case SSL_AES128CCM8:
1746 enc = "AESCCM8(128)";
1748 case SSL_AES256CCM8:
1749 enc = "AESCCM8(256)";
1751 case SSL_CAMELLIA128:
1752 enc = "Camellia(128)";
1754 case SSL_CAMELLIA256:
1755 enc = "Camellia(256)";
1760 case SSL_eGOST2814789CNT:
1761 case SSL_eGOST2814789CNT12:
1762 enc = "GOST89(256)";
1764 case SSL_CHACHA20POLY1305:
1765 enc = "CHACHA20/POLY1305(256)";
1789 case SSL_GOST89MAC12:
1795 case SSL_GOST12_256:
1796 case SSL_GOST12_512:
1804 BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1809 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1813 return ssl_protocol_to_string(c->min_tls);
1816 /* return the actual cipher being used */
1817 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1824 /* number of bits for symmetric cipher */
1825 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1830 if (alg_bits != NULL)
1831 *alg_bits = (int) c->alg_bits;
1832 ret = (int) c->strength_bits;
1837 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1842 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1847 if ((n == 0) || (sk == NULL))
1849 nn = sk_SSL_COMP_num(sk);
1850 for (i = 0; i < nn; i++) {
1851 ctmp = sk_SSL_COMP_value(sk, i);
1858 #ifdef OPENSSL_NO_COMP
1859 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1863 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1868 void SSL_COMP_free_compression_methods(void)
1871 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1877 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1879 load_builtin_compressions();
1880 return (ssl_comp_methods);
1883 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1886 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1887 ssl_comp_methods = meths;
1891 static void cmeth_free(SSL_COMP *cm)
1896 void SSL_COMP_free_compression_methods(void)
1898 STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
1899 ssl_comp_methods = NULL;
1900 sk_SSL_COMP_pop_free(old_meths, cmeth_free);
1903 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1907 if (cm == NULL || COMP_get_type(cm) == NID_undef)
1911 * According to draft-ietf-tls-compression-04.txt, the
1912 * compression number ranges should be the following:
1914 * 0 to 63: methods defined by the IETF
1915 * 64 to 192: external party methods assigned by IANA
1916 * 193 to 255: reserved for private use
1918 if (id < 193 || id > 255) {
1919 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1920 SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1924 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
1925 comp = OPENSSL_malloc(sizeof(*comp));
1927 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1928 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1934 load_builtin_compressions();
1935 if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
1937 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1938 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,
1939 SSL_R_DUPLICATE_COMPRESSION_ID);
1942 if ((ssl_comp_methods == NULL)
1943 || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
1945 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1946 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD, ERR_R_MALLOC_FAILURE);
1949 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
1954 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
1956 #ifndef OPENSSL_NO_COMP
1957 return comp ? COMP_get_name(comp) : NULL;
1963 /* For a cipher return the index corresponding to the certificate type */
1964 int ssl_cipher_get_cert_index(const SSL_CIPHER *c)
1968 alg_a = c->algorithm_auth;
1970 if (alg_a & SSL_aECDSA)
1971 return SSL_PKEY_ECC;
1972 else if (alg_a & SSL_aDSS)
1973 return SSL_PKEY_DSA_SIGN;
1974 else if (alg_a & SSL_aRSA)
1975 return SSL_PKEY_RSA_ENC;
1976 else if (alg_a & SSL_aGOST12)
1977 return SSL_PKEY_GOST_EC;
1978 else if (alg_a & SSL_aGOST01)
1979 return SSL_PKEY_GOST01;
1984 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr)
1986 const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
1988 if (c == NULL || c->valid == 0)
1993 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
1995 return ssl->method->get_cipher_by_char(ptr);
1998 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2003 i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2006 return ssl_cipher_table_cipher[i].nid;
2009 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2011 int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2015 return ssl_cipher_table_mac[i].nid;
2018 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2020 int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2024 return ssl_cipher_table_kx[i].nid;
2027 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2029 int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2033 return ssl_cipher_table_auth[i].nid;
2036 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2038 return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;