591ba90900de67451016cc00a5c79761f24f08d0
[openssl.git] / doc / crypto / EC_GROUP_copy.pod
1 =pod
2
3 =head1 NAME
4
5 EC_GROUP_copy, EC_GROUP_dup, EC_GROUP_method_of, EC_GROUP_set_generator, EC_GROUP_get0_generator, EC_GROUP_get_order, EC_GROUP_get_cofactor, EC_GROUP_set_curve_name, EC_GROUP_get_curve_name, EC_GROUP_set_asn1_flag, EC_GROUP_get_asn1_flag, EC_GROUP_set_point_conversion_form, EC_GROUP_get_point_conversion_form, EC_GROUP_get0_seed, EC_GROUP_get_seed_len, EC_GROUP_set_seed, EC_GROUP_get_degree, EC_GROUP_check, EC_GROUP_check_discriminant, EC_GROUP_cmp, EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis, EC_GROUP_get_pentanomial_basis - Functions for manipulating B<EC_GROUP> objects.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ec.h>
10  #include <openssl/bn.h>
11
12  int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
13  EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
14
15  const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
16
17  int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
18  const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
19
20  int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
21  int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);
22
23  void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
24  int EC_GROUP_get_curve_name(const EC_GROUP *group);
25
26  void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
27  int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
28
29  void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form);
30  point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
31
32  unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
33  size_t EC_GROUP_get_seed_len(const EC_GROUP *);
34  size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
35
36  int EC_GROUP_get_degree(const EC_GROUP *group);
37
38  int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
39
40  int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
41
42  int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
43
44  int EC_GROUP_get_basis_type(const EC_GROUP *);
45  int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
46  int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1, 
47         unsigned int *k2, unsigned int *k3);
48
49 =head1 DESCRIPTION
50
51 EC_GROUP_copy copies the curve B<src> into B<dst>. Both B<src> and B<dst> must use the same EC_METHOD.
52
53 EC_GROUP_dup creates a new EC_GROUP object and copies the content from B<src> to the newly created
54 EC_GROUP object.
55
56 EC_GROUP_method_of obtains the EC_METHOD of B<group>.
57
58 EC_GROUP_set_generator sets curve paramaters that must be agreed by all participants using the curve. These
59 paramaters include the B<generator>, the B<order> and the B<cofactor>. The B<generator> is a well defined point on the
60 curve chosen for cryptographic operations. Integers used for point multiplications will be between 0 and
61 n-1 where n is the B<order>. The B<order> multiplied by the B<cofactor> gives the number of points on the curve.
62
63 EC_GROUP_get0_generator returns the generator for the identified B<group>.
64
65 The functions EC_GROUP_get_order and EC_GROUP_get_cofactor populate the provided B<order> and B<cofactor> parameters
66 with the respective order and cofactors for the B<group>.
67
68 The functions EC_GROUP_set_curve_name and EC_GROUP_get_curve_name, set and get the NID for the curve respectively
69 (see L<EC_GROUP_new(3)>). If a curve does not have a NID associated with it, then EC_GROUP_get_curve_name
70 will return 0.
71
72 The asn1_flag value is used to determine whether the curve encoding uses
73 explicit parameters or a named curve using an ASN1 OID: many applications only
74 support the latter form. If asn1_flag is B<OPENSSL_EC_NAMED_CURVE> then the
75 named curve form is used and the parameters must have a corresponding
76 named curve NID set. If asn1_flags is B<OPENSSL_EC_EXPLICIT_CURVE> the
77 parameters are explicitly encoded. The functions EC_GROUP_get_asn1_flag and
78 EC_GROUP_set_asn1_flag get and set the status of the asn1_flag for the curve.
79 Note: B<OPENSSL_EC_EXPLICIT_CURVE> was first added to OpenSSL 1.1.0, for
80 previous versions of OpenSSL the value 0 must be used instead. Before OpenSSL
81 1.1.0 the default form was to use explicit parameters (meaning that
82 applications would have to explicitly set the named curve form) in OpenSSL
83 1.1.0 and later the named curve form is the default.
84
85 The point_conversion_form for a curve controls how EC_POINT data is encoded as ASN1 as defined in X9.62 (ECDSA).
86 point_conversion_form_t is an enum defined as follows: 
87
88  typedef enum {
89         /** the point is encoded as z||x, where the octet z specifies 
90          *   which solution of the quadratic equation y is  */
91         POINT_CONVERSION_COMPRESSED = 2,
92         /** the point is encoded as z||x||y, where z is the octet 0x02  */
93         POINT_CONVERSION_UNCOMPRESSED = 4,
94         /** the point is encoded as z||x||y, where the octet z specifies
95          *  which solution of the quadratic equation y is  */
96         POINT_CONVERSION_HYBRID = 6
97  } point_conversion_form_t;
98
99  
100 For POINT_CONVERSION_UNCOMPRESSED the point is encoded as an octet signifying the UNCOMPRESSED form has been used followed by
101 the octets for x, followed by the octets for y.
102
103 For any given x co-ordinate for a point on a curve it is possible to derive two possible y values. For
104 POINT_CONVERSION_COMPRESSED the point is encoded as an octet signifying that the COMPRESSED form has been used AND which of
105 the two possible solutions for y has been used, followed by the octets for x. 
106
107 For POINT_CONVERSION_HYBRID the point is encoded as an octet signifying the HYBRID form has been used AND which of the two
108 possible solutions for y has been used, followed by the octets for x, followed by the octets for y.
109
110 The functions EC_GROUP_set_point_conversion_form and EC_GROUP_get_point_conversion_form set and get the point_conversion_form
111 for the curve respectively.
112
113 ANSI X9.62 (ECDSA standard) defines a method of generating the curve parameter b from a random number. This provides advantages
114 in that a parameter obtained in this way is highly unlikely to be susceptible to special purpose attacks, or have any trapdoors in it.
115 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
116 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
117 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
118 builtin curves within the library provide seed values that can be obtained. It is also possible to set a custom seed using
119 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
120 this seed value, although it will be preserved in any ASN1 based communications.
121
122 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
123 the value m.
124
125 The function EC_GROUP_check_discriminant calculates the discriminant for the curve and verifies that it is valid.
126 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
127 simply b. In either case for the curve to be valid the discriminant must be non zero.
128
129 The function EC_GROUP_check performs a number of checks on a curve to verify that it is valid. Checks performed include
130 verifying that the discriminant is non zero; that a generator has been defined; that the generator is on the curve and has
131 the correct order.
132
133 EC_GROUP_cmp compares B<a> and B<b> to determine whether they represent the same curve or not.
134
135 The functions EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis and EC_GROUP_get_pentanomial_basis should only be called for curves
136 defined over an F2^m field. Addition and multiplication operations within an F2^m field are performed using an irreducible polynomial
137 function f(x). This function is either a trinomial of the form:
138
139 f(x) = x^m + x^k + 1 with m > k >= 1
140
141 or a pentanomial of the form:
142
143 f(x) = x^m + x^k3 + x^k2 + x^k1 + 1 with m > k3 > k2 > k1 >= 1
144
145 The function EC_GROUP_get_basis_type returns a NID identifying whether a trinomial or pentanomial is in use for the field. The
146 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
147 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>,
148 B<k2> and B<k3> respectively.
149
150 =head1 RETURN VALUES
151
152 The following functions return 1 on success or 0 on error: EC_GROUP_copy, EC_GROUP_set_generator, EC_GROUP_check,
153 EC_GROUP_check_discriminant, EC_GROUP_get_trinomial_basis and EC_GROUP_get_pentanomial_basis.
154
155 EC_GROUP_dup returns a pointer to the duplicated curve, or NULL on error.
156
157 EC_GROUP_method_of returns the EC_METHOD implementation in use for the given curve or NULL on error.
158
159 EC_GROUP_get0_generator returns the generator for the given curve or NULL on error.
160
161 EC_GROUP_get_order, EC_GROUP_get_cofactor, EC_GROUP_get_curve_name, EC_GROUP_get_asn1_flag, EC_GROUP_get_point_conversion_form
162 and EC_GROUP_get_degree return the order, cofactor, curve name (NID), ASN1 flag, point_conversion_form and degree for the
163 specified curve respectively. If there is no curve name associated with a curve then EC_GROUP_get_curve_name will return 0.
164
165 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
166 specified. EC_GROUP_get_seed_len returns the length of the seed or 0 if the seed is not specified.
167
168 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
169 0, the the return value will be 1. On error 0 is returned.
170
171 EC_GROUP_cmp returns 0 if the curves are equal, 1 if they are not equal, or -1 on error.
172
173 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
174 trinomial or pentanomial respectively. Alternatively in the event of an error a 0 is returned.
175
176 =head1 SEE ALSO
177
178 L<crypto(3)>, L<ec(3)>, L<EC_GROUP_new(3)>,
179 L<EC_POINT_new(3)>, L<EC_POINT_add(3)>, L<EC_KEY_new(3)>,
180 L<EC_GFp_simple_method(3)>, L<d2i_ECPKParameters(3)>
181
182 =cut