b84e99ede3eefc70a2b0620649195d9970408358
[openssl.git] / crypto / evp / p5_crpt2.c
1 /* p5_crpt2.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 1999.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999-2006 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
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
19  *    distribution.
20  *
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/)"
25  *
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.
30  *
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.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
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  * ====================================================================
53  *
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).
57  *
58  */
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include "internal/cryptlib.h"
62 # include <openssl/x509.h>
63 # include <openssl/evp.h>
64 # include <openssl/hmac.h>
65 # include "evp_locl.h"
66
67 /* set this to print out info about the keygen algorithm */
68 /* #define DEBUG_PKCS5V2 */
69
70 # ifdef DEBUG_PKCS5V2
71 static void h__dump(const unsigned char *p, int len);
72 # endif
73
74 /*
75  * This is an implementation of PKCS#5 v2.0 password based encryption key
76  * derivation function PBKDF2. SHA1 version verified against test vectors
77  * posted by Peter Gutmann <pgut001@cs.auckland.ac.nz> to the PKCS-TNG
78  * <pkcs-tng@rsa.com> mailing list.
79  */
80
81 int PKCS5_PBKDF2_HMAC(const char *pass, int passlen,
82                       const unsigned char *salt, int saltlen, int iter,
83                       const EVP_MD *digest, int keylen, unsigned char *out)
84 {
85     unsigned char digtmp[EVP_MAX_MD_SIZE], *p, itmp[4];
86     int cplen, j, k, tkeylen, mdlen;
87     unsigned long i = 1;
88     HMAC_CTX *hctx_tpl = NULL, *hctx = NULL;
89
90     mdlen = EVP_MD_size(digest);
91     if (mdlen < 0)
92         return 0;
93
94     hctx_tpl = HMAC_CTX_new();
95     if (hctx_tpl == NULL)
96         return 0;
97     p = out;
98     tkeylen = keylen;
99     if (!pass)
100         passlen = 0;
101     else if (passlen == -1)
102         passlen = strlen(pass);
103     if (!HMAC_Init_ex(hctx_tpl, pass, passlen, digest, NULL)) {
104         HMAC_CTX_free(hctx_tpl);
105         return 0;
106     }
107     hctx = HMAC_CTX_new();
108     if (hctx == NULL) {
109         HMAC_CTX_free(hctx_tpl);
110         return 0;
111     }
112     while (tkeylen) {
113         if (tkeylen > mdlen)
114             cplen = mdlen;
115         else
116             cplen = tkeylen;
117         /*
118          * We are unlikely to ever use more than 256 blocks (5120 bits!) but
119          * just in case...
120          */
121         itmp[0] = (unsigned char)((i >> 24) & 0xff);
122         itmp[1] = (unsigned char)((i >> 16) & 0xff);
123         itmp[2] = (unsigned char)((i >> 8) & 0xff);
124         itmp[3] = (unsigned char)(i & 0xff);
125         if (!HMAC_CTX_copy(hctx, hctx_tpl)) {
126             HMAC_CTX_free(hctx);
127             HMAC_CTX_free(hctx_tpl);
128             return 0;
129         }
130         if (!HMAC_Update(hctx, salt, saltlen)
131             || !HMAC_Update(hctx, itmp, 4)
132             || !HMAC_Final(hctx, digtmp, NULL)) {
133             HMAC_CTX_free(hctx);
134             HMAC_CTX_free(hctx_tpl);
135             return 0;
136         }
137         HMAC_CTX_cleanup(hctx);
138         memcpy(p, digtmp, cplen);
139         for (j = 1; j < iter; j++) {
140             if (!HMAC_CTX_copy(hctx, hctx_tpl)) {
141                 HMAC_CTX_free(hctx);
142                 HMAC_CTX_free(hctx_tpl);
143                 return 0;
144             }
145             if (!HMAC_Update(hctx, digtmp, mdlen)
146                 || !HMAC_Final(hctx, digtmp, NULL)) {
147                 HMAC_CTX_free(hctx);
148                 HMAC_CTX_free(hctx_tpl);
149                 return 0;
150             }
151             HMAC_CTX_cleanup(hctx);
152             for (k = 0; k < cplen; k++)
153                 p[k] ^= digtmp[k];
154         }
155         tkeylen -= cplen;
156         i++;
157         p += cplen;
158     }
159     HMAC_CTX_free(hctx);
160     HMAC_CTX_free(hctx_tpl);
161 # ifdef DEBUG_PKCS5V2
162     fprintf(stderr, "Password:\n");
163     h__dump(pass, passlen);
164     fprintf(stderr, "Salt:\n");
165     h__dump(salt, saltlen);
166     fprintf(stderr, "Iteration count %d\n", iter);
167     fprintf(stderr, "Key:\n");
168     h__dump(out, keylen);
169 # endif
170     return 1;
171 }
172
173 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
174                            const unsigned char *salt, int saltlen, int iter,
175                            int keylen, unsigned char *out)
176 {
177     return PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, EVP_sha1(),
178                              keylen, out);
179 }
180
181 # ifdef DO_TEST
182 main()
183 {
184     unsigned char out[4];
185     unsigned char salt[] = { 0x12, 0x34, 0x56, 0x78 };
186     PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt, 4, 5, 4, out);
187     fprintf(stderr, "Out %02X %02X %02X %02X\n",
188             out[0], out[1], out[2], out[3]);
189 }
190
191 # endif
192
193 /*
194  * Now the key derivation function itself. This is a bit evil because it has
195  * to check the ASN1 parameters are valid: and there are quite a few of
196  * them...
197  */
198
199 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
200                           ASN1_TYPE *param, const EVP_CIPHER *c,
201                           const EVP_MD *md, int en_de)
202 {
203     PBE2PARAM *pbe2 = NULL;
204     const EVP_CIPHER *cipher;
205     EVP_PBE_KEYGEN *kdf;
206
207     int rv = 0;
208
209     pbe2 = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBE2PARAM), param);
210     if (pbe2 == NULL) {
211         EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_DECODE_ERROR);
212         goto err;
213     }
214
215     /* See if we recognise the key derivation function */
216     if (!EVP_PBE_find(EVP_PBE_TYPE_KDF, OBJ_obj2nid(pbe2->keyfunc->algorithm),
217                         NULL, NULL, &kdf)) {
218         EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
219                EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION);
220         goto err;
221     }
222
223     /*
224      * lets see if we recognise the encryption algorithm.
225      */
226
227     cipher = EVP_get_cipherbyobj(pbe2->encryption->algorithm);
228
229     if (!cipher) {
230         EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_UNSUPPORTED_CIPHER);
231         goto err;
232     }
233
234     /* Fixup cipher based on AlgorithmIdentifier */
235     if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, en_de))
236         goto err;
237     if (EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) {
238         EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_CIPHER_PARAMETER_ERROR);
239         goto err;
240     }
241     rv = kdf(ctx, pass, passlen, pbe2->keyfunc->parameter, NULL, NULL, en_de);
242  err:
243     PBE2PARAM_free(pbe2);
244     return rv;
245 }
246
247 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
248                              int passlen, ASN1_TYPE *param,
249                              const EVP_CIPHER *c, const EVP_MD *md, int en_de)
250 {
251     unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
252     int saltlen, iter;
253     int rv = 0;
254     unsigned int keylen = 0;
255     int prf_nid, hmac_md_nid;
256     PBKDF2PARAM *kdf = NULL;
257     const EVP_MD *prfmd;
258
259     if (EVP_CIPHER_CTX_cipher(ctx) == NULL) {
260         EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_NO_CIPHER_SET);
261         goto err;
262     }
263     keylen = EVP_CIPHER_CTX_key_length(ctx);
264     OPENSSL_assert(keylen <= sizeof key);
265
266     /* Decode parameter */
267
268     kdf = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), param);
269
270     if (kdf == NULL) {
271         EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_DECODE_ERROR);
272         goto err;
273     }
274
275     keylen = EVP_CIPHER_CTX_key_length(ctx);
276
277     /* Now check the parameters of the kdf */
278
279     if (kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != (int)keylen)) {
280         EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_KEYLENGTH);
281         goto err;
282     }
283
284     if (kdf->prf)
285         prf_nid = OBJ_obj2nid(kdf->prf->algorithm);
286     else
287         prf_nid = NID_hmacWithSHA1;
288
289     if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, prf_nid, NULL, &hmac_md_nid, 0)) {
290         EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
291         goto err;
292     }
293
294     prfmd = EVP_get_digestbynid(hmac_md_nid);
295     if (prfmd == NULL) {
296         EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
297         goto err;
298     }
299
300     if (kdf->salt->type != V_ASN1_OCTET_STRING) {
301         EVPerr(EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN, EVP_R_UNSUPPORTED_SALT_TYPE);
302         goto err;
303     }
304
305     /* it seems that its all OK */
306     salt = kdf->salt->value.octet_string->data;
307     saltlen = kdf->salt->value.octet_string->length;
308     iter = ASN1_INTEGER_get(kdf->iter);
309     if (!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, prfmd,
310                            keylen, key))
311         goto err;
312     rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
313  err:
314     OPENSSL_cleanse(key, keylen);
315     PBKDF2PARAM_free(kdf);
316     return rv;
317 }
318
319 # ifdef DEBUG_PKCS5V2
320 static void h__dump(const unsigned char *p, int len)
321 {
322     for (; len--; p++)
323         fprintf(stderr, "%02X ", *p);
324     fprintf(stderr, "\n");
325 }
326 # endif