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
89 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
90 unsigned char *salt, int saltlen)
92 X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
95 unsigned char iv[EVP_MAX_IV_LENGTH];
96 PBKDF2PARAM *kdf = NULL;
97 PBE2PARAM *pbe2 = NULL;
98 ASN1_OCTET_STRING *osalt = NULL;
101 alg_nid = EVP_CIPHER_type(cipher);
102 if (alg_nid == NID_undef) {
103 ASN1err(ASN1_F_PKCS5_PBE2_SET,
104 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
107 obj = OBJ_nid2obj(alg_nid);
109 if (!(pbe2 = PBE2PARAM_new()))
112 /* Setup the AlgorithmIdentifier for the encryption scheme */
113 scheme = pbe2->encryption;
115 scheme->algorithm = obj;
116 if (!(scheme->parameter = ASN1_TYPE_new()))
119 /* Create random IV */
120 if (EVP_CIPHER_iv_length(cipher) &&
121 RAND_pseudo_bytes(iv, EVP_CIPHER_iv_length(cipher)) < 0)
124 EVP_CIPHER_CTX_init(&ctx);
126 /* Dummy cipherinit to just setup the IV */
127 EVP_CipherInit_ex(&ctx, cipher, NULL, NULL, iv, 0);
128 if (EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
129 ASN1err(ASN1_F_PKCS5_PBE2_SET, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
130 EVP_CIPHER_CTX_cleanup(&ctx);
133 EVP_CIPHER_CTX_cleanup(&ctx);
135 if (!(kdf = PBKDF2PARAM_new()))
137 if (!(osalt = M_ASN1_OCTET_STRING_new()))
141 saltlen = PKCS5_SALT_LEN;
142 if (!(osalt->data = OPENSSL_malloc(saltlen)))
144 osalt->length = saltlen;
146 memcpy(osalt->data, salt, saltlen);
147 else if (RAND_pseudo_bytes(osalt->data, saltlen) < 0)
151 iter = PKCS5_DEFAULT_ITER;
152 if (!ASN1_INTEGER_set(kdf->iter, iter))
155 /* Now include salt in kdf structure */
156 kdf->salt->value.octet_string = osalt;
157 kdf->salt->type = V_ASN1_OCTET_STRING;
160 /* If its RC2 then we'd better setup the key length */
162 if (alg_nid == NID_rc2_cbc) {
163 if (!(kdf->keylength = M_ASN1_INTEGER_new()))
165 if (!ASN1_INTEGER_set(kdf->keylength, EVP_CIPHER_key_length(cipher)))
169 /* prf can stay NULL because we are using hmacWithSHA1 */
171 /* Now setup the PBE2PARAM keyfunc structure */
173 pbe2->keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
175 /* Encode PBKDF2PARAM into parameter of pbe2 */
177 if (!(pbe2->keyfunc->parameter = ASN1_TYPE_new()))
180 if (!ASN1_pack_string_of(PBKDF2PARAM, kdf, i2d_PBKDF2PARAM,
181 &pbe2->keyfunc->parameter->value.sequence))
183 pbe2->keyfunc->parameter->type = V_ASN1_SEQUENCE;
185 PBKDF2PARAM_free(kdf);
188 /* Now set up top level AlgorithmIdentifier */
190 if (!(ret = X509_ALGOR_new()))
192 if (!(ret->parameter = ASN1_TYPE_new()))
195 ret->algorithm = OBJ_nid2obj(NID_pbes2);
197 /* Encode PBE2PARAM into parameter */
199 if (!ASN1_pack_string_of(PBE2PARAM, pbe2, i2d_PBE2PARAM,
200 &ret->parameter->value.sequence))
202 ret->parameter->type = V_ASN1_SEQUENCE;
204 PBE2PARAM_free(pbe2);
210 ASN1err(ASN1_F_PKCS5_PBE2_SET, ERR_R_MALLOC_FAILURE);
213 PBE2PARAM_free(pbe2);
214 /* Note 'scheme' is freed as part of pbe2 */
215 M_ASN1_OCTET_STRING_free(osalt);
216 PBKDF2PARAM_free(kdf);
217 X509_ALGOR_free(kalg);
218 X509_ALGOR_free(ret);