Add PRF preference ctrl to ciphers.
[openssl.git] / crypto / asn1 / p5_pbev2.c
1 /* p5_pbev2.c */
2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
3  * project 1999-2004.
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
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include <openssl/rand.h>
64
65 /* PKCS#5 v2.0 password based encryption structures */
66
67 ASN1_SEQUENCE(PBE2PARAM) = {
68         ASN1_SIMPLE(PBE2PARAM, keyfunc, X509_ALGOR),
69         ASN1_SIMPLE(PBE2PARAM, encryption, X509_ALGOR)
70 } ASN1_SEQUENCE_END(PBE2PARAM)
71
72 IMPLEMENT_ASN1_FUNCTIONS(PBE2PARAM)
73
74 ASN1_SEQUENCE(PBKDF2PARAM) = {
75         ASN1_SIMPLE(PBKDF2PARAM, salt, ASN1_ANY),
76         ASN1_SIMPLE(PBKDF2PARAM, iter, ASN1_INTEGER),
77         ASN1_OPT(PBKDF2PARAM, keylength, ASN1_INTEGER),
78         ASN1_OPT(PBKDF2PARAM, prf, X509_ALGOR)
79 } ASN1_SEQUENCE_END(PBKDF2PARAM)
80
81 IMPLEMENT_ASN1_FUNCTIONS(PBKDF2PARAM)
82
83 /* Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm:
84  * yes I know this is horrible!
85  */
86
87 X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter,
88                                  unsigned char *salt, int saltlen)
89 {
90         X509_ALGOR *scheme = NULL, *kalg = NULL, *ret = NULL;
91         int alg_nid;
92         EVP_CIPHER_CTX ctx;
93         unsigned char iv[EVP_MAX_IV_LENGTH];
94         PBKDF2PARAM *kdf = NULL;
95         PBE2PARAM *pbe2 = NULL;
96         ASN1_OCTET_STRING *osalt = NULL;
97         ASN1_OBJECT *obj;
98         int prf_nid;
99
100         alg_nid = EVP_CIPHER_type(cipher);
101         if(alg_nid == NID_undef) {
102                 ASN1err(ASN1_F_PKCS5_PBE2_SET,
103                                 ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
104                 goto err;
105         }
106         obj = OBJ_nid2obj(alg_nid);
107
108         if(!(pbe2 = PBE2PARAM_new())) goto merr;
109
110         /* Setup the AlgorithmIdentifier for the encryption scheme */
111         scheme = pbe2->encryption;
112
113         scheme->algorithm = obj;
114         if(!(scheme->parameter = ASN1_TYPE_new())) goto merr;
115
116         /* Create random IV */
117         if (EVP_CIPHER_iv_length(cipher) &&
118                 RAND_pseudo_bytes(iv, EVP_CIPHER_iv_length(cipher)) < 0)
119                 goto err;
120
121         EVP_CIPHER_CTX_init(&ctx);
122
123         /* Dummy cipherinit to just setup the IV, and PRF */
124         EVP_CipherInit_ex(&ctx, cipher, NULL, NULL, iv, 0);
125         if(EVP_CIPHER_param_to_asn1(&ctx, scheme->parameter) < 0) {
126                 ASN1err(ASN1_F_PKCS5_PBE2_SET,
127                                         ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
128                 EVP_CIPHER_CTX_cleanup(&ctx);
129                 goto err;
130         }
131         /* An error is OK here: just means use default PRF */
132         if (EVP_CIPHER_CTX_ctrl(&ctx, EVP_CTRL_PBE_PRF_NID, 0, &prf_nid) <= 0)
133                 {
134                 ERR_clear_error();
135                 prf_nid = NID_hmacWithSHA1;
136                 }
137         EVP_CIPHER_CTX_cleanup(&ctx);
138
139         if(!(kdf = PBKDF2PARAM_new())) goto merr;
140         if(!(osalt = M_ASN1_OCTET_STRING_new())) goto merr;
141
142         if (!saltlen) saltlen = PKCS5_SALT_LEN;
143         if (!(osalt->data = OPENSSL_malloc (saltlen))) goto merr;
144         osalt->length = saltlen;
145         if (salt) memcpy (osalt->data, salt, saltlen);
146         else if (RAND_pseudo_bytes (osalt->data, saltlen) < 0) goto merr;
147
148         if(iter <= 0) iter = PKCS5_DEFAULT_ITER;
149         if(!ASN1_INTEGER_set(kdf->iter, iter)) goto merr;
150
151         /* Now include salt in kdf structure */
152         kdf->salt->value.octet_string = osalt;
153         kdf->salt->type = V_ASN1_OCTET_STRING;
154         osalt = NULL;
155
156         /* If its RC2 then we'd better setup the key length */
157
158         if(alg_nid == NID_rc2_cbc) {
159                 if(!(kdf->keylength = M_ASN1_INTEGER_new())) goto merr;
160                 if(!ASN1_INTEGER_set (kdf->keylength,
161                                  EVP_CIPHER_key_length(cipher))) goto merr;
162         }
163
164         /* prf can stay NULL if we are using hmacWithSHA1 */
165         if (prf_nid != NID_hmacWithSHA1)
166                 {
167                 kdf->prf = X509_ALGOR_new();
168                 if (!kdf->prf)
169                         goto merr;
170                 X509_ALGOR_set0(kdf->prf, OBJ_nid2obj(prf_nid),
171                                         V_ASN1_NULL, NULL);
172                 }
173
174         /* Now setup the PBE2PARAM keyfunc structure */
175
176         pbe2->keyfunc->algorithm = OBJ_nid2obj(NID_id_pbkdf2);
177
178         /* Encode PBKDF2PARAM into parameter of pbe2 */
179
180         if(!(pbe2->keyfunc->parameter = ASN1_TYPE_new())) goto merr;
181
182         if(!ASN1_pack_string_of(PBKDF2PARAM, kdf, i2d_PBKDF2PARAM,
183                          &pbe2->keyfunc->parameter->value.sequence)) goto merr;
184         pbe2->keyfunc->parameter->type = V_ASN1_SEQUENCE;
185
186         PBKDF2PARAM_free(kdf);
187         kdf = NULL;
188
189         /* Now set up top level AlgorithmIdentifier */
190
191         if(!(ret = X509_ALGOR_new())) goto merr;
192         if(!(ret->parameter = ASN1_TYPE_new())) goto merr;
193
194         ret->algorithm = OBJ_nid2obj(NID_pbes2);
195
196         /* Encode PBE2PARAM into parameter */
197
198         if(!ASN1_pack_string_of(PBE2PARAM, pbe2, i2d_PBE2PARAM,
199                                  &ret->parameter->value.sequence)) goto merr;
200         ret->parameter->type = V_ASN1_SEQUENCE;
201
202         PBE2PARAM_free(pbe2);
203         pbe2 = NULL;
204
205         return ret;
206
207         merr:
208         ASN1err(ASN1_F_PKCS5_PBE2_SET,ERR_R_MALLOC_FAILURE);
209
210         err:
211         PBE2PARAM_free(pbe2);
212         /* Note 'scheme' is freed as part of pbe2 */
213         M_ASN1_OCTET_STRING_free(osalt);
214         PBKDF2PARAM_free(kdf);
215         X509_ALGOR_free(kalg);
216         X509_ALGOR_free(ret);
217
218         return NULL;
219
220 }