2 * Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include "internal/cryptlib.h"
12 #include <openssl/pkcs12.h>
14 /* Simplified PKCS#12 routines */
16 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
17 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
19 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
20 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
22 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
23 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
26 * Parse and decrypt a PKCS#12 structure returning user key, user cert and
27 * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
28 * should point to a valid STACK structure. pkey and cert can be passed
32 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
35 STACK_OF(X509) *ocerts = NULL;
37 /* Check for NULL PKCS12 structure */
40 PKCS12err(PKCS12_F_PKCS12_PARSE,
41 PKCS12_R_INVALID_NULL_PKCS12_POINTER);
53 * If password is zero length or NULL then try verifying both cases to
54 * determine which password is correct. The reason for this is that under
55 * PKCS#12 password based encryption no password and a zero length
56 * password are two different things...
59 if (!pass || !*pass) {
60 if (PKCS12_verify_mac(p12, NULL, 0))
62 else if (PKCS12_verify_mac(p12, "", 0))
65 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
68 } else if (!PKCS12_verify_mac(p12, pass, -1)) {
69 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
73 /* Allocate stack for other certificates */
74 ocerts = sk_X509_new_null();
77 PKCS12err(PKCS12_F_PKCS12_PARSE, ERR_R_MALLOC_FAILURE);
81 if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
82 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_PARSE_ERROR);
86 while ((x = sk_X509_pop(ocerts))) {
87 if (pkey && *pkey && cert && !*cert) {
89 if (X509_check_private_key(x, *pkey)) {
98 *ca = sk_X509_new_null();
101 if (!sk_X509_push(*ca, x))
108 sk_X509_pop_free(ocerts, X509_free);
115 EVP_PKEY_free(*pkey);
119 sk_X509_pop_free(ocerts, X509_free);
124 /* Parse the outer PKCS#12 structure */
126 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
127 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
129 STACK_OF(PKCS7) *asafes;
130 STACK_OF(PKCS12_SAFEBAG) *bags;
134 if ((asafes = PKCS12_unpack_authsafes(p12)) == NULL)
136 for (i = 0; i < sk_PKCS7_num(asafes); i++) {
137 p7 = sk_PKCS7_value(asafes, i);
138 bagnid = OBJ_obj2nid(p7->type);
139 if (bagnid == NID_pkcs7_data) {
140 bags = PKCS12_unpack_p7data(p7);
141 } else if (bagnid == NID_pkcs7_encrypted) {
142 bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
146 sk_PKCS7_pop_free(asafes, PKCS7_free);
149 if (!parse_bags(bags, pass, passlen, pkey, ocerts)) {
150 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
151 sk_PKCS7_pop_free(asafes, PKCS7_free);
154 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
156 sk_PKCS7_pop_free(asafes, PKCS7_free);
160 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
161 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
164 for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
165 if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
166 pass, passlen, pkey, ocerts))
172 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
173 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
175 PKCS8_PRIV_KEY_INFO *p8;
177 const ASN1_TYPE *attrib;
178 ASN1_BMPSTRING *fname = NULL;
179 ASN1_OCTET_STRING *lkid = NULL;
181 if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_friendlyName)))
182 fname = attrib->value.bmpstring;
184 if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_localKeyID)))
185 lkid = attrib->value.octet_string;
187 switch (PKCS12_SAFEBAG_get_nid(bag)) {
191 *pkey = EVP_PKCS82PKEY(PKCS12_SAFEBAG_get0_p8inf(bag));
196 case NID_pkcs8ShroudedKeyBag:
199 if ((p8 = PKCS12_decrypt_skey(bag, pass, passlen)) == NULL)
201 *pkey = EVP_PKCS82PKEY(p8);
202 PKCS8_PRIV_KEY_INFO_free(p8);
208 if (PKCS12_SAFEBAG_get_bag_nid(bag) != NID_x509Certificate)
210 if ((x509 = PKCS12_SAFEBAG_get1_cert(bag)) == NULL)
212 if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
219 len = ASN1_STRING_to_UTF8(&data, fname);
221 r = X509_alias_set1(x509, data, len);
230 if (!sk_X509_push(ocerts, x509)) {
237 case NID_safeContentsBag:
238 return parse_bags(PKCS12_SAFEBAG_get0_safes(bag), pass, passlen, pkey,