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