76edc4800bb718c1241d0ffa6ec2858adbf3ca26
[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(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, STACK_OF(X509) *ca,
12                                 int nid_key, int nid_cert, int iter, int mac_iter, int keytype);
13
14 =head1 DESCRIPTION
15
16 PKCS12_create() creates a PKCS#12 structure.
17
18 B<pass> is the passphrase to use. B<name> is the B<friendlyName> to use for
19 the supplied certificate and key. B<pkey> is the private key to include in
20 the structure and B<cert> its corresponding certificates. B<ca>, if not B<NULL>
21 is an optional set of certificates to also include in the structure.
22
23 B<nid_key> and B<nid_cert> are the encryption algorithms that should be used
24 for the key and certificate respectively. B<iter> is the encryption algorithm
25 iteration count to use and B<mac_iter> is the MAC iteration count to use.
26 B<keytype> is the type of key.
27
28 =head1 NOTES
29
30 The parameters B<nid_key>, B<nid_cert>, B<iter>, B<mac_iter> and B<keytype>
31 can all be set to zero and sensible defaults will be used.
32
33 These defaults are: 40 bit RC2 encryption for certificates, triple DES
34 encryption for private keys, a key iteration count of PKCS12_DEFAULT_ITER
35 (currently 2048) and a MAC iteration count of 1.
36
37 The default MAC iteration count is 1 in order to retain compatibility with
38 old software which did not interpret MAC iteration counts. If such compatibility
39 is not required then B<mac_iter> should be set to PKCS12_DEFAULT_ITER.
40
41 B<keytype> adds a flag to the store private key. This is a non standard extension
42 that is only currently interpreted by MSIE. If set to zero the flag is omitted,
43 if set to B<KEY_SIG> the key can be used for signing only, if set to B<KEY_EX>
44 it can be used for signing and encryption. This option was useful for old
45 export grade software which could use signing only keys of arbitrary size but
46 had restrictions on the permissible sizes of keys which could be used for
47 encryption.
48
49 =head1 NEW FUNCTIONALITY IN OPENSSL 0.9.8
50
51 Some additional functionality was added to PKCS12_create() in OpenSSL
52 0.9.8. These extensions are detailed below.
53
54 If a certificate contains an B<alias> or B<keyid> then this will be
55 used for the corresponding B<friendlyName> or B<localKeyID> in the
56 PKCS12 structure.
57
58 Either B<pkey>, B<cert> or both can be B<NULL> to indicate that no key or
59 certificate is required. In previous versions both had to be present or
60 a fatal error is returned.
61
62 B<nid_key> or B<nid_cert> can be set to -1 indicating that no encryption
63 should be used. 
64
65 B<mac_iter> can be set to -1 and the MAC will then be omitted entirely.
66
67 =head1 SEE ALSO
68
69 L<d2i_PKCS12(3)>
70
71 =head1 HISTORY
72
73 PKCS12_create was added in OpenSSL 0.9.3
74
75 =cut