X509_get_pubkey.pod 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. =pod
  2. =head1 NAME
  3. X509_get_pubkey, X509_get0_pubkey, X509_set_pubkey, X509_get_X509_PUBKEY,
  4. X509_REQ_get_pubkey, X509_REQ_get0_pubkey, X509_REQ_set_pubkey,
  5. X509_REQ_get_X509_PUBKEY - get or set certificate or certificate request
  6. public key
  7. =head1 SYNOPSIS
  8. #include <openssl/x509.h>
  9. EVP_PKEY *X509_get_pubkey(X509 *x);
  10. EVP_PKEY *X509_get0_pubkey(const X509 *x);
  11. int X509_set_pubkey(X509 *x, EVP_PKEY *pkey);
  12. X509_PUBKEY *X509_get_X509_PUBKEY(X509 *x);
  13. EVP_PKEY *X509_REQ_get_pubkey(X509_REQ *req);
  14. EVP_PKEY *X509_REQ_get0_pubkey(X509_REQ *req);
  15. int X509_REQ_set_pubkey(X509_REQ *x, EVP_PKEY *pkey);
  16. X509_PUBKEY *X509_REQ_get_X509_PUBKEY(X509_REQ *x);
  17. =head1 DESCRIPTION
  18. X509_get_pubkey() attempts to decode the public key for certificate B<x>. If
  19. successful it returns the public key as an B<EVP_PKEY> pointer with its
  20. reference count incremented: this means the returned key must be freed up
  21. after use. X509_get0_pubkey() is similar except it does B<not> increment
  22. the reference count of the returned B<EVP_PKEY> so it must not be freed up
  23. after use.
  24. X509_get_X509_PUBKEY() returns an internal pointer to the B<X509_PUBKEY>
  25. structure which encodes the certificate of B<x>. The returned value
  26. must not be freed up after use.
  27. X509_set_pubkey() attempts to set the public key for certificate B<x> to
  28. B<pkey>. The key B<pkey> should be freed up after use.
  29. X509_REQ_get_pubkey(), X509_REQ_get0_pubkey(), X509_REQ_set_pubkey() and
  30. X509_REQ_get_X509_PUBKEY() are similar but operate on certificate request B<req>.
  31. =head1 NOTES
  32. The first time a public key is decoded the B<EVP_PKEY> structure is
  33. cached in the certificate or certificate request itself. Subsequent calls
  34. return the cached structure with its reference count incremented to
  35. improve performance.
  36. =head1 RETURN VALUES
  37. X509_get_pubkey(), X509_get0_pubkey(), X509_get_X509_PUBKEY(),
  38. X509_REQ_get_pubkey() and X509_REQ_get_X509_PUBKEY() return a public key or
  39. B<NULL> if an error occurred.
  40. X509_set_pubkey() and X509_REQ_set_pubkey() return 1 for success and 0
  41. for failure.
  42. =head1 SEE ALSO
  43. L<d2i_X509(3)>,
  44. L<ERR_get_error(3)>,
  45. L<X509_CRL_get0_by_serial(3)>,
  46. L<X509_get0_signature(3)>,
  47. L<X509_get_ext_d2i(3)>,
  48. L<X509_get_extension_flags(3)>,
  49. L<X509_get_subject_name(3)>,
  50. L<X509_get_version(3)>,
  51. L<X509_NAME_add_entry_by_txt(3)>,
  52. L<X509_NAME_ENTRY_get_object(3)>,
  53. L<X509_NAME_get_index_by_NID(3)>,
  54. L<X509_NAME_print_ex(3)>,
  55. L<X509_new(3)>,
  56. L<X509_sign(3)>,
  57. L<X509V3_get_d2i(3)>,
  58. L<X509_verify_cert(3)>
  59. =head1 COPYRIGHT
  60. Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  61. Licensed under the Apache License 2.0 (the "License"). You may not use
  62. this file except in compliance with the License. You can obtain a copy
  63. in the file LICENSE in the source distribution or at
  64. L<https://www.openssl.org/source/license.html>.
  65. =cut