3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/pkcs12.h>
64 /* Simplified PKCS#12 routines */
66 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
67 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
69 static int parse_bags(STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
70 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
72 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
73 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
76 * Parse and decrypt a PKCS#12 structure returning user key, user cert and
77 * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
78 * should point to a valid STACK structure. pkey and cert can be passed
82 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
85 STACK_OF(X509) *ocerts = NULL;
87 /* Check for NULL PKCS12 structure */
90 PKCS12err(PKCS12_F_PKCS12_PARSE,
91 PKCS12_R_INVALID_NULL_PKCS12_POINTER);
103 * If password is zero length or NULL then try verifying both cases to
104 * determine which password is correct. The reason for this is that under
105 * PKCS#12 password based encryption no password and a zero length
106 * password are two different things...
109 if (!pass || !*pass) {
110 if (PKCS12_verify_mac(p12, NULL, 0))
112 else if (PKCS12_verify_mac(p12, "", 0))
115 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
118 } else if (!PKCS12_verify_mac(p12, pass, -1)) {
119 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
123 /* Allocate stack for other certificates */
124 ocerts = sk_X509_new_null();
127 PKCS12err(PKCS12_F_PKCS12_PARSE, ERR_R_MALLOC_FAILURE);
131 if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
132 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_PARSE_ERROR);
136 while ((x = sk_X509_pop(ocerts))) {
137 if (pkey && *pkey && cert && !*cert) {
138 if (X509_check_private_key(x, *pkey)) {
146 *ca = sk_X509_new_null();
149 if (!sk_X509_push(*ca, x))
158 sk_X509_pop_free(ocerts, X509_free);
165 EVP_PKEY_free(*pkey);
171 sk_X509_pop_free(ocerts, X509_free);
176 /* Parse the outer PKCS#12 structure */
178 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
179 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
181 STACK_OF(PKCS7) *asafes;
182 STACK_OF(PKCS12_SAFEBAG) *bags;
186 if (!(asafes = PKCS12_unpack_authsafes(p12)))
188 for (i = 0; i < sk_PKCS7_num(asafes); i++) {
189 p7 = sk_PKCS7_value(asafes, i);
190 bagnid = OBJ_obj2nid(p7->type);
191 if (bagnid == NID_pkcs7_data) {
192 bags = PKCS12_unpack_p7data(p7);
193 } else if (bagnid == NID_pkcs7_encrypted) {
194 bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
198 sk_PKCS7_pop_free(asafes, PKCS7_free);
201 if (!parse_bags(bags, pass, passlen, pkey, ocerts)) {
202 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
203 sk_PKCS7_pop_free(asafes, PKCS7_free);
206 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
208 sk_PKCS7_pop_free(asafes, PKCS7_free);
212 static int parse_bags(STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
213 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
216 for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
217 if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
218 pass, passlen, pkey, ocerts))
224 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
225 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
227 PKCS8_PRIV_KEY_INFO *p8;
230 ASN1_BMPSTRING *fname = NULL;
231 ASN1_OCTET_STRING *lkid = NULL;
233 if ((attrib = PKCS12_get_attr(bag, NID_friendlyName)))
234 fname = attrib->value.bmpstring;
236 if ((attrib = PKCS12_get_attr(bag, NID_localKeyID)))
237 lkid = attrib->value.octet_string;
239 switch (M_PKCS12_bag_type(bag)) {
243 if (!(*pkey = EVP_PKCS82PKEY(bag->value.keybag)))
247 case NID_pkcs8ShroudedKeyBag:
250 if (!(p8 = PKCS12_decrypt_skey(bag, pass, passlen)))
252 *pkey = EVP_PKCS82PKEY(p8);
253 PKCS8_PRIV_KEY_INFO_free(p8);
259 if (M_PKCS12_cert_bag_type(bag) != NID_x509Certificate)
261 if (!(x509 = PKCS12_certbag2x509(bag)))
263 if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
270 len = ASN1_STRING_to_UTF8(&data, fname);
272 r = X509_alias_set1(x509, data, len);
281 if (!sk_X509_push(ocerts, x509)) {
288 case NID_safeContentsBag:
289 return parse_bags(bag->value.safes, pass, passlen, pkey, ocerts);