]>
Commit | Line | Data |
---|---|---|
aafbe1cc MC |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
c952780c | 5 | EC_GROUP_get_ecparameters, EC_GROUP_get_ecpkparameters, |
60b350a3 RS |
6 | EC_GROUP_new, EC_GROUP_new_from_ecparameters, |
7 | EC_GROUP_new_from_ecpkparameters, | |
8 | EC_GROUP_free, EC_GROUP_clear_free, EC_GROUP_new_curve_GFp, | |
9 | EC_GROUP_new_curve_GF2m, EC_GROUP_new_by_curve_name, EC_GROUP_set_curve_GFp, | |
10 | EC_GROUP_get_curve_GFp, EC_GROUP_set_curve_GF2m, EC_GROUP_get_curve_GF2m, | |
bb9ad09e RS |
11 | EC_get_builtin_curves - Functions for creating and destroying EC_GROUP |
12 | objects | |
aafbe1cc MC |
13 | |
14 | =head1 SYNOPSIS | |
15 | ||
16 | #include <openssl/ec.h> | |
aafbe1cc MC |
17 | |
18 | EC_GROUP *EC_GROUP_new(const EC_METHOD *meth); | |
60b350a3 RS |
19 | EC_GROUP *EC_GROUP_new_from_ecparameters(const ECPARAMETERS *params) |
20 | EC_GROUP *EC_GROUP_new_from_ecpkparameters(const ECPKPARAMETERS *params) | |
aafbe1cc MC |
21 | void EC_GROUP_free(EC_GROUP *group); |
22 | void EC_GROUP_clear_free(EC_GROUP *group); | |
23 | ||
e9b77246 BB |
24 | EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, |
25 | const BIGNUM *b, BN_CTX *ctx); | |
26 | EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a, | |
27 | const BIGNUM *b, BN_CTX *ctx); | |
aafbe1cc MC |
28 | EC_GROUP *EC_GROUP_new_by_curve_name(int nid); |
29 | ||
e9b77246 BB |
30 | int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, |
31 | const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); | |
32 | int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, | |
33 | BIGNUM *a, BIGNUM *b, BN_CTX *ctx); | |
34 | int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, | |
35 | const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); | |
36 | int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, | |
37 | BIGNUM *a, BIGNUM *b, BN_CTX *ctx); | |
aafbe1cc | 38 | |
60b350a3 RS |
39 | ECPARAMETERS *EC_GROUP_get_ecparameters(const EC_GROUP *group, ECPARAMETERS *params) |
40 | ECPKPARAMETERS *EC_GROUP_get_ecpkparameters(const EC_GROUP *group, ECPKPARAMETERS *params) | |
41 | ||
aafbe1cc MC |
42 | size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems); |
43 | ||
44 | =head1 DESCRIPTION | |
45 | ||
46 | Within the library there are two forms of elliptic curve that are of interest. The first form is those defined over the | |
47 | 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 | |
48 | elliptic curve equation as follows: | |
49 | ||
50 | y^2 mod p = x^3 +ax + b mod p | |
51 | ||
52 | The second form is those defined over a binary field F2^m where the elements of the field are integers of length at | |
53 | most m bits. For this form the elliptic curve equation is modified to: | |
54 | ||
55 | y^2 + xy = x^3 + ax^2 + b (where b != 0) | |
56 | ||
57 | Operations in a binary field are performed relative to an B<irreducible polynomial>. All such curves with OpenSSL | |
58 | use a trinomial or a pentanomial for this parameter. | |
59 | ||
60 | A new curve can be constructed by calling EC_GROUP_new, using the implementation provided by B<meth> (see | |
9b86974e | 61 | L<EC_GFp_simple_method(3)>). It is then necessary to call either EC_GROUP_set_curve_GFp or |
186bb907 | 62 | EC_GROUP_set_curve_GF2m as appropriate to create a curve defined over Fp or over F2^m respectively. |
60b350a3 RS |
63 | EC_GROUP_new_from_ecparameters() will create a group from the |
64 | specified B<params> and | |
65 | EC_GROUP_new_from_ecpkparameters() will create a group from the specific PK B<params>. | |
aafbe1cc MC |
66 | |
67 | EC_GROUP_set_curve_GFp sets the curve parameters B<p>, B<a> and B<b> for a curve over Fp stored in B<group>. | |
68 | EC_group_get_curve_GFp obtains the previously set curve parameters. | |
69 | ||
70 | EC_GROUP_set_curve_GF2m sets the equivalent curve parameters for a curve over F2^m. In this case B<p> represents | |
186bb907 AM |
71 | the irreducible polynomial - each bit represents a term in the polynomial. Therefore there will either be three |
72 | or five bits set dependent on whether the polynomial is a trinomial or a pentanomial. | |
aafbe1cc MC |
73 | EC_group_get_curve_GF2m obtains the previously set curve parameters. |
74 | ||
75 | The functions EC_GROUP_new_curve_GFp and EC_GROUP_new_curve_GF2m are shortcuts for calling EC_GROUP_new and the | |
76 | appropriate EC_group_set_curve function. An appropriate default implementation method will be used. | |
77 | ||
78 | Whilst the library can be used to create any curve using the functions described above, there are also a number of | |
79 | predefined curves that are available. In order to obtain a list of all of the predefined curves, call the function | |
80 | EC_get_builtin_curves. The parameter B<r> should be an array of EC_builtin_curve structures of size B<nitems>. The function | |
81 | will populate the B<r> array with information about the builtin curves. If B<nitems> is less than the total number of | |
82 | curves available, then the first B<nitems> curves will be returned. Otherwise the total number of curves will be | |
83 | provided. The return value is the total number of curves available (whether that number has been populated in B<r> or | |
84 | not). Passing a NULL B<r>, or setting B<nitems> to 0 will do nothing other than return the total number of curves available. | |
85 | The EC_builtin_curve structure is defined as follows: | |
86 | ||
1bc74519 RS |
87 | typedef struct { |
88 | int nid; | |
89 | const char *comment; | |
90 | } EC_builtin_curve; | |
aafbe1cc MC |
91 | |
92 | Each EC_builtin_curve item has a unique integer id (B<nid>), and a human readable comment string describing the curve. | |
93 | ||
94 | In order to construct a builtin curve use the function EC_GROUP_new_by_curve_name and provide the B<nid> of the curve to | |
95 | be constructed. | |
96 | ||
97 | EC_GROUP_free frees the memory associated with the EC_GROUP. | |
8fdc3734 | 98 | If B<group> is NULL nothing is done. |
aafbe1cc MC |
99 | |
100 | EC_GROUP_clear_free destroys any sensitive data held within the EC_GROUP and then frees its memory. | |
8fdc3734 | 101 | If B<group> is NULL nothing is done. |
aafbe1cc MC |
102 | |
103 | =head1 RETURN VALUES | |
104 | ||
105 | All EC_GROUP_new* functions return a pointer to the newly constructed group, or NULL on error. | |
106 | ||
107 | EC_get_builtin_curves returns the number of builtin curves that are available. | |
108 | ||
109 | 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. | |
110 | ||
111 | =head1 SEE ALSO | |
112 | ||
9e183d22 | 113 | L<crypto(7)>, L<EC_GROUP_copy(3)>, |
9b86974e RS |
114 | L<EC_POINT_new(3)>, L<EC_POINT_add(3)>, L<EC_KEY_new(3)>, |
115 | L<EC_GFp_simple_method(3)>, L<d2i_ECPKParameters(3)> | |
aafbe1cc | 116 | |
e2f92610 RS |
117 | =head1 COPYRIGHT |
118 | ||
9e183d22 | 119 | Copyright 2013-2017 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 RS |
120 | |
121 | Licensed under the OpenSSL license (the "License"). You may not use | |
122 | this file except in compliance with the License. You can obtain a copy | |
123 | in the file LICENSE in the source distribution or at | |
124 | L<https://www.openssl.org/source/license.html>. | |
125 | ||
126 | =cut |