2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include <openssl/rand.h>
65 /* PKCS#5 v2.0 password based encryption structures */
67 ASN1_SEQUENCE(PBE2PARAM
) = {
68 ASN1_SIMPLE(PBE2PARAM
, keyfunc
, X509_ALGOR
),
69 ASN1_SIMPLE(PBE2PARAM
, encryption
, X509_ALGOR
)
70 } ASN1_SEQUENCE_END(PBE2PARAM
)
72 IMPLEMENT_ASN1_FUNCTIONS(PBE2PARAM
)
74 ASN1_SEQUENCE(PBKDF2PARAM
) = {
75 ASN1_SIMPLE(PBKDF2PARAM
, salt
, ASN1_ANY
),
76 ASN1_SIMPLE(PBKDF2PARAM
, iter
, ASN1_INTEGER
),
77 ASN1_OPT(PBKDF2PARAM
, keylength
, ASN1_INTEGER
),
78 ASN1_OPT(PBKDF2PARAM
, prf
, X509_ALGOR
)
79 } ASN1_SEQUENCE_END(PBKDF2PARAM
)
81 IMPLEMENT_ASN1_FUNCTIONS(PBKDF2PARAM
)
83 /* Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm:
84 * yes I know this is horrible!
86 * Extended version to allow application supplied PRF NID and IV.
89 X509_ALGOR
*PKCS5_pbe2_set_iv(const EVP_CIPHER
*cipher
, int iter
,
90 unsigned char *salt
, int saltlen
,
91 unsigned char *aiv
, int prf_nid
)
93 X509_ALGOR
*scheme
= NULL
, *kalg
= NULL
, *ret
= NULL
;
96 unsigned char iv
[EVP_MAX_IV_LENGTH
];
97 PBE2PARAM
*pbe2
= NULL
;
100 alg_nid
= EVP_CIPHER_type(cipher
);
101 if(alg_nid
== NID_undef
) {
102 ASN1err(ASN1_F_PKCS5_PBE2_SET_IV
,
103 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER
);
106 obj
= OBJ_nid2obj(alg_nid
);
108 if(!(pbe2
= PBE2PARAM_new())) goto merr
;
110 /* Setup the AlgorithmIdentifier for the encryption scheme */
111 scheme
= pbe2
->encryption
;
113 scheme
->algorithm
= obj
;
114 if(!(scheme
->parameter
= ASN1_TYPE_new())) goto merr
;
116 /* Create random IV */
117 if (EVP_CIPHER_iv_length(cipher
))
120 memcpy(iv
, aiv
, EVP_CIPHER_iv_length(cipher
));
121 else if (RAND_pseudo_bytes(iv
, EVP_CIPHER_iv_length(cipher
)) < 0)
125 EVP_CIPHER_CTX_init(&ctx
);
127 /* Dummy cipherinit to just setup the IV, and PRF */
128 if (!EVP_CipherInit_ex(&ctx
, cipher
, NULL
, NULL
, iv
, 0))
130 if(EVP_CIPHER_param_to_asn1(&ctx
, scheme
->parameter
) < 0) {
131 ASN1err(ASN1_F_PKCS5_PBE2_SET_IV
,
132 ASN1_R_ERROR_SETTING_CIPHER_PARAMS
);
133 EVP_CIPHER_CTX_cleanup(&ctx
);
136 /* If prf NID unspecified see if cipher has a preference.
137 * An error is OK here: just means use default PRF.
139 if ((prf_nid
== -1) &&
140 EVP_CIPHER_CTX_ctrl(&ctx
, EVP_CTRL_PBE_PRF_NID
, 0, &prf_nid
) <= 0)
143 prf_nid
= NID_hmacWithSHA1
;
145 EVP_CIPHER_CTX_cleanup(&ctx
);
147 /* If its RC2 then we'd better setup the key length */
149 if(alg_nid
== NID_rc2_cbc
)
150 keylen
= EVP_CIPHER_key_length(cipher
);
156 X509_ALGOR_free(pbe2
->keyfunc
);
158 pbe2
->keyfunc
= PKCS5_pbkdf2_set(iter
, salt
, saltlen
, prf_nid
, keylen
);
163 /* Now set up top level AlgorithmIdentifier */
165 if(!(ret
= X509_ALGOR_new())) goto merr
;
166 if(!(ret
->parameter
= ASN1_TYPE_new())) goto merr
;
168 ret
->algorithm
= OBJ_nid2obj(NID_pbes2
);
170 /* Encode PBE2PARAM into parameter */
172 if(!ASN1_item_pack(pbe2
, ASN1_ITEM_rptr(PBE2PARAM
),
173 &ret
->parameter
->value
.sequence
)) goto merr
;
174 ret
->parameter
->type
= V_ASN1_SEQUENCE
;
176 PBE2PARAM_free(pbe2
);
182 ASN1err(ASN1_F_PKCS5_PBE2_SET_IV
,ERR_R_MALLOC_FAILURE
);
185 PBE2PARAM_free(pbe2
);
186 /* Note 'scheme' is freed as part of pbe2 */
187 X509_ALGOR_free(kalg
);
188 X509_ALGOR_free(ret
);
194 X509_ALGOR
*PKCS5_pbe2_set(const EVP_CIPHER
*cipher
, int iter
,
195 unsigned char *salt
, int saltlen
)
197 return PKCS5_pbe2_set_iv(cipher
, iter
, salt
, saltlen
, NULL
, -1);
200 X509_ALGOR
*PKCS5_pbkdf2_set(int iter
, unsigned char *salt
, int saltlen
,
201 int prf_nid
, int keylen
)
203 X509_ALGOR
*keyfunc
= NULL
;
204 PBKDF2PARAM
*kdf
= NULL
;
205 ASN1_OCTET_STRING
*osalt
= NULL
;
207 if(!(kdf
= PBKDF2PARAM_new()))
209 if(!(osalt
= M_ASN1_OCTET_STRING_new()))
212 kdf
->salt
->value
.octet_string
= osalt
;
213 kdf
->salt
->type
= V_ASN1_OCTET_STRING
;
216 saltlen
= PKCS5_SALT_LEN
;
217 if (!(osalt
->data
= OPENSSL_malloc (saltlen
)))
220 osalt
->length
= saltlen
;
223 memcpy (osalt
->data
, salt
, saltlen
);
224 else if (RAND_pseudo_bytes (osalt
->data
, saltlen
) < 0)
228 iter
= PKCS5_DEFAULT_ITER
;
230 if(!ASN1_INTEGER_set(kdf
->iter
, iter
))
233 /* If have a key len set it up */
237 if(!(kdf
->keylength
= M_ASN1_INTEGER_new()))
239 if(!ASN1_INTEGER_set (kdf
->keylength
, keylen
))
243 /* prf can stay NULL if we are using hmacWithSHA1 */
244 if (prf_nid
> 0 && prf_nid
!= NID_hmacWithSHA1
)
246 kdf
->prf
= X509_ALGOR_new();
249 X509_ALGOR_set0(kdf
->prf
, OBJ_nid2obj(prf_nid
),
253 /* Finally setup the keyfunc structure */
255 keyfunc
= X509_ALGOR_new();
259 keyfunc
->algorithm
= OBJ_nid2obj(NID_id_pbkdf2
);
261 /* Encode PBKDF2PARAM into parameter of pbe2 */
263 if(!(keyfunc
->parameter
= ASN1_TYPE_new()))
266 if(!ASN1_item_pack(kdf
, ASN1_ITEM_rptr(PBKDF2PARAM
),
267 &keyfunc
->parameter
->value
.sequence
))
269 keyfunc
->parameter
->type
= V_ASN1_SEQUENCE
;
271 PBKDF2PARAM_free(kdf
);
275 ASN1err(ASN1_F_PKCS5_PBKDF2_SET
,ERR_R_MALLOC_FAILURE
);
276 PBKDF2PARAM_free(kdf
);
277 X509_ALGOR_free(keyfunc
);