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