3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999 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).
62 #include <openssl/asn1t.h>
63 #include <openssl/x509.h>
64 #include <openssl/rand.h>
66 /* PKCS#5 v2.0 password based encryption structures */
68 ASN1_SEQUENCE(PBE2PARAM) = {
69 ASN1_SIMPLE(PBE2PARAM, keyfunc, X509_ALGOR),
70 ASN1_SIMPLE(PBE2PARAM, encryption, X509_ALGOR)
71 } ASN1_SEQUENCE_END(PBE2PARAM)
73 IMPLEMENT_ASN1_FUNCTIONS(PBE2PARAM)
75 ASN1_SEQUENCE(PBKDF2PARAM) = {
76 ASN1_SIMPLE(PBKDF2PARAM, salt, ASN1_ANY),
77 ASN1_SIMPLE(PBKDF2PARAM, iter, ASN1_INTEGER),
78 ASN1_OPT(PBKDF2PARAM, keylength, ASN1_INTEGER),
79 ASN1_OPT(PBKDF2PARAM, prf, X509_ALGOR)
80 } ASN1_SEQUENCE_END(PBKDF2PARAM)
82 IMPLEMENT_ASN1_FUNCTIONS(PBKDF2PARAM)
85 * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm: yes I know
86 * this is horrible! Extended version to allow application supplied PRF NID
90 X509_ALGOR *PKCS5_pbe2_set_iv(const EVP_CIPHER *cipher, int iter,
91 unsigned char *salt, int saltlen,
92 unsigned char *aiv, int prf_nid)
94 X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
97 unsigned char iv[EVP_MAX_IV_LENGTH];
98 PBKDF2PARAM *kdf = NULL;
99 PBE2PARAM *pbe2 = NULL;
100 ASN1_OCTET_STRING *osalt = NULL;
103 alg_nid = EVP_CIPHER_type(cipher);
104 if (alg_nid == NID_undef) {
105 ASN1err(ASN1_F_PKCS5_PBE2_SET_IV,
106 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
109 obj = OBJ_nid2obj(alg_nid);
111 if (!(pbe2 = PBE2PARAM_new()))
114 /* Setup the AlgorithmIdentifier for the encryption scheme */
115 scheme = pbe2->encryption;
117 scheme->algorithm = obj;
118 if (!(scheme->parameter = ASN1_TYPE_new()))
121 /* Create random IV */
122 if (EVP_CIPHER_iv_length(cipher)) {
124 memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
125 else if (RAND_pseudo_bytes(iv, EVP_CIPHER_iv_length(cipher)) < 0)
129 EVP_CIPHER_CTX_init(&ctx);
131 /* Dummy cipherinit to just setup the IV, and PRF */
132 EVP_CipherInit_ex(&ctx, cipher, NULL, NULL, iv, 0);
133 if (EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
134 ASN1err(ASN1_F_PKCS5_PBE2_SET_IV, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
135 EVP_CIPHER_CTX_cleanup(&ctx);
139 * If prf NID unspecified see if cipher has a preference. An error is OK
140 * here: just means use default PRF.
142 if ((prf_nid == -1) &&
143 EVP_CIPHER_CTX_ctrl(&ctx, EVP_CTRL_PBE_PRF_NID, 0, &prf_nid) <= 0) {
145 prf_nid = NID_hmacWithSHA1;
147 EVP_CIPHER_CTX_cleanup(&ctx);
149 if (!(kdf = PBKDF2PARAM_new()))
151 if (!(osalt = M_ASN1_OCTET_STRING_new()))
155 saltlen = PKCS5_SALT_LEN;
156 if (!(osalt->data = OPENSSL_malloc(saltlen)))
158 osalt->length = saltlen;
160 memcpy(osalt->data, salt, saltlen);
161 else if (RAND_pseudo_bytes(osalt->data, saltlen) < 0)
165 iter = PKCS5_DEFAULT_ITER;
166 if (!ASN1_INTEGER_set(kdf->iter, iter))
169 /* Now include salt in kdf structure */
170 kdf->salt->value.octet_string = osalt;
171 kdf->salt->type = V_ASN1_OCTET_STRING;
174 /* If its RC2 then we'd better setup the key length */
176 if (alg_nid == NID_rc2_cbc) {
177 if (!(kdf->keylength = M_ASN1_INTEGER_new()))
179 if (!ASN1_INTEGER_set(kdf->keylength, EVP_CIPHER_key_length(cipher)))
183 /* prf can stay NULL if we are using hmacWithSHA1 */
184 if (prf_nid != NID_hmacWithSHA1) {
185 kdf->prf = X509_ALGOR_new();
188 X509_ALGOR_set0(kdf->prf, OBJ_nid2obj(prf_nid), V_ASN1_NULL, NULL);
191 /* Now setup the PBE2PARAM keyfunc structure */
193 pbe2->keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
195 /* Encode PBKDF2PARAM into parameter of pbe2 */
197 if (!(pbe2->keyfunc->parameter = ASN1_TYPE_new()))
200 if (!ASN1_item_pack(kdf, ASN1_ITEM_rptr(PBKDF2PARAM),
201 &pbe2->keyfunc->parameter->value.sequence))
203 pbe2->keyfunc->parameter->type = V_ASN1_SEQUENCE;
205 PBKDF2PARAM_free(kdf);
208 /* Now set up top level AlgorithmIdentifier */
210 if (!(ret = X509_ALGOR_new()))
212 if (!(ret->parameter = ASN1_TYPE_new()))
215 ret->algorithm = OBJ_nid2obj(NID_pbes2);
217 /* Encode PBE2PARAM into parameter */
219 if (!ASN1_item_pack(pbe2, ASN1_ITEM_rptr(PBE2PARAM),
220 &ret->parameter->value.sequence))
222 ret->parameter->type = V_ASN1_SEQUENCE;
224 PBE2PARAM_free(pbe2);
230 ASN1err(ASN1_F_PKCS5_PBE2_SET_IV, ERR_R_MALLOC_FAILURE);
233 PBE2PARAM_free(pbe2);
234 /* Note 'scheme' is freed as part of pbe2 */
235 M_ASN1_OCTET_STRING_free(osalt);
236 PBKDF2PARAM_free(kdf);
237 X509_ALGOR_free(kalg);
238 X509_ALGOR_free(ret);
244 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
245 unsigned char *salt, int saltlen)
247 return PKCS5_pbe2_set_iv(cipher, iter, salt, saltlen, NULL, -1);