2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2006 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 #if !defined(OPENSSL_NO_HMAC) && !defined(OPENSSL_NO_SHA)
62 #include <openssl/x509.h>
63 #include <openssl/evp.h>
64 #include <openssl/hmac.h>
67 /* set this to print out info about the keygen algorithm */
68 /* #define DEBUG_PKCS5V2 */
71 static void h__dump (const unsigned char *p
, int len
);
74 /* This is an implementation of PKCS#5 v2.0 password based encryption key
75 * derivation function PBKDF2.
76 * SHA1 version verified against test vectors posted by Peter Gutmann
77 * <pgut001@cs.auckland.ac.nz> to the PKCS-TNG <pkcs-tng@rsa.com> mailing list.
80 int PKCS5_PBKDF2_HMAC(const char *pass
, int passlen
,
81 const unsigned char *salt
, int saltlen
, int iter
,
83 int keylen
, unsigned char *out
)
85 unsigned char digtmp
[EVP_MAX_MD_SIZE
], *p
, itmp
[4];
86 int cplen
, j
, k
, tkeylen
, mdlen
;
88 HMAC_CTX hctx_tpl
, hctx
;
90 mdlen
= EVP_MD_size(digest
);
94 HMAC_CTX_init(&hctx_tpl
);
99 else if(passlen
== -1)
100 passlen
= strlen(pass
);
101 if (!HMAC_Init_ex(&hctx_tpl
, pass
, passlen
, digest
, NULL
))
103 HMAC_CTX_cleanup(&hctx_tpl
);
112 /* We are unlikely to ever use more than 256 blocks (5120 bits!)
113 * but just in case...
115 itmp
[0] = (unsigned char)((i
>> 24) & 0xff);
116 itmp
[1] = (unsigned char)((i
>> 16) & 0xff);
117 itmp
[2] = (unsigned char)((i
>> 8) & 0xff);
118 itmp
[3] = (unsigned char)(i
& 0xff);
119 if (!HMAC_CTX_copy(&hctx
, &hctx_tpl
))
121 HMAC_CTX_cleanup(&hctx_tpl
);
124 if (!HMAC_Update(&hctx
, salt
, saltlen
)
125 || !HMAC_Update(&hctx
, itmp
, 4)
126 || !HMAC_Final(&hctx
, digtmp
, NULL
))
128 HMAC_CTX_cleanup(&hctx_tpl
);
129 HMAC_CTX_cleanup(&hctx
);
132 HMAC_CTX_cleanup(&hctx
);
133 memcpy(p
, digtmp
, cplen
);
134 for(j
= 1; j
< iter
; j
++)
136 if (!HMAC_CTX_copy(&hctx
, &hctx_tpl
))
138 HMAC_CTX_cleanup(&hctx_tpl
);
141 if (!HMAC_Update(&hctx
, digtmp
, mdlen
)
142 || !HMAC_Final(&hctx
, digtmp
, NULL
))
144 HMAC_CTX_cleanup(&hctx_tpl
);
145 HMAC_CTX_cleanup(&hctx
);
148 HMAC_CTX_cleanup(&hctx
);
149 for(k
= 0; k
< cplen
; k
++)
156 HMAC_CTX_cleanup(&hctx_tpl
);
158 fprintf(stderr
, "Password:\n");
159 h__dump (pass
, passlen
);
160 fprintf(stderr
, "Salt:\n");
161 h__dump (salt
, saltlen
);
162 fprintf(stderr
, "Iteration count %d\n", iter
);
163 fprintf(stderr
, "Key:\n");
164 h__dump (out
, keylen
);
169 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass
, int passlen
,
170 const unsigned char *salt
, int saltlen
, int iter
,
171 int keylen
, unsigned char *out
)
173 return PKCS5_PBKDF2_HMAC(pass
, passlen
, salt
, saltlen
, iter
, EVP_sha1(),
180 unsigned char out
[4];
181 unsigned char salt
[] = {0x12, 0x34, 0x56, 0x78};
182 PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt
, 4, 5, 4, out
);
183 fprintf(stderr
, "Out %02X %02X %02X %02X\n",
184 out
[0], out
[1], out
[2], out
[3]);
189 /* Now the key derivation function itself. This is a bit evil because
190 * it has to check the ASN1 parameters are valid: and there are quite a
194 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX
*ctx
, const char *pass
, int passlen
,
195 ASN1_TYPE
*param
, const EVP_CIPHER
*c
, const EVP_MD
*md
,
198 const unsigned char *pbuf
;
200 PBE2PARAM
*pbe2
= NULL
;
201 const EVP_CIPHER
*cipher
;
205 if (param
== NULL
|| param
->type
!= V_ASN1_SEQUENCE
||
206 param
->value
.sequence
== NULL
) {
207 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,EVP_R_DECODE_ERROR
);
211 pbuf
= param
->value
.sequence
->data
;
212 plen
= param
->value
.sequence
->length
;
213 if(!(pbe2
= d2i_PBE2PARAM(NULL
, &pbuf
, plen
))) {
214 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,EVP_R_DECODE_ERROR
);
218 /* See if we recognise the key derivation function */
220 if(OBJ_obj2nid(pbe2
->keyfunc
->algorithm
) != NID_id_pbkdf2
) {
221 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
222 EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION
);
226 /* lets see if we recognise the encryption algorithm.
229 cipher
= EVP_get_cipherbyobj(pbe2
->encryption
->algorithm
);
232 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
233 EVP_R_UNSUPPORTED_CIPHER
);
237 /* Fixup cipher based on AlgorithmIdentifier */
238 if (!EVP_CipherInit_ex(ctx
, cipher
, NULL
, NULL
, NULL
, en_de
))
240 if(EVP_CIPHER_asn1_to_param(ctx
, pbe2
->encryption
->parameter
) < 0) {
241 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
242 EVP_R_CIPHER_PARAMETER_ERROR
);
245 rv
= PKCS5_v2_PBKDF2_keyivgen(ctx
, pass
, passlen
,
246 pbe2
->keyfunc
->parameter
, c
, md
, en_de
);
248 PBE2PARAM_free(pbe2
);
252 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX
*ctx
, const char *pass
, int passlen
,
254 const EVP_CIPHER
*c
, const EVP_MD
*md
, int en_de
)
256 unsigned char *salt
, key
[EVP_MAX_KEY_LENGTH
];
257 const unsigned char *pbuf
;
258 int saltlen
, iter
, plen
;
260 unsigned int keylen
= 0;
261 int prf_nid
, hmac_md_nid
;
262 PBKDF2PARAM
*kdf
= NULL
;
265 if (EVP_CIPHER_CTX_cipher(ctx
) == NULL
)
267 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
,EVP_R_NO_CIPHER_SET
);
270 keylen
= EVP_CIPHER_CTX_key_length(ctx
);
271 OPENSSL_assert(keylen
<= sizeof key
);
273 /* Decode parameter */
275 if(!param
|| (param
->type
!= V_ASN1_SEQUENCE
))
277 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
,EVP_R_DECODE_ERROR
);
281 pbuf
= param
->value
.sequence
->data
;
282 plen
= param
->value
.sequence
->length
;
284 if(!(kdf
= d2i_PBKDF2PARAM(NULL
, &pbuf
, plen
)) ) {
285 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
,EVP_R_DECODE_ERROR
);
289 keylen
= EVP_CIPHER_CTX_key_length(ctx
);
291 /* Now check the parameters of the kdf */
293 if(kdf
->keylength
&& (ASN1_INTEGER_get(kdf
->keylength
) != (int)keylen
)){
294 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
,
295 EVP_R_UNSUPPORTED_KEYLENGTH
);
300 prf_nid
= OBJ_obj2nid(kdf
->prf
->algorithm
);
302 prf_nid
= NID_hmacWithSHA1
;
304 if (!EVP_PBE_find(EVP_PBE_TYPE_PRF
, prf_nid
, NULL
, &hmac_md_nid
, 0))
306 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
, EVP_R_UNSUPPORTED_PRF
);
310 prfmd
= EVP_get_digestbynid(hmac_md_nid
);
313 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
, EVP_R_UNSUPPORTED_PRF
);
317 if(kdf
->salt
->type
!= V_ASN1_OCTET_STRING
) {
318 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN
,
319 EVP_R_UNSUPPORTED_SALT_TYPE
);
323 /* it seems that its all OK */
324 salt
= kdf
->salt
->value
.octet_string
->data
;
325 saltlen
= kdf
->salt
->value
.octet_string
->length
;
326 iter
= ASN1_INTEGER_get(kdf
->iter
);
327 if(!PKCS5_PBKDF2_HMAC(pass
, passlen
, salt
, saltlen
, iter
, prfmd
,
330 rv
= EVP_CipherInit_ex(ctx
, NULL
, NULL
, key
, NULL
, en_de
);
332 OPENSSL_cleanse(key
, keylen
);
333 PBKDF2PARAM_free(kdf
);
338 static void h__dump (const unsigned char *p
, int len
)
340 for (; len
--; p
++) fprintf(stderr
, "%02X ", *p
);
341 fprintf(stderr
, "\n");