1 /*
2 * Copyright 1999-2025 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 "p12_local.h"
14
15 static int pkcs12_add_bag(STACK_OF(PKCS12_SAFEBAG) **pbags,
16 PKCS12_SAFEBAG *bag);
17 static int pkcs12_remove_bag(STACK_OF(PKCS12_SAFEBAG) **pbags,
18 PKCS12_SAFEBAG *bag);
19 static PKCS12_SAFEBAG *pkcs12_add_cert_bag(STACK_OF(PKCS12_SAFEBAG) **pbags,
20 X509 *cert,
21 const char *name,
22 int namelen,
23 unsigned char *keyid,
24 int keyidlen);
25
copy_bag_attr(PKCS12_SAFEBAG * bag,EVP_PKEY * pkey,int nid)26 static int copy_bag_attr(PKCS12_SAFEBAG *bag, EVP_PKEY *pkey, int nid)
27 {
28 int idx = EVP_PKEY_get_attr_by_NID(pkey, nid, -1);
29
30 if (idx < 0)
31 return 1;
32 return X509at_add1_attr(&bag->attrib, EVP_PKEY_get_attr(pkey, idx)) != NULL;
33 }
34
PKCS12_create_ex2(const char * pass,const char * name,EVP_PKEY * pkey,X509 * cert,STACK_OF (X509)* ca,int nid_key,int nid_cert,int iter,int mac_iter,int keytype,OSSL_LIB_CTX * ctx,const char * propq,PKCS12_create_cb * cb,void * cbarg)35 PKCS12 *PKCS12_create_ex2(const char *pass, const char *name, EVP_PKEY *pkey,
36 X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert,
37 int iter, int mac_iter, int keytype,
38 OSSL_LIB_CTX *ctx, const char *propq,
39 PKCS12_create_cb *cb, void *cbarg)
40 {
41 PKCS12 *p12 = NULL;
42 STACK_OF(PKCS7) *safes = NULL;
43 STACK_OF(PKCS12_SAFEBAG) *bags = NULL;
44 PKCS12_SAFEBAG *bag = NULL;
45 int i, cbret;
46 unsigned char keyid[EVP_MAX_MD_SIZE];
47 unsigned int keyidlen = 0;
48 int namelen = -1;
49 unsigned char *pkeyid = NULL;
50 int pkeyidlen = -1;
51
52 /* Set defaults */
53 if (nid_cert == NID_undef)
54 nid_cert = NID_aes_256_cbc;
55 if (nid_key == NID_undef)
56 nid_key = NID_aes_256_cbc;
57 if (!iter)
58 iter = PKCS12_DEFAULT_ITER;
59 if (!mac_iter)
60 mac_iter = PKCS12_DEFAULT_ITER;
61
62 if (pkey == NULL && cert == NULL && ca == NULL) {
63 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_INVALID_NULL_ARGUMENT);
64 return NULL;
65 }
66
67 if (pkey && cert) {
68 if (!X509_check_private_key(cert, pkey))
69 return NULL;
70 if (!X509_digest(cert, EVP_sha1(), keyid, &keyidlen))
71 return NULL;
72 }
73
74 if (cert) {
75 if (name == NULL)
76 name = (char *)X509_alias_get0(cert, &namelen);
77 if (keyidlen > 0) {
78 pkeyid = keyid;
79 pkeyidlen = keyidlen;
80 } else {
81 pkeyid = X509_keyid_get0(cert, &pkeyidlen);
82 }
83
84 bag = pkcs12_add_cert_bag(&bags, cert, name, namelen, pkeyid, pkeyidlen);
85 if (cb != NULL) {
86 cbret = cb(bag, cbarg);
87 if (cbret == -1) {
88 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_CALLBACK_FAILED);
89 goto err;
90 } else if (cbret == 0) {
91 pkcs12_remove_bag(&bags, bag);
92 }
93 }
94 }
95
96 /* Add all other certificates */
97 for (i = 0; i < sk_X509_num(ca); i++) {
98 if ((bag = PKCS12_add_cert(&bags, sk_X509_value(ca, i))) == NULL)
99 goto err;
100 if (cb != NULL) {
101 cbret = cb(bag, cbarg);
102 if (cbret == -1) {
103 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_CALLBACK_FAILED);
104 goto err;
105 } else if (cbret == 0) {
106 pkcs12_remove_bag(&bags, bag);
107 }
108 }
109 }
110
111 if (bags && !PKCS12_add_safe_ex(&safes, bags, nid_cert, iter, pass, ctx, propq))
112 goto err;
113
114 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
115 bags = NULL;
116
117 if (pkey) {
118 bag = PKCS12_add_key_ex(&bags, pkey, keytype, iter, nid_key, pass,
119 ctx, propq);
120
121 if (!bag)
122 goto err;
123
124 if (!copy_bag_attr(bag, pkey, NID_ms_csp_name))
125 goto err;
126 if (!copy_bag_attr(bag, pkey, NID_LocalKeySet))
127 goto err;
128
129 if (name && !PKCS12_add_friendlyname(bag, name, -1))
130 goto err;
131 if (keyidlen && !PKCS12_add_localkeyid(bag, keyid, keyidlen))
132 goto err;
133 if (cb != NULL) {
134 cbret = cb(bag, cbarg);
135 if (cbret == -1) {
136 ERR_raise(ERR_LIB_PKCS12, PKCS12_R_CALLBACK_FAILED);
137 goto err;
138 } else if (cbret == 0) {
139 pkcs12_remove_bag(&bags, bag);
140 }
141 }
142 }
143
144 if (bags && !PKCS12_add_safe(&safes, bags, -1, 0, NULL))
145 goto err;
146
147 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
148 bags = NULL;
149
150 p12 = PKCS12_add_safes_ex(safes, 0, ctx, propq);
151
152 if (p12 == NULL)
153 goto err;
154
155 sk_PKCS7_pop_free(safes, PKCS7_free);
156
157 safes = NULL;
158
159 if ((mac_iter != -1) && !PKCS12_set_mac(p12, pass, -1, NULL, 0, mac_iter, NULL))
160 goto err;
161
162 return p12;
163
164 err:
165 PKCS12_free(p12);
166 sk_PKCS7_pop_free(safes, PKCS7_free);
167 sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
168 return NULL;
169 }
170
PKCS12_create_ex(const char * pass,const char * name,EVP_PKEY * pkey,X509 * cert,STACK_OF (X509)* ca,int nid_key,int nid_cert,int iter,int mac_iter,int keytype,OSSL_LIB_CTX * ctx,const char * propq)171 PKCS12 *PKCS12_create_ex(const char *pass, const char *name, EVP_PKEY *pkey, X509 *cert,
172 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
173 int mac_iter, int keytype,
174 OSSL_LIB_CTX *ctx, const char *propq)
175 {
176 return PKCS12_create_ex2(pass, name, pkey, cert, ca, nid_key, nid_cert,
177 iter, mac_iter, keytype, ctx, propq,
178 NULL, NULL);
179 }
180
PKCS12_create(const char * pass,const char * name,EVP_PKEY * pkey,X509 * cert,STACK_OF (X509)* ca,int nid_key,int nid_cert,int iter,int mac_iter,int keytype)181 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey, X509 *cert,
182 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
183 int mac_iter, int keytype)
184 {
185 return PKCS12_create_ex(pass, name, pkey, cert, ca, nid_key, nid_cert,
186 iter, mac_iter, keytype, NULL, NULL);
187 }
188
pkcs12_add_cert_bag(STACK_OF (PKCS12_SAFEBAG)** pbags,X509 * cert,const char * name,int namelen,unsigned char * keyid,int keyidlen)189 static PKCS12_SAFEBAG *pkcs12_add_cert_bag(STACK_OF(PKCS12_SAFEBAG) **pbags,
190 X509 *cert,
191 const char *name,
192 int namelen,
193 unsigned char *keyid,
194 int keyidlen)
195 {
196 PKCS12_SAFEBAG *bag = NULL;
197
198 /* Add user certificate */
199 if ((bag = PKCS12_SAFEBAG_create_cert(cert)) == NULL)
200 goto err;
201
202 if (name != NULL && !PKCS12_add_friendlyname(bag, name, namelen))
203 goto err;
204
205 if (keyid != NULL && !PKCS12_add_localkeyid(bag, keyid, keyidlen))
206 goto err;
207
208 if (!pkcs12_add_bag(pbags, bag))
209 goto err;
210
211 return bag;
212
213 err:
214 PKCS12_SAFEBAG_free(bag);
215 return NULL;
216 }
217
PKCS12_add_cert(STACK_OF (PKCS12_SAFEBAG)** pbags,X509 * cert)218 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert)
219 {
220 char *name = NULL;
221 int namelen = -1;
222 unsigned char *keyid = NULL;
223 int keyidlen = -1;
224
225 /*
226 * Use friendlyName and localKeyID in certificate. (if present)
227 */
228 name = (char *)X509_alias_get0(cert, &namelen);
229 keyid = X509_keyid_get0(cert, &keyidlen);
230
231 return pkcs12_add_cert_bag(pbags, cert, name, namelen, keyid, keyidlen);
232 }
233
PKCS12_add_key_ex(STACK_OF (PKCS12_SAFEBAG)** pbags,EVP_PKEY * key,int key_usage,int iter,int nid_key,const char * pass,OSSL_LIB_CTX * ctx,const char * propq)234 PKCS12_SAFEBAG *PKCS12_add_key_ex(STACK_OF(PKCS12_SAFEBAG) **pbags,
235 EVP_PKEY *key, int key_usage, int iter,
236 int nid_key, const char *pass,
237 OSSL_LIB_CTX *ctx, const char *propq)
238 {
239
240 PKCS12_SAFEBAG *bag = NULL;
241 PKCS8_PRIV_KEY_INFO *p8 = NULL;
242
243 /* Make a PKCS#8 structure */
244 if ((p8 = EVP_PKEY2PKCS8(key)) == NULL)
245 goto err;
246 if (key_usage && !PKCS8_add_keyusage(p8, key_usage)) {
247 PKCS8_PRIV_KEY_INFO_free(p8);
248 goto err;
249 }
250 if (nid_key != -1) {
251 /* This call does not take ownership of p8 */
252 bag = PKCS12_SAFEBAG_create_pkcs8_encrypt_ex(nid_key, pass, -1, NULL, 0,
253 iter, p8, ctx, propq);
254 } else {
255 bag = PKCS12_SAFEBAG_create0_p8inf(p8);
256 if (bag != NULL)
257 p8 = NULL; /* bag takes ownership of p8 */
258 }
259 /* This does not need to be in the error path */
260 if (p8 != NULL)
261 PKCS8_PRIV_KEY_INFO_free(p8);
262
263 if (bag == NULL || !pkcs12_add_bag(pbags, bag))
264 goto err;
265
266 return bag;
267
268 err:
269 PKCS12_SAFEBAG_free(bag);
270 return NULL;
271 }
272
PKCS12_add_key(STACK_OF (PKCS12_SAFEBAG)** pbags,EVP_PKEY * key,int key_usage,int iter,int nid_key,const char * pass)273 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
274 EVP_PKEY *key, int key_usage, int iter,
275 int nid_key, const char *pass)
276 {
277 return PKCS12_add_key_ex(pbags, key, key_usage, iter, nid_key, pass,
278 NULL, NULL);
279 }
280
PKCS12_add_secret(STACK_OF (PKCS12_SAFEBAG)** pbags,int nid_type,const unsigned char * value,int len)281 PKCS12_SAFEBAG *PKCS12_add_secret(STACK_OF(PKCS12_SAFEBAG) **pbags,
282 int nid_type, const unsigned char *value, int len)
283 {
284 PKCS12_SAFEBAG *bag = NULL;
285
286 /* Add secret, storing the value as an octet string */
287 if ((bag = PKCS12_SAFEBAG_create_secret(nid_type, V_ASN1_OCTET_STRING, value, len)) == NULL)
288 goto err;
289
290 if (!pkcs12_add_bag(pbags, bag))
291 goto err;
292
293 return bag;
294 err:
295 PKCS12_SAFEBAG_free(bag);
296 return NULL;
297 }
298
PKCS12_add_safe_ex(STACK_OF (PKCS7)** psafes,STACK_OF (PKCS12_SAFEBAG)* bags,int nid_safe,int iter,const char * pass,OSSL_LIB_CTX * ctx,const char * propq)299 int PKCS12_add_safe_ex(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
300 int nid_safe, int iter, const char *pass,
301 OSSL_LIB_CTX *ctx, const char *propq)
302 {
303 PKCS7 *p7 = NULL;
304 int free_safes = 0;
305
306 if (*psafes == NULL) {
307 *psafes = sk_PKCS7_new_null();
308 if (*psafes == NULL)
309 return 0;
310 free_safes = 1;
311 }
312
313 if (nid_safe == 0)
314 #ifdef OPENSSL_NO_RC2
315 nid_safe = NID_pbe_WithSHA1And3_Key_TripleDES_CBC;
316 #else
317 nid_safe = NID_pbe_WithSHA1And40BitRC2_CBC;
318 #endif
319
320 if (nid_safe == -1)
321 p7 = PKCS12_pack_p7data(bags);
322 else
323 p7 = PKCS12_pack_p7encdata_ex(nid_safe, pass, -1, NULL, 0, iter, bags, ctx, propq);
324 if (p7 == NULL)
325 goto err;
326
327 if (!sk_PKCS7_push(*psafes, p7))
328 goto err;
329
330 return 1;
331
332 err:
333 if (free_safes) {
334 sk_PKCS7_free(*psafes);
335 *psafes = NULL;
336 }
337 PKCS7_free(p7);
338 return 0;
339 }
340
PKCS12_add_safe(STACK_OF (PKCS7)** psafes,STACK_OF (PKCS12_SAFEBAG)* bags,int nid_safe,int iter,const char * pass)341 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
342 int nid_safe, int iter, const char *pass)
343 {
344 return PKCS12_add_safe_ex(psafes, bags, nid_safe, iter, pass, NULL, NULL);
345 }
346
pkcs12_remove_bag(STACK_OF (PKCS12_SAFEBAG)** pbags,PKCS12_SAFEBAG * bag)347 static int pkcs12_remove_bag(STACK_OF(PKCS12_SAFEBAG) **pbags,
348 PKCS12_SAFEBAG *bag)
349 {
350 PKCS12_SAFEBAG *tmp;
351
352 if (pbags == NULL || bag == NULL)
353 return 1;
354
355 if ((tmp = sk_PKCS12_SAFEBAG_delete_ptr(*pbags, bag)) == NULL)
356 return 0;
357
358 PKCS12_SAFEBAG_free(tmp);
359 return 1;
360 }
361
pkcs12_add_bag(STACK_OF (PKCS12_SAFEBAG)** pbags,PKCS12_SAFEBAG * bag)362 static int pkcs12_add_bag(STACK_OF(PKCS12_SAFEBAG) **pbags,
363 PKCS12_SAFEBAG *bag)
364 {
365 int free_bags = 0;
366
367 if (pbags == NULL)
368 return 1;
369 if (*pbags == NULL) {
370 *pbags = sk_PKCS12_SAFEBAG_new_null();
371 if (*pbags == NULL)
372 return 0;
373 free_bags = 1;
374 }
375
376 if (!sk_PKCS12_SAFEBAG_push(*pbags, bag)) {
377 if (free_bags) {
378 sk_PKCS12_SAFEBAG_free(*pbags);
379 *pbags = NULL;
380 }
381 return 0;
382 }
383
384 return 1;
385 }
386
PKCS12_add_safes_ex(STACK_OF (PKCS7)* safes,int nid_p7,OSSL_LIB_CTX * ctx,const char * propq)387 PKCS12 *PKCS12_add_safes_ex(STACK_OF(PKCS7) *safes, int nid_p7,
388 OSSL_LIB_CTX *ctx, const char *propq)
389 {
390 PKCS12 *p12;
391
392 if (nid_p7 <= 0)
393 nid_p7 = NID_pkcs7_data;
394 p12 = PKCS12_init_ex(nid_p7, ctx, propq);
395 if (p12 == NULL)
396 return NULL;
397
398 if (!PKCS12_pack_authsafes(p12, safes)) {
399 PKCS12_free(p12);
400 return NULL;
401 }
402
403 return p12;
404 }
405
PKCS12_add_safes(STACK_OF (PKCS7)* safes,int nid_p7)406 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int nid_p7)
407 {
408 return PKCS12_add_safes_ex(safes, nid_p7, NULL, NULL);
409 }
410