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