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