PKCS12_parse.pod 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. =pod
  2. =head1 NAME
  3. PKCS12_parse - parse a PKCS#12 structure
  4. =head1 SYNOPSIS
  5. #include <openssl/pkcs12.h>
  6. int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, STACK_OF(X509) **ca);
  7. =head1 DESCRIPTION
  8. PKCS12_parse() parses a PKCS12 structure.
  9. B<p12> is the B<PKCS12> structure to parse. B<pass> is the passphrase to use.
  10. If successful the private key will be written to B<*pkey>, the corresponding
  11. certificate to B<*cert> and any additional certificates to B<*ca>.
  12. =head1 NOTES
  13. The parameters B<pkey> and B<cert> cannot be B<NULL>. B<ca> can be <NULL> in
  14. which case additional certificates will be discarded. B<*ca> can also be a
  15. valid STACK in which case additional certificates are appended to B<*ca>. If
  16. B<*ca> is B<NULL> a new STACK will be allocated.
  17. The B<friendlyName> and B<localKeyID> attributes (if present) on each
  18. certificate will be stored in the B<alias> and B<keyid> attributes of the
  19. B<X509> structure.
  20. The parameter B<pass> is interpreted as a string in the UTF-8 encoding. If it
  21. is not valid UTF-8, then it is assumed to be ISO8859-1 instead.
  22. In particular, this means that passwords in the locale character set
  23. (or code page on Windows) must potentially be converted to UTF-8 before
  24. use. This may include passwords from local text files, or input from
  25. the terminal or command line. Refer to the documentation of
  26. L<UI_OpenSSL(3)>, for example.
  27. =head1 RETURN VALUES
  28. PKCS12_parse() returns 1 for success and zero if an error occurred.
  29. The error can be obtained from L<ERR_get_error(3)>
  30. =head1 BUGS
  31. Only a single private key and corresponding certificate is returned by this
  32. function. More complex PKCS#12 files with multiple private keys will only
  33. return the first match.
  34. Only B<friendlyName> and B<localKeyID> attributes are currently stored in
  35. certificates. Other attributes are discarded.
  36. Attributes currently cannot be stored in the private key B<EVP_PKEY> structure.
  37. =head1 SEE ALSO
  38. L<d2i_PKCS12(3)>
  39. =head1 COPYRIGHT
  40. Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
  41. Licensed under the OpenSSL license (the "License"). You may not use
  42. this file except in compliance with the License. You can obtain a copy
  43. in the file LICENSE in the source distribution or at
  44. L<https://www.openssl.org/source/license.html>.
  45. =cut