Make PKCS#12 code handle missing passwords.
[openssl.git] / crypto / pkcs12 / p12_kiss.c
1 /* p12_kiss.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
59 #include <stdio.h>
60 #include "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, X509 **cert, STACK_OF(X509) **ca);
67
68 static int parse_bags( STACK *bags, const char *pass, int passlen,
69                 EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca,
70                 ASN1_OCTET_STRING **keyid, char *keymatch);
71
72 static int parse_bag( PKCS12_SAFEBAG *bag, const char *pass, int passlen,
73                         EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca,
74                         ASN1_OCTET_STRING **keyid, char *keymatch);
75
76 /* Parse and decrypt a PKCS#12 structure returning user key, user cert
77  * and other (CA) certs. Note either ca should be NULL, *ca should be NULL,
78  * or it should point to a valid STACK structure. pkey and cert can be
79  * passed unitialised.
80  */
81
82 int PKCS12_parse (PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
83              STACK_OF(X509) **ca)
84 {
85
86         /* Check for NULL PKCS12 structure */
87
88         if(!p12)
89                 {
90                 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_INVALID_NULL_PKCS12_POINTER);
91                 return 0;
92                 }
93
94         /* Allocate stack for ca certificates if needed */
95         if ((ca != NULL) && (*ca == NULL))
96                 {
97                 if (!(*ca = sk_X509_new(NULL)))
98                         {
99                         PKCS12err(PKCS12_F_PKCS12_PARSE,ERR_R_MALLOC_FAILURE);
100                         return 0;
101                         }
102                 }
103
104         if(pkey) *pkey = NULL;
105         if(cert) *cert = NULL;
106
107         /* Check the mac */
108
109         /* If password is zero length or NULL then try verifying both cases
110          * to determine which password is correct. The reason for this is that
111          * under PKCS#12 password based encryption no password and a zero length
112          * password are two different things...
113          */
114
115         if(!pass || !*pass) {
116                 if(PKCS12_verify_mac(p12, NULL, 0)) pass = NULL;
117                 else if(PKCS12_verify_mac(p12, "", 0)) pass = "";
118                 else {
119                         PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_MAC_VERIFY_FAILURE);
120                         goto err;
121                 }
122         } else if (!PKCS12_verify_mac(p12, pass, -1)) {
123                 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_MAC_VERIFY_FAILURE);
124                 goto err;
125         }
126
127         if (!parse_pk12 (p12, pass, -1, pkey, cert, ca))
128                 {
129                 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_PARSE_ERROR);
130                 goto err;
131                 }
132
133         return 1;
134
135  err:
136
137         if (pkey && *pkey) EVP_PKEY_free (*pkey);
138         if (cert && *cert) X509_free (*cert);
139         if (ca) sk_X509_pop_free (*ca, X509_free);
140         return 0;
141
142 }
143
144 /* Parse the outer PKCS#12 structure */
145
146 static int parse_pk12 (PKCS12 *p12, const char *pass, int passlen,
147              EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca)
148 {
149         STACK *asafes, *bags;
150         int i, bagnid;
151         PKCS7 *p7;
152         ASN1_OCTET_STRING *keyid = NULL;
153         char keymatch = 0;
154         if (!( asafes = M_PKCS12_unpack_authsafes (p12))) return 0;
155         for (i = 0; i < sk_num (asafes); i++) {
156                 p7 = (PKCS7 *) sk_value (asafes, i);
157                 bagnid = OBJ_obj2nid (p7->type);
158                 if (bagnid == NID_pkcs7_data) {
159                         bags = M_PKCS12_unpack_p7data (p7);
160                 } else if (bagnid == NID_pkcs7_encrypted) {
161                         bags = M_PKCS12_unpack_p7encdata (p7, pass, passlen);
162                 } else continue;
163                 if (!bags) {
164                         sk_pop_free (asafes, PKCS7_free);
165                         return 0;
166                 }
167                 if (!parse_bags(bags, pass, passlen, pkey, cert, ca,
168                                                          &keyid, &keymatch)) {
169                         sk_pop_free(bags, PKCS12_SAFEBAG_free);
170                         sk_pop_free(asafes, PKCS7_free);
171                         return 0;
172                 }
173                 sk_pop_free(bags, PKCS12_SAFEBAG_free);
174         }
175         sk_pop_free(asafes, PKCS7_free);
176         if (keyid) M_ASN1_OCTET_STRING_free(keyid);
177         return 1;
178 }
179
180
181 static int parse_bags (STACK *bags, const char *pass, int passlen,
182                        EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca,
183                        ASN1_OCTET_STRING **keyid, char *keymatch)
184 {
185         int i;
186         for (i = 0; i < sk_num(bags); i++) {
187                 if (!parse_bag((PKCS12_SAFEBAG *)sk_value (bags, i),
188                          pass, passlen, pkey, cert, ca, keyid,
189                                                          keymatch)) return 0;
190         }
191         return 1;
192 }
193
194 #define MATCH_KEY  0x1
195 #define MATCH_CERT 0x2
196 #define MATCH_ALL  0x3
197
198 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
199                       EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca,
200                       ASN1_OCTET_STRING **keyid,
201              char *keymatch)
202 {
203         PKCS8_PRIV_KEY_INFO *p8;
204         X509 *x509;
205         ASN1_OCTET_STRING *lkey = NULL;
206         ASN1_TYPE *attrib;
207
208
209         if ((attrib = PKCS12_get_attr (bag, NID_localKeyID)))
210                                             lkey = attrib->value.octet_string;
211
212         /* Check for any local key id matching (if needed) */
213         if (lkey && ((*keymatch & MATCH_ALL) != MATCH_ALL)) {
214                 if (*keyid) {
215                         if (M_ASN1_OCTET_STRING_cmp(*keyid, lkey)) lkey = NULL;
216                 } else {
217                         if (!(*keyid = M_ASN1_OCTET_STRING_dup(lkey))) {
218                                 PKCS12err(PKCS12_F_PARSE_BAGS,ERR_R_MALLOC_FAILURE);
219                                 return 0;
220                     }
221                 }
222         }
223         
224         switch (M_PKCS12_bag_type(bag))
225         {
226         case NID_keyBag:
227                 if (!lkey || !pkey) return 1;   
228                 if (!(*pkey = EVP_PKCS82PKEY(bag->value.keybag))) return 0;
229                 *keymatch |= MATCH_KEY;
230         break;
231
232         case NID_pkcs8ShroudedKeyBag:
233                 if (!lkey || !pkey) return 1;   
234                 if (!(p8 = M_PKCS12_decrypt_skey(bag, pass, passlen)))
235                                 return 0;
236                 *pkey = EVP_PKCS82PKEY(p8);
237                 PKCS8_PRIV_KEY_INFO_free(p8);
238                 if (!(*pkey)) return 0;
239                 *keymatch |= MATCH_KEY;
240         break;
241
242         case NID_certBag:
243                 if (M_PKCS12_cert_bag_type(bag) != NID_x509Certificate )
244                                                                  return 1;
245                 if (!(x509 = M_PKCS12_certbag2x509(bag))) return 0;
246                 if (lkey) {
247                         *keymatch |= MATCH_CERT;
248                         if (cert) *cert = x509;
249                 } else {
250                         if(ca) sk_X509_push (*ca, x509);
251                         else X509_free(x509);
252                 }
253         break;
254
255         case NID_safeContentsBag:
256                 return parse_bags(bag->value.safes, pass, passlen,
257                                         pkey, cert, ca, keyid, keymatch);
258         break;
259
260         default:
261                 return 1;
262         break;
263         }
264         return 1;
265 }
266