doc/crypto/EC_KEY_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags,
   6 EC_KEY_new_by_curve_name, EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref,
   7 EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key,
   8 EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key,
   9 EC_KEY_get_enc_flags, EC_KEY_set_enc_flags, EC_KEY_get_conv_form,
  10 EC_KEY_set_conv_form, EC_KEY_set_asn1_flag, EC_KEY_precompute_mult,
  11 EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates,
  12 EC_KEY_oct2key, EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct,
  13 EC_KEY_priv2buf - Functions for creating, destroying and manipulating
  14 EC_KEY objects.
  15
  16 =head1 SYNOPSIS
  17
  18  #include <openssl/ec.h>
  19  #include <openssl/bn.h>
  20
  21  EC_KEY *EC_KEY_new(void);
  22  int EC_KEY_get_flags(const EC_KEY *key);
  23  void EC_KEY_set_flags(EC_KEY *key, int flags);
  24  void EC_KEY_clear_flags(EC_KEY *key, int flags);
  25  EC_KEY *EC_KEY_new_by_curve_name(int nid);
  26  void EC_KEY_free(EC_KEY *key);
  27  EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
  28  EC_KEY *EC_KEY_dup(const EC_KEY *src);
  29  int EC_KEY_up_ref(EC_KEY *key);
  30  const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
  31  int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
  32  const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
  33  int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
  34  const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
  35  int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
  36  point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
  37  void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
  38  void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
  39  int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
  40  int EC_KEY_generate_key(EC_KEY *key);
  41  int EC_KEY_check_key(const EC_KEY *key);
  42  int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key,
  43                                               BIGNUM *x, BIGNUM *y);
  44  const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
  45  int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
  46
  47  int EC_KEY_oct2key(EC_KEY *eckey, const unsigned char *buf, size_t len,
  48                     BN_CTX *ctx);
  49  size_t EC_KEY_key2buf(const EC_KEY *eckey, point_conversion_form_t form,
  50                        unsigned char **pbuf, BN_CTX *ctx);
  51
  52  int EC_KEY_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len);
  53  size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len);
  54
  55  size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf);
  56
  57 =head1 DESCRIPTION
  58
  59 An EC_KEY represents a public key and, optionally, the associated private
  60 key. A new EC_KEY with no associated curve can be constructed by calling
  61 EC_KEY_new(). The reference count for the newly created EC_KEY is initially
  62 set to 1. A curve can be associated with the EC_KEY by calling
  63 EC_KEY_set_group().
  64
  65 Alternatively a new EC_KEY can be constructed by calling
  66 EC_KEY_new_by_curve_name() and supplying the nid of the associated curve. See
  67 L<EC_GROUP_new(3)> for a description of curve names. This function simply
  68 wraps calls to EC_KEY_new() and EC_GROUP_new_by_curve_name().
  69
  70 Calling EC_KEY_free() decrements the reference count for the EC_KEY object,
  71 and if it has dropped to zero then frees the memory associated with it.  If
  72 B<key> is NULL nothing is done.
  73
  74 EC_KEY_copy() copies the contents of the EC_KEY in B<src> into B<dest>.
  75
  76 EC_KEY_dup() creates a new EC_KEY object and copies B<ec_key> into it.
  77
  78 EC_KEY_up_ref() increments the reference count associated with the EC_KEY
  79 object.
  80
  81 EC_KEY_generate_key() generates a new public and private key for the supplied
  82 B<eckey> object. B<eckey> must have an EC_GROUP object associated with it
  83 before calling this function. The private key is a random integer (0 < priv_key
  84 < order, where I<order> is the order of the EC_GROUP object). The public key is
  85 an EC_POINT on the curve calculated by multiplying the generator for the
  86 curve by the private key.
  87
  88 EC_KEY_check_key() performs various sanity checks on the EC_KEY object to
  89 confirm that it is valid.
  90
  91 EC_KEY_set_public_key_affine_coordinates() sets the public key for B<key> based
  92 on its affine co-ordinates; i.e., it constructs an EC_POINT object based on
  93 the supplied B<x> and B<y> values and sets the public key to be this
  94 EC_POINT. It also performs certain sanity checks on the key to confirm
  95 that it is valid.
  96
  97 The functions EC_KEY_get0_group(), EC_KEY_set_group(),
  98 EC_KEY_get0_private_key(), EC_KEY_set_private_key(), EC_KEY_get0_public_key(),
  99 and EC_KEY_set_public_key() get and set the EC_GROUP object, the private key,
 100 and the EC_POINT public key for the B<key> respectively.
 101
 102 The functions EC_KEY_get_conv_form() and EC_KEY_set_conv_form() get and set the
 103 point_conversion_form for the B<key>. For a description of
 104 point_conversion_forms please see L<EC_POINT_new(3)>.
 105
 106 EC_KEY_set_flags() sets the flags in the B<flags> parameter on the EC_KEY
 107 object. Any flags that are already set are left set. The flags currently
 108 defined are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED. In
 109 addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific to ECDH.
 110 EC_KEY_get_flags() returns the current flags that are set for this EC_KEY.
 111 EC_KEY_clear_flags() clears the flags indicated by the B<flags> parameter; all
 112 other flags are left in their existing state.
 113
 114 EC_KEY_set_asn1_flag() sets the asn1_flag on the underlying EC_GROUP object
 115 (if set). Refer to L<EC_GROUP_copy(3)> for further information on the
 116 asn1_flag.
 117
 118 EC_KEY_precompute_mult() stores multiples of the underlying EC_GROUP generator
 119 for faster point multiplication. See also L<EC_POINT_add(3)>.
 120
 121 EC_KEY_oct2key() and EC_KEY_key2buf() are identical to the functions
 122 EC_POINT_oct2point() and EC_KEY_point2buf() except they use the public key
 123 EC_POINT in B<eckey>.
 124
 125 EC_KEY_oct2priv() and EC_KEY_priv2oct() convert between the private key
 126 component of B<eckey> and octet form. The octet form consists of the content
 127 octets of the B<privateKey> OCTET STRING in an B<ECPrivateKey> ASN.1 structure.
 128
 129 The function EC_KEY_priv2oct() must be supplied with a buffer long enough to
 130 store the octet form. The return value provides the number of octets stored.
 131 Calling the function with a NULL buffer will not perform the conversion but
 132 will just return the required buffer length.
 133
 134 The function EC_KEY_priv2buf() allocates a buffer of suitable length and writes
 135 an EC_KEY to it in octet format. The allocated buffer is written to B<*pbuf>
 136 and its length is returned. The caller must free up the allocated buffer with a
 137 call to OPENSSL_free(). Since the allocated buffer value is written to B<*pbuf>
 138 the B<pbuf> parameter B<MUST NOT> be B<NULL>.
 139
 140 EC_KEY_priv2buf() converts an EC_KEY private key into an allocated buffer.
 141
 142 =head1 RETURN VALUES
 143
 144 EC_KEY_new(), EC_KEY_new_by_curve_name() and EC_KEY_dup() return a pointer to
 145 the newly created EC_KEY object, or NULL on error.
 146
 147 EC_KEY_get_flags() returns the flags associated with the EC_KEY object as an
 148 integer.
 149
 150 EC_KEY_copy() returns a pointer to the destination key, or NULL on error.
 151
 152 EC_KEY_up_ref(), EC_KEY_set_group(), EC_KEY_set_private_key(),
 153 EC_KEY_set_public_key(), EC_KEY_precompute_mult(), EC_KEY_generate_key(),
 154 EC_KEY_check_key(), EC_KEY_set_public_key_affine_coordinates(),
 155 EC_KEY_oct2key() and EC_KEY_oct2priv() return 1 on success or 0 on error.
 156
 157 EC_KEY_get0_group() returns the EC_GROUP associated with the EC_KEY.
 158
 159 EC_KEY_get0_private_key() returns the private key associated with the EC_KEY.
 160
 161 EC_KEY_get_conv_form() return the point_conversion_form for the EC_KEY.
 162
 163 EC_KEY_key2buf(), EC_KEY_priv2oct() and EC_KEY_priv2buf() return the length
 164 of the buffer or 0 on error.
 165
 166 =head1 SEE ALSO
 167
 168 L<crypto(3)>, L<ec(3)>, L<EC_GROUP_new(3)>,
 169 L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>,
 170 L<EC_POINT_add(3)>,
 171 L<EC_GFp_simple_method(3)>,
 172 L<d2i_ECPKParameters(3)>
 173
 174 =cut