diff options
Diffstat (limited to 'src/lib/libcrypto/doc/PKCS12_parse.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/PKCS12_parse.pod | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/PKCS12_parse.pod b/src/lib/libcrypto/doc/PKCS12_parse.pod new file mode 100644 index 0000000000..51344f883a --- /dev/null +++ b/src/lib/libcrypto/doc/PKCS12_parse.pod | |||
| @@ -0,0 +1,50 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | PKCS12_parse - parse a PKCS#12 structure | ||
| 6 | |||
| 7 | =head1 SYNOPSIS | ||
| 8 | |||
| 9 | #include <openssl/pkcs12.h> | ||
| 10 | |||
| 11 | int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca); | ||
| 12 | |||
| 13 | =head1 DESCRIPTION | ||
| 14 | |||
| 15 | PKCS12_parse() parses a PKCS12 structure. | ||
| 16 | |||
| 17 | B<p12> is the B<PKCS12> structure to parse. B<pass> is the passphrase to use. | ||
| 18 | If successful the private key will be written to B<*pkey>, the corresponding | ||
| 19 | certificate to B<*cert> and any additional certificates to B<*ca>. | ||
| 20 | |||
| 21 | =head1 NOTES | ||
| 22 | |||
| 23 | The parameters B<pkey> and B<cert> cannot be B<NULL>. B<ca> can be <NULL> | ||
| 24 | in which case additional certificates will be discarded. B<*ca> can also | ||
| 25 | be a valid STACK in which case additional certificates are appended to | ||
| 26 | B<*ca>. If B<*ca> is B<NULL> a new STACK will be allocated. | ||
| 27 | |||
| 28 | The B<friendlyName> and B<localKeyID> attributes (if present) on each certificate | ||
| 29 | will be stored in the B<alias> and B<keyid> attributes of the B<X509> structure. | ||
| 30 | |||
| 31 | =head1 BUGS | ||
| 32 | |||
| 33 | Only a single private key and corresponding certificate is returned by this function. | ||
| 34 | More complex PKCS#12 files with multiple private keys will only return the first | ||
| 35 | match. | ||
| 36 | |||
| 37 | Only B<friendlyName> and B<localKeyID> attributes are currently stored in certificates. | ||
| 38 | Other attributes are discarded. | ||
| 39 | |||
| 40 | Attributes currently cannot be store in the private key B<EVP_PKEY> structure. | ||
| 41 | |||
| 42 | =head1 SEE ALSO | ||
| 43 | |||
| 44 | L<d2i_PKCS12(3)|d2i_PKCS12(3)> | ||
| 45 | |||
| 46 | =head1 HISTORY | ||
| 47 | |||
| 48 | PKCS12_parse was added in OpenSSL 0.9.3 | ||
| 49 | |||
| 50 | =cut | ||
