1 /* crypto/ec/ec_lcl.h */
2 /* ====================================================================
3 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * 3. All advertising materials mentioning features or use of this
18 * software must display the following acknowledgment:
19 * "This product includes software developed by the OpenSSL Project
20 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 * endorse or promote products derived from this software without
24 * prior written permission. For written permission, please contact
25 * openssl-core@openssl.org.
27 * 5. Products derived from this software may not be called "OpenSSL"
28 * nor may "OpenSSL" appear in their names without prior written
29 * permission of the OpenSSL Project.
31 * 6. Redistributions of any form whatsoever must retain the following
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
50 * This product includes cryptographic software written by Eric Young
51 * (eay@cryptsoft.com). This product includes software written by Tim
52 * Hudson (tjh@cryptsoft.com).
55 /* ====================================================================
56 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
58 * Portions of the attached software ("Contribution") are developed by
59 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
61 * The Contribution is licensed pursuant to the OpenSSL open source
62 * license provided above.
64 * In addition, Sun covenants to all licensees who provide a reciprocal
65 * covenant with respect to their own patents if any, not to sue under
66 * current and future patent claims necessarily infringed by the making,
67 * using, practicing, selling, offering for sale and/or otherwise
68 * disposing of the Contribution as delivered hereunder
69 * (or portions thereof), provided that such covenant shall not apply:
70 * 1) for code that a licensee deletes from the Contribution;
71 * 2) separates from the Contribution; or
72 * 3) for infringements caused by:
73 * i) the modification of the Contribution or
74 * ii) the combination of the Contribution with other software or
75 * devices where such combination causes the infringement.
77 * The elliptic curve binary polynomial software is originally written by
78 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
85 #include <openssl/obj_mac.h>
86 #include <openssl/ec.h>
89 /* Structure details are not part of the exported interface,
90 * so all this may change in future versions. */
93 /* used by EC_METHOD_get_field_type: */
94 int field_type; /* a NID */
96 /* used by EC_GROUP_new, EC_GROUP_free, EC_GROUP_clear_free, EC_GROUP_copy: */
97 int (*group_init)(EC_GROUP *);
98 void (*group_finish)(EC_GROUP *);
99 void (*group_clear_finish)(EC_GROUP *);
100 int (*group_copy)(EC_GROUP *, const EC_GROUP *);
102 /* used by EC_GROUP_set_curve_GFp, EC_GROUP_get_curve_GFp, */
103 /* EC_GROUP_set_curve_GF2m, and EC_GROUP_get_curve_GF2m: */
104 int (*group_set_curve)(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
105 int (*group_get_curve)(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
107 /* used by EC_GROUP_get_degree: */
108 int (*group_get_degree)(const EC_GROUP *);
110 /* used by EC_GROUP_check: */
111 int (*group_check_discriminant)(const EC_GROUP *, BN_CTX *);
113 /* used by EC_POINT_new, EC_POINT_free, EC_POINT_clear_free, EC_POINT_copy: */
114 int (*point_init)(EC_POINT *);
115 void (*point_finish)(EC_POINT *);
116 void (*point_clear_finish)(EC_POINT *);
117 int (*point_copy)(EC_POINT *, const EC_POINT *);
119 /* used by EC_POINT_set_to_infinity,
120 * EC_POINT_set_Jprojective_coordinates_GFp, EC_POINT_get_Jprojective_coordinates_GFp,
121 * EC_POINT_set_affine_coordinates_GFp, EC_POINT_get_affine_coordinates_GFp,
122 * EC_POINT_set_compressed_coordinates_GFp, EC_POINT_set_Jprojective_coordinates_GF2m,
123 * EC_POINT_get_Jprojective_coordinates_GF2m, EC_POINT_set_affine_coordinates_GF2m,
124 * EC_POINT_get_affine_coordinates_GF2m, and EC_POINT_set_compressed_coordinates_GF2m:
126 int (*point_set_to_infinity)(const EC_GROUP *, EC_POINT *);
127 int (*point_set_Jprojective_coordinates)(const EC_GROUP *, EC_POINT *,
128 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
129 int (*point_get_Jprojective_coordinates)(const EC_GROUP *, const EC_POINT *,
130 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
131 int (*point_set_affine_coordinates)(const EC_GROUP *, EC_POINT *,
132 const BIGNUM *x, const BIGNUM *y, BN_CTX *);
133 int (*point_get_affine_coordinates)(const EC_GROUP *, const EC_POINT *,
134 BIGNUM *x, BIGNUM *y, BN_CTX *);
135 int (*point_set_compressed_coordinates)(const EC_GROUP *, EC_POINT *,
136 const BIGNUM *x, int y_bit, BN_CTX *);
138 /* used by EC_POINT_point2oct, EC_POINT_oct2point: */
139 size_t (*point2oct)(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
140 unsigned char *buf, size_t len, BN_CTX *);
141 int (*oct2point)(const EC_GROUP *, EC_POINT *,
142 const unsigned char *buf, size_t len, BN_CTX *);
144 /* used by EC_POINT_add, EC_POINT_dbl, ECP_POINT_invert: */
145 int (*add)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
146 int (*dbl)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
147 int (*invert)(const EC_GROUP *, EC_POINT *, BN_CTX *);
149 /* used by EC_POINTs_mul, EC_POINT_mul, EC_POINT_precompute_mult: */
150 int (*mul)(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
151 size_t num, const EC_POINT *points[], const BIGNUM *scalars[], BN_CTX *);
152 int (*precompute_mult)(EC_GROUP *group, BN_CTX *);
154 /* used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_cmp: */
155 int (*is_at_infinity)(const EC_GROUP *, const EC_POINT *);
156 int (*is_on_curve)(const EC_GROUP *, const EC_POINT *, BN_CTX *);
157 int (*point_cmp)(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
159 /* used by EC_POINT_make_affine, EC_POINTs_make_affine: */
160 int (*make_affine)(const EC_GROUP *, EC_POINT *, BN_CTX *);
161 int (*points_make_affine)(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
164 /* internal functions */
166 /* 'field_mul', 'field_sqr', and 'field_div' can be used by 'add' and 'dbl' so that
167 * the same implementations of point operations can be used with different
168 * optimized implementations of expensive field operations: */
169 int (*field_mul)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
170 int (*field_sqr)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
171 int (*field_div)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
173 int (*field_encode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. to Montgomery */
174 int (*field_decode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. from Montgomery */
175 int (*field_set_to_one)(const EC_GROUP *, BIGNUM *r, BN_CTX *);
180 const EC_METHOD *meth;
182 EC_POINT *generator; /* optional */
183 BIGNUM order, cofactor;
185 int curve_name;/* optional NID for named curve */
186 int asn1_flag; /* flag to control the asn1 encoding */
187 point_conversion_form_t asn1_form;
189 unsigned char *seed; /* optional seed for parameters (appears in ASN1) */
193 void *(*extra_data_dup_func)(void *);
194 void (*extra_data_free_func)(void *);
195 void (*extra_data_clear_free_func)(void *);
197 /* The following members are handled by the method functions,
198 * even if they appear generic */
200 BIGNUM field; /* Field specification.
201 * For curves over GF(p), this is the modulus;
202 * for curves over GF(2^m), this is the
203 * irreducible polynomial defining the field.
206 unsigned int poly[5]; /* Field specification for curves over GF(2^m).
207 * The irreducible f(t) is then of the form:
208 * t^poly[0] + t^poly[1] + ... + t^poly[k]
209 * where m = poly[0] > poly[1] > ... > poly[k] = 0.
212 BIGNUM a, b; /* Curve coefficients.
213 * (Here the assumption is that BIGNUMs can be used
214 * or abused for all kinds of fields, not just GF(p).)
215 * For characteristic > 3, the curve is defined
216 * by a Weierstrass equation of the form
217 * y^2 = x^3 + a*x + b.
218 * For characteristic 2, the curve is defined by
219 * an equation of the form
220 * y^2 + x*y = x^3 + a*x^2 + b.
223 int a_is_minus3; /* enable optimized point arithmetics for special case */
225 void *field_data1; /* method-specific (e.g., Montgomery structure) */
226 void *field_data2; /* method-specific */
230 /* Basically a 'mixin' for extra data, but available for EC_GROUPs only
231 * (with visibility limited to 'package' level for now).
232 * We use the function pointers as index for retrieval; this obviates
233 * global ex_data-style index tables.
234 * (Currently, we have one slot only, but is is possible to extend this
236 int EC_GROUP_set_extra_data(EC_GROUP *, void *extra_data, void *(*extra_data_dup_func)(void *),
237 void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *));
238 void *EC_GROUP_get_extra_data(const EC_GROUP *, void *(*extra_data_dup_func)(void *),
239 void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *));
240 void EC_GROUP_free_extra_data(EC_GROUP *);
241 void EC_GROUP_clear_free_extra_data(EC_GROUP *);
246 const EC_METHOD *meth;
248 /* All members except 'meth' are handled by the method functions,
249 * even if they appear generic */
253 BIGNUM Z; /* Jacobian projective coordinates:
254 * (X, Y, Z) represents (X/Z^2, Y/Z^3) if Z != 0 */
255 int Z_is_one; /* enable optimized point arithmetics for special case */
260 /* method functions in ec_mult.c */
261 int ec_wNAF_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
262 size_t num, const EC_POINT *points[], const BIGNUM *scalars[], BN_CTX *);
263 int ec_wNAF_precompute_mult(EC_GROUP *group, BN_CTX *);
265 /* method functions in ecp_smpl.c */
266 int ec_GFp_simple_group_init(EC_GROUP *);
267 void ec_GFp_simple_group_finish(EC_GROUP *);
268 void ec_GFp_simple_group_clear_finish(EC_GROUP *);
269 int ec_GFp_simple_group_copy(EC_GROUP *, const EC_GROUP *);
270 int ec_GFp_simple_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
271 int ec_GFp_simple_group_get_curve_GFp(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
272 int ec_GFp_simple_group_get_degree(const EC_GROUP *);
273 int ec_GFp_simple_group_check_discriminant(const EC_GROUP *, BN_CTX *);
274 int ec_GFp_simple_point_init(EC_POINT *);
275 void ec_GFp_simple_point_finish(EC_POINT *);
276 void ec_GFp_simple_point_clear_finish(EC_POINT *);
277 int ec_GFp_simple_point_copy(EC_POINT *, const EC_POINT *);
278 int ec_GFp_simple_point_set_to_infinity(const EC_GROUP *, EC_POINT *);
279 int ec_GFp_simple_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
280 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
281 int ec_GFp_simple_get_Jprojective_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
282 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
283 int ec_GFp_simple_point_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
284 const BIGNUM *x, const BIGNUM *y, BN_CTX *);
285 int ec_GFp_simple_point_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
286 BIGNUM *x, BIGNUM *y, BN_CTX *);
287 int ec_GFp_simple_set_compressed_coordinates_GFp(const EC_GROUP *, EC_POINT *,
288 const BIGNUM *x, int y_bit, BN_CTX *);
289 size_t ec_GFp_simple_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
290 unsigned char *buf, size_t len, BN_CTX *);
291 int ec_GFp_simple_oct2point(const EC_GROUP *, EC_POINT *,
292 const unsigned char *buf, size_t len, BN_CTX *);
293 int ec_GFp_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
294 int ec_GFp_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
295 int ec_GFp_simple_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
296 int ec_GFp_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
297 int ec_GFp_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
298 int ec_GFp_simple_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
299 int ec_GFp_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
300 int ec_GFp_simple_points_make_affine(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
301 int ec_GFp_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
302 int ec_GFp_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
305 /* method functions in ecp_mont.c */
306 int ec_GFp_mont_group_init(EC_GROUP *);
307 int ec_GFp_mont_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
308 void ec_GFp_mont_group_finish(EC_GROUP *);
309 void ec_GFp_mont_group_clear_finish(EC_GROUP *);
310 int ec_GFp_mont_group_copy(EC_GROUP *, const EC_GROUP *);
311 int ec_GFp_mont_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
312 int ec_GFp_mont_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
313 int ec_GFp_mont_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
314 int ec_GFp_mont_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
315 int ec_GFp_mont_field_set_to_one(const EC_GROUP *, BIGNUM *r, BN_CTX *);
318 /* method functions in ecp_recp.c */
319 int ec_GFp_recp_group_init(EC_GROUP *);
320 int ec_GFp_recp_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
321 void ec_GFp_recp_group_finish(EC_GROUP *);
322 void ec_GFp_recp_group_clear_finish(EC_GROUP *);
323 int ec_GFp_recp_group_copy(EC_GROUP *, const EC_GROUP *);
324 int ec_GFp_recp_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
325 int ec_GFp_recp_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
328 /* method functions in ecp_nist.c */
329 int ec_GFp_nist_group_init(EC_GROUP *);
330 int ec_GFp_nist_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
331 void ec_GFp_nist_group_finish(EC_GROUP *);
332 void ec_GFp_nist_group_clear_finish(EC_GROUP *);
333 int ec_GFp_nist_group_copy(EC_GROUP *, const EC_GROUP *);
334 int ec_GFp_nist_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
335 int ec_GFp_nist_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
338 /* method functions in ec2_smpl.c */
339 int ec_GF2m_simple_group_init(EC_GROUP *);
340 void ec_GF2m_simple_group_finish(EC_GROUP *);
341 void ec_GF2m_simple_group_clear_finish(EC_GROUP *);
342 int ec_GF2m_simple_group_copy(EC_GROUP *, const EC_GROUP *);
343 int ec_GF2m_simple_group_set_curve_GF2m(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
344 int ec_GF2m_simple_group_get_curve_GF2m(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
345 int ec_GF2m_simple_group_get_degree(const EC_GROUP *);
346 int ec_GF2m_simple_group_check_discriminant(const EC_GROUP *, BN_CTX *);
347 int ec_GF2m_simple_point_init(EC_POINT *);
348 void ec_GF2m_simple_point_finish(EC_POINT *);
349 void ec_GF2m_simple_point_clear_finish(EC_POINT *);
350 int ec_GF2m_simple_point_copy(EC_POINT *, const EC_POINT *);
351 int ec_GF2m_simple_point_set_to_infinity(const EC_GROUP *, EC_POINT *);
352 int ec_GF2m_simple_point_set_affine_coordinates_GF2m(const EC_GROUP *, EC_POINT *,
353 const BIGNUM *x, const BIGNUM *y, BN_CTX *);
354 int ec_GF2m_simple_point_get_affine_coordinates_GF2m(const EC_GROUP *, const EC_POINT *,
355 BIGNUM *x, BIGNUM *y, BN_CTX *);
356 int ec_GF2m_simple_set_compressed_coordinates_GF2m(const EC_GROUP *, EC_POINT *,
357 const BIGNUM *x, int y_bit, BN_CTX *);
358 size_t ec_GF2m_simple_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
359 unsigned char *buf, size_t len, BN_CTX *);
360 int ec_GF2m_simple_oct2point(const EC_GROUP *, EC_POINT *,
361 const unsigned char *buf, size_t len, BN_CTX *);
362 int ec_GF2m_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
363 int ec_GF2m_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
364 int ec_GF2m_simple_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
365 int ec_GF2m_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
366 int ec_GF2m_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
367 int ec_GF2m_simple_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
368 int ec_GF2m_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
369 int ec_GF2m_simple_points_make_affine(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
370 int ec_GF2m_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
371 int ec_GF2m_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
372 int ec_GF2m_simple_field_div(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
375 /* method functions in ec2_mult.c */
376 int ec_GF2m_mont_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
377 size_t num, const EC_POINT *points[], const BIGNUM *scalars[], BN_CTX *);
378 int ec_GF2m_mont_precompute_mult(EC_GROUP *group, BN_CTX *ctx);