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 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(EVP_PKEY *pkey);
  32  DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey);
  33  DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey);
  34  EC_KEY *EVP_PKEY_get0_EC_KEY(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  int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type);
  47
  48  int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *engine);
  49
  50 =head1 DESCRIPTION
  51
  52 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
  53 EVP_PKEY_set1_EC_KEY() set the key referenced by B<pkey> to B<key>.
  54
  55 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
  56 EVP_PKEY_get1_EC_KEY() return the referenced key in B<pkey> or
  57 B<NULL> if the key is not of the correct type.
  58
  59 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_poly1305(), EVP_PKEY_get0_siphash(),
  60 EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(), EVP_PKEY_get0_DH()
  61 and EVP_PKEY_get0_EC_KEY() also return the referenced key in B<pkey> or B<NULL>
  62 if the key is not of the correct type but the reference count of the
  63 returned key is B<not> incremented and so must not be freed up after use.
  64
  65 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
  66 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305() and
  67 EVP_PKEY_assign_SIPHASH() also set the referenced key to B<key>
  68 however these use the supplied B<key> internally and so B<key>
  69 will be freed when the parent B<pkey> is freed.
  70
  71 EVP_PKEY_base_id() returns the type of B<pkey>. For example
  72 an RSA key will return B<EVP_PKEY_RSA>.
  73
  74 EVP_PKEY_id() returns the actual OID associated with B<pkey>. Historically keys
  75 using the same algorithm could use different OIDs. For example an RSA key could
  76 use the OIDs corresponding to the NIDs B<NID_rsaEncryption> (equivalent to
  77 B<EVP_PKEY_RSA>) or B<NID_rsa> (equivalent to B<EVP_PKEY_RSA2>). The use of
  78 alternative non-standard OIDs is now rare so B<EVP_PKEY_RSA2> et al are not
  79 often seen in practice.
  80
  81 EVP_PKEY_type() returns the underlying type of the NID B<type>. For example
  82 EVP_PKEY_type(EVP_PKEY_RSA2) will return B<EVP_PKEY_RSA>.
  83
  84 EVP_PKEY_set1_engine() sets the ENGINE handling B<pkey> to B<engine>. It
  85 must be called after the key algorithm and components are set up.
  86 If B<engine> does not include an B<EVP_PKEY_METHOD> for B<pkey> an
  87 error occurs.
  88
  89 EVP_PKEY_set_alias_type() allows modifying a EVP_PKEY to use a
  90 different set of algorithms than the default. This is currently used
  91 to support SM2 keys, which use an identical encoding to ECDSA.
  92
  93 =head1 NOTES
  94
  95 In accordance with the OpenSSL naming convention the key obtained
  96 from or assigned to the B<pkey> using the B<1> functions must be
  97 freed as well as B<pkey>.
  98
  99 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
 100 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305()
 101 and EVP_PKEY_assign_SIPHASH() are implemented as macros.
 102
 103 Most applications wishing to know a key type will simply call
 104 EVP_PKEY_base_id() and will not care about the actual type:
 105 which will be identical in almost all cases.
 106
 107 Previous versions of this document suggested using EVP_PKEY_type(pkey->type)
 108 to determine the type of a key. Since B<EVP_PKEY> is now opaque this
 109 is no longer possible: the equivalent is EVP_PKEY_base_id(pkey).
 110
 111 EVP_PKEY_set1_engine() is typically used by an ENGINE returning an HSM
 112 key as part of its routine to load a private key.
 113
 114 =head1 EXAMPLES
 115
 116 After loading an ECC key, it is possible to convert it to using SM2
 117 algorithms with EVP_PKEY_set_alias_type:
 118
 119  EVP_PKEY_set_alias_type(pkey, EVP_PKEY_SM2);
 120
 121 =head1 RETURN VALUES
 122
 123 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
 124 EVP_PKEY_set1_EC_KEY() return 1 for success or 0 for failure.
 125
 126 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
 127 EVP_PKEY_get1_EC_KEY() return the referenced key or B<NULL> if
 128 an error occurred.
 129
 130 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(),
 131 EVP_PKEY_assign_EC_KEY(), EVP_PKEY_assign_POLY1305()
 132 and EVP_PKEY_assign_SIPHASH() return 1 for success and 0 for failure.
 133
 134 EVP_PKEY_base_id(), EVP_PKEY_id() and EVP_PKEY_type() return a key
 135 type or B<NID_undef> (equivalently B<EVP_PKEY_NONE>) on error.
 136
 137 EVP_PKEY_set1_engine() returns 1 for success and 0 for failure.
 138
 139 EVP_PKEY_set_alias_type() returns 1 for success and 0 for error.
 140
 141 =head1 SEE ALSO
 142
 143 L<EVP_PKEY_new(3)>
 144
 145 =head1 COPYRIGHT
 146
 147 Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
 148
 149 Licensed under the OpenSSL license (the "License").  You may not use
 150 this file except in compliance with the License.  You can obtain a copy
 151 in the file LICENSE in the source distribution or at
 152 L<https://www.openssl.org/source/license.html>.
 153
 154 =cut