doc/man3/EC_KEY_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EC_KEY_get_method, EC_KEY_set_method, EC_KEY_new_ex,
   6 EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags,
   7 EC_KEY_new_by_curve_name_ex, EC_KEY_new_by_curve_name, EC_KEY_free,
   8 EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref, EC_KEY_get0_engine,
   9 EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key,
  10 EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key,
  11 EC_KEY_get_conv_form,
  12 EC_KEY_set_conv_form, EC_KEY_set_asn1_flag,
  13 EC_KEY_decoded_from_explicit_params, EC_KEY_precompute_mult,
  14 EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates,
  15 EC_KEY_oct2key, EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct,
  16 EC_KEY_priv2buf - Functions for creating, destroying and manipulating
  17 EC_KEY objects
  18
  19 =head1 SYNOPSIS
  20
  21  #include <openssl/ec.h>
  22
  23 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  24 B<OPENSSL_API_COMPAT> with a suitable version value, see
  25 L<openssl_user_macros(7)>:
  26
  27  EC_KEY *EC_KEY_new_ex(OSSL_LIB_CTX *ctx, const char *propq);
  28  EC_KEY *EC_KEY_new(void);
  29  int EC_KEY_get_flags(const EC_KEY *key);
  30  void EC_KEY_set_flags(EC_KEY *key, int flags);
  31  void EC_KEY_clear_flags(EC_KEY *key, int flags);
  32  EC_KEY *EC_KEY_new_by_curve_name_ex(OSSL_LIB_CTX *ctx, const char *propq,
  33                                      int nid);
  34  EC_KEY *EC_KEY_new_by_curve_name(int nid);
  35  void EC_KEY_free(EC_KEY *key);
  36  EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
  37  EC_KEY *EC_KEY_dup(const EC_KEY *src);
  38  int EC_KEY_up_ref(EC_KEY *key);
  39  ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey);
  40  const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
  41  int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
  42  const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
  43  int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
  44  const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
  45  int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
  46  point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
  47  void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
  48  void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
  49  int EC_KEY_decoded_from_explicit_params(const EC_KEY *key);
  50  int EC_KEY_generate_key(EC_KEY *key);
  51  int EC_KEY_check_key(const EC_KEY *key);
  52  int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
  53  const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
  54  int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
  55
  56  int EC_KEY_oct2key(EC_KEY *eckey, const unsigned char *buf, size_t len, BN_CTX *ctx);
  57  size_t EC_KEY_key2buf(const EC_KEY *eckey, point_conversion_form_t form,
  58                        unsigned char **pbuf, BN_CTX *ctx);
  59
  60  int EC_KEY_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len);
  61  size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len);
  62
  63  size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf);
  64  int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
  65
  66 =head1 DESCRIPTION
  67
  68 All of the functions described on this page are deprecated.
  69 Applications should instead use L<EVP_PKEY_new(3)> and L<EVP_PKEY_free(3)>.
  70
  71 An EC_KEY represents a public key and, optionally, the associated private
  72 key.
  73 A new EC_KEY with no associated curve can be constructed by calling
  74 EC_KEY_new_ex() and specifying the associated library context in I<ctx>
  75 (see L<OSSL_LIB_CTX(3)>) and property query string I<propq>.
  76 The I<ctx> parameter may be NULL in which case the default library context is
  77 used.
  78 The reference count for the newly created EC_KEY is initially
  79 set to 1.
  80 A curve can be associated with the EC_KEY by calling
  81 EC_KEY_set_group().
  82
  83 EC_KEY_new() is the same as EC_KEY_new_ex() except that the default library
  84 context is always used.
  85
  86 Alternatively a new EC_KEY can be constructed by calling
  87 EC_KEY_new_by_curve_name_ex() and supplying the nid of the associated
  88 curve, the library context to be used I<ctx> (see L<OSSL_LIB_CTX(3)>) and any
  89 property query string I<propq>.
  90 The I<ctx> parameter may be NULL in which case the default library context is
  91 used. The I<propq> value may also be NULL.
  92 See L<EC_GROUP_new(3)> for a description of curve names.
  93 This function simply wraps calls to EC_KEY_new_ex() and
  94 EC_GROUP_new_by_curve_name_ex().
  95
  96 EC_KEY_new_by_curve_name() is the same as EC_KEY_new_by_curve_name_ex()
  97 except that the default library context is always used and a NULL property query
  98 string.
  99
 100 Calling EC_KEY_free() decrements the reference count for the EC_KEY object,
 101 and if it has dropped to zero then frees the memory associated with it.  If
 102 I<key> is NULL nothing is done.
 103
 104 EC_KEY_copy() copies the contents of the EC_KEY in I<src> into I<dest>.
 105
 106 EC_KEY_dup() creates a new EC_KEY object and copies I<ec_key> into it.
 107
 108 EC_KEY_up_ref() increments the reference count associated with the EC_KEY
 109 object.
 110
 111 EC_KEY_get0_engine() returns a handle to the ENGINE that has been set for
 112 this EC_KEY object.
 113
 114 EC_KEY_generate_key() generates a new public and private key for the supplied
 115 I<eckey> object. I<eckey> must have an EC_GROUP object associated with it
 116 before calling this function. The private key is a random integer (0 < priv_key
 117 < order, where I<order> is the order of the EC_GROUP object). The public key is
 118 an EC_POINT on the curve calculated by multiplying the generator for the
 119 curve by the private key.
 120
 121 EC_KEY_check_key() performs various sanity checks on the EC_KEY object to
 122 confirm that it is valid.
 123
 124 EC_KEY_set_public_key_affine_coordinates() sets the public key for I<key> based
 125 on its affine co-ordinates; i.e., it constructs an EC_POINT object based on
 126 the supplied I<x> and I<y> values and sets the public key to be this
 127 EC_POINT. It also performs certain sanity checks on the key to confirm
 128 that it is valid.
 129
 130 The functions EC_KEY_get0_group(), EC_KEY_set_group(),
 131 EC_KEY_get0_private_key(), EC_KEY_set_private_key(), EC_KEY_get0_public_key(),
 132 and EC_KEY_set_public_key() get and set the EC_GROUP object, the private key,
 133 and the EC_POINT public key for the I<key> respectively.
 134
 135 The functions EC_KEY_get_conv_form() and EC_KEY_set_conv_form() get and set the
 136 point_conversion_form for the I<key>. For a description of
 137 point_conversion_forms please see L<EC_POINT_new(3)>.
 138
 139 EC_KEY_set_flags() sets the flags in the I<flags> parameter on the EC_KEY
 140 object. Any flags that are already set are left set. The flags currently
 141 defined are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED. In
 142 addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific to ECDH.
 143 EC_KEY_get_flags() returns the current flags that are set for this EC_KEY.
 144 EC_KEY_clear_flags() clears the flags indicated by the I<flags> parameter; all
 145 other flags are left in their existing state.
 146
 147 EC_KEY_set_asn1_flag() sets the asn1_flag on the underlying EC_GROUP object
 148 (if set). Refer to L<EC_GROUP_copy(3)> for further information on the
 149 asn1_flag.
 150
 151 EC_KEY_decoded_from_explicit_params() returns 1 if the group of the I<key> was
 152 decoded from data with explicitly encoded group parameters, -1 if the I<key>
 153 is NULL or the group parameters are missing, and 0 otherwise.
 154
 155 Although deprecated in OpenSSL 3.0 and should no longer be used,
 156 EC_KEY_precompute_mult() stores multiples of the underlying EC_GROUP generator
 157 for faster point multiplication. See also L<EC_POINT_add(3)>.
 158 Modern versions should instead switch to named curves which OpenSSL has
 159 hardcoded lookup tables for.
 160
 161 EC_KEY_oct2key() and EC_KEY_key2buf() are identical to the functions
 162 EC_POINT_oct2point() and EC_POINT_point2buf() except they use the public key
 163 EC_POINT in I<eckey>.
 164
 165 EC_KEY_oct2priv() and EC_KEY_priv2oct() convert between the private key
 166 component of I<eckey> and octet form. The octet form consists of the content
 167 octets of the I<privateKey> OCTET STRING in an I<ECPrivateKey> ASN.1 structure.
 168
 169 The function EC_KEY_priv2oct() must be supplied with a buffer long enough to
 170 store the octet form. The return value provides the number of octets stored.
 171 Calling the function with a NULL buffer will not perform the conversion but
 172 will just return the required buffer length.
 173
 174 The function EC_KEY_priv2buf() allocates a buffer of suitable length and writes
 175 an EC_KEY to it in octet format. The allocated buffer is written to I<*pbuf>
 176 and its length is returned. The caller must free up the allocated buffer with a
 177 call to OPENSSL_free(). Since the allocated buffer value is written to I<*pbuf>
 178 the I<pbuf> parameter B<MUST NOT> be B<NULL>.
 179
 180 EC_KEY_priv2buf() converts an EC_KEY private key into an allocated buffer.
 181
 182 =head1 RETURN VALUES
 183
 184 EC_KEY_new_ex(), EC_KEY_new(), EC_KEY_new_by_curve_name_ex(),
 185 EC_KEY_new_by_curve_name() and EC_KEY_dup() return a pointer to the newly
 186 created EC_KEY object, or NULL on error.
 187
 188 EC_KEY_get_flags() returns the flags associated with the EC_KEY object as an
 189 integer.
 190
 191 EC_KEY_copy() returns a pointer to the destination key, or NULL on error.
 192
 193 EC_KEY_get0_engine() returns a pointer to an ENGINE, or NULL if it wasn't set.
 194
 195 EC_KEY_up_ref(), EC_KEY_set_group(), EC_KEY_set_private_key(),
 196 EC_KEY_set_public_key(), EC_KEY_precompute_mult(), EC_KEY_generate_key(),
 197 EC_KEY_check_key(), EC_KEY_set_public_key_affine_coordinates(),
 198 EC_KEY_oct2key() and EC_KEY_oct2priv() return 1 on success or 0 on error.
 199
 200 EC_KEY_get0_group() returns the EC_GROUP associated with the EC_KEY.
 201
 202 EC_KEY_get0_private_key() returns the private key associated with the EC_KEY.
 203
 204 EC_KEY_get_conv_form() return the point_conversion_form for the EC_KEY.
 205
 206 EC_KEY_key2buf(), EC_KEY_priv2oct() and EC_KEY_priv2buf() return the length
 207 of the buffer or 0 on error.
 208
 209 =head1 SEE ALSO
 210
 211 L<crypto(7)>, L<EC_GROUP_new(3)>,
 212 L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>,
 213 L<EC_POINT_add(3)>,
 214 L<EC_GFp_simple_method(3)>,
 215 L<d2i_ECPKParameters(3)>,
 216 L<OSSL_LIB_CTX(3)>
 217
 218 =head1 HISTORY
 219
 220 All of these functions were deprecated in OpenSSL 3.0.
 221
 222 =head1 COPYRIGHT
 223
 224 Copyright 2013-2021 The OpenSSL Project Authors. All Rights Reserved.
 225
 226 Licensed under the Apache License 2.0 (the "License").  You may not use
 227 this file except in compliance with the License.  You can obtain a copy
 228 in the file LICENSE in the source distribution or at
 229 L<https://www.openssl.org/source/license.html>.
 230
 231 =cut