doc/crypto/X509_get_pubkey.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_get_pubkey, X509_get0_pubkey, X509_set_pubkey, X509_get_X509_PUBKEY,
   6 X509_REQ_get_pubkey, X509_REQ_set_pubkey, X509_REQ_get_X509_PUBKEY - get or
   7 set certificate or certificate request public key.
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/x509.h>
  12
  13  EVP_PKEY *X509_get_pubkey(X509 *x);
  14  EVP_PKEY *X509_get0_pubkey(X509 *x);
  15  int X509_set_pubkey(X509 *x, EVP_PKEY *pkey);
  16  X509_PUBKEY *X509_get_X509_PUBKEY(X509 *x);
  17
  18  EVP_PKEY *X509_REQ_get_pubkey(X509_REQ *req);
  19  int X509_REQ_set_pubkey(X509_REQ *x, EVP_PKEY *pkey);
  20  X509_PUBKEY *X509_REQ_get_X509_PUBKEY(X509_REQ *x);
  21
  22 =head1 DESCRIPTION
  23
  24 X509_get_pubkey() attempts to decode the public key for certificate B<x>. If
  25 successful it returns the public key as an B<EVP_PKEY> pointer with its
  26 reference count incremented: this means the returned key must be freed up
  27 after use. X509_get0_pubkey() is similar except it does B<not> increment
  28 the reference count of the returned B<EVP_PKEY> so it must not be freed up
  29 after use.
  30
  31 X509_get_X509_PUBKEY() returns an internal pointer to the B<X509_PUBKEY>
  32 structure which encodes the certificate of B<x>. The returned value
  33 must not be freed up after use.
  34
  35 X509_set_pubkey() attempts to set the public key for certificate B<x> to
  36 B<pkey>. The key B<pkey> should be freed up after use.
  37
  38 X509_REQ_get_pubkey(), X509_REQ_set_pubkey() and X509_REQ_get_X509_PUBKEY()
  39 are similar but operate on certificate request B<req>.
  40
  41 =head1 NOTES
  42
  43 The first time a public key is decoded the B<EVP_PKEY> structure is
  44 cached in the certificate or certificate request itself. Subsequent calls
  45 return the cached structure with its reference count incremented to
  46 improve performance.
  47
  48 =head1 RETURN VALUES
  49
  50 X509_get_pubkey(), X509_get0_pubkey(), X509_get_X509_PUBKEY(),
  51 X509_REQ_get_pubkey() and X509_REQ_get_X509_PUBKEY() return a public key or
  52 B<NULL> if an error occurred.
  53
  54 X509_set_pubkey() and X509_REQ_set_pubkey() rerturn 1 for success and 0
  55 for failure.
  56
  57 =head1 SEE ALSO
  58
  59 L<d2i_X509(3)>,
  60 L<ERR_get_error(3)>,
  61 L<X509_CRL_get0_by_serial(3)>,
  62 L<X509_get0_signature(3)>,
  63 L<X509_get_ext_d2i(3)>,
  64 L<X509_get_extension_flags(3)>,
  65 L<X509_get_subject_name(3)>,
  66 L<X509_get_version(3)>,
  67 L<X509_NAME_add_entry_by_txt(3)>,
  68 L<X509_NAME_ENTRY_get_object(3)>,
  69 L<X509_NAME_get_index_by_NID(3)>,
  70 L<X509_NAME_print_ex(3)>,
  71 L<X509_new(3)>,
  72 L<X509_sign(3)>,
  73 L<X509V3_get_d2i(3)>,
  74 L<X509_verify_cert(3)>
  75
  76 =head1 HISTORY
  77
  78 =cut