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