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