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