diff options
Diffstat (limited to 'src/lib/libcrypto/doc/PKCS12_create.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/PKCS12_create.pod | 73 |
1 files changed, 0 insertions, 73 deletions
diff --git a/src/lib/libcrypto/doc/PKCS12_create.pod b/src/lib/libcrypto/doc/PKCS12_create.pod deleted file mode 100644 index 3b27c11a10..0000000000 --- a/src/lib/libcrypto/doc/PKCS12_create.pod +++ /dev/null | |||
| @@ -1,73 +0,0 @@ | |||
| 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, | ||
| 12 | X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert, | ||
| 13 | 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> is an optional | ||
| 22 | set of certificates to also include in the structure. | ||
| 23 | Either B<pkey>, B<cert> or both can be B<NULL> to indicate that no key or | ||
| 24 | certificate is required. | ||
| 25 | |||
| 26 | B<nid_key> and B<nid_cert> are the encryption algorithms that should be used | ||
| 27 | for the key and certificate respectively. If either B<nid_key> or B<nid_cert> | ||
| 28 | is set to -1, no encryption will be used. | ||
| 29 | |||
| 30 | B<iter> is the encryption algorithm iteration count to use and B<mac_iter> is | ||
| 31 | the MAC iteration count to use. If B<mac_iter> is set to -1, the MAC will be | ||
| 32 | omitted entirely. | ||
| 33 | |||
| 34 | B<keytype> is the type of key. | ||
| 35 | |||
| 36 | =head1 NOTES | ||
| 37 | |||
| 38 | The parameters B<nid_key>, B<nid_cert>, B<iter>, B<mac_iter> and B<keytype> | ||
| 39 | can all be set to zero and sensible defaults will be used. | ||
| 40 | |||
| 41 | These defaults are: 40 bit RC2 encryption for certificates, triple DES | ||
| 42 | encryption for private keys, a key iteration count of PKCS12_DEFAULT_ITER | ||
| 43 | (currently 2048) and a MAC iteration count of 1. | ||
| 44 | |||
| 45 | The default MAC iteration count is 1 in order to retain compatibility with | ||
| 46 | old software which did not interpret MAC iteration counts. If such compatibility | ||
| 47 | is not required then B<mac_iter> should be set to PKCS12_DEFAULT_ITER. | ||
| 48 | |||
| 49 | B<keytype> adds a flag to the store private key. This is a non standard | ||
| 50 | extension that is only currently interpreted by MSIE. If set to zero the flag | ||
| 51 | is omitted, if set to B<KEY_SIG> the key can be used for signing only, if set | ||
| 52 | to B<KEY_EX> it can be used for signing and encryption. This option was useful | ||
| 53 | for old export grade software which could use signing only keys of arbitrary | ||
| 54 | size but had restrictions on the permissible sizes of keys which could be used | ||
| 55 | for encryption. | ||
| 56 | |||
| 57 | If a certificate contains an B<alias> or B<keyid> then this will be | ||
| 58 | used for the corresponding B<friendlyName> or B<localKeyID> in the | ||
| 59 | PKCS12 structure. | ||
| 60 | |||
| 61 | =head1 SEE ALSO | ||
| 62 | |||
| 63 | L<d2i_PKCS12(3)|d2i_PKCS12(3)> | ||
| 64 | |||
| 65 | =head1 HISTORY | ||
| 66 | |||
| 67 | PKCS12_create was added in OpenSSL 0.9.3. | ||
| 68 | |||
| 69 | Before OpenSSL 0.9.8, neither B<pkey> nor B<cert> were allowed to be B<NULL>, | ||
| 70 | and a value of B<-1> was not allowed for B<nid_key>, B<nid_cert> and | ||
| 71 | B<mac_iter>. | ||
| 72 | |||
| 73 | =cut | ||
