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, EC_KEY_new_by_curve_name, EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref, EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key, EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key, EC_KEY_get_enc_flags, EC_KEY_set_enc_flags, EC_KEY_get_conv_form, EC_KEY_set_conv_form, EC_KEY_set_asn1_flag, EC_KEY_precompute_mult, EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates - Functions for creating, destroying and manipulating B<EC_KEY> objects.
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ec.h>
  10  #include <openssl/bn.h>
  11
  12  EC_KEY *EC_KEY_new(void);
  13  int EC_KEY_get_flags(const EC_KEY *key);
  14  void EC_KEY_set_flags(EC_KEY *key, int flags);
  15  void EC_KEY_clear_flags(EC_KEY *key, int flags);
  16  EC_KEY *EC_KEY_new_by_curve_name(int nid);
  17  void EC_KEY_free(EC_KEY *key);
  18  EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
  19  EC_KEY *EC_KEY_dup(const EC_KEY *src);
  20  int EC_KEY_up_ref(EC_KEY *key);
  21  const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
  22  int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
  23  const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
  24  int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
  25  const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
  26  int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
  27  point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
  28  void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
  29  void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
  30  int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
  31  int EC_KEY_generate_key(EC_KEY *key);
  32  int EC_KEY_check_key(const EC_KEY *key);
  33  int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
  34  const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
  35  int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
  36
  37 =head1 DESCRIPTION
  38
  39 An EC_KEY represents a public key and (optionally) an associated private key. A new EC_KEY (with no associated curve) can be constructed by calling EC_KEY_new().
  40 The reference count for the newly created EC_KEY is initially set to 1. A curve can be associated with the EC_KEY by calling
  41 EC_KEY_set_group().
  42
  43 Alternatively a new EC_KEY can be constructed by calling EC_KEY_new_by_curve_name() and supplying the nid of the associated curve. Refer to L<EC_GROUP_new(3)> for a description of curve names. This function simply wraps calls to EC_KEY_new() and
  44 EC_GROUP_new_by_curve_name().
  45
  46 Calling EC_KEY_free() decrements the reference count for the EC_KEY object, and if it has dropped to zero then frees the memory associated
  47 with it.
  48 If B<key> is NULL nothing is done.
  49
  50 EC_KEY_copy() copies the contents of the EC_KEY in B<src> into B<dest>.
  51
  52 EC_KEY_dup() creates a new EC_KEY object and copies B<ec_key> into it.
  53
  54 EC_KEY_up_ref() increments the reference count associated with the EC_KEY object.
  55
  56 EC_KEY_generate_key() generates a new public and private key for the supplied B<eckey> object. B<eckey> must have an EC_GROUP object
  57 associated with it before calling this function. The private key is a random integer (0 < priv_key < order, where order is the order
  58 of the EC_GROUP object). The public key is an EC_POINT on the curve calculated by multiplying the generator for the curve by the
  59 private key.
  60
  61 EC_KEY_check_key() performs various sanity checks on the EC_KEY object to confirm that it is valid.
  62
  63 EC_KEY_set_public_key_affine_coordinates() sets the public key for B<key> based on its affine co-ordinates, i.e. it constructs an EC_POINT
  64 object based on the supplied B<x> and B<y> values and sets the public key to be this EC_POINT. It will also performs certain sanity checks
  65 on the key to confirm that it is valid.
  66
  67 The functions EC_KEY_get0_group(), EC_KEY_set_group(), EC_KEY_get0_private_key(), EC_KEY_set_private_key(), EC_KEY_get0_public_key(), and EC_KEY_set_public_key() get and set the EC_GROUP object, the private key and the EC_POINT public key for the B<key> respectively.
  68
  69 The functions EC_KEY_get_conv_form() and EC_KEY_set_conv_form() get and set the point_conversion_form for the B<key>. For a description
  70 of point_conversion_forms please refer to L<EC_POINT_new(3)>.
  71
  72 EC_KEY_set_flags() sets the flags in the B<flags> parameter on the EC_KEY object. Any flags that are already set are left set. The currently defined standard flags are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED. In addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific to ECDH and is defined in ecdh.h. EC_KEY_get_flags returns the current flags that are set for this EC_KEY. EC_KEY_clear_flags clears the flags indicated by the B<flags> parameter. All other flags are left in their existing state.
  73
  74 EC_KEY_set_asn1_flag() sets the asn1_flag on the underlying EC_GROUP object (if set). Refer to L<EC_GROUP_copy(3)> for further information on the asn1_flag.
  75
  76 EC_KEY_precompute_mult() stores multiples of the underlying EC_GROUP generator for faster point multiplication. See also L<EC_POINT_add(3)>.
  77
  78
  79 =head1 RETURN VALUES
  80
  81 EC_KEY_new(), EC_KEY_new_by_curve_name() and EC_KEY_dup() return a pointer to the newly created EC_KEY object, or NULL on error.
  82
  83 EC_KEY_get_flags() returns the flags associated with the EC_KEY object as an integer.
  84
  85 EC_KEY_copy() returns a pointer to the destination key, or NULL on error.
  86
  87 EC_KEY_up_ref(), EC_KEY_set_group(), EC_KEY_set_private_key(), EC_KEY_set_public_key(), EC_KEY_precompute_mult(), EC_KEY_generate_key(), EC_KEY_check_key() and EC_KEY_set_public_key_affine_coordinates() return 1 on success or 0 on error.
  88
  89 EC_KEY_get0_group() returns the EC_GROUP associated with the EC_KEY.
  90
  91 EC_KEY_get0_private_key() returns the private key associated with the EC_KEY.
  92
  93 EC_KEY_get_conv_form() return the point_conversion_form for the EC_KEY.
  94
  95
  96 =head1 SEE ALSO
  97
  98 L<crypto(3)>, L<ec(3)>, L<EC_GROUP_new(3)>,
  99 L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>,
 100 L<EC_POINT_add(3)>,
 101 L<EC_GFp_simple_method(3)>,
 102 L<d2i_ECPKParameters(3)>
 103
 104 =cut