2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
61 #include <openssl/pkcs12.h>
63 /* Simplified PKCS#12 routines */
65 static int parse_pk12( PKCS12 *p12, const char *pass, int passlen,
66 EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca);
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,
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);
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
83 int PKCS12_parse (PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
87 /* Check for NULL PKCS12 structure */
91 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_INVALID_NULL_PKCS12_POINTER);
95 /* Allocate stack for ca certificates if needed */
96 if ((ca != NULL) && (*ca == NULL))
98 if (!(*ca = sk_X509_new(NULL)))
100 PKCS12err(PKCS12_F_PKCS12_PARSE,ERR_R_MALLOC_FAILURE);
105 if(pkey) *pkey = NULL;
106 if(cert) *cert = NULL;
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...
116 if(!pass || !*pass) {
117 if(PKCS12_verify_mac(p12, NULL, 0)) pass = NULL;
118 else if(PKCS12_verify_mac(p12, "", 0)) pass = "";
120 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_MAC_VERIFY_FAILURE);
123 } else if (!PKCS12_verify_mac(p12, pass, -1)) {
124 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_MAC_VERIFY_FAILURE);
128 if (!parse_pk12 (p12, pass, -1, pkey, cert, ca))
130 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_PARSE_ERROR);
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);
145 /* Parse the outer PKCS#12 structure */
147 static int parse_pk12 (PKCS12 *p12, const char *pass, int passlen,
148 EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca)
150 STACK_OF(PKCS7) *asafes;
151 STACK_OF(PKCS12_SAFEBAG) *bags;
154 ASN1_OCTET_STRING *keyid = NULL;
157 if (!( asafes = M_PKCS12_unpack_authsafes (p12))) return 0;
158 for (i = 0; i < sk_PKCS7_num (asafes); i++) {
159 p7 = sk_PKCS7_value (asafes, i);
160 bagnid = OBJ_obj2nid (p7->type);
161 if (bagnid == NID_pkcs7_data) {
162 bags = M_PKCS12_unpack_p7data (p7);
163 } else if (bagnid == NID_pkcs7_encrypted) {
164 bags = M_PKCS12_unpack_p7encdata (p7, pass, passlen);
167 sk_PKCS7_pop_free (asafes, PKCS7_free);
170 if (!parse_bags(bags, pass, passlen, pkey, cert, ca,
171 &keyid, &keymatch)) {
172 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
173 sk_PKCS7_pop_free(asafes, PKCS7_free);
176 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
178 sk_PKCS7_pop_free(asafes, PKCS7_free);
179 if (keyid) M_ASN1_OCTET_STRING_free(keyid);
184 static int parse_bags (STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
185 int passlen, EVP_PKEY **pkey, X509 **cert,
186 STACK_OF(X509) **ca, ASN1_OCTET_STRING **keyid,
190 for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
191 if (!parse_bag(sk_PKCS12_SAFEBAG_value (bags, i),
192 pass, passlen, pkey, cert, ca, keyid,
198 #define MATCH_KEY 0x1
199 #define MATCH_CERT 0x2
200 #define MATCH_ALL 0x3
202 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
203 EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca,
204 ASN1_OCTET_STRING **keyid,
207 PKCS8_PRIV_KEY_INFO *p8;
209 ASN1_OCTET_STRING *lkey = NULL;
213 if ((attrib = PKCS12_get_attr (bag, NID_localKeyID)))
214 lkey = attrib->value.octet_string;
216 /* Check for any local key id matching (if needed) */
217 if (lkey && ((*keymatch & MATCH_ALL) != MATCH_ALL)) {
219 if (M_ASN1_OCTET_STRING_cmp(*keyid, lkey)) lkey = NULL;
221 if (!(*keyid = M_ASN1_OCTET_STRING_dup(lkey))) {
222 PKCS12err(PKCS12_F_PARSE_BAGS,ERR_R_MALLOC_FAILURE);
228 switch (M_PKCS12_bag_type(bag))
231 if (!lkey || !pkey) return 1;
232 if (!(*pkey = EVP_PKCS82PKEY(bag->value.keybag))) return 0;
233 *keymatch |= MATCH_KEY;
236 case NID_pkcs8ShroudedKeyBag:
237 if (!lkey || !pkey) return 1;
238 if (!(p8 = M_PKCS12_decrypt_skey(bag, pass, passlen)))
240 *pkey = EVP_PKCS82PKEY(p8);
241 PKCS8_PRIV_KEY_INFO_free(p8);
242 if (!(*pkey)) return 0;
243 *keymatch |= MATCH_KEY;
247 if (M_PKCS12_cert_bag_type(bag) != NID_x509Certificate )
249 if (!(x509 = M_PKCS12_certbag2x509(bag))) return 0;
251 *keymatch |= MATCH_CERT;
252 if (cert) *cert = x509;
254 if(ca) sk_X509_push (*ca, x509);
255 else X509_free(x509);
259 case NID_safeContentsBag:
260 return parse_bags(bag->value.safes, pass, passlen,
261 pkey, cert, ca, keyid, keymatch);