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