doc/man3/X509_PUBKEY_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_PUBKEY_new, X509_PUBKEY_free, X509_PUBKEY_dup,
   6 X509_PUBKEY_set, X509_PUBKEY_get0, X509_PUBKEY_get,
   7 d2i_PUBKEY_ex, d2i_PUBKEY, i2d_PUBKEY, d2i_PUBKEY_bio, d2i_PUBKEY_fp,
   8 i2d_PUBKEY_fp, i2d_PUBKEY_bio, X509_PUBKEY_set0_param, X509_PUBKEY_get0_param,
   9 X509_PUBKEY_eq - SubjectPublicKeyInfo public key functions
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/x509.h>
  14
  15  X509_PUBKEY *X509_PUBKEY_new(void);
  16  void X509_PUBKEY_free(X509_PUBKEY *a);
  17  X509_PUBKEY *X509_PUBKEY_dup(const X509_PUBKEY *a);
  18
  19  int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey);
  20  EVP_PKEY *X509_PUBKEY_get0(const X509_PUBKEY *key);
  21  EVP_PKEY *X509_PUBKEY_get(const X509_PUBKEY *key);
  22
  23  EVP_PKEY *d2i_PUBKEY_ex(EVP_PKEY **a, const unsigned char **pp, long length,
  24                          OSSL_LIB_CTX *libctx, const char *propq);
  25  EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length);
  26  int i2d_PUBKEY(const EVP_PKEY *a, unsigned char **pp);
  27
  28  EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a);
  29  EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a);
  30
  31  int i2d_PUBKEY_fp(const FILE *fp, EVP_PKEY *pkey);
  32  int i2d_PUBKEY_bio(BIO *bp, const EVP_PKEY *pkey);
  33
  34  int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
  35                             int ptype, void *pval,
  36                             unsigned char *penc, int penclen);
  37  int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
  38                             const unsigned char **pk, int *ppklen,
  39                             X509_ALGOR **pa, const X509_PUBKEY *pub);
  40  int X509_PUBKEY_eq(X509_PUBKEY *a, X509_PUBKEY *b);
  41
  42 =head1 DESCRIPTION
  43
  44 The B<X509_PUBKEY> structure represents the ASN.1 B<SubjectPublicKeyInfo>
  45 structure defined in RFC5280 and used in certificates and certificate requests.
  46
  47 X509_PUBKEY_new() allocates and initializes an B<X509_PUBKEY> structure.
  48
  49 X509_PUBKEY_dup() creates a duplicate copy of the B<X509_PUBKEY> object
  50 specified by I<a>.
  51
  52 X509_PUBKEY_free() frees up B<X509_PUBKEY> structure I<a>. If I<a> is NULL
  53 nothing is done.
  54
  55 X509_PUBKEY_set() sets the public key in I<*x> to the public key contained
  56 in the B<EVP_PKEY> structure I<pkey>. If I<*x> is not NULL any existing
  57 public key structure will be freed.
  58
  59 X509_PUBKEY_get0() returns the public key contained in I<key>. The returned
  60 value is an internal pointer which B<MUST NOT> be freed after use.
  61
  62 X509_PUBKEY_get() is similar to X509_PUBKEY_get0() except the reference
  63 count on the returned key is incremented so it B<MUST> be freed using
  64 EVP_PKEY_free() after use.
  65
  66 d2i_PUBKEY_ex() decodes an B<EVP_PKEY> structure using B<SubjectPublicKeyInfo>
  67 format.  Some public key decoding implementations may use cryptographic
  68 algorithms. In this case the supplied library context I<libctx> and property
  69 query string I<propq> are used.
  70 d2i_PUBKEY() does the same as d2i_PUBKEY_ex() except that the default
  71 library context and property query string are used.
  72
  73 i2d_PUBKEY() encodes an B<EVP_PKEY> structure using B<SubjectPublicKeyInfo>
  74 format.
  75
  76 d2i_PUBKEY_bio(), d2i_PUBKEY_fp(), i2d_PUBKEY_bio() and i2d_PUBKEY_fp() are
  77 similar to d2i_PUBKEY() and i2d_PUBKEY() except they decode or encode using a
  78 B<BIO> or B<FILE> pointer.
  79
  80 X509_PUBKEY_set0_param() sets the public key parameters of I<pub>. The
  81 OID associated with the algorithm is set to I<aobj>. The type of the
  82 algorithm parameters is set to I<type> using the structure I<pval>.
  83 The encoding of the public key itself is set to the I<penclen>
  84 bytes contained in buffer I<penc>. On success ownership of all the supplied
  85 parameters is passed to I<pub> so they must not be freed after the
  86 call.
  87
  88 X509_PUBKEY_get0_param() retrieves the public key parameters from I<pub>,
  89 I<*ppkalg> is set to the associated OID and the encoding consists of
  90 I<*ppklen> bytes at I<*pk>, I<*pa> is set to the associated
  91 AlgorithmIdentifier for the public key. If the value of any of these
  92 parameters is not required it can be set to NULL. All of the
  93 retrieved pointers are internal and must not be freed after the
  94 call.
  95
  96 X509_PUBKEY_eq() compares two B<X509_PUBKEY> values.
  97
  98 =head1 NOTES
  99
 100 The B<X509_PUBKEY> functions can be used to encode and decode public keys
 101 in a standard format.
 102
 103 In many cases applications will not call the B<X509_PUBKEY> functions
 104 directly: they will instead call wrapper functions such as X509_get0_pubkey().
 105
 106 =head1 RETURN VALUES
 107
 108 If the allocation fails, X509_PUBKEY_new() and X509_PUBKEY_dup() return
 109 NULL and set an error code that can be obtained by L<ERR_get_error(3)>.
 110 Otherwise they return a pointer to the newly allocated structure.
 111
 112 X509_PUBKEY_free() does not return a value.
 113
 114 X509_PUBKEY_get0() and X509_PUBKEY_get() return a pointer to an B<EVP_PKEY>
 115 structure or NULL if an error occurs.
 116
 117 X509_PUBKEY_set(), X509_PUBKEY_set0_param() and X509_PUBKEY_get0_param()
 118 return 1 for success and 0 if an error occurred.
 119
 120 X509_PUBKEY_eq() returns 1 for equal, 0 for different, and < 0 on error.
 121
 122 =head1 SEE ALSO
 123
 124 L<d2i_X509(3)>,
 125 L<ERR_get_error(3)>,
 126 L<X509_get_pubkey(3)>,
 127
 128 =head1 HISTORY
 129
 130 The X509_PUBKEY_eq() function was added in OpenSSL 3.0.
 131
 132 =head1 COPYRIGHT
 133
 134 Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
 135
 136 Licensed under the Apache License 2.0 (the "License").  You may not use
 137 this file except in compliance with the License.  You can obtain a copy
 138 in the file LICENSE in the source distribution or at
 139 L<https://www.openssl.org/source/license.html>.
 140
 141 =cut