1 /*
2 * Copyright 1999-2022 The OpenSSL Project Authors. All Rights Reserved.
3 *
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
8 */
9
10 #include <stdio.h>
11 #include "internal/cryptlib.h"
12 #include <openssl/pkcs12.h>
13 #include "crypto/x509.h" /* for ossl_x509_add_cert_new() */
14
15 /* Simplified PKCS#12 routines */
16
17 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
18 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
19
20 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
21 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
22
23 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
24 EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
25
26 /*
27 * Parse and decrypt a PKCS#12 structure returning user key, user cert and
28 * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
29 * should point to a valid STACK structure. pkey and/or cert may be NULL;
30 * if non-NULL the variables they point to can be passed uninitialised.
31 */
32
PKCS12_parse(PKCS12 * p12,const char * pass,EVP_PKEY ** pkey,X509 ** cert,STACK_OF (X509)** ca)33 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
34 STACK_OF(X509) **ca)
35 {
36 STACK_OF(X509) *ocerts = NULL;
37 X509 *x = NULL;
38
39 if (pkey != NULL)
40 *pkey = NULL;
41 if (cert != NULL)
42 *cert = NULL;
43
44 /* Check for NULL PKCS12 structure */
45
46 if (p12 == NULL) {
47 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_INVALID_NULL_PKCS12_POINTER);
48 return 0;
49 }
50
51 /* Check the mac */
52 if (PKCS12_mac_present(p12)) {
53 /*
54 * If password is zero length or NULL then try verifying both cases to
55 * determine which password is correct. The reason for this is that under
56 * PKCS#12 password based encryption no password and a zero length
57 * password are two different things...
58 */
59 if (pass == NULL || *pass == '\0') {
60 if (PKCS12_verify_mac(p12, NULL, 0))
61 pass = NULL;
62 else if (PKCS12_verify_mac(p12, "", 0))
63 pass = "";
64 else {
65 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_VERIFY_FAILURE);
66 goto err;
67 }
68 } else if (!PKCS12_verify_mac(p12, pass, -1)) {
69 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_VERIFY_FAILURE);
70 goto err;
71 }
72 } else if (pass == NULL || *pass == '\0') {
73 pass = NULL;
74 }
75
76 /* If needed, allocate stack for other certificates */
77 if ((cert != NULL || ca != NULL)
78 && (ocerts = sk_X509_new_null()) == NULL) {
79 ERR_raise(ERR_LIB_PKCS12, ERR_R_MALLOC_FAILURE);
80 goto err;
81 }
82
83 if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
84 int err = ERR_peek_last_error();
85
86 if (ERR_GET_LIB(err) != ERR_LIB_EVP
87 && ERR_GET_REASON(err) != EVP_R_UNSUPPORTED_ALGORITHM)
88 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_PARSE_ERROR);
89 goto err;
90 }
91
92 /* Split the certs in ocerts over *cert and *ca as far as requested */
93 while ((x = sk_X509_shift(ocerts)) != NULL) {
94 if (pkey != NULL && *pkey != NULL
95 && cert != NULL && *cert == NULL) {
96 int match;
97
98 ERR_set_mark();
99 match = X509_check_private_key(x, *pkey);
100 ERR_pop_to_mark();
101 if (match) {
102 *cert = x;
103 continue;
104 }
105 }
106
107 if (ca != NULL) {
108 if (!ossl_x509_add_cert_new(ca, x, X509_ADD_FLAG_DEFAULT))
109 goto err;
110 continue;
111 }
112 X509_free(x);
113 }
114 sk_X509_free(ocerts);
115
116 return 1;
117
118 err:
119
120 if (pkey != NULL) {
121 EVP_PKEY_free(*pkey);
122 *pkey = NULL;
123 }
124 if (cert != NULL) {
125 X509_free(*cert);
126 *cert = NULL;
127 }
128 X509_free(x);
129 OSSL_STACK_OF_X509_free(ocerts);
130 return 0;
131
132 }
133
134 /* Parse the outer PKCS#12 structure */
135
136 /* pkey and/or ocerts may be NULL */
parse_pk12(PKCS12 * p12,const char * pass,int passlen,EVP_PKEY ** pkey,STACK_OF (X509)* ocerts)137 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
138 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
139 {
140 STACK_OF(PKCS7) *asafes;
141 STACK_OF(PKCS12_SAFEBAG) *bags;
142 int i, bagnid;
143 PKCS7 *p7;
144
145 if ((asafes = PKCS12_unpack_authsafes(p12)) == NULL)
146 return 0;
147 for (i = 0; i < sk_PKCS7_num(asafes); i++) {
148 p7 = sk_PKCS7_value(asafes, i);
149 bagnid = OBJ_obj2nid(p7->type);
150 if (bagnid == NID_pkcs7_data) {
151 bags = PKCS12_unpack_p7data(p7);
152 } else if (bagnid == NID_pkcs7_encrypted) {
153 bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
154 } else
155 continue;
156 if (!bags) {
157 sk_PKCS7_pop_free(asafes, PKCS7_free);
158 return 0;
159 }
160 if (!parse_bags(bags, pass, passlen, pkey, ocerts)) {
161 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
162 sk_PKCS7_pop_free(asafes, PKCS7_free);
163 return 0;
164 }
165 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
166 }
167 sk_PKCS7_pop_free(asafes, PKCS7_free);
168 return 1;
169 }
170
171 /* pkey and/or ocerts may be NULL */
parse_bags(const STACK_OF (PKCS12_SAFEBAG)* bags,const char * pass,int passlen,EVP_PKEY ** pkey,STACK_OF (X509)* ocerts)172 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
173 int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
174 {
175 int i;
176 for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
177 if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
178 pass, passlen, pkey, ocerts))
179 return 0;
180 }
181 return 1;
182 }
183
184 /* pkey and/or ocerts may be NULL */
parse_bag(PKCS12_SAFEBAG * bag,const char * pass,int passlen,EVP_PKEY ** pkey,STACK_OF (X509)* ocerts)185 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
186 EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
187 {
188 PKCS8_PRIV_KEY_INFO *p8;
189 X509 *x509;
190 const ASN1_TYPE *attrib;
191 ASN1_BMPSTRING *fname = NULL;
192 ASN1_OCTET_STRING *lkid = NULL;
193
194 if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_friendlyName)))
195 fname = attrib->value.bmpstring;
196
197 if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_localKeyID)))
198 lkid = attrib->value.octet_string;
199
200 switch (PKCS12_SAFEBAG_get_nid(bag)) {
201 case NID_keyBag:
202 if (pkey == NULL || *pkey != NULL)
203 return 1;
204 *pkey = EVP_PKCS82PKEY(PKCS12_SAFEBAG_get0_p8inf(bag));
205 if (*pkey == NULL)
206 return 0;
207 break;
208
209 case NID_pkcs8ShroudedKeyBag:
210 if (pkey == NULL || *pkey != NULL)
211 return 1;
212 if ((p8 = PKCS12_decrypt_skey(bag, pass, passlen)) == NULL)
213 return 0;
214 *pkey = EVP_PKCS82PKEY(p8);
215 PKCS8_PRIV_KEY_INFO_free(p8);
216 if (!(*pkey))
217 return 0;
218 break;
219
220 case NID_certBag:
221 if (ocerts == NULL
222 || PKCS12_SAFEBAG_get_bag_nid(bag) != NID_x509Certificate)
223 return 1;
224 if ((x509 = PKCS12_SAFEBAG_get1_cert(bag)) == NULL)
225 return 0;
226 if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
227 X509_free(x509);
228 return 0;
229 }
230 if (fname) {
231 int len, r;
232 unsigned char *data;
233
234 len = ASN1_STRING_to_UTF8(&data, fname);
235 if (len >= 0) {
236 r = X509_alias_set1(x509, data, len);
237 OPENSSL_free(data);
238 if (!r) {
239 X509_free(x509);
240 return 0;
241 }
242 }
243 }
244
245 if (!sk_X509_push(ocerts, x509)) {
246 X509_free(x509);
247 return 0;
248 }
249
250 break;
251
252 case NID_safeContentsBag:
253 return parse_bags(PKCS12_SAFEBAG_get0_safes(bag), pass, passlen, pkey,
254 ocerts);
255
256 default:
257 return 1;
258 }
259 return 1;
260 }
261
