2 * Copyright 1999-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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>
13 #include "crypto/x509.h" /* for X509_add_cert_new() */
16 DEFINE_STACK_OF(PKCS7)
17 DEFINE_STACK_OF(PKCS12_SAFEBAG)
19 /* Simplified PKCS#12 routines */
21 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
22 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
24 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
25 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
27 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
28 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
31 * Parse and decrypt a PKCS#12 structure returning user key, user cert and
32 * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
33 * should point to a valid STACK structure. pkey and/or cert may be NULL;
34 * if non-NULL the variables they point to can be passed uninitialised.
37 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
40 STACK_OF(X509) *ocerts = NULL;
48 /* Check for NULL PKCS12 structure */
51 PKCS12err(PKCS12_F_PKCS12_PARSE,
52 PKCS12_R_INVALID_NULL_PKCS12_POINTER);
59 * If password is zero length or NULL then try verifying both cases to
60 * determine which password is correct. The reason for this is that under
61 * PKCS#12 password based encryption no password and a zero length
62 * password are two different things...
65 if (pass == NULL || *pass == '\0') {
66 if (PKCS12_verify_mac(p12, NULL, 0))
68 else if (PKCS12_verify_mac(p12, "", 0))
71 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
74 } else if (!PKCS12_verify_mac(p12, pass, -1)) {
75 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
79 /* If needed, allocate stack for other certificates */
80 if ((cert != NULL || ca != NULL)
81 && (ocerts = sk_X509_new_null()) == NULL) {
82 PKCS12err(PKCS12_F_PKCS12_PARSE, ERR_R_MALLOC_FAILURE);
86 if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
87 PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_PARSE_ERROR);
91 /* Split the certs in ocerts over *cert and *ca as far as requested */
92 while ((x = sk_X509_shift(ocerts)) != NULL) {
93 if (pkey != NULL && *pkey != NULL
94 && cert != NULL && *cert == NULL) {
98 match = X509_check_private_key(x, *pkey);
107 if (!X509_add_cert_new(ca, x, X509_ADD_FLAG_DEFAULT))
113 sk_X509_free(ocerts);
120 EVP_PKEY_free(*pkey);
128 sk_X509_pop_free(ocerts, X509_free);
133 /* Parse the outer PKCS#12 structure */
135 /* pkey and/or ocerts may be NULL */
136 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
137 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
139 STACK_OF(PKCS7) *asafes;
140 STACK_OF(PKCS12_SAFEBAG) *bags;
144 if ((asafes = PKCS12_unpack_authsafes(p12)) == NULL)
146 for (i = 0; i < sk_PKCS7_num(asafes); i++) {
147 p7 = sk_PKCS7_value(asafes, i);
148 bagnid = OBJ_obj2nid(p7->type);
149 if (bagnid == NID_pkcs7_data) {
150 bags = PKCS12_unpack_p7data(p7);
151 } else if (bagnid == NID_pkcs7_encrypted) {
152 bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
156 sk_PKCS7_pop_free(asafes, PKCS7_free);
159 if (!parse_bags(bags, pass, passlen, pkey, ocerts)) {
160 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
161 sk_PKCS7_pop_free(asafes, PKCS7_free);
164 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
166 sk_PKCS7_pop_free(asafes, PKCS7_free);
170 /* pkey and/or ocerts may be NULL */
171 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
172 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
175 for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
176 if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
177 pass, passlen, pkey, ocerts))
183 /* pkey and/or ocerts may be NULL */
184 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
185 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
187 PKCS8_PRIV_KEY_INFO *p8;
189 const ASN1_TYPE *attrib;
190 ASN1_BMPSTRING *fname = NULL;
191 ASN1_OCTET_STRING *lkid = NULL;
193 if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_friendlyName)))
194 fname = attrib->value.bmpstring;
196 if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_localKeyID)))
197 lkid = attrib->value.octet_string;
199 switch (PKCS12_SAFEBAG_get_nid(bag)) {
201 if (pkey == NULL || *pkey != NULL)
203 *pkey = EVP_PKCS82PKEY(PKCS12_SAFEBAG_get0_p8inf(bag));
208 case NID_pkcs8ShroudedKeyBag:
209 if (pkey == NULL || *pkey != NULL)
211 if ((p8 = PKCS12_decrypt_skey(bag, pass, passlen)) == NULL)
213 *pkey = EVP_PKCS82PKEY(p8);
214 PKCS8_PRIV_KEY_INFO_free(p8);
221 || PKCS12_SAFEBAG_get_bag_nid(bag) != NID_x509Certificate)
223 if ((x509 = PKCS12_SAFEBAG_get1_cert(bag)) == NULL)
225 if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
233 len = ASN1_STRING_to_UTF8(&data, fname);
235 r = X509_alias_set1(x509, data, len);
244 if (!sk_X509_push(ocerts, x509)) {
251 case NID_safeContentsBag:
252 return parse_bags(PKCS12_SAFEBAG_get0_safes(bag), pass, passlen, pkey,