3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999-2006 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
61 #include "internal/cryptlib.h"
62 #include <openssl/evp.h>
63 #include <openssl/pkcs12.h>
64 #include <openssl/x509.h>
67 /* Password based encryption (PBE) functions */
69 /* Setup a cipher context from a PBE algorithm */
76 EVP_PBE_KEYGEN *keygen;
79 static STACK_OF(EVP_PBE_CTL) *pbe_algs;
81 static const EVP_PBE_CTL builtin_pbe[] = {
82 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndDES_CBC,
83 NID_des_cbc, NID_md2, PKCS5_PBE_keyivgen},
84 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndDES_CBC,
85 NID_des_cbc, NID_md5, PKCS5_PBE_keyivgen},
86 {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndRC2_CBC,
87 NID_rc2_64_cbc, NID_sha1, PKCS5_PBE_keyivgen},
89 {EVP_PBE_TYPE_OUTER, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
91 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC4,
92 NID_rc4, NID_sha1, PKCS12_PBE_keyivgen},
93 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC4,
94 NID_rc4_40, NID_sha1, PKCS12_PBE_keyivgen},
95 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And3_Key_TripleDES_CBC,
96 NID_des_ede3_cbc, NID_sha1, PKCS12_PBE_keyivgen},
97 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And2_Key_TripleDES_CBC,
98 NID_des_ede_cbc, NID_sha1, PKCS12_PBE_keyivgen},
99 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC2_CBC,
100 NID_rc2_cbc, NID_sha1, PKCS12_PBE_keyivgen},
101 {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC2_CBC,
102 NID_rc2_40_cbc, NID_sha1, PKCS12_PBE_keyivgen},
104 {EVP_PBE_TYPE_OUTER, NID_pbes2, -1, -1, PKCS5_v2_PBE_keyivgen},
106 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndRC2_CBC,
107 NID_rc2_64_cbc, NID_md2, PKCS5_PBE_keyivgen},
108 {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndRC2_CBC,
109 NID_rc2_64_cbc, NID_md5, PKCS5_PBE_keyivgen},
110 {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndDES_CBC,
111 NID_des_cbc, NID_sha1, PKCS5_PBE_keyivgen},
113 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA1, -1, NID_sha1, 0},
114 {EVP_PBE_TYPE_PRF, NID_hmacWithMD5, -1, NID_md5, 0},
115 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA224, -1, NID_sha224, 0},
116 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA256, -1, NID_sha256, 0},
117 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA384, -1, NID_sha384, 0},
118 {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512, -1, NID_sha512, 0},
119 {EVP_PBE_TYPE_PRF, NID_id_HMACGostR3411_94, -1, NID_id_GostR3411_94, 0},
120 {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_256, -1,
121 NID_id_GostR3411_2012_256, 0},
122 {EVP_PBE_TYPE_PRF, NID_id_tc26_hmac_gost_3411_2012_512, -1,
123 NID_id_GostR3411_2012_512, 0},
124 {EVP_PBE_TYPE_KDF, NID_id_pbkdf2, -1, -1, PKCS5_v2_PBKDF2_keyivgen},
125 #ifndef OPENSSL_NO_SCRYPT
126 {EVP_PBE_TYPE_KDF, NID_id_scrypt, -1, -1, PKCS5_v2_scrypt_keyivgen}
130 int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
131 ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
133 const EVP_CIPHER *cipher;
135 int cipher_nid, md_nid;
136 EVP_PBE_KEYGEN *keygen;
138 if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
139 &cipher_nid, &md_nid, &keygen)) {
141 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_PBE_ALGORITHM);
143 OPENSSL_strlcpy(obj_tmp, "NULL", sizeof obj_tmp);
145 i2t_ASN1_OBJECT(obj_tmp, sizeof obj_tmp, pbe_obj);
146 ERR_add_error_data(2, "TYPE=", obj_tmp);
152 else if (passlen == -1)
153 passlen = strlen(pass);
155 if (cipher_nid == -1)
158 cipher = EVP_get_cipherbynid(cipher_nid);
160 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_CIPHER);
168 md = EVP_get_digestbynid(md_nid);
170 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_UNKNOWN_DIGEST);
175 if (!keygen(ctx, pass, passlen, param, cipher, md, en_de)) {
176 EVPerr(EVP_F_EVP_PBE_CIPHERINIT, EVP_R_KEYGEN_FAILURE);
182 DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
184 static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
186 int ret = pbe1->pbe_type - pbe2->pbe_type;
190 return pbe1->pbe_nid - pbe2->pbe_nid;
193 IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
195 static int pbe_cmp(const EVP_PBE_CTL *const *a, const EVP_PBE_CTL *const *b)
197 int ret = (*a)->pbe_type - (*b)->pbe_type;
201 return (*a)->pbe_nid - (*b)->pbe_nid;
204 /* Add a PBE algorithm */
206 int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid,
207 int md_nid, EVP_PBE_KEYGEN *keygen)
209 EVP_PBE_CTL *pbe_tmp;
211 if (pbe_algs == NULL) {
212 pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
213 if (pbe_algs == NULL)
217 if ((pbe_tmp = OPENSSL_malloc(sizeof(*pbe_tmp))) == NULL)
220 pbe_tmp->pbe_type = pbe_type;
221 pbe_tmp->pbe_nid = pbe_nid;
222 pbe_tmp->cipher_nid = cipher_nid;
223 pbe_tmp->md_nid = md_nid;
224 pbe_tmp->keygen = keygen;
226 sk_EVP_PBE_CTL_push(pbe_algs, pbe_tmp);
230 EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE, ERR_R_MALLOC_FAILURE);
234 int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
235 EVP_PBE_KEYGEN *keygen)
237 int cipher_nid, md_nid;
240 cipher_nid = EVP_CIPHER_nid(cipher);
244 md_nid = EVP_MD_type(md);
248 return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
249 cipher_nid, md_nid, keygen);
252 int EVP_PBE_find(int type, int pbe_nid,
253 int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
255 EVP_PBE_CTL *pbetmp = NULL, pbelu;
257 if (pbe_nid == NID_undef)
260 pbelu.pbe_type = type;
261 pbelu.pbe_nid = pbe_nid;
264 i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
266 pbetmp = sk_EVP_PBE_CTL_value(pbe_algs, i);
268 if (pbetmp == NULL) {
269 pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe, OSSL_NELEM(builtin_pbe));
274 *pcnid = pbetmp->cipher_nid;
276 *pmnid = pbetmp->md_nid;
278 *pkeygen = pbetmp->keygen;
282 static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
287 void EVP_PBE_cleanup(void)
289 sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
293 int EVP_PBE_get(int *ptype, int *ppbe_nid, size_t num)
295 const EVP_PBE_CTL *tpbe;
297 if (num >= OSSL_NELEM(builtin_pbe))
300 tpbe = builtin_pbe + num;
302 *ptype = tpbe->pbe_type;
304 *ppbe_nid = tpbe->pbe_nid;