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