]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/evp/evp_pbe.c
GH715: ENGINE_finish can take NULL
[thirdparty/openssl.git] / crypto / evp / evp_pbe.c
CommitLineData
0f113f3e
MC
1/*
2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3 * 1999.
cfcefcbe
DSH
4 */
5/* ====================================================================
856640b5 6 * Copyright (c) 1999-2006 The OpenSSL Project. All rights reserved.
cfcefcbe
DSH
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
0f113f3e 13 * notice, this list of conditions and the following disclaimer.
cfcefcbe
DSH
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24 *
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
29 *
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
33 *
34 * 6. Redistributions of any form whatsoever must retain the following
35 * acknowledgment:
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38 *
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
52 *
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
56 *
57 */
58
59#include <stdio.h>
b39fc560 60#include "internal/cryptlib.h"
ec577822 61#include <openssl/evp.h>
b8f702a0 62#include <openssl/pkcs12.h>
ec577822 63#include <openssl/x509.h>
3d63b396 64#include "evp_locl.h"
cfcefcbe
DSH
65
66/* Password based encryption (PBE) functions */
67
cfcefcbe
DSH
68/* Setup a cipher context from a PBE algorithm */
69
4a1f3f27 70struct evp_pbe_st {
0f113f3e
MC
71 int pbe_type;
72 int pbe_nid;
73 int cipher_nid;
74 int md_nid;
75 EVP_PBE_KEYGEN *keygen;
4a1f3f27 76};
0f113f3e 77
4a640fb6
DSH
78static STACK_OF(EVP_PBE_CTL) *pbe_algs;
79
0f113f3e
MC
80static const EVP_PBE_CTL builtin_pbe[] = {
81 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndDES_CBC,
82 NID_des_cbc, NID_md2, PKCS5_PBE_keyivgen},
83 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndDES_CBC,
84 NID_des_cbc, NID_md5, PKCS5_PBE_keyivgen},
85 {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndRC2_CBC,
86 NID_rc2_64_cbc, NID_sha1, PKCS5_PBE_keyivgen},
b8f702a0 87
0f113f3e 88 {EVP_PBE_TYPE_OUTER, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
3d63b396 89
0f113f3e
MC
90 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC4,
91 NID_rc4, NID_sha1, PKCS12_PBE_keyivgen},
92 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC4,
93 NID_rc4_40, NID_sha1, PKCS12_PBE_keyivgen},
94 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And3_Key_TripleDES_CBC,
95 NID_des_ede3_cbc, NID_sha1, PKCS12_PBE_keyivgen},
96 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And2_Key_TripleDES_CBC,
97 NID_des_ede_cbc, NID_sha1, PKCS12_PBE_keyivgen},
98 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC2_CBC,
99 NID_rc2_cbc, NID_sha1, PKCS12_PBE_keyivgen},
100 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC2_CBC,
101 NID_rc2_40_cbc, NID_sha1, PKCS12_PBE_keyivgen},
b8f702a0 102
0f113f3e 103 {EVP_PBE_TYPE_OUTER, NID_pbes2, -1, -1, PKCS5_v2_PBE_keyivgen},
a283d2a8 104
0f113f3e
MC
105 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndRC2_CBC,
106 NID_rc2_64_cbc, NID_md2, PKCS5_PBE_keyivgen},
107 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndRC2_CBC,
108 NID_rc2_64_cbc, NID_md5, PKCS5_PBE_keyivgen},
109 {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndDES_CBC,
110 NID_des_cbc, NID_sha1, PKCS5_PBE_keyivgen},
111
112 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA1, -1, NID_sha1, 0},
113 {EVP_PBE_TYPE_PRF, NID_hmacWithMD5, -1, NID_md5, 0},
114 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA224, -1, NID_sha224, 0},
115 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA256, -1, NID_sha256, 0},
116 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA384, -1, NID_sha384, 0},
117 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512, -1, NID_sha512, 0},
118 {EVP_PBE_TYPE_PRF, NID_id_HMACGostR3411_94, -1, NID_id_GostR3411_94, 0},
eeb1c397
MC
119 {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_256, -1,
120 NID_id_GostR3411_2012_256, 0},
121 {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_512, -1,
122 NID_id_GostR3411_2012_512, 0},
e98aa30d 123 {EVP_PBE_TYPE_KDF, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
b0809bc8 124#ifndef OPENSSL_NO_SCRYPT
e98aa30d 125 {EVP_PBE_TYPE_KDF, NID_id_scrypt, -1, -1, PKCS5_v2_scrypt_keyivgen}
b0809bc8 126#endif
0f113f3e 127};
b8f702a0 128
8afca8d9 129int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
0f113f3e
MC
130 ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
131{
132 const EVP_CIPHER *cipher;
133 const EVP_MD *md;
134 int cipher_nid, md_nid;
135 EVP_PBE_KEYGEN *keygen;
136
137 if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
138 &cipher_nid, &md_nid, &keygen)) {
139 char obj_tmp[80];
140 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_PBE_ALGORITHM);
141 if (!pbe_obj)
7644a9ae 142 OPENSSL_strlcpy(obj_tmp, "NULL", sizeof obj_tmp);
0f113f3e
MC
143 else
144 i2t_ASN1_OBJECT(obj_tmp, sizeof obj_tmp, pbe_obj);
145 ERR_add_error_data(2, "TYPE=", obj_tmp);
146 return 0;
147 }
148
149 if (!pass)
150 passlen = 0;
151 else if (passlen == -1)
152 passlen = strlen(pass);
153
154 if (cipher_nid == -1)
155 cipher = NULL;
156 else {
157 cipher = EVP_get_cipherbynid(cipher_nid);
158 if (!cipher) {
159 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_CIPHER);
160 return 0;
161 }
162 }
163
164 if (md_nid == -1)
165 md = NULL;
166 else {
167 md = EVP_get_digestbynid(md_nid);
168 if (!md) {
169 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_DIGEST);
170 return 0;
171 }
172 }
173
174 if (!keygen(ctx, pass, passlen, param, cipher, md, en_de)) {
175 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_KEYGEN_FAILURE);
176 return 0;
177 }
178 return 1;
cfcefcbe
DSH
179}
180
e19106f5 181DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
babb3798 182
e19106f5 183static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
0f113f3e
MC
184{
185 int ret = pbe1->pbe_type - pbe2->pbe_type;
186 if (ret)
187 return ret;
188 else
189 return pbe1->pbe_nid - pbe2->pbe_nid;
190}
b8f702a0 191
e19106f5 192IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
babb3798 193
0f113f3e
MC
194static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
195{
196 int ret = (*a)->pbe_type - (*b)->pbe_type;
197 if (ret)
198 return ret;
199 else
200 return (*a)->pbe_nid - (*b)->pbe_nid;
201}
cfcefcbe
DSH
202
203/* Add a PBE algorithm */
204
0f113f3e
MC
205int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
206 int md_nid, EVP_PBE_KEYGEN *keygen)
207{
208 EVP_PBE_CTL *pbe_tmp;
b4faea50 209
8cf9d71a 210 if (pbe_algs == NULL) {
0f113f3e 211 pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
8cf9d71a
AG
212 if (pbe_algs == NULL)
213 goto err;
0f113f3e 214 }
8cf9d71a
AG
215
216 if ((pbe_tmp = OPENSSL_malloc(sizeof(*pbe_tmp))) == NULL)
217 goto err;
218
0f113f3e
MC
219 pbe_tmp->pbe_type = pbe_type;
220 pbe_tmp->pbe_nid = pbe_nid;
221 pbe_tmp->cipher_nid = cipher_nid;
222 pbe_tmp->md_nid = md_nid;
223 pbe_tmp->keygen = keygen;
224
225 sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp);
226 return 1;
8cf9d71a
AG
227
228 err:
229 EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE, ERR_R_MALLOC_FAILURE);
230 return 0;
0f113f3e 231}
856640b5
DSH
232
233int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
0f113f3e
MC
234 EVP_PBE_KEYGEN *keygen)
235{
236 int cipher_nid, md_nid;
75ebbd9a 237
0f113f3e
MC
238 if (cipher)
239 cipher_nid = EVP_CIPHER_nid(cipher);
240 else
241 cipher_nid = -1;
242 if (md)
243 md_nid = EVP_MD_type(md);
244 else
245 md_nid = -1;
246
247 return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
248 cipher_nid, md_nid, keygen);
249}
856640b5
DSH
250
251int EVP_PBE_find(int type, int pbe_nid,
0f113f3e
MC
252 int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
253{
254 EVP_PBE_CTL *pbetmp = NULL, pbelu;
255 int i;
256 if (pbe_nid == NID_undef)
257 return 0;
258
259 pbelu.pbe_type = type;
260 pbelu.pbe_nid = pbe_nid;
261
262 if (pbe_algs) {
263 i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
264 if (i != -1)
265 pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
266 }
267 if (pbetmp == NULL) {
b6eb9827 268 pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
0f113f3e
MC
269 }
270 if (pbetmp == NULL)
271 return 0;
272 if (pcnid)
273 *pcnid = pbetmp->cipher_nid;
274 if (pmnid)
275 *pmnid = pbetmp->md_nid;
276 if (pkeygen)
277 *pkeygen = pbetmp->keygen;
278 return 1;
279}
856640b5 280
5ce278a7 281static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
0f113f3e 282{
4b45c6e5 283 OPENSSL_free(pbe);
0f113f3e 284}
ee0508d4 285
6b691a5c 286void EVP_PBE_cleanup(void)
0f113f3e
MC
287{
288 sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
289 pbe_algs = NULL;
290}
d9546693
DSH
291
292int EVP_PBE_get(int *ptype, int *ppbe_nid, size_t num)
293{
294 const EVP_PBE_CTL *tpbe;
295
296 if (num >= OSSL_NELEM(builtin_pbe))
297 return 0;
298
299 tpbe = builtin_pbe + num;
300 if (ptype)
301 *ptype = tpbe->pbe_type;
302 if (ppbe_nid)
303 *ppbe_nid = tpbe->pbe_nid;
304 return 1;
305}