2de3a2c9d2f8f4fa07595fdd2cd6848d1463bddd
[openssl.git] / crypto / evp / p5_crpt2.c
1 /* p5_crpt2.c */
2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58 #include <stdio.h>
59 #include <stdlib.h>
60 #include <openssl/x509.h>
61 #include <openssl/evp.h>
62 #include <openssl/hmac.h>
63 #include "cryptlib.h"
64
65 /* set this to print out info about the keygen algorithm */
66 /* #define DEBUG_PKCS5V2 */
67
68 #ifdef DEBUG_PKCS5V2
69         static void h__dump (const unsigned char *p, int len);
70 #endif
71
72 /* This is an implementation of PKCS#5 v2.0 password based encryption key
73  * derivation function PBKDF2 using the only currently defined function HMAC
74  * with SHA1. Verified against test vectors posted by Peter Gutmann
75  * <pgut001@cs.auckland.ac.nz> to the PKCS-TNG <pkcs-tng@rsa.com> mailing list.
76  */
77
78 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
79                            unsigned char *salt, int saltlen, int iter,
80                            int keylen, unsigned char *out)
81 {
82         unsigned char digtmp[SHA_DIGEST_LENGTH], *p, itmp[4];
83         int cplen, j, k, tkeylen;
84         unsigned long i = 1;
85         HMAC_CTX hctx;
86         p = out;
87         tkeylen = keylen;
88         if(passlen == -1) passlen = strlen(pass);
89         while(tkeylen) {
90                 if(tkeylen > SHA_DIGEST_LENGTH) cplen = SHA_DIGEST_LENGTH;
91                 else cplen = tkeylen;
92                 /* We are unlikely to ever use more than 256 blocks (5120 bits!)
93                  * but just in case...
94                  */
95                 itmp[0] = (i >> 24) & 0xff;
96                 itmp[1] = (i >> 16) & 0xff;
97                 itmp[2] = (i >> 8) & 0xff;
98                 itmp[3] = i & 0xff;
99                 HMAC_Init(&hctx, pass, passlen, EVP_sha1());
100                 HMAC_Update(&hctx, salt, saltlen);
101                 HMAC_Update(&hctx, itmp, 4);
102                 HMAC_Final(&hctx, digtmp, NULL);
103                 memcpy(p, digtmp, cplen);
104                 for(j = 1; j < iter; j++) {
105                         HMAC(EVP_sha1(), pass, passlen,
106                                  digtmp, SHA_DIGEST_LENGTH, digtmp, NULL);
107                         for(k = 0; k < cplen; k++) p[k] ^= digtmp[k];
108                 }
109                 tkeylen-= cplen;
110                 i++;
111                 p+= cplen;
112         }
113         HMAC_cleanup(&hctx);
114 #ifdef DEBUG_PKCS5V2
115         fprintf(stderr, "Password:\n");
116         h__dump (pass, passlen);
117         fprintf(stderr, "Salt:\n");
118         h__dump (salt, saltlen);
119         fprintf(stderr, "Iteration count %d\n", iter);
120         fprintf(stderr, "Key:\n");
121         h__dump (out, keylen);
122 #endif
123         return 1;
124 }
125
126 #ifdef DO_TEST
127 main()
128 {
129         unsigned char out[4];
130         unsigned char salt[] = {0x12, 0x34, 0x56, 0x78};
131         PKCS5_PBKDF2_HMAC_SHA1("password", -1, salt, 4, 5, 4, out);
132         fprintf(stderr, "Out %02X %02X %02X %02X\n",
133                                          out[0], out[1], out[2], out[3]);
134 }
135
136 #endif
137
138 /* Now the key derivation function itself. This is a bit evil because
139  * it has to check the ASN1 parameters are valid: and there are quite a
140  * few of them...
141  */
142
143 int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
144                          ASN1_TYPE *param, EVP_CIPHER *c, EVP_MD *md,
145                          int en_de)
146 {
147         unsigned char *pbuf, *salt, key[EVP_MAX_KEY_LENGTH];
148         int saltlen, keylen, iter, plen;
149         PBE2PARAM *pbe2 = NULL;
150         const EVP_CIPHER *cipher;
151         PBKDF2PARAM *kdf = NULL;
152
153         pbuf = param->value.sequence->data;
154         plen = param->value.sequence->length;
155         if(!param || (param->type != V_ASN1_SEQUENCE) ||
156                                    !(pbe2 = d2i_PBE2PARAM(NULL, &pbuf, plen))) {
157                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
158                 return 0;
159         }
160
161         /* See if we recognise the key derivation function */
162
163         if(OBJ_obj2nid(pbe2->keyfunc->algorithm) != NID_id_pbkdf2) {
164                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
165                                 EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION);
166                 goto err;
167         }
168
169         /* lets see if we recognise the encryption algorithm.
170          */
171
172         cipher = EVP_get_cipherbyname(
173                         OBJ_nid2sn(OBJ_obj2nid(pbe2->encryption->algorithm)));
174
175         if(!cipher) {
176                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
177                                                 EVP_R_UNSUPPORTED_CIPHER);
178                 goto err;
179         }
180
181         /* Fixup cipher based on AlgorithmIdentifier */
182         EVP_CipherInit(ctx, cipher, NULL, NULL, en_de);
183         if(EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) {
184                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
185                                         EVP_R_CIPHER_PARAMETER_ERROR);
186                 goto err;
187         }
188         keylen = EVP_CIPHER_CTX_key_length(ctx);
189
190         /* Now decode key derivation function */
191
192         pbuf = pbe2->keyfunc->parameter->value.sequence->data;
193         plen = pbe2->keyfunc->parameter->value.sequence->length;
194         if(!pbe2->keyfunc->parameter ||
195                  (pbe2->keyfunc->parameter->type != V_ASN1_SEQUENCE) ||
196                                 !(kdf = d2i_PBKDF2PARAM(NULL, &pbuf, plen)) ) {
197                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,EVP_R_DECODE_ERROR);
198                 goto err;
199         }
200
201         PBE2PARAM_free(pbe2);
202         pbe2 = NULL;
203
204         /* Now check the parameters of the kdf */
205
206         if(kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != keylen)){
207                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
208                                                 EVP_R_UNSUPPORTED_KEYLENGTH);
209                 goto err;
210         }
211
212         if(kdf->prf && (OBJ_obj2nid(kdf->prf->algorithm) != NID_hmacWithSHA1)) {
213                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN, EVP_R_UNSUPPORTED_PRF);
214                 goto err;
215         }
216
217         if(kdf->salt->type != V_ASN1_OCTET_STRING) {
218                 EVPerr(EVP_F_PKCS5_V2_PBE_KEYIVGEN,
219                                                 EVP_R_UNSUPPORTED_SALT_TYPE);
220                 goto err;
221         }
222
223         /* it seems that its all OK */
224         salt = kdf->salt->value.octet_string->data;
225         saltlen = kdf->salt->value.octet_string->length;
226         iter = ASN1_INTEGER_get(kdf->iter);
227         PKCS5_PBKDF2_HMAC_SHA1(pass, passlen, salt, saltlen, iter, keylen, key);
228         EVP_CipherInit(ctx, NULL, key, NULL, en_de);
229         memset(key, 0, keylen);
230         PBKDF2PARAM_free(kdf);
231         return 1;
232
233         err:
234         PBE2PARAM_free(pbe2);
235         PBKDF2PARAM_free(kdf);
236         return 0;
237 }
238
239 #ifdef DEBUG_PKCS5V2
240 static void h__dump (const unsigned char *p, int len)
241 {
242         for (; len --; p++) fprintf(stderr, "%02X ", *p);
243         fprintf(stderr, "\n");
244 }
245 #endif
246