cd6e40dcaa3ad4381f800ac67658f9181c2e67ba
[openssl.git] / crypto / evp / evp_pbe.c
1 /* evp_pbe.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999-2006 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
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/evp.h>
62 #include <openssl/pkcs12.h>
63 #include <openssl/x509.h>
64
65 /* Password based encryption (PBE) functions */
66
67 DECLARE_STACK_OF(EVP_PBE_CTL)
68 static STACK_OF(EVP_PBE_CTL) *pbe_algs;
69
70 /* Setup a cipher context from a PBE algorithm */
71
72 typedef struct
73         {
74         int pbe_type;
75         int pbe_nid;
76         int cipher_nid;
77         int md_nid;
78         EVP_PBE_KEYGEN *keygen;
79         } EVP_PBE_CTL;
80
81 static const EVP_PBE_CTL builtin_pbe[] = 
82         {
83         {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndDES_CBC,
84                         NID_des_cbc, NID_md2, PKCS5_PBE_keyivgen},
85         {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndDES_CBC,
86                         NID_des_cbc, NID_md5, PKCS5_PBE_keyivgen},
87         {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndRC2_CBC,
88                         NID_rc2_64_cbc, NID_sha1, PKCS5_PBE_keyivgen},
89
90         {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC4,
91                         NID_rc4, NID_sha1, PKCS12_PBE_keyivgen},
92         {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC4,
93                         NID_rc4_40, NID_sha1, PKCS12_PBE_keyivgen},
94         {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And3_Key_TripleDES_CBC,
95                         NID_des_ede3_cbc, NID_sha1, PKCS12_PBE_keyivgen},
96         {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And2_Key_TripleDES_CBC, 
97                         NID_des_ede_cbc, NID_sha1, PKCS12_PBE_keyivgen},
98         {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And128BitRC2_CBC,
99                         NID_rc2_cbc, NID_sha1, PKCS12_PBE_keyivgen},
100         {EVP_PBE_TYPE_OUTER, NID_pbe_WithSHA1And40BitRC2_CBC,
101                         NID_rc2_40_cbc, NID_sha1, PKCS12_PBE_keyivgen},
102
103 #ifndef OPENSSL_NO_HMAC
104         {EVP_PBE_TYPE_OUTER, NID_pbes2, -1, -1, PKCS5_v2_PBE_keyivgen},
105 #endif
106         {EVP_PBE_TYPE_OUTER, NID_pbeWithMD2AndRC2_CBC,
107                         NID_rc2_64_cbc, NID_md2, PKCS5_PBE_keyivgen},
108         {EVP_PBE_TYPE_OUTER, NID_pbeWithMD5AndRC2_CBC,
109                         NID_rc2_64_cbc, NID_md5, PKCS5_PBE_keyivgen},
110         {EVP_PBE_TYPE_OUTER, NID_pbeWithSHA1AndDES_CBC,
111                         NID_des_cbc, NID_sha1, PKCS5_PBE_keyivgen},
112
113
114         {EVP_PBE_TYPE_PRF, NID_hmacWithSHA1, -1, NID_sha1, 0},
115         {EVP_PBE_TYPE_PRF, NID_hmacWithMD5, -1, NID_md5, 0},
116         {EVP_PBE_TYPE_PRF, NID_hmacWithSHA224, -1, NID_sha224, 0},
117         {EVP_PBE_TYPE_PRF, NID_hmacWithSHA256, -1, NID_sha256, 0},
118         {EVP_PBE_TYPE_PRF, NID_hmacWithSHA384, -1, NID_sha384, 0},
119         {EVP_PBE_TYPE_PRF, NID_hmacWithSHA512, -1, NID_sha512, 0},
120         {EVP_PBE_TYPE_PRF, NID_id_HMACGostR3411_94, -1, NID_id_GostR3411_94, 0},
121         };
122
123 #ifdef TEST
124 int main(int argc, char **argv)
125         {
126         int i, nid_md, nid_cipher;
127         EVP_PBE_CTL *tpbe, *tpbe2;
128         /*OpenSSL_add_all_algorithms();*/
129
130         for (i = 0; i < sizeof(builtin_pbe)/sizeof(EVP_PBE_CTL); i++)
131                 {
132                 tpbe = builtin_pbe + i;
133                 fprintf(stderr, "%d %d %s ", tpbe->pbe_type, tpbe->pbe_nid,
134                                                 OBJ_nid2sn(tpbe->pbe_nid));
135                 if (EVP_PBE_find(tpbe->pbe_type, tpbe->pbe_nid,
136                                         &nid_cipher ,&nid_md,0))
137                         fprintf(stderr, "Found %s %s\n",
138                                         OBJ_nid2sn(nid_cipher),
139                                         OBJ_nid2sn(nid_md));
140                 else
141                         fprintf(stderr, "Find ERROR!!\n");
142                 }
143
144         return 0;
145         }
146 #endif
147                 
148
149
150 int EVP_PBE_CipherInit(ASN1_OBJECT *pbe_obj, const char *pass, int passlen,
151                        ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de)
152         {
153         const EVP_CIPHER *cipher;
154         const EVP_MD *md;
155         int cipher_nid, md_nid;
156         EVP_PBE_KEYGEN *keygen;
157
158         if (!EVP_PBE_find(EVP_PBE_TYPE_OUTER, OBJ_obj2nid(pbe_obj),
159                                         &cipher_nid, &md_nid, &keygen))
160                 {
161                 char obj_tmp[80];
162                 EVPerr(EVP_F_EVP_PBE_CIPHERINIT,EVP_R_UNKNOWN_PBE_ALGORITHM);
163                 if (!pbe_obj) BUF_strlcpy (obj_tmp, "NULL", sizeof obj_tmp);
164                 else i2t_ASN1_OBJECT(obj_tmp, sizeof obj_tmp, pbe_obj);
165                 ERR_add_error_data(2, "TYPE=", obj_tmp);
166                 return 0;
167                 }
168
169         if(!pass)
170                 passlen = 0;
171         else if (passlen == -1)
172                 passlen = strlen(pass);
173
174         if (cipher_nid == -1)
175                 cipher = NULL;
176         else
177                 cipher = EVP_get_cipherbynid(cipher_nid);
178
179         if (md_nid == -1)
180                 md = NULL;
181         else
182                 md = EVP_get_digestbynid(md_nid);
183
184         if (!keygen(ctx, pass, passlen, param, cipher, md, en_de))
185                 {
186                 EVPerr(EVP_F_EVP_PBE_CIPHERINIT,EVP_R_KEYGEN_FAILURE);
187                 return 0;
188                 }
189         return 1;       
190 }
191
192 DECLARE_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
193
194 static int pbe2_cmp(const EVP_PBE_CTL *pbe1, const EVP_PBE_CTL *pbe2)
195         {
196         int ret = pbe1->pbe_type - pbe2->pbe_type;
197         if (ret)
198                 return ret;
199         else
200                 return pbe1->pbe_nid - pbe2->pbe_nid;
201         }
202
203 IMPLEMENT_OBJ_BSEARCH_CMP_FN(EVP_PBE_CTL, EVP_PBE_CTL, pbe2);
204
205 static int pbe_cmp(const EVP_PBE_CTL * const *a, const EVP_PBE_CTL * const *b)
206         {
207         int ret = (*a)->pbe_type - (*b)->pbe_type;
208         if (ret)
209                 return ret;
210         else
211                 return (*a)->pbe_nid - (*b)->pbe_nid;
212         }
213
214 /* Add a PBE algorithm */
215
216 int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid, int md_nid,
217                          EVP_PBE_KEYGEN *keygen)
218         {
219         EVP_PBE_CTL *pbe_tmp;
220         if (!pbe_algs)
221                 pbe_algs = sk_EVP_PBE_CTL_new(pbe_cmp);
222         if (!(pbe_tmp = (EVP_PBE_CTL*) OPENSSL_malloc (sizeof(EVP_PBE_CTL))))
223                 {
224                 EVPerr(EVP_F_EVP_PBE_ALG_ADD_TYPE,ERR_R_MALLOC_FAILURE);
225                 return 0;
226                 }
227         pbe_tmp->pbe_type = pbe_type;
228         pbe_tmp->pbe_nid = pbe_nid;
229         pbe_tmp->cipher_nid = cipher_nid;
230         pbe_tmp->md_nid = md_nid;
231         pbe_tmp->keygen = keygen;
232
233
234         sk_EVP_PBE_CTL_push (pbe_algs, pbe_tmp);
235         return 1;
236         }
237
238 int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md,
239                     EVP_PBE_KEYGEN *keygen)
240         {
241         int cipher_nid, md_nid;
242         if (cipher)
243                 cipher_nid = EVP_CIPHER_type(cipher);
244         else
245                 cipher_nid = -1;
246         if (md)
247                 md_nid = EVP_MD_type(md);
248         else
249                 md_nid = -1;
250
251         return EVP_PBE_alg_add_type(EVP_PBE_TYPE_OUTER, nid,
252                                         cipher_nid, md_nid, keygen);
253         }
254
255 int EVP_PBE_find(int type, int pbe_nid,
256                  int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen)
257         {
258         EVP_PBE_CTL *pbetmp = NULL, pbelu;
259         int i;
260         if (pbe_nid == NID_undef)
261                 return 0;
262
263         pbelu.pbe_type = type;
264         pbelu.pbe_nid = pbe_nid;
265
266         if (pbe_algs)
267                 {
268                 i = sk_EVP_PBE_CTL_find(pbe_algs, &pbelu);
269                 if (i != -1)
270                         pbetmp = sk_EVP_PBE_CTL_value (pbe_algs, i);
271                 }
272         if (pbetmp == NULL)
273                 {
274                 pbetmp = OBJ_bsearch_pbe2(&pbelu, builtin_pbe,
275                                      sizeof(builtin_pbe)/sizeof(EVP_PBE_CTL));
276                 }
277         if (pbetmp == NULL)
278                 return 0;
279         if (pcnid)
280                 *pcnid = pbetmp->cipher_nid;
281         if (pmnid)
282                 *pmnid = pbetmp->md_nid;
283         if (pkeygen)
284                 *pkeygen = pbetmp->keygen;
285         return 1;
286         }
287
288 static void free_evp_pbe_ctl(EVP_PBE_CTL *pbe)
289          {
290          OPENSSL_freeFunc(pbe);
291          }
292
293 void EVP_PBE_cleanup(void)
294         {
295         sk_EVP_PBE_CTL_pop_free(pbe_algs, free_evp_pbe_ctl);
296         pbe_algs = NULL;
297         }