doc/man3/EVP_PKEY_set1_RSA.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_set1_RSA, EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH, EVP_PKEY_set1_EC_KEY,
   6 EVP_PKEY_get1_RSA, EVP_PKEY_get1_DSA, EVP_PKEY_get1_DH, EVP_PKEY_get1_EC_KEY,
   7 EVP_PKEY_get0_RSA, EVP_PKEY_get0_DSA, EVP_PKEY_get0_DH, EVP_PKEY_get0_EC_KEY,
   8 EVP_PKEY_assign_RSA, EVP_PKEY_assign_DSA, EVP_PKEY_assign_DH,
   9 EVP_PKEY_assign_EC_KEY, EVP_PKEY_assign_POLY1305, EVP_PKEY_assign_SIPHASH,
  10 EVP_PKEY_get0_hmac, EVP_PKEY_get0_poly1305, EVP_PKEY_get0_siphash,
  11 EVP_PKEY_get0, EVP_PKEY_type, EVP_PKEY_get_id, EVP_PKEY_get_base_id,
  12 EVP_PKEY_set1_engine, EVP_PKEY_get0_engine,
  13 EVP_PKEY_id, EVP_PKEY_base_id -
  14 EVP_PKEY assignment functions
  15
  16 =head1 SYNOPSIS
  17
  18  #include <openssl/evp.h>
  19
  20  int EVP_PKEY_get_id(const EVP_PKEY *pkey);
  21  int EVP_PKEY_get_base_id(const EVP_PKEY *pkey);
  22  int EVP_PKEY_type(int type);
  23
  24  #define EVP_PKEY_id EVP_PKEY_get_id
  25  #define EVP_PKEY_base_id EVP_PKEY_get_base_id
  26
  27 The following functions have been deprecated since OpenSSL 3.0, and can be
  28 hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  29 see L<openssl_user_macros(7)>:
  30
  31  int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key);
  32  int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key);
  33  int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key);
  34  int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
  35
  36  RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey);
  37  DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey);
  38  DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey);
  39  EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey);
  40
  41  const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len);
  42  const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len);
  43  const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len);
  44  const RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey);
  45  const DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey);
  46  const DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey);
  47  const EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey);
  48  void *EVP_PKEY_get0(const EVP_PKEY *pkey);
  49
  50  int EVP_PKEY_assign_RSA(EVP_PKEY *pkey, RSA *key);
  51  int EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key);
  52  int EVP_PKEY_assign_DH(EVP_PKEY *pkey, DH *key);
  53  int EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
  54  int EVP_PKEY_assign_POLY1305(EVP_PKEY *pkey, ASN1_OCTET_STRING *key);
  55  int EVP_PKEY_assign_SIPHASH(EVP_PKEY *pkey, ASN1_OCTET_STRING *key);
  56
  57  ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey);
  58  int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *engine);
  59
  60 =head1 DESCRIPTION
  61
  62 EVP_PKEY_get_base_id() returns the type of I<pkey>. For example
  63 an RSA key will return B<EVP_PKEY_RSA>.
  64
  65 EVP_PKEY_get_id() returns the actual NID associated with I<pkey>
  66 only if the I<pkey> type isn't implemented just in a L<provider(7)>.
  67 Historically keys using the same algorithm could use different NIDs.
  68 For example an RSA key could use the NIDs corresponding to
  69 the NIDs B<NID_rsaEncryption> (equivalent to B<EVP_PKEY_RSA>) or
  70 B<NID_rsa> (equivalent to B<EVP_PKEY_RSA2>). The use of
  71 alternative non-standard NIDs is now rare so B<EVP_PKEY_RSA2> et al are not
  72 often seen in practice.
  73 EVP_PKEY_get_id() returns -1 (B<EVP_PKEY_KEYMGMT>) if the I<pkey> is
  74 only implemented in a L<provider(7)>.
  75
  76 EVP_PKEY_type() returns the underlying type of the NID I<type>. For example
  77 EVP_PKEY_type(EVP_PKEY_RSA2) will return B<EVP_PKEY_RSA>.
  78
  79 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
  80 EVP_PKEY_set1_EC_KEY() set the key referenced by I<pkey> to I<key>. These
  81 functions are deprecated. Applications should instead use
  82 L<EVP_PKEY_fromdata(3)>.
  83
  84 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
  85 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305() and
  86 EVP_PKEY_assign_SIPHASH() set the referenced key to I<key> however these use
  87 the supplied I<key> internally and so I<key> will be freed when the parent
  88 I<pkey> is freed. These macros are deprecated. Applications should instead read
  89 an EVP_PKEY directly using the OSSL_DECODER APIs (see
  90 L<OSSL_DECODER_CTX_new_for_pkey(3)>), or construct an EVP_PKEY from data using
  91 L<EVP_PKEY_fromdata(3)>.
  92
  93 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
  94 EVP_PKEY_get1_EC_KEY() return the referenced key in I<pkey> or NULL if the
  95 key is not of the correct type. The returned key must be freed after use.
  96 These functions are deprecated. Applications should instead use the EVP_PKEY
  97 directly where possible. If access to the low level key parameters is required
  98 then applications should use L<EVP_PKEY_get_params(3)> and other similar
  99 functions. To write an EVP_PKEY out use the OSSL_ENCODER APIs (see
 100 L<OSSL_ENCODER_CTX_new_for_pkey(3)>).
 101
 102 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_poly1305(), EVP_PKEY_get0_siphash(),
 103 EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(), EVP_PKEY_get0_DH() and
 104 EVP_PKEY_get0_EC_KEY() return the referenced key in I<pkey> or NULL if the
 105 key is not of the correct type. The reference count of the returned key is
 106 B<not> incremented and so the key must not be freed after use. These functions
 107 are deprecated. Applications should instead use the EVP_PKEY directly where
 108 possible. If access to the low level key parameters is required then
 109 applications should use L<EVP_PKEY_get_params(3)> and other similar functions.
 110 To write an EVP_PKEY out use the OSSL_ENCODER APIs (see
 111 L<OSSL_ENCODER_CTX_new_for_pkey(3)>). EVP_PKEY_get0() returns a pointer to the
 112 legacy key or NULL if the key is not legacy.
 113
 114 Note that if an EVP_PKEY was not constructed using one of the deprecated
 115 functions such as EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH()
 116 or EVP_PKEY_set1_EC_KEY(), or via the similarly named B<EVP_PKEY_assign> macros
 117 described above then the internal key will be managed by a provider (see
 118 L<provider(7)>). In that case the key returned by EVP_PKEY_get1_RSA(),
 119 EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH(), EVP_PKEY_get1_EC_KEY(),
 120 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_poly1305(), EVP_PKEY_get0_siphash(),
 121 EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(), EVP_PKEY_get0_DH() or
 122 EVP_PKEY_get0_EC_KEY() will be a cached copy of the provider's key. Subsequent
 123 updates to the provider's key will not be reflected back in the cached copy, and
 124 updates made by an application to the returned key will not be reflected back in
 125 the provider's key. Subsequent calls to EVP_PKEY_get1_RSA(),
 126 EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and EVP_PKEY_get1_EC_KEY() will always
 127 return the cached copy returned by the first call.
 128
 129 EVP_PKEY_get0_engine() returns a reference to the ENGINE handling I<pkey>. This
 130 function is deprecated. Applications should use providers instead of engines
 131 (see L<provider(7)> for details).
 132
 133 EVP_PKEY_set1_engine() sets the ENGINE handling I<pkey> to I<engine>. It
 134 must be called after the key algorithm and components are set up.
 135 If I<engine> does not include an B<EVP_PKEY_METHOD> for I<pkey> an
 136 error occurs. This function is deprecated. Applications should use providers
 137 instead of engines (see L<provider(7)> for details).
 138
 139 =head1 WARNINGS
 140
 141 The following functions are only reliable with B<EVP_PKEY>s that have
 142 been assigned an internal key with EVP_PKEY_assign_*():
 143
 144 EVP_PKEY_get_id(), EVP_PKEY_get_base_id(), EVP_PKEY_type()
 145
 146 For EVP_PKEY key type checking purposes, L<EVP_PKEY_is_a(3)> is more generic.
 147
 148 For purposes of retrieving the name of the B<EVP_PKEY> the function
 149 L<EVP_PKEY_get0_type_name(3)> is more generally useful.
 150
 151 The keys returned from the functions EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(),
 152 EVP_PKEY_get0_DH() and EVP_PKEY_get0_EC_KEY() were changed to have a "const"
 153 return type in OpenSSL 3.0. As described above the keys returned may be cached
 154 copies of the key held in a provider. Due to this, and unlike in earlier
 155 versions of OpenSSL, they should be considered read-only copies of the key.
 156 Updates to these keys will not be reflected back in the provider side key. The
 157 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
 158 EVP_PKEY_get1_EC_KEY() functions were not changed to have a "const" return type
 159 in order that applications can "free" the return value. However applications
 160 should still consider them as read-only copies.
 161
 162 =head1 NOTES
 163
 164 In accordance with the OpenSSL naming convention the key obtained
 165 from or assigned to the I<pkey> using the B<1> functions must be
 166 freed as well as I<pkey>.
 167
 168 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
 169 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305()
 170 and EVP_PKEY_assign_SIPHASH() are implemented as macros.
 171
 172 EVP_PKEY_assign_EC_KEY() looks at the curve name id to determine if
 173 the passed B<EC_KEY> is an L<SM2(7)> key, and will set the B<EVP_PKEY>
 174 type to B<EVP_PKEY_SM2> in that case, instead of B<EVP_PKEY_EC>.
 175
 176 Most applications wishing to know a key type will simply call
 177 EVP_PKEY_get_base_id() and will not care about the actual type:
 178 which will be identical in almost all cases.
 179
 180 Previous versions of this document suggested using EVP_PKEY_type(pkey->type)
 181 to determine the type of a key. Since B<EVP_PKEY> is now opaque this
 182 is no longer possible: the equivalent is EVP_PKEY_get_base_id(pkey).
 183
 184 EVP_PKEY_set1_engine() is typically used by an ENGINE returning an HSM
 185 key as part of its routine to load a private key.
 186
 187 =head1 RETURN VALUES
 188
 189 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
 190 EVP_PKEY_set1_EC_KEY() return 1 for success or 0 for failure.
 191
 192 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
 193 EVP_PKEY_get1_EC_KEY() return the referenced key or NULL if
 194 an error occurred.
 195
 196 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
 197 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305()
 198 and EVP_PKEY_assign_SIPHASH() return 1 for success and 0 for failure.
 199
 200 EVP_PKEY_get_base_id(), EVP_PKEY_get_id() and EVP_PKEY_type() return a key
 201 type or B<NID_undef> (equivalently B<EVP_PKEY_NONE>) on error.
 202
 203 EVP_PKEY_set1_engine() returns 1 for success and 0 for failure.
 204
 205 =head1 SEE ALSO
 206
 207 L<EVP_PKEY_new(3)>, L<SM2(7)>
 208
 209 =head1 HISTORY
 210
 211 The EVP_PKEY_id() and EVP_PKEY_base_id() functions were renamed to
 212 include C<get> in their names in OpenSSL 3.0, respectively. The old names
 213 are kept as non-deprecated alias macros.
 214
 215 EVP_PKEY_set1_RSA, EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH, EVP_PKEY_set1_EC_KEY,
 216 EVP_PKEY_get1_RSA, EVP_PKEY_get1_DSA, EVP_PKEY_get1_DH, EVP_PKEY_get1_EC_KEY,
 217 EVP_PKEY_get0_RSA, EVP_PKEY_get0_DSA, EVP_PKEY_get0_DH, EVP_PKEY_get0_EC_KEY,
 218 EVP_PKEY_assign_RSA, EVP_PKEY_assign_DSA, EVP_PKEY_assign_DH,
 219 EVP_PKEY_assign_EC_KEY, EVP_PKEY_assign_POLY1305, EVP_PKEY_assign_SIPHASH,
 220 EVP_PKEY_get0_hmac, EVP_PKEY_get0_poly1305, EVP_PKEY_get0_siphash,
 221 EVP_PKEY_set1_engine and EVP_PKEY_get0_engine were deprecated in OpenSSL 3.0.
 222
 223 The return value from EVP_PKEY_get0_RSA, EVP_PKEY_get0_DSA, EVP_PKEY_get0_DH,
 224 EVP_PKEY_get0_EC_KEY were made const in OpenSSL 3.0.
 225
 226 The function EVP_PKEY_set_alias_type() was previously documented on this page.
 227 It was removed in OpenSSL 3.0.
 228
 229 =head1 COPYRIGHT
 230
 231 Copyright 2002-2023 The OpenSSL Project Authors. All Rights Reserved.
 232
 233 Licensed under the Apache License 2.0 (the "License").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file LICENSE in the source distribution or at
 236 L<https://www.openssl.org/source/license.html>.
 237
 238 =cut