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_type, EVP_PKEY_id, EVP_PKEY_base_id, EVP_PKEY_set_alias_type,
  12 EVP_PKEY_set1_engine, EVP_PKEY_get0_engine - EVP_PKEY assignment functions
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/evp.h>
  17
  18  int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key);
  19  int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key);
  20  int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key);
  21  int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
  22
  23  RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey);
  24  DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey);
  25  DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey);
  26  EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey);
  27
  28  const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len);
  29  const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len);
  30  const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len);
  31  RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey);
  32  DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey);
  33  DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey);
  34  EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey);
  35
  36  int EVP_PKEY_assign_RSA(EVP_PKEY *pkey, RSA *key);
  37  int EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key);
  38  int EVP_PKEY_assign_DH(EVP_PKEY *pkey, DH *key);
  39  int EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
  40  int EVP_PKEY_assign_POLY1305(EVP_PKEY *pkey, ASN1_OCTET_STRING *key);
  41  int EVP_PKEY_assign_SIPHASH(EVP_PKEY *pkey, ASN1_OCTET_STRING *key);
  42
  43  int EVP_PKEY_id(const EVP_PKEY *pkey);
  44  int EVP_PKEY_base_id(const EVP_PKEY *pkey);
  45  int EVP_PKEY_type(int type);
  46
  47  ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey);
  48  int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *engine);
  49
  50 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  51 B<OPENSSL_API_COMPAT> with a suitable version value, see
  52 L<openssl_user_macros(7)>:
  53
  54  int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type);
  55
  56 =head1 DESCRIPTION
  57
  58 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
  59 EVP_PKEY_set1_EC_KEY() set the key referenced by I<pkey> to I<key>.
  60
  61 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
  62 EVP_PKEY_get1_EC_KEY() return the referenced key in I<pkey> or NULL if the
  63 key is not of the correct type.  The returned key must be freed after use.
  64
  65 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_poly1305(), EVP_PKEY_get0_siphash(),
  66 EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(), EVP_PKEY_get0_DH() and
  67 EVP_PKEY_get0_EC_KEY() return the referenced key in I<pkey> or NULL if the
  68 key is not of the correct type but the reference count of the returned key
  69 is B<not> incremented and so must not be freed after use.
  70
  71 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
  72 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305() and
  73 EVP_PKEY_assign_SIPHASH() set the referenced key to I<key> however these use
  74 the supplied I<key> internally and so I<key> will be freed when the parent
  75 I<pkey> is freed.
  76
  77 EVP_PKEY_base_id() returns the type of I<pkey>. For example
  78 an RSA key will return B<EVP_PKEY_RSA>.
  79
  80 EVP_PKEY_id() returns the actual OID associated with I<pkey>. Historically keys
  81 using the same algorithm could use different OIDs. For example an RSA key could
  82 use the OIDs corresponding to the NIDs B<NID_rsaEncryption> (equivalent to
  83 B<EVP_PKEY_RSA>) or B<NID_rsa> (equivalent to B<EVP_PKEY_RSA2>). The use of
  84 alternative non-standard OIDs is now rare so B<EVP_PKEY_RSA2> et al are not
  85 often seen in practice.
  86
  87 EVP_PKEY_type() returns the underlying type of the NID I<type>. For example
  88 EVP_PKEY_type(EVP_PKEY_RSA2) will return B<EVP_PKEY_RSA>.
  89
  90 EVP_PKEY_get0_engine() returns a reference to the ENGINE handling I<pkey>.
  91
  92 EVP_PKEY_set1_engine() sets the ENGINE handling I<pkey> to I<engine>. It
  93 must be called after the key algorithm and components are set up.
  94 If I<engine> does not include an B<EVP_PKEY_METHOD> for I<pkey> an
  95 error occurs.
  96
  97 EVP_PKEY_set_alias_type() allows modifying a EVP_PKEY to use a
  98 different set of algorithms than the default.
  99
 100 =head1 WARNINGS
 101
 102 The following functions are only reliable with B<EVP_PKEY>s that have
 103 been assigned an internal key with EVP_PKEY_assign_*():
 104
 105 EVP_PKEY_id(), EVP_PKEY_base_id(), EVP_PKEY_type(), EVP_PKEY_set_alias_type()
 106
 107 For EVP_PKEY key type checking purposes, L<EVP_PKEY_is_a(3)> is more generic.
 108
 109 =head1 NOTES
 110
 111 In accordance with the OpenSSL naming convention the key obtained
 112 from or assigned to the I<pkey> using the B<1> functions must be
 113 freed as well as I<pkey>.
 114
 115 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
 116 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305()
 117 and EVP_PKEY_assign_SIPHASH() are implemented as macros.
 118
 119 EVP_PKEY_assign_EC_KEY() looks at the curve name id to determine if
 120 the passed B<EC_KEY> is an L<SM2(7)> key, and will set the B<EVP_PKEY>
 121 type to B<EVP_PKEY_SM2> in that case, instead of B<EVP_PKEY_EC>.
 122
 123 It's possible to switch back and forth between the types B<EVP_PKEY_EC>
 124 and B<EVP_PKEY_SM2> with a call to EVP_PKEY_set_alias_type() on keys
 125 assigned with this macro if it's desirable to do a normal EC
 126 computations with the SM2 curve instead of the special SM2
 127 computations, and vice versa.
 128
 129 Most applications wishing to know a key type will simply call
 130 EVP_PKEY_base_id() and will not care about the actual type:
 131 which will be identical in almost all cases.
 132
 133 Previous versions of this document suggested using EVP_PKEY_type(pkey->type)
 134 to determine the type of a key. Since B<EVP_PKEY> is now opaque this
 135 is no longer possible: the equivalent is EVP_PKEY_base_id(pkey).
 136
 137 EVP_PKEY_set1_engine() is typically used by an ENGINE returning an HSM
 138 key as part of its routine to load a private key.
 139
 140 =head1 RETURN VALUES
 141
 142 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
 143 EVP_PKEY_set1_EC_KEY() return 1 for success or 0 for failure.
 144
 145 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
 146 EVP_PKEY_get1_EC_KEY() return the referenced key or NULL if
 147 an error occurred.
 148
 149 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
 150 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305()
 151 and EVP_PKEY_assign_SIPHASH() return 1 for success and 0 for failure.
 152
 153 EVP_PKEY_base_id(), EVP_PKEY_id() and EVP_PKEY_type() return a key
 154 type or B<NID_undef> (equivalently B<EVP_PKEY_NONE>) on error.
 155
 156 EVP_PKEY_set1_engine() returns 1 for success and 0 for failure.
 157
 158 EVP_PKEY_set_alias_type() returns 1 for success and 0 for error.
 159
 160 =head1 EXAMPLES
 161
 162 After loading an ECC key, it is possible to convert it to using SM2
 163 algorithms with EVP_PKEY_set_alias_type:
 164
 165  EVP_PKEY_set_alias_type(pkey, EVP_PKEY_SM2);
 166
 167 =head1 SEE ALSO
 168
 169 L<EVP_PKEY_new(3)>, L<SM2(7)>
 170
 171 =head1 HISTORY
 172
 173 EVP_PKEY_set_alias_type() was deprecated in OpenSSL 3.0.
 174
 175 =head1 COPYRIGHT
 176
 177 Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
 178
 179 Licensed under the Apache License 2.0 (the "License").  You may not use
 180 this file except in compliance with the License.  You can obtain a copy
 181 in the file LICENSE in the source distribution or at
 182 L<https://www.openssl.org/source/license.html>.
 183
 184 =cut