diff options
author | Dr. Stephen Henson <steve@openssl.org> | 2002-10-09 12:06:58 +0000 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2002-10-09 12:06:58 +0000 |
commit | 5fbb02fcb1ef8fc708ea12b41f70d1b6ce5732d8 (patch) | |
tree | e365676b5c5ee3e17f877375277d9d056c2f500b /doc | |
parent | 4e1b50e219c175d3a6a70cc6bf3bf65fb91af269 (diff) |
PKCS12_create manual page
Diffstat (limited to 'doc')
-rw-r--r-- | doc/crypto/PKCS12_create.pod | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/crypto/PKCS12_create.pod b/doc/crypto/PKCS12_create.pod new file mode 100644 index 0000000000..495a2b8c40 --- /dev/null +++ b/doc/crypto/PKCS12_create.pod @@ -0,0 +1,71 @@ +=pod + +=head1 NAME + +PKCS12_create - create a PKCS#12 structure + +=head1 SYNOPSIS + + #include <openssl/pkcs12.h> + + PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, STACK_OF(X509) *ca, + int nid_key, int nid_cert, int iter, int mac_iter, int keytype); + +=head1 DESCRIPTION + +PKCS12_create() creates a PKCS#12 structure. + +B<pass> is the passphrase to use. B<name> is the B<friendlyName> to use for +the supplied certifictate and key. B<pkey> is the private key to include in +the structure and B<cert> its corresponding certificates. B<ca>, if not B<NULL> +is an optional set of certificates to also include in the structure. + +B<nid_key> and B<nid_cert> are the encryption algorithms that should be used +for the key and certificate respectively. B<iter> is the encryption algorithm +iteration count to use and B<mac_iter> is the MAC iteration count to use. +B<keytype> is the type of key. + +=head1 NOTES + +The parameters B<nid_key>, B<nid_cert>, B<iter>, B<mac_iter> and B<keytype> +can all be set to zero and sensible defaults will be used. + +These defaults are: 40 bit RC2 encryption for certificates, triple DES +encryption for private keys, a key iteration count of PKCS12_DEFAULT_ITER +(currently 2048) and a MAC iteration count of 1. + +The default MAC iteration count is 1 in order to retain compatibility with +old software which did not interpret MAC iteration counts. If such compatibility +is not required then B<mac_iter> should be set to PKCS12_DEFAULT_ITER. + +B<keytype> adds a flag to the store private key. This is a non standard extension +that is only currently interpreted by MSIE. If set to zero the flag is omitted, +if set to B<KEY_SIG> the key can be used for signing only, if set to B<KEY_EX> +it can be used for signing and encryption. This option was useful for old +export grade software which could use signing only keys of arbitrary size but +had restrictions on the permissible sizes of keys which could be used for +encryption. + +=head1 NEW FUNCTIONALITY IN OPENSSL 0.9.8 + +Some additional functionality was added to PKCS12_create() in OpenSSL +0.9.8. These extensions are detailed below. + +Either B<pkey>, B<cert> or both can be B<NULL> to indicate that no key or +certficate is required. In previous versions both hasves to be present or +a fatal error is returned. + +B<nid_key> or B<nid_cert> can be set to -1 indicating that no encryption +should be used. + +B<mac_iter> can be set to -1 and the MAC will then be omitted entirely. + +=head1 SEE ALSO + +L<d2i_PKCS12(3)|d2i_PKCS12(3)> + +=head1 HISTORY + +PKCS12_create was added in OpenSSL 0.9.3 + +=cut |