]>
Commit | Line | Data |
---|---|---|
5fbb02fc DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | PKCS12_create - create a PKCS#12 structure | |
6 | ||
7 | =head1 SYNOPSIS | |
8 | ||
9 | #include <openssl/pkcs12.h> | |
10 | ||
82af00fb F |
11 | PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey, |
12 | X509 *cert, STACK_OF(X509) *ca, | |
13 | int nid_key, int nid_cert, int iter, int mac_iter, int keytype); | |
5fbb02fc DSH |
14 | |
15 | =head1 DESCRIPTION | |
16 | ||
17 | PKCS12_create() creates a PKCS#12 structure. | |
18 | ||
19 | B<pass> is the passphrase to use. B<name> is the B<friendlyName> to use for | |
186bb907 | 20 | the supplied certificate and key. B<pkey> is the private key to include in |
5fbb02fc DSH |
21 | the structure and B<cert> its corresponding certificates. B<ca>, if not B<NULL> |
22 | is an optional set of certificates to also include in the structure. | |
23 | ||
24 | B<nid_key> and B<nid_cert> are the encryption algorithms that should be used | |
49c9c1b3 DO |
25 | for the key and certificate respectively. The modes |
26 | GCM, CCM, XTS, and OCB are unsupported. B<iter> is the encryption algorithm | |
5fbb02fc DSH |
27 | iteration count to use and B<mac_iter> is the MAC iteration count to use. |
28 | B<keytype> is the type of key. | |
29 | ||
30 | =head1 NOTES | |
31 | ||
32 | The parameters B<nid_key>, B<nid_cert>, B<iter>, B<mac_iter> and B<keytype> | |
33 | can all be set to zero and sensible defaults will be used. | |
34 | ||
35 | These defaults are: 40 bit RC2 encryption for certificates, triple DES | |
36 | encryption for private keys, a key iteration count of PKCS12_DEFAULT_ITER | |
37 | (currently 2048) and a MAC iteration count of 1. | |
38 | ||
39 | The default MAC iteration count is 1 in order to retain compatibility with | |
40 | old software which did not interpret MAC iteration counts. If such compatibility | |
41 | is not required then B<mac_iter> should be set to PKCS12_DEFAULT_ITER. | |
42 | ||
43 | B<keytype> adds a flag to the store private key. This is a non standard extension | |
44 | that is only currently interpreted by MSIE. If set to zero the flag is omitted, | |
45 | if set to B<KEY_SIG> the key can be used for signing only, if set to B<KEY_EX> | |
46 | it can be used for signing and encryption. This option was useful for old | |
47 | export grade software which could use signing only keys of arbitrary size but | |
48 | had restrictions on the permissible sizes of keys which could be used for | |
49 | encryption. | |
50 | ||
8c4b69d3 DSH |
51 | If a certificate contains an B<alias> or B<keyid> then this will be |
52 | used for the corresponding B<friendlyName> or B<localKeyID> in the | |
53 | PKCS12 structure. | |
54 | ||
5fbb02fc | 55 | Either B<pkey>, B<cert> or both can be B<NULL> to indicate that no key or |
186bb907 | 56 | certificate is required. In previous versions both had to be present or |
5fbb02fc DSH |
57 | a fatal error is returned. |
58 | ||
59 | B<nid_key> or B<nid_cert> can be set to -1 indicating that no encryption | |
1bc74519 | 60 | should be used. |
5fbb02fc DSH |
61 | |
62 | B<mac_iter> can be set to -1 and the MAC will then be omitted entirely. | |
63 | ||
84814344 RL |
64 | PKCS12_create() makes assumptions regarding the encoding of the given pass |
65 | phrase. | |
66 | See L<passphrase-encoding(7)> for more information. | |
67 | ||
1f13ad31 PY |
68 | =head1 RETURN VALUES |
69 | ||
70 | PKCS12_create() returns a valid B<PKCS12> structure or NULL if an error occurred. | |
71 | ||
5fbb02fc DSH |
72 | =head1 SEE ALSO |
73 | ||
84814344 RL |
74 | L<d2i_PKCS12(3)>, |
75 | L<passphrase-encoding(7)> | |
5fbb02fc | 76 | |
e2f92610 RS |
77 | =head1 COPYRIGHT |
78 | ||
61f805c1 | 79 | Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 80 | |
4746f25a | 81 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
82 | this file except in compliance with the License. You can obtain a copy |
83 | in the file LICENSE in the source distribution or at | |
84 | L<https://www.openssl.org/source/license.html>. | |
85 | ||
86 | =cut |