doc/man3/EC_GROUP_copy.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EC_GROUP_get0_order, EC_GROUP_order_bits, EC_GROUP_get0_cofactor,
   6 EC_GROUP_copy, EC_GROUP_dup, EC_GROUP_method_of, EC_GROUP_set_generator,
   7 EC_GROUP_get0_generator, EC_GROUP_get_order, EC_GROUP_get_cofactor,
   8 EC_GROUP_set_curve_name, EC_GROUP_get_curve_name, EC_GROUP_set_asn1_flag,
   9 EC_GROUP_get_asn1_flag, EC_GROUP_set_point_conversion_form,
  10 EC_GROUP_get_point_conversion_form, EC_GROUP_get0_seed,
  11 EC_GROUP_get_seed_len, EC_GROUP_set_seed, EC_GROUP_get_degree,
  12 EC_GROUP_check, EC_GROUP_check_named_curve,
  13 EC_GROUP_check_discriminant, EC_GROUP_cmp,
  14 EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis,
  15 EC_GROUP_get_pentanomial_basis, EC_GROUP_get0_field
  16 - Functions for manipulating EC_GROUP objects
  17
  18 =head1 SYNOPSIS
  19
  20  #include <openssl/ec.h>
  21
  22  int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
  23  EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
  24
  25  const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
  26
  27  int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator,
  28                             const BIGNUM *order, const BIGNUM *cofactor);
  29  const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
  30
  31  int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
  32  const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);
  33  int EC_GROUP_order_bits(const EC_GROUP *group);
  34  int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);
  35  const BIGNUM *EC_GROUP_get0_cofactor(const EC_GROUP *group);
  36  const BIGNUM *EC_GROUP_get0_field(const EC_GROUP *group);
  37
  38  void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
  39  int EC_GROUP_get_curve_name(const EC_GROUP *group);
  40
  41  void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
  42  int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
  43
  44  void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form);
  45  point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
  46
  47  unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
  48  size_t EC_GROUP_get_seed_len(const EC_GROUP *);
  49  size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
  50
  51  int EC_GROUP_get_degree(const EC_GROUP *group);
  52
  53  int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
  54  int EC_GROUP_check_named_curve(const EC_GROUP *group, int nist_only);
  55
  56  int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
  57
  58  int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
  59
  60  int EC_GROUP_get_basis_type(const EC_GROUP *);
  61  int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
  62  int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1,
  63                                     unsigned int *k2, unsigned int *k3);
  64
  65 =head1 DESCRIPTION
  66
  67 EC_GROUP_copy copies the curve B<src> into B<dst>. Both B<src> and B<dst> must use the same EC_METHOD.
  68
  69 EC_GROUP_dup creates a new EC_GROUP object and copies the content from B<src> to the newly created
  70 EC_GROUP object.
  71
  72 EC_GROUP_method_of obtains the EC_METHOD of B<group>.
  73
  74 EC_GROUP_set_generator sets curve parameters that must be agreed by all participants using the curve. These
  75 parameters include the B<generator>, the B<order> and the B<cofactor>. The B<generator> is a well defined point on the
  76 curve chosen for cryptographic operations. Integers used for point multiplications will be between 0 and
  77 n-1 where n is the B<order>. The B<order> multiplied by the B<cofactor> gives the number of points on the curve.
  78
  79 EC_GROUP_get0_generator returns the generator for the identified B<group>.
  80
  81 The functions EC_GROUP_get_order and EC_GROUP_get_cofactor populate the provided B<order> and B<cofactor> parameters
  82 with the respective order and cofactors for the B<group>.
  83
  84 The functions EC_GROUP_set_curve_name and EC_GROUP_get_curve_name, set and get the NID for the curve respectively
  85 (see L<EC_GROUP_new(3)>). If a curve does not have a NID associated with it, then EC_GROUP_get_curve_name
  86 will return 0.
  87
  88 The asn1_flag value is used to determine whether the curve encoding uses
  89 explicit parameters or a named curve using an ASN1 OID: many applications only
  90 support the latter form. If asn1_flag is B<OPENSSL_EC_NAMED_CURVE> then the
  91 named curve form is used and the parameters must have a corresponding
  92 named curve NID set. If asn1_flags is B<OPENSSL_EC_EXPLICIT_CURVE> the
  93 parameters are explicitly encoded. The functions EC_GROUP_get_asn1_flag and
  94 EC_GROUP_set_asn1_flag get and set the status of the asn1_flag for the curve.
  95 Note: B<OPENSSL_EC_EXPLICIT_CURVE> was added in OpenSSL 1.1.0, for
  96 previous versions of OpenSSL the value 0 must be used instead. Before OpenSSL
  97 1.1.0 the default form was to use explicit parameters (meaning that
  98 applications would have to explicitly set the named curve form) in OpenSSL
  99 1.1.0 and later the named curve form is the default.
 100
 101 The point_conversion_form for a curve controls how EC_POINT data is encoded as ASN1 as defined in X9.62 (ECDSA).
 102 point_conversion_form_t is an enum defined as follows:
 103
 104  typedef enum {
 105         /** the point is encoded as z||x, where the octet z specifies
 106          *   which solution of the quadratic equation y is  */
 107         POINT_CONVERSION_COMPRESSED = 2,
 108         /** the point is encoded as z||x||y, where z is the octet 0x04  */
 109         POINT_CONVERSION_UNCOMPRESSED = 4,
 110         /** the point is encoded as z||x||y, where the octet z specifies
 111          *  which solution of the quadratic equation y is  */
 112         POINT_CONVERSION_HYBRID = 6
 113  } point_conversion_form_t;
 114
 115 For POINT_CONVERSION_UNCOMPRESSED the point is encoded as an octet signifying the UNCOMPRESSED form has been used followed by
 116 the octets for x, followed by the octets for y.
 117
 118 For any given x co-ordinate for a point on a curve it is possible to derive two possible y values. For
 119 POINT_CONVERSION_COMPRESSED the point is encoded as an octet signifying that the COMPRESSED form has been used AND which of
 120 the two possible solutions for y has been used, followed by the octets for x.
 121
 122 For POINT_CONVERSION_HYBRID the point is encoded as an octet signifying the HYBRID form has been used AND which of the two
 123 possible solutions for y has been used, followed by the octets for x, followed by the octets for y.
 124
 125 The functions EC_GROUP_set_point_conversion_form and EC_GROUP_get_point_conversion_form set and get the point_conversion_form
 126 for the curve respectively.
 127
 128 ANSI X9.62 (ECDSA standard) defines a method of generating the curve parameter b from a random number. This provides advantages
 129 in that a parameter obtained in this way is highly unlikely to be susceptible to special purpose attacks, or have any trapdoors in it.
 130 If the seed is present for a curve then the b parameter was generated in a verifiable fashion using that seed. The OpenSSL EC library
 131 does not use this seed value but does enable you to inspect it using EC_GROUP_get0_seed. This returns a pointer to a memory block
 132 containing the seed that was used. The length of the memory block can be obtained using EC_GROUP_get_seed_len. A number of the
 133 builtin curves within the library provide seed values that can be obtained. It is also possible to set a custom seed using
 134 EC_GROUP_set_seed and passing a pointer to a memory block, along with the length of the seed. Again, the EC library will not use
 135 this seed value, although it will be preserved in any ASN1 based communications.
 136
 137 EC_GROUP_get_degree gets the degree of the field. For Fp fields this will be the number of bits in p.  For F2^m fields this will be
 138 the value m.
 139
 140 The function EC_GROUP_check_discriminant calculates the discriminant for the curve and verifies that it is valid.
 141 For a curve defined over Fp the discriminant is given by the formula 4*a^3 + 27*b^2 whilst for F2^m curves the discriminant is
 142 simply b. In either case for the curve to be valid the discriminant must be non zero.
 143
 144 The function EC_GROUP_check performs a number of checks on a curve to verify that it is valid. Checks performed include
 145 verifying that the discriminant is non zero; that a generator has been defined; that the generator is on the curve and has
 146 the correct order.
 147
 148 EC_GROUP_check_named_curve determines if the group's domain parameters match one of the built in curves supported by the library.
 149 The curve name is returned as a B<NID> if it matches. If the group's domain parameters have been modified then no match will be found.
 150 If the curve name of the given group is B<NID_undef> (e.g. it has been created by using explicit parameters with no curve name),
 151 then this method can be used to lookup the name of the curve that matches the group domain parameters. The built in curves contain
 152 aliases, so that multiple NID's can map to the same domain parameters. For such curves it is unspecified which of the aliases will be
 153 returned if the curve name of the given group is NID_undef.
 154 If B<nist_only> is 1 it will only look for NIST approved curves, otherwise it searches all built in curves.
 155
 156 EC_GROUP_cmp compares B<a> and B<b> to determine whether they represent the same curve or not.
 157
 158 The functions EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis and EC_GROUP_get_pentanomial_basis should only be called for curves
 159 defined over an F2^m field. Addition and multiplication operations within an F2^m field are performed using an irreducible polynomial
 160 function f(x). This function is either a trinomial of the form:
 161
 162 f(x) = x^m + x^k + 1 with m > k >= 1
 163
 164 or a pentanomial of the form:
 165
 166 f(x) = x^m + x^k3 + x^k2 + x^k1 + 1 with m > k3 > k2 > k1 >= 1
 167
 168 The function EC_GROUP_get_basis_type returns a NID identifying whether a trinomial or pentanomial is in use for the field. The
 169 function EC_GROUP_get_trinomial_basis must only be called where f(x) is of the trinomial form, and returns the value of B<k>. Similarly
 170 the function EC_GROUP_get_pentanomial_basis must only be called where f(x) is of the pentanomial form, and returns the values of B<k1>,
 171 B<k2> and B<k3> respectively.
 172
 173 =head1 RETURN VALUES
 174
 175 The following functions return 1 on success or 0 on error: EC_GROUP_copy, EC_GROUP_set_generator, EC_GROUP_check,
 176 EC_GROUP_check_discriminant, EC_GROUP_get_trinomial_basis and EC_GROUP_get_pentanomial_basis.
 177
 178 EC_GROUP_dup returns a pointer to the duplicated curve, or NULL on error.
 179
 180 EC_GROUP_method_of returns the EC_METHOD implementation in use for the given curve or NULL on error.
 181
 182 EC_GROUP_get0_generator returns the generator for the given curve or NULL on error.
 183
 184 EC_GROUP_get_order, EC_GROUP_get_cofactor, EC_GROUP_get_curve_name, EC_GROUP_get_asn1_flag, EC_GROUP_get_point_conversion_form
 185 and EC_GROUP_get_degree return the order, cofactor, curve name (NID), ASN1 flag, point_conversion_form and degree for the
 186 specified curve respectively. If there is no curve name associated with a curve then EC_GROUP_get_curve_name will return 0.
 187
 188 EC_GROUP_check_named_curve returns the nid of the matching named curve, otherwise it returns 0 for no match, or -1 on error.
 189
 190 EC_GROUP_get0_order() returns an internal pointer to the group order.
 191 EC_GROUP_order_bits() returns the number of bits in the group order.
 192 EC_GROUP_get0_cofactor() returns an internal pointer to the group cofactor.
 193 EC_GROUP_get0_field() returns an internal pointer to the group field. For curves over GF(p), this is the modulus; for curves
 194 over GF(2^m), this is the irreducible polynomial defining the field.
 195
 196 EC_GROUP_get0_seed returns a pointer to the seed that was used to generate the parameter b, or NULL if the seed is not
 197 specified. EC_GROUP_get_seed_len returns the length of the seed or 0 if the seed is not specified.
 198
 199 EC_GROUP_set_seed returns the length of the seed that has been set. If the supplied seed is NULL, or the supplied seed length is
 200 0, the return value will be 1. On error 0 is returned.
 201
 202 EC_GROUP_cmp returns 0 if the curves are equal, 1 if they are not equal, or -1 on error.
 203
 204 EC_GROUP_get_basis_type returns the values NID_X9_62_tpBasis or NID_X9_62_ppBasis (as defined in <openssl/obj_mac.h>) for a
 205 trinomial or pentanomial respectively. Alternatively in the event of an error a 0 is returned.
 206
 207 =head1 SEE ALSO
 208
 209 L<crypto(7)>, L<EC_GROUP_new(3)>,
 210 L<EC_POINT_new(3)>, L<EC_POINT_add(3)>, L<EC_KEY_new(3)>,
 211 L<EC_GFp_simple_method(3)>, L<d2i_ECPKParameters(3)>
 212
 213 =head1 HISTORY
 214
 215 The EC_GROUP_check_named_curve() function was added in OpenSSL 3.0.
 216
 217 =head1 COPYRIGHT
 218
 219 Copyright 2013-2017 The OpenSSL Project Authors. All Rights Reserved.
 220
 221 Licensed under the Apache License 2.0 (the "License").  You may not use
 222 this file except in compliance with the License.  You can obtain a copy
 223 in the file LICENSE in the source distribution or at
 224 L<https://www.openssl.org/source/license.html>.
 225
 226 =cut