X509_PUBKEY_new.pod 7.2 KB

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