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 *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                                 BN_CTX *ctx);
  56
  57  int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
  58
  59  int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
  60
  61  int EC_GROUP_get_basis_type(const EC_GROUP *);
  62  int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
  63  int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1,
  64                                     unsigned int *k2, unsigned int *k3);
  65
  66 =head1 DESCRIPTION
  67
  68 EC_GROUP_copy() copies the curve B<src> into B<dst>. Both B<src> and B<dst> must use the same EC_METHOD.
  69
  70 EC_GROUP_dup() creates a new EC_GROUP object and copies the content from B<src> to the newly created
  71 EC_GROUP object.
  72
  73 EC_GROUP_method_of() obtains the EC_METHOD of B<group>.
  74
  75 EC_GROUP_set_generator() sets curve parameters that must be agreed by all participants using the curve. These
  76 parameters include the B<generator>, the B<order> and the B<cofactor>. The B<generator> is a well defined point on the
  77 curve chosen for cryptographic operations. Integers used for point multiplications will be between 0 and
  78 n-1 where n is the B<order>. The B<order> multiplied by the B<cofactor> gives the number of points on the curve.
  79
  80 EC_GROUP_get0_generator() returns the generator for the identified B<group>.
  81
  82 EC_GROUP_get_order() retrieves the order of B<group> and copies its value into
  83 B<order>.  It fails in case B<group> is not fully initialized (i.e., its order
  84 is not set or set to zero).
  85
  86 EC_GROUP_get_cofactor() retrieves the cofactor of B<group> and copies its value
  87 into B<cofactor>. It fails in case  B<group> is not fully initialized or if the
  88 cofactor is not set (or set to zero).
  89
  90 The functions EC_GROUP_set_curve_name() and EC_GROUP_get_curve_name(), set and get the NID for the curve respectively
  91 (see L<EC_GROUP_new(3)>). If a curve does not have a NID associated with it, then EC_GROUP_get_curve_name
  92 will return NID_undef.
  93
  94 The asn1_flag value is used to determine whether the curve encoding uses
  95 explicit parameters or a named curve using an ASN1 OID: many applications only
  96 support the latter form. If asn1_flag is B<OPENSSL_EC_NAMED_CURVE> then the
  97 named curve form is used and the parameters must have a corresponding
  98 named curve NID set. If asn1_flags is B<OPENSSL_EC_EXPLICIT_CURVE> the
  99 parameters are explicitly encoded. The functions EC_GROUP_get_asn1_flag() and
 100 EC_GROUP_set_asn1_flag() get and set the status of the asn1_flag for the curve.
 101 Note: B<OPENSSL_EC_EXPLICIT_CURVE> was added in OpenSSL 1.1.0, for
 102 previous versions of OpenSSL the value 0 must be used instead. Before OpenSSL
 103 1.1.0 the default form was to use explicit parameters (meaning that
 104 applications would have to explicitly set the named curve form) in OpenSSL
 105 1.1.0 and later the named curve form is the default.
 106
 107 The point_conversion_form for a curve controls how EC_POINT data is encoded as ASN1 as defined in X9.62 (ECDSA).
 108 point_conversion_form_t is an enum defined as follows:
 109
 110  typedef enum {
 111         /** the point is encoded as z||x, where the octet z specifies
 112          *   which solution of the quadratic equation y is  */
 113         POINT_CONVERSION_COMPRESSED = 2,
 114         /** the point is encoded as z||x||y, where z is the octet 0x04  */
 115         POINT_CONVERSION_UNCOMPRESSED = 4,
 116         /** the point is encoded as z||x||y, where the octet z specifies
 117          *  which solution of the quadratic equation y is  */
 118         POINT_CONVERSION_HYBRID = 6
 119  } point_conversion_form_t;
 120
 121 For POINT_CONVERSION_UNCOMPRESSED the point is encoded as an octet signifying the UNCOMPRESSED form has been used followed by
 122 the octets for x, followed by the octets for y.
 123
 124 For any given x co-ordinate for a point on a curve it is possible to derive two possible y values. For
 125 POINT_CONVERSION_COMPRESSED the point is encoded as an octet signifying that the COMPRESSED form has been used AND which of
 126 the two possible solutions for y has been used, followed by the octets for x.
 127
 128 For POINT_CONVERSION_HYBRID the point is encoded as an octet signifying the HYBRID form has been used AND which of the two
 129 possible solutions for y has been used, followed by the octets for x, followed by the octets for y.
 130
 131 The functions EC_GROUP_set_point_conversion_form() and EC_GROUP_get_point_conversion_form(), set and get the point_conversion_form
 132 for the curve respectively.
 133
 134 ANSI X9.62 (ECDSA standard) defines a method of generating the curve parameter b from a random number. This provides advantages
 135 in that a parameter obtained in this way is highly unlikely to be susceptible to special purpose attacks, or have any trapdoors in it.
 136 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
 137 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
 138 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
 139 built-in curves within the library provide seed values that can be obtained. It is also possible to set a custom seed using
 140 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
 141 this seed value, although it will be preserved in any ASN1 based communications.
 142
 143 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
 144 the value m.
 145
 146 The function EC_GROUP_check_discriminant() calculates the discriminant for the curve and verifies that it is valid.
 147 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
 148 simply b. In either case for the curve to be valid the discriminant must be non zero.
 149
 150 The function EC_GROUP_check() performs a number of checks on a curve to verify that it is valid. Checks performed include
 151 verifying that the discriminant is non zero; that a generator has been defined; that the generator is on the curve and has
 152 the correct order.
 153
 154 The function EC_GROUP_check_named_curve() determines if the group's domain parameters match one of the built-in curves supported by the library.
 155 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.
 156 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),
 157 then this method can be used to lookup the name of the curve that matches the group domain parameters. The built-in curves contain
 158 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
 159 returned if the curve name of the given group is NID_undef.
 160 If B<nist_only> is 1 it will only look for NIST approved curves, otherwise it searches all built-in curves.
 161 This function may be passed a BN_CTX object in the B<ctx> parameter.
 162 The B<ctx> parameter may be NULL.
 163
 164 EC_GROUP_cmp() compares B<a> and B<b> to determine whether they represent the same curve or not.
 165
 166 The functions EC_GROUP_get_basis_type(), EC_GROUP_get_trinomial_basis() and EC_GROUP_get_pentanomial_basis() should only be called for curves
 167 defined over an F2^m field. Addition and multiplication operations within an F2^m field are performed using an irreducible polynomial
 168 function f(x). This function is either a trinomial of the form:
 169
 170 f(x) = x^m + x^k + 1 with m > k >= 1
 171
 172 or a pentanomial of the form:
 173
 174 f(x) = x^m + x^k3 + x^k2 + x^k1 + 1 with m > k3 > k2 > k1 >= 1
 175
 176 The function EC_GROUP_get_basis_type() returns a NID identifying whether a trinomial or pentanomial is in use for the field. The
 177 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
 178 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>,
 179 B<k2> and B<k3> respectively.
 180
 181 =head1 RETURN VALUES
 182
 183 The following functions return 1 on success or 0 on error: EC_GROUP_copy(), EC_GROUP_set_generator(), EC_GROUP_check(),
 184 EC_GROUP_check_discriminant(), EC_GROUP_get_trinomial_basis() and EC_GROUP_get_pentanomial_basis().
 185
 186 EC_GROUP_dup() returns a pointer to the duplicated curve, or NULL on error.
 187
 188 EC_GROUP_method_of() returns the EC_METHOD implementation in use for the given curve or NULL on error.
 189
 190 EC_GROUP_get0_generator() returns the generator for the given curve or NULL on error.
 191
 192 EC_GROUP_get_order() returns 0 if the order is not set (or set to zero) for
 193 B<group> or if copying into B<order> fails, 1 otherwise.
 194
 195 EC_GROUP_get_cofactor() returns 0 if the cofactor is not set (or is set to zero) for B<group> or if copying into B<cofactor> fails, 1 otherwise.
 196
 197 EC_GROUP_get_curve_name() returns the curve name (NID) for B<group> or will return NID_undef if no curve name is associated.
 198
 199 EC_GROUP_get_asn1_flag() returns the ASN1 flag for the specified B<group> .
 200
 201 EC_GROUP_get_point_conversion_form() returns the point_conversion_form for B<group>.
 202
 203 EC_GROUP_get_degree() returns the degree for B<group> or 0 if the operation is not supported by the underlying group implementation.
 204
 205 EC_GROUP_check_named_curve() returns the nid of the matching named curve, otherwise it returns 0 for no match, or -1 on error.
 206
 207 EC_GROUP_get0_order() returns an internal pointer to the group order.
 208 EC_GROUP_order_bits() returns the number of bits in the group order.
 209 EC_GROUP_get0_cofactor() returns an internal pointer to the group cofactor.
 210 EC_GROUP_get0_field() returns an internal pointer to the group field. For curves over GF(p), this is the modulus; for curves
 211 over GF(2^m), this is the irreducible polynomial defining the field.
 212
 213 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
 214 specified. EC_GROUP_get_seed_len() returns the length of the seed or 0 if the seed is not specified.
 215
 216 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
 217 0, the return value will be 1. On error 0 is returned.
 218
 219 EC_GROUP_cmp() returns 0 if the curves are equal, 1 if they are not equal, or -1 on error.
 220
 221 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
 222 trinomial or pentanomial respectively. Alternatively in the event of an error a 0 is returned.
 223
 224 =head1 SEE ALSO
 225
 226 L<crypto(7)>, L<EC_GROUP_new(3)>,
 227 L<EC_POINT_new(3)>, L<EC_POINT_add(3)>, L<EC_KEY_new(3)>,
 228 L<EC_GFp_simple_method(3)>, L<d2i_ECPKParameters(3)>
 229
 230 =head1 HISTORY
 231
 232 The EC_GROUP_check_named_curve() function was added in OpenSSL 3.0.
 233
 234 =head1 COPYRIGHT
 235
 236 Copyright 2013-2019 The OpenSSL Project Authors. All Rights Reserved.
 237
 238 Licensed under the Apache License 2.0 (the "License").  You may not use
 239 this file except in compliance with the License.  You can obtain a copy
 240 in the file LICENSE in the source distribution or at
 241 L<https://www.openssl.org/source/license.html>.
 242
 243 =cut