2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) 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>
66 /* set this to print out info about the keygen algorithm */
67 /* #define DEBUG_PKCS5V2 */
70 static void h__dump (const unsigned char *p
, int len
);
73 /* This is an implementation of PKCS#5 v2.0 password based encryption key
74 * derivation function PBKDF2.
75 * SHA1 version verified against test vectors posted by Peter Gutmann
76 * <pgut001@cs.auckland.ac.nz> to the PKCS-TNG <pkcs-tng@rsa.com> mailing list.
79 int PKCS5_PBKDF2_HMAC(const char *pass
, int passlen
,
80 const unsigned char *salt
, int saltlen
, int iter
,
82 int keylen
, unsigned char *out
)
84 unsigned char digtmp
[EVP_MAX_MD_SIZE
], *p
, itmp
[4];
85 int cplen
, j
, k
, tkeylen
, mdlen
;
89 mdlen
= EVP_MD_size(digest
);
96 else if(passlen
== -1)
97 passlen
= strlen(pass
);
104 /* We are unlikely to ever use more than 256 blocks (5120 bits!)
105 * but just in case...
107 itmp
[0] = (unsigned char)((i
>> 24) & 0xff);
108 itmp
[1] = (unsigned char)((i
>> 16) & 0xff);
109 itmp
[2] = (unsigned char)((i
>> 8) & 0xff);
110 itmp
[3] = (unsigned char)(i
& 0xff);
111 HMAC_Init_ex(&hctx
, pass
, passlen
, digest
, NULL
);
112 HMAC_Update(&hctx
, salt
, saltlen
);
113 HMAC_Update(&hctx
, itmp
, 4);
114 HMAC_Final(&hctx
, digtmp
, NULL
);
115 memcpy(p
, digtmp
, cplen
);
116 for(j
= 1; j
< iter
; j
++)
118 HMAC(digest
, pass
, passlen
,
119 digtmp
, mdlen
, digtmp
, NULL
);
120 for(k
= 0; k
< cplen
; k
++)
127 HMAC_CTX_cleanup(&hctx
);
129 fprintf(stderr
, "Password:\n");
130 h__dump (pass
, passlen
);
131 fprintf(stderr
, "Salt:\n");
132 h__dump (salt
, saltlen
);
133 fprintf(stderr
, "Iteration count %d\n", iter
);
134 fprintf(stderr
, "Key:\n");
135 h__dump (out
, keylen
);
140 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass
, int passlen
,
141 const unsigned char *salt
, int saltlen
, int iter
,
142 int keylen
, unsigned char *out
)
144 return PKCS5_PBKDF2_HMAC(pass
, passlen
, salt
, saltlen
, iter
, EVP_sha1(),
151 unsigned char out
[4];
152 unsigned char salt
[] = {0x12, 0x34, 0x56, 0x78};
153 PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt
, 4, 5, 4, out
);
154 fprintf(stderr
, "Out %02X %02X %02X %02X\n",
155 out
[0], out
[1], out
[2], out
[3]);
160 /* Now the key derivation function itself. This is a bit evil because
161 * it has to check the ASN1 parameters are valid: and there are quite a
165 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX
*ctx
, const char *pass
, int passlen
,
166 ASN1_TYPE
*param
, const EVP_CIPHER
*c
, const EVP_MD
*md
,
169 unsigned char *salt
, key
[EVP_MAX_KEY_LENGTH
];
170 const unsigned char *pbuf
;
171 int saltlen
, iter
, plen
;
173 PBE2PARAM
*pbe2
= NULL
;
174 const EVP_CIPHER
*cipher
;
175 PBKDF2PARAM
*kdf
= NULL
;
177 int prf_nid
, hmac_md_nid
;
179 if (param
== NULL
|| param
->type
!= V_ASN1_SEQUENCE
||
180 param
->value
.sequence
== NULL
) {
181 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,EVP_R_DECODE_ERROR
);
185 pbuf
= param
->value
.sequence
->data
;
186 plen
= param
->value
.sequence
->length
;
187 if(!(pbe2
= d2i_PBE2PARAM(NULL
, &pbuf
, plen
))) {
188 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,EVP_R_DECODE_ERROR
);
192 /* See if we recognise the key derivation function */
194 if(OBJ_obj2nid(pbe2
->keyfunc
->algorithm
) != NID_id_pbkdf2
) {
195 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
196 EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION
);
200 /* lets see if we recognise the encryption algorithm.
203 cipher
= EVP_get_cipherbyname(
204 OBJ_nid2sn(OBJ_obj2nid(pbe2
->encryption
->algorithm
)));
207 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
208 EVP_R_UNSUPPORTED_CIPHER
);
212 /* Fixup cipher based on AlgorithmIdentifier */
213 EVP_CipherInit_ex(ctx
, cipher
, NULL
, NULL
, NULL
, en_de
);
214 if(EVP_CIPHER_asn1_to_param(ctx
, pbe2
->encryption
->parameter
) < 0) {
215 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
216 EVP_R_CIPHER_PARAMETER_ERROR
);
219 keylen
= EVP_CIPHER_CTX_key_length(ctx
);
220 OPENSSL_assert(keylen
<= sizeof key
);
222 /* Now decode key derivation function */
224 if(!pbe2
->keyfunc
->parameter
||
225 (pbe2
->keyfunc
->parameter
->type
!= V_ASN1_SEQUENCE
))
227 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,EVP_R_DECODE_ERROR
);
231 pbuf
= pbe2
->keyfunc
->parameter
->value
.sequence
->data
;
232 plen
= pbe2
->keyfunc
->parameter
->value
.sequence
->length
;
233 if(!(kdf
= d2i_PBKDF2PARAM(NULL
, &pbuf
, plen
)) ) {
234 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,EVP_R_DECODE_ERROR
);
238 PBE2PARAM_free(pbe2
);
241 /* Now check the parameters of the kdf */
243 if(kdf
->keylength
&& (ASN1_INTEGER_get(kdf
->keylength
) != (int)keylen
)){
244 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
245 EVP_R_UNSUPPORTED_KEYLENGTH
);
250 prf_nid
= OBJ_obj2nid(kdf
->prf
->algorithm
);
252 prf_nid
= NID_hmacWithSHA1
;
254 if (!EVP_PBE_find(EVP_PBE_TYPE_PRF
, prf_nid
, NULL
, &hmac_md_nid
, 0))
256 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
, EVP_R_UNSUPPORTED_PRF
);
260 prfmd
= EVP_get_digestbynid(hmac_md_nid
);
263 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
, EVP_R_UNSUPPORTED_PRF
);
267 if(kdf
->salt
->type
!= V_ASN1_OCTET_STRING
) {
268 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN
,
269 EVP_R_UNSUPPORTED_SALT_TYPE
);
273 /* it seems that its all OK */
274 salt
= kdf
->salt
->value
.octet_string
->data
;
275 saltlen
= kdf
->salt
->value
.octet_string
->length
;
276 iter
= ASN1_INTEGER_get(kdf
->iter
);
277 PKCS5_PBKDF2_HMAC(pass
, passlen
, salt
, saltlen
, iter
, prfmd
,
279 EVP_CipherInit_ex(ctx
, NULL
, NULL
, key
, NULL
, en_de
);
280 OPENSSL_cleanse(key
, keylen
);
281 PBKDF2PARAM_free(kdf
);
285 PBE2PARAM_free(pbe2
);
286 PBKDF2PARAM_free(kdf
);
291 static void h__dump (const unsigned char *p
, int len
)
293 for (; len
--; p
++) fprintf(stderr
, "%02X ", *p
);
294 fprintf(stderr
, "\n");