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