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 *bags, const char *pass, int passlen,
69 EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca,
70 ASN1_OCTET_STRING **keyid, char *keymatch);
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);
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
82 int PKCS12_parse (PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
86 /* Check for NULL PKCS12 structure */
90 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_INVALID_NULL_PKCS12_POINTER);
94 /* Allocate stack for ca certificates if needed */
95 if ((ca != NULL) && (*ca == NULL))
97 if (!(*ca = sk_X509_new(NULL)))
99 PKCS12err(PKCS12_F_PKCS12_PARSE,ERR_R_MALLOC_FAILURE);
104 if(pkey) *pkey = NULL;
105 if(cert) *cert = NULL;
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...
115 if(!pass || !*pass) {
116 if(PKCS12_verify_mac(p12, NULL, 0)) pass = NULL;
117 else if(PKCS12_verify_mac(p12, "", 0)) pass = "";
119 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_MAC_VERIFY_FAILURE);
122 } else if (!PKCS12_verify_mac(p12, pass, -1)) {
123 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_MAC_VERIFY_FAILURE);
127 if (!parse_pk12 (p12, pass, -1, pkey, cert, ca))
129 PKCS12err(PKCS12_F_PKCS12_PARSE,PKCS12_R_PARSE_ERROR);
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);
144 /* Parse the outer PKCS#12 structure */
146 static int parse_pk12 (PKCS12 *p12, const char *pass, int passlen,
147 EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca)
149 STACK *asafes, *bags;
152 ASN1_OCTET_STRING *keyid = NULL;
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);
164 sk_pop_free (asafes, (void(*)(void *)) PKCS7_free);
167 if (!parse_bags(bags, pass, passlen, pkey, cert, ca,
168 &keyid, &keymatch)) {
169 sk_pop_free(bags, (void(*)(void *)) PKCS12_SAFEBAG_free);
170 sk_pop_free(asafes, (void(*)(void *)) PKCS7_free);
173 sk_pop_free(bags, (void(*)(void *)) PKCS12_SAFEBAG_free);
175 sk_pop_free(asafes, (void(*)(void *)) PKCS7_free);
176 if (keyid) M_ASN1_OCTET_STRING_free(keyid);
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)
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,
194 #define MATCH_KEY 0x1
195 #define MATCH_CERT 0x2
196 #define MATCH_ALL 0x3
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,
203 PKCS8_PRIV_KEY_INFO *p8;
205 ASN1_OCTET_STRING *lkey = NULL;
209 if ((attrib = PKCS12_get_attr (bag, NID_localKeyID)))
210 lkey = attrib->value.octet_string;
212 /* Check for any local key id matching (if needed) */
213 if (lkey && ((*keymatch & MATCH_ALL) != MATCH_ALL)) {
215 if (M_ASN1_OCTET_STRING_cmp(*keyid, lkey)) lkey = NULL;
217 if (!(*keyid = M_ASN1_OCTET_STRING_dup(lkey))) {
218 PKCS12err(PKCS12_F_PARSE_BAGS,ERR_R_MALLOC_FAILURE);
224 switch (M_PKCS12_bag_type(bag))
227 if (!lkey || !pkey) return 1;
228 if (!(*pkey = EVP_PKCS82PKEY(bag->value.keybag))) return 0;
229 *keymatch |= MATCH_KEY;
232 case NID_pkcs8ShroudedKeyBag:
233 if (!lkey || !pkey) return 1;
234 if (!(p8 = M_PKCS12_decrypt_skey(bag, pass, passlen)))
236 *pkey = EVP_PKCS82PKEY(p8);
237 PKCS8_PRIV_KEY_INFO_free(p8);
238 if (!(*pkey)) return 0;
239 *keymatch |= MATCH_KEY;
243 if (M_PKCS12_cert_bag_type(bag) != NID_x509Certificate )
245 if (!(x509 = M_PKCS12_certbag2x509(bag))) return 0;
247 *keymatch |= MATCH_CERT;
248 if (cert) *cert = x509;
250 if(ca) sk_X509_push (*ca, x509);
251 else X509_free(x509);
255 case NID_safeContentsBag:
256 return parse_bags(bag->value.safes, pass, passlen,
257 pkey, cert, ca, keyid, keymatch);