Constify PKCS12_create, PKCS12_add_key, PKCS12_add_safe.
[openssl.git] / doc / crypto / PKCS12_create.pod
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
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);
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
20 the supplied certificate and key. B<pkey> is the private key to include in
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
25 for the key and certificate respectively. B<iter> is the encryption algorithm
26 iteration count to use and B<mac_iter> is the MAC iteration count to use.
27 B<keytype> is the type of key.
28
29 =head1 NOTES
30
31 The parameters B<nid_key>, B<nid_cert>, B<iter>, B<mac_iter> and B<keytype>
32 can all be set to zero and sensible defaults will be used.
33
34 These defaults are: 40 bit RC2 encryption for certificates, triple DES
35 encryption for private keys, a key iteration count of PKCS12_DEFAULT_ITER
36 (currently 2048) and a MAC iteration count of 1.
37
38 The default MAC iteration count is 1 in order to retain compatibility with
39 old software which did not interpret MAC iteration counts. If such compatibility
40 is not required then B<mac_iter> should be set to PKCS12_DEFAULT_ITER.
41
42 B<keytype> adds a flag to the store private key. This is a non standard extension
43 that is only currently interpreted by MSIE. If set to zero the flag is omitted,
44 if set to B<KEY_SIG> the key can be used for signing only, if set to B<KEY_EX>
45 it can be used for signing and encryption. This option was useful for old
46 export grade software which could use signing only keys of arbitrary size but
47 had restrictions on the permissible sizes of keys which could be used for
48 encryption.
49
50 If a certificate contains an B<alias> or B<keyid> then this will be
51 used for the corresponding B<friendlyName> or B<localKeyID> in the
52 PKCS12 structure.
53
54 Either B<pkey>, B<cert> or both can be B<NULL> to indicate that no key or
55 certificate is required. In previous versions both had to be present or
56 a fatal error is returned.
57
58 B<nid_key> or B<nid_cert> can be set to -1 indicating that no encryption
59 should be used.
60
61 B<mac_iter> can be set to -1 and the MAC will then be omitted entirely.
62
63 =head1 SEE ALSO
64
65 L<d2i_PKCS12(3)>
66
67 =head1 COPYRIGHT
68
69 Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
70
71 Licensed under the OpenSSL license (the "License").  You may not use
72 this file except in compliance with the License.  You can obtain a copy
73 in the file LICENSE in the source distribution or at
74 L<https://www.openssl.org/source/license.html>.
75
76 =cut