doc/man3/EC_GROUP_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EC_GROUP_get_ecparameters,
   6 EC_GROUP_get_ecpkparameters,
   7 EC_GROUP_new_ex,
   8 EC_GROUP_new,
   9 EC_GROUP_new_from_ecparameters,
  10 EC_GROUP_new_from_ecpkparameters,
  11 EC_GROUP_free,
  12 EC_GROUP_clear_free,
  13 EC_GROUP_new_curve_GFp,
  14 EC_GROUP_new_curve_GF2m,
  15 EC_GROUP_new_by_curve_name_ex,
  16 EC_GROUP_new_by_curve_name,
  17 EC_GROUP_set_curve,
  18 EC_GROUP_get_curve,
  19 EC_GROUP_set_curve_GFp,
  20 EC_GROUP_get_curve_GFp,
  21 EC_GROUP_set_curve_GF2m,
  22 EC_GROUP_get_curve_GF2m,
  23 EC_get_builtin_curves - Functions for creating and destroying EC_GROUP
  24 objects
  25
  26 =head1 SYNOPSIS
  27
  28  #include <openssl/ec.h>
  29
  30  EC_GROUP *EC_GROUP_new_ex(OPENSSL_CTX *libctx, const EC_METHOD *meth);
  31  EC_GROUP *EC_GROUP_new(const EC_METHOD *meth);
  32  EC_GROUP *EC_GROUP_new_from_ecparameters(const ECPARAMETERS *params)
  33  EC_GROUP *EC_GROUP_new_from_ecpkparameters(const ECPKPARAMETERS *params)
  34  void EC_GROUP_free(EC_GROUP *group);
  35
  36  EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a,
  37                                   const BIGNUM *b, BN_CTX *ctx);
  38  EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a,
  39                                    const BIGNUM *b, BN_CTX *ctx);
  40  EC_GROUP *EC_GROUP_new_by_curve_name_ex(OPENSSL_CTX *libctx, int nid);
  41  EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
  42
  43  int EC_GROUP_set_curve(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,
  44                         const BIGNUM *b, BN_CTX *ctx);
  45  int EC_GROUP_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b,
  46                         BN_CTX *ctx);
  47  int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p,
  48                             const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
  49  int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p,
  50                             BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
  51  int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p,
  52                              const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
  53  int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p,
  54                              BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
  55
  56  ECPARAMETERS *EC_GROUP_get_ecparameters(const EC_GROUP *group, ECPARAMETERS *params)
  57  ECPKPARAMETERS *EC_GROUP_get_ecpkparameters(const EC_GROUP *group, ECPKPARAMETERS *params)
  58
  59  size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems);
  60
  61 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  62 B<OPENSSL_API_COMPAT> with a suitable version value, see
  63 L<openssl_user_macros(7)>:
  64
  65  void EC_GROUP_clear_free(EC_GROUP *group);
  66
  67 =head1 DESCRIPTION
  68
  69 Within the library there are two forms of elliptic curve that are of interest. The first form is those defined over the
  70 prime field Fp. The elements of Fp are the integers 0 to p-1, where p is a prime number. This gives us a revised
  71 elliptic curve equation as follows:
  72
  73 y^2 mod p = x^3 +ax + b mod p
  74
  75 The second form is those defined over a binary field F2^m where the elements of the field are integers of length at
  76 most m bits. For this form the elliptic curve equation is modified to:
  77
  78 y^2 + xy = x^3 + ax^2 + b (where b != 0)
  79
  80 Operations in a binary field are performed relative to an B<irreducible polynomial>. All such curves with OpenSSL
  81 use a trinomial or a pentanomial for this parameter.
  82
  83 A new curve can be constructed by calling EC_GROUP_new_ex, using the implementation provided by B<meth> (see
  84 L<EC_GFp_simple_method(3)>) and associated with the library context B<ctx>
  85 (see L<OPENSSL_CTX(3)>).
  86 The B<ctx> parameter may be NULL in which case the default library context is used.
  87 It is then necessary to call EC_GROUP_set_curve() to set the curve parameters.
  88 EC_GROUP_new_from_ecparameters() will create a group from the
  89 specified B<params> and
  90 EC_GROUP_new_from_ecpkparameters() will create a group from the specific PK B<params>.
  91
  92 EC_GROUP_new is the same as EC_GROUP_new_ex() except that the library context
  93 used is always the default library context.
  94
  95 EC_GROUP_set_curve() sets the curve parameters B<p>, B<a> and B<b>. For a curve over Fp B<b>
  96 is the prime for the field. For a curve over F2^m B<p> represents the irreducible polynomial - each bit
  97 represents a term in the polynomial. Therefore there will either be three or five bits set dependent on whether
  98 the polynomial is a trinomial or a pentanomial.
  99
 100 EC_group_get_curve() obtains the previously set curve parameters.
 101
 102 EC_GROUP_set_curve_GFp() and EC_GROUP_set_curve_GF2m() are synonyms for EC_GROUP_set_curve(). They are defined for
 103 backwards compatibility only and should not be used.
 104
 105 EC_GROUP_get_curve_GFp() and EC_GROUP_get_curve_GF2m() are synonyms for EC_GROUP_get_curve(). They are defined for
 106 backwards compatibility only and should not be used.
 107
 108 The functions EC_GROUP_new_curve_GFp and EC_GROUP_new_curve_GF2m are shortcuts for calling EC_GROUP_new and then the
 109 EC_GROUP_set_curve function. An appropriate default implementation method will be used.
 110
 111 Whilst the library can be used to create any curve using the functions described above, there are also a number of
 112 predefined curves that are available. In order to obtain a list of all of the predefined curves, call the function
 113 EC_get_builtin_curves(). The parameter B<r> should be an array of EC_builtin_curve structures of size B<nitems>. The function
 114 will populate the B<r> array with information about the built-in curves. If B<nitems> is less than the total number of
 115 curves available, then the first B<nitems> curves will be returned. Otherwise the total number of curves will be
 116 provided. The return value is the total number of curves available (whether that number has been populated in B<r> or
 117 not). Passing a NULL B<r>, or setting B<nitems> to 0 will do nothing other than return the total number of curves available.
 118 The EC_builtin_curve structure is defined as follows:
 119
 120  typedef struct {
 121         int nid;
 122         const char *comment;
 123         } EC_builtin_curve;
 124
 125 Each EC_builtin_curve item has a unique integer id (B<nid>), and a human readable comment string describing the curve.
 126
 127 In order to construct a built-in curve use the function EC_GROUP_new_by_curve_name_ex and provide the B<nid> of the curve to
 128 be constructed and the associated library context to be used in B<ctx> (see L<OPENSSL_CTX(3)>).
 129 The B<ctx> value may be NULL in which case the default library context is used.
 130
 131 EC_GROUP_new_by_curve_name is the same as EC_GROUP_new_by_curve_name_ex except
 132 that the default library context is always used.
 133
 134 EC_GROUP_free frees the memory associated with the EC_GROUP.
 135 If B<group> is NULL nothing is done.
 136
 137 EC_GROUP_clear_free is deprecated: it was meant to destroy any sensitive data
 138 held within the EC_GROUP and then free its memory, but since all the data stored
 139 in the EC_GROUP is public anyway, this function is unnecessary.
 140 Its use can be safely replaced with EC_GROUP_free.
 141 If B<group> is NULL nothing is done.
 142
 143 =head1 RETURN VALUES
 144
 145 All EC_GROUP_new* functions return a pointer to the newly constructed group, or NULL on error.
 146
 147 EC_get_builtin_curves returns the number of built-in curves that are available.
 148
 149 EC_GROUP_set_curve_GFp, EC_GROUP_get_curve_GFp, EC_GROUP_set_curve_GF2m, EC_GROUP_get_curve_GF2m return 1 on success or 0 on error.
 150
 151 =head1 SEE ALSO
 152
 153 L<crypto(7)>, L<EC_GROUP_copy(3)>,
 154 L<EC_POINT_new(3)>, L<EC_POINT_add(3)>, L<EC_KEY_new(3)>,
 155 L<EC_GFp_simple_method(3)>, L<d2i_ECPKParameters(3)>,
 156 L<OPENSSL_CTX(3)>
 157
 158 =head1 HISTORY
 159
 160 =over 2
 161
 162 =item *
 163
 164 EC_GROUP_new_ex and EC_GROUP_new_by_curve_name_ex were added in OpenSSL 3.0.
 165
 166 =item *
 167
 168 EC_GROUP_clear_free() was deprecated in OpenSSL 3.0; use EC_GROUP_free() instead.
 169
 170 =back
 171
 172 =head1 COPYRIGHT
 173
 174 Copyright 2013-2018 The OpenSSL Project Authors. All Rights Reserved.
 175
 176 Licensed under the Apache License 2.0 (the "License").  You may not use
 177 this file except in compliance with the License.  You can obtain a copy
 178 in the file LICENSE in the source distribution or at
 179 L<https://www.openssl.org/source/license.html>.
 180
 181 =cut