Adapt all EVP_CIPHER_CTX users for it becoming opaque
[openssl.git] / crypto / asn1 / p5_pbev2.c
1 /* p5_pbev2.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 1999-2004.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999 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
60 #include <stdio.h>
61 #include "internal/cryptlib.h"
62 #include <openssl/asn1t.h>
63 #include <openssl/x509.h>
64 #include <openssl/rand.h>
65
66 /* PKCS#5 v2.0 password based encryption structures */
67
68 ASN1_SEQUENCE(PBE2PARAM) = {
69         ASN1_SIMPLE(PBE2PARAM, keyfunc, X509_ALGOR),
70         ASN1_SIMPLE(PBE2PARAM, encryption, X509_ALGOR)
71 } ASN1_SEQUENCE_END(PBE2PARAM)
72
73 IMPLEMENT_ASN1_FUNCTIONS(PBE2PARAM)
74
75 ASN1_SEQUENCE(PBKDF2PARAM) = {
76         ASN1_SIMPLE(PBKDF2PARAM, salt, ASN1_ANY),
77         ASN1_SIMPLE(PBKDF2PARAM, iter, ASN1_INTEGER),
78         ASN1_OPT(PBKDF2PARAM, keylength, ASN1_INTEGER),
79         ASN1_OPT(PBKDF2PARAM, prf, X509_ALGOR)
80 } ASN1_SEQUENCE_END(PBKDF2PARAM)
81
82 IMPLEMENT_ASN1_FUNCTIONS(PBKDF2PARAM)
83
84 /*
85  * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm: yes I know
86  * this is horrible! Extended version to allow application supplied PRF NID
87  * and IV.
88  */
89
90 X509_ALGOR *PKCS5_pbe2_set_iv(const EVP_CIPHER *cipher, int iter,
91                               unsigned char *salt, int saltlen,
92                               unsigned char *aiv, int prf_nid)
93 {
94     X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
95     int alg_nid, keylen;
96     EVP_CIPHER_CTX *ctx = NULL;
97     unsigned char iv[EVP_MAX_IV_LENGTH];
98     PBE2PARAM *pbe2 = NULL;
99     ASN1_OBJECT *obj;
100
101     alg_nid = EVP_CIPHER_type(cipher);
102     if (alg_nid == NID_undef) {
103         ASN1err(ASN1_F_PKCS5_PBE2_SET_IV,
104                 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
105         goto err;
106     }
107     obj = OBJ_nid2obj(alg_nid);
108
109     if ((pbe2 = PBE2PARAM_new()) == NULL)
110         goto merr;
111
112     /* Setup the AlgorithmIdentifier for the encryption scheme */
113     scheme = pbe2->encryption;
114     scheme->algorithm = obj;
115     if ((scheme->parameter = ASN1_TYPE_new()) == NULL)
116         goto merr;
117
118     /* Create random IV */
119     if (EVP_CIPHER_iv_length(cipher)) {
120         if (aiv)
121             memcpy(iv, aiv, EVP_CIPHER_iv_length(cipher));
122         else if (RAND_bytes(iv, EVP_CIPHER_iv_length(cipher)) <= 0)
123             goto err;
124     }
125
126     ctx = EVP_CIPHER_CTX_new();
127     if (ctx == NULL)
128         goto merr;
129
130     /* Dummy cipherinit to just setup the IV, and PRF */
131     if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0))
132         goto err;
133     if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) < 0) {
134         ASN1err(ASN1_F_PKCS5_PBE2_SET_IV, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
135         goto err;
136     }
137     /*
138      * If prf NID unspecified see if cipher has a preference. An error is OK
139      * here: just means use default PRF.
140      */
141     if ((prf_nid == -1) &&
142         EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_PBE_PRF_NID, 0, &prf_nid) <= 0) {
143         ERR_clear_error();
144         prf_nid = NID_hmacWithSHA1;
145     }
146     EVP_CIPHER_CTX_free(ctx);
147     ctx = NULL;
148
149     /* If its RC2 then we'd better setup the key length */
150
151     if (alg_nid == NID_rc2_cbc)
152         keylen = EVP_CIPHER_key_length(cipher);
153     else
154         keylen = -1;
155
156     /* Setup keyfunc */
157
158     X509_ALGOR_free(pbe2->keyfunc);
159
160     pbe2->keyfunc = PKCS5_pbkdf2_set(iter, salt, saltlen, prf_nid, keylen);
161
162     if (!pbe2->keyfunc)
163         goto merr;
164
165     /* Now set up top level AlgorithmIdentifier */
166
167     if ((ret = X509_ALGOR_new()) == NULL)
168         goto merr;
169
170     ret->algorithm = OBJ_nid2obj(NID_pbes2);
171
172     /* Encode PBE2PARAM into parameter */
173
174     if (!ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
175                                  &ret->parameter))
176          goto merr;
177
178     PBE2PARAM_free(pbe2);
179     pbe2 = NULL;
180
181     return ret;
182
183  merr:
184     ASN1err(ASN1_F_PKCS5_PBE2_SET_IV, ERR_R_MALLOC_FAILURE);
185
186  err:
187     EVP_CIPHER_CTX_free(ctx);
188     PBE2PARAM_free(pbe2);
189     /* Note 'scheme' is freed as part of pbe2 */
190     X509_ALGOR_free(kalg);
191     X509_ALGOR_free(ret);
192
193     return NULL;
194
195 }
196
197 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
198                            unsigned char *salt, int saltlen)
199 {
200     return PKCS5_pbe2_set_iv(cipher, iter, salt, saltlen, NULL, -1);
201 }
202
203 X509_ALGOR *PKCS5_pbkdf2_set(int iter, unsigned char *salt, int saltlen,
204                              int prf_nid, int keylen)
205 {
206     X509_ALGOR *keyfunc = NULL;
207     PBKDF2PARAM *kdf = NULL;
208     ASN1_OCTET_STRING *osalt = NULL;
209
210     if ((kdf = PBKDF2PARAM_new()) == NULL)
211         goto merr;
212     if ((osalt = ASN1_OCTET_STRING_new()) == NULL)
213         goto merr;
214
215     kdf->salt->value.octet_string = osalt;
216     kdf->salt->type = V_ASN1_OCTET_STRING;
217
218     if (saltlen == 0)
219         saltlen = PKCS5_SALT_LEN;
220     if ((osalt->data = OPENSSL_malloc(saltlen)) == NULL)
221         goto merr;
222
223     osalt->length = saltlen;
224
225     if (salt)
226         memcpy(osalt->data, salt, saltlen);
227     else if (RAND_bytes(osalt->data, saltlen) <= 0)
228         goto merr;
229
230     if (iter <= 0)
231         iter = PKCS5_DEFAULT_ITER;
232
233     if (!ASN1_INTEGER_set(kdf->iter, iter))
234         goto merr;
235
236     /* If have a key len set it up */
237
238     if (keylen > 0) {
239         if ((kdf->keylength = ASN1_INTEGER_new()) == NULL)
240             goto merr;
241         if (!ASN1_INTEGER_set(kdf->keylength, keylen))
242             goto merr;
243     }
244
245     /* prf can stay NULL if we are using hmacWithSHA1 */
246     if (prf_nid > 0 && prf_nid != NID_hmacWithSHA1) {
247         kdf->prf = X509_ALGOR_new();
248         if (kdf->prf == NULL)
249             goto merr;
250         X509_ALGOR_set0(kdf->prf, OBJ_nid2obj(prf_nid), V_ASN1_NULL, NULL);
251     }
252
253     /* Finally setup the keyfunc structure */
254
255     keyfunc = X509_ALGOR_new();
256     if (keyfunc == NULL)
257         goto merr;
258
259     keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
260
261     /* Encode PBKDF2PARAM into parameter of pbe2 */
262
263     if (!ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), kdf,
264                                  &keyfunc->parameter))
265          goto merr;
266
267     PBKDF2PARAM_free(kdf);
268     return keyfunc;
269
270  merr:
271     ASN1err(ASN1_F_PKCS5_PBKDF2_SET, ERR_R_MALLOC_FAILURE);
272     PBKDF2PARAM_free(kdf);
273     X509_ALGOR_free(keyfunc);
274     return NULL;
275 }