59c84a0493e596129a333ecf7244d115f267d20b
[openssl.git] / crypto / pkcs12 / p12_kiss.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 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
59 #include <stdio.h>
60 #include "internal/cryptlib.h"
61 #include <openssl/pkcs12.h>
62
63 /* Simplified PKCS#12 routines */
64
65 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
66                       EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
67
68 static int parse_bags(STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
69                       int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
70
71 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
72                      EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
73
74 /*
75  * Parse and decrypt a PKCS#12 structure returning user key, user cert and
76  * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
77  * should point to a valid STACK structure. pkey and cert can be passed
78  * uninitialised.
79  */
80
81 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
82                  STACK_OF(X509) **ca)
83 {
84     STACK_OF(X509) *ocerts = NULL;
85     X509 *x = NULL;
86     /* Check for NULL PKCS12 structure */
87
88     if (!p12) {
89         PKCS12err(PKCS12_F_PKCS12_PARSE,
90                   PKCS12_R_INVALID_NULL_PKCS12_POINTER);
91         return 0;
92     }
93
94     if (pkey)
95         *pkey = NULL;
96     if (cert)
97         *cert = NULL;
98
99     /* Check the mac */
100
101     /*
102      * If password is zero length or NULL then try verifying both cases to
103      * determine which password is correct. The reason for this is that under
104      * PKCS#12 password based encryption no password and a zero length
105      * password are two different things...
106      */
107
108     if (!pass || !*pass) {
109         if (PKCS12_verify_mac(p12, NULL, 0))
110             pass = NULL;
111         else if (PKCS12_verify_mac(p12, "", 0))
112             pass = "";
113         else {
114             PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
115             goto err;
116         }
117     } else if (!PKCS12_verify_mac(p12, pass, -1)) {
118         PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
119         goto err;
120     }
121
122     /* Allocate stack for other certificates */
123     ocerts = sk_X509_new_null();
124
125     if (!ocerts) {
126         PKCS12err(PKCS12_F_PKCS12_PARSE, ERR_R_MALLOC_FAILURE);
127         return 0;
128     }
129
130     if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
131         PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_PARSE_ERROR);
132         goto err;
133     }
134
135     while ((x = sk_X509_pop(ocerts))) {
136         if (pkey && *pkey && cert && !*cert) {
137             ERR_set_mark();
138             if (X509_check_private_key(x, *pkey)) {
139                 *cert = x;
140                 x = NULL;
141             }
142             ERR_pop_to_mark();
143         }
144
145         if (ca && x) {
146             if (!*ca)
147                 *ca = sk_X509_new_null();
148             if (!*ca)
149                 goto err;
150             if (!sk_X509_push(*ca, x))
151                 goto err;
152             x = NULL;
153         }
154         X509_free(x);
155     }
156
157     sk_X509_pop_free(ocerts, X509_free);
158
159     return 1;
160
161  err:
162
163     if (pkey)
164         EVP_PKEY_free(*pkey);
165     if (cert)
166         X509_free(*cert);
167     X509_free(x);
168     sk_X509_pop_free(ocerts, X509_free);
169     return 0;
170
171 }
172
173 /* Parse the outer PKCS#12 structure */
174
175 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
176                       EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
177 {
178     STACK_OF(PKCS7) *asafes;
179     STACK_OF(PKCS12_SAFEBAG) *bags;
180     int i, bagnid;
181     PKCS7 *p7;
182
183     if ((asafes = PKCS12_unpack_authsafes(p12)) == NULL)
184         return 0;
185     for (i = 0; i < sk_PKCS7_num(asafes); i++) {
186         p7 = sk_PKCS7_value(asafes, i);
187         bagnid = OBJ_obj2nid(p7->type);
188         if (bagnid == NID_pkcs7_data) {
189             bags = PKCS12_unpack_p7data(p7);
190         } else if (bagnid == NID_pkcs7_encrypted) {
191             bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
192         } else
193             continue;
194         if (!bags) {
195             sk_PKCS7_pop_free(asafes, PKCS7_free);
196             return 0;
197         }
198         if (!parse_bags(bags, pass, passlen, pkey, ocerts)) {
199             sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
200             sk_PKCS7_pop_free(asafes, PKCS7_free);
201             return 0;
202         }
203         sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
204     }
205     sk_PKCS7_pop_free(asafes, PKCS7_free);
206     return 1;
207 }
208
209 static int parse_bags(STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
210                       int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
211 {
212     int i;
213     for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
214         if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
215                        pass, passlen, pkey, ocerts))
216             return 0;
217     }
218     return 1;
219 }
220
221 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
222                      EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
223 {
224     PKCS8_PRIV_KEY_INFO *p8;
225     X509 *x509;
226     ASN1_TYPE *attrib;
227     ASN1_BMPSTRING *fname = NULL;
228     ASN1_OCTET_STRING *lkid = NULL;
229
230     if ((attrib = PKCS12_get_attr(bag, NID_friendlyName)))
231         fname = attrib->value.bmpstring;
232
233     if ((attrib = PKCS12_get_attr(bag, NID_localKeyID)))
234         lkid = attrib->value.octet_string;
235
236     switch (M_PKCS12_bag_type(bag)) {
237     case NID_keyBag:
238         if (!pkey || *pkey)
239             return 1;
240         if ((*pkey = EVP_PKCS82PKEY(bag->value.keybag)) == NULL)
241             return 0;
242         break;
243
244     case NID_pkcs8ShroudedKeyBag:
245         if (!pkey || *pkey)
246             return 1;
247         if ((p8 = PKCS12_decrypt_skey(bag, pass, passlen)) == NULL)
248             return 0;
249         *pkey = EVP_PKCS82PKEY(p8);
250         PKCS8_PRIV_KEY_INFO_free(p8);
251         if (!(*pkey))
252             return 0;
253         break;
254
255     case NID_certBag:
256         if (M_PKCS12_cert_bag_type(bag) != NID_x509Certificate)
257             return 1;
258         if ((x509 = PKCS12_certbag2x509(bag)) == NULL)
259             return 0;
260         if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
261             X509_free(x509);
262             return 0;
263         }
264         if (fname) {
265             int len, r;
266             unsigned char *data;
267             len = ASN1_STRING_to_UTF8(&data, fname);
268             if (len >= 0) {
269                 r = X509_alias_set1(x509, data, len);
270                 OPENSSL_free(data);
271                 if (!r) {
272                     X509_free(x509);
273                     return 0;
274                 }
275             }
276         }
277
278         if (!sk_X509_push(ocerts, x509)) {
279             X509_free(x509);
280             return 0;
281         }
282
283         break;
284
285     case NID_safeContentsBag:
286         return parse_bags(bag->value.safes, pass, passlen, pkey, ocerts);
287
288     default:
289         return 1;
290     }
291     return 1;
292 }