2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
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).
60 #include "internal/cryptlib.h"
61 # include <openssl/x509.h>
62 # include <openssl/evp.h>
63 # include <openssl/hmac.h>
64 # include "evp_locl.h"
66 /* set this to print out info about the keygen algorithm */
67 /* #define OPENSSL_DEBUG_PKCS5V2 */
69 # ifdef OPENSSL_DEBUG_PKCS5V2
70 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. SHA1 version verified against test vectors
76 * posted by Peter Gutmann <pgut001@cs.auckland.ac.nz> to the PKCS-TNG
77 * <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,
82 const EVP_MD *digest, int keylen, unsigned char *out)
84 unsigned char digtmp[EVP_MAX_MD_SIZE], *p, itmp[4];
85 int cplen, j, k, tkeylen, mdlen;
87 HMAC_CTX *hctx_tpl = NULL, *hctx = NULL;
89 mdlen = EVP_MD_size(digest);
93 hctx_tpl = HMAC_CTX_new();
100 else if (passlen == -1)
101 passlen = strlen(pass);
102 if (!HMAC_Init_ex(hctx_tpl, pass, passlen, digest, NULL)) {
103 HMAC_CTX_free(hctx_tpl);
106 hctx = HMAC_CTX_new();
108 HMAC_CTX_free(hctx_tpl);
117 * We are unlikely to ever use more than 256 blocks (5120 bits!) but
120 itmp[0] = (unsigned char)((i >> 24) & 0xff);
121 itmp[1] = (unsigned char)((i >> 16) & 0xff);
122 itmp[2] = (unsigned char)((i >> 8) & 0xff);
123 itmp[3] = (unsigned char)(i & 0xff);
124 if (!HMAC_CTX_copy(hctx, hctx_tpl)) {
126 HMAC_CTX_free(hctx_tpl);
129 if (!HMAC_Update(hctx, salt, saltlen)
130 || !HMAC_Update(hctx, itmp, 4)
131 || !HMAC_Final(hctx, digtmp, NULL)) {
133 HMAC_CTX_free(hctx_tpl);
136 HMAC_CTX_reset(hctx);
137 memcpy(p, digtmp, cplen);
138 for (j = 1; j < iter; j++) {
139 if (!HMAC_CTX_copy(hctx, hctx_tpl)) {
141 HMAC_CTX_free(hctx_tpl);
144 if (!HMAC_Update(hctx, digtmp, mdlen)
145 || !HMAC_Final(hctx, digtmp, NULL)) {
147 HMAC_CTX_free(hctx_tpl);
150 HMAC_CTX_reset(hctx);
151 for (k = 0; k < cplen; k++)
159 HMAC_CTX_free(hctx_tpl);
160 # ifdef OPENSSL_DEBUG_PKCS5V2
161 fprintf(stderr, "Password:\n");
162 h__dump(pass, passlen);
163 fprintf(stderr, "Salt:\n");
164 h__dump(salt, saltlen);
165 fprintf(stderr, "Iteration count %d\n", iter);
166 fprintf(stderr, "Key:\n");
167 h__dump(out, keylen);
172 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
173 const unsigned char *salt, int saltlen, int iter,
174 int keylen, unsigned char *out)
176 return PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, EVP_sha1(),
183 unsigned char out[4];
184 unsigned char salt[] = { 0x12, 0x34, 0x56, 0x78 };
185 PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt, 4, 5, 4, out);
186 fprintf(stderr, "Out %02X %02X %02X %02X\n",
187 out[0], out[1], out[2], out[3]);
193 * Now the key derivation function itself. This is a bit evil because it has
194 * to check the ASN1 parameters are valid: and there are quite a few of
198 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
199 ASN1_TYPE *param, const EVP_CIPHER *c,
200 const EVP_MD *md, int en_de)
202 PBE2PARAM *pbe2 = NULL;
203 const EVP_CIPHER *cipher;
208 pbe2 = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBE2PARAM), param);
210 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_DECODE_ERROR);
214 /* See if we recognise the key derivation function */
215 if (!EVP_PBE_find(EVP_PBE_TYPE_KDF, OBJ_obj2nid(pbe2->keyfunc->algorithm),
217 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
218 EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION);
223 * lets see if we recognise the encryption algorithm.
226 cipher = EVP_get_cipherbyobj(pbe2->encryption->algorithm);
229 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_UNSUPPORTED_CIPHER);
233 /* Fixup cipher based on AlgorithmIdentifier */
234 if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, en_de))
236 if (EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) {
237 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_CIPHER_PARAMETER_ERROR);
240 rv = kdf(ctx, pass, passlen, pbe2->keyfunc->parameter, NULL, NULL, en_de);
242 PBE2PARAM_free(pbe2);
246 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
247 int passlen, ASN1_TYPE *param,
248 const EVP_CIPHER *c, const EVP_MD *md, int en_de)
250 unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
253 unsigned int keylen = 0;
254 int prf_nid, hmac_md_nid;
255 PBKDF2PARAM *kdf = NULL;
258 if (EVP_CIPHER_CTX_cipher(ctx) == NULL) {
259 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_NO_CIPHER_SET);
262 keylen = EVP_CIPHER_CTX_key_length(ctx);
263 OPENSSL_assert(keylen <= sizeof key);
265 /* Decode parameter */
267 kdf = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), param);
270 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_DECODE_ERROR);
274 keylen = EVP_CIPHER_CTX_key_length(ctx);
276 /* Now check the parameters of the kdf */
278 if (kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != (int)keylen)) {
279 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_KEYLENGTH);
284 prf_nid = OBJ_obj2nid(kdf->prf->algorithm);
286 prf_nid = NID_hmacWithSHA1;
288 if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, prf_nid, NULL, &hmac_md_nid, 0)) {
289 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
293 prfmd = EVP_get_digestbynid(hmac_md_nid);
295 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
299 if (kdf->salt->type != V_ASN1_OCTET_STRING) {
300 EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_SALT_TYPE);
304 /* it seems that its all OK */
305 salt = kdf->salt->value.octet_string->data;
306 saltlen = kdf->salt->value.octet_string->length;
307 iter = ASN1_INTEGER_get(kdf->iter);
308 if (!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, prfmd,
311 rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
313 OPENSSL_cleanse(key, keylen);
314 PBKDF2PARAM_free(kdf);
318 # ifdef OPENSSL_DEBUG_PKCS5V2
319 static void h__dump(const unsigned char *p, int len)
322 fprintf(stderr, "%02X ", *p);
323 fprintf(stderr, "\n");