SCA hardening for mod. field inversion in EC_GROUP
[openssl.git] / crypto / ec / ec_lcl.h
1 /*
2  * Copyright 2001-2019 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* ====================================================================
11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12  *
13  * Portions of the attached software ("Contribution") are developed by
14  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
15  *
16  * The Contribution is licensed pursuant to the OpenSSL open source
17  * license provided above.
18  *
19  * The elliptic curve binary polynomial software is originally written by
20  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
21  *
22  */
23
24 #include <stdlib.h>
25
26 #include <openssl/obj_mac.h>
27 #include <openssl/ec.h>
28 #include <openssl/bn.h>
29
30 #include "e_os.h"
31
32 #if defined(__SUNPRO_C)
33 # if __SUNPRO_C >= 0x520
34 #  pragma error_messages (off,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
35 # endif
36 #endif
37
38 /* Use default functions for poin2oct, oct2point and compressed coordinates */
39 #define EC_FLAGS_DEFAULT_OCT    0x1
40
41 /* Use custom formats for EC_GROUP, EC_POINT and EC_KEY */
42 #define EC_FLAGS_CUSTOM_CURVE   0x2
43
44 /* Curve does not support signing operations */
45 #define EC_FLAGS_NO_SIGN        0x4
46
47 /*
48  * Structure details are not part of the exported interface, so all this may
49  * change in future versions.
50  */
51
52 struct ec_method_st {
53     /* Various method flags */
54     int flags;
55     /* used by EC_METHOD_get_field_type: */
56     int field_type;             /* a NID */
57     /*
58      * used by EC_GROUP_new, EC_GROUP_free, EC_GROUP_clear_free,
59      * EC_GROUP_copy:
60      */
61     int (*group_init) (EC_GROUP *);
62     void (*group_finish) (EC_GROUP *);
63     void (*group_clear_finish) (EC_GROUP *);
64     int (*group_copy) (EC_GROUP *, const EC_GROUP *);
65     /* used by EC_GROUP_set_curve_GFp, EC_GROUP_get_curve_GFp, */
66     /* EC_GROUP_set_curve_GF2m, and EC_GROUP_get_curve_GF2m: */
67     int (*group_set_curve) (EC_GROUP *, const BIGNUM *p, const BIGNUM *a,
68                             const BIGNUM *b, BN_CTX *);
69     int (*group_get_curve) (const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b,
70                             BN_CTX *);
71     /* used by EC_GROUP_get_degree: */
72     int (*group_get_degree) (const EC_GROUP *);
73     int (*group_order_bits) (const EC_GROUP *);
74     /* used by EC_GROUP_check: */
75     int (*group_check_discriminant) (const EC_GROUP *, BN_CTX *);
76     /*
77      * used by EC_POINT_new, EC_POINT_free, EC_POINT_clear_free,
78      * EC_POINT_copy:
79      */
80     int (*point_init) (EC_POINT *);
81     void (*point_finish) (EC_POINT *);
82     void (*point_clear_finish) (EC_POINT *);
83     int (*point_copy) (EC_POINT *, const EC_POINT *);
84     /*-
85      * used by EC_POINT_set_to_infinity,
86      * EC_POINT_set_Jprojective_coordinates_GFp,
87      * EC_POINT_get_Jprojective_coordinates_GFp,
88      * EC_POINT_set_affine_coordinates_GFp,     ..._GF2m,
89      * EC_POINT_get_affine_coordinates_GFp,     ..._GF2m,
90      * EC_POINT_set_compressed_coordinates_GFp, ..._GF2m:
91      */
92     int (*point_set_to_infinity) (const EC_GROUP *, EC_POINT *);
93     int (*point_set_Jprojective_coordinates_GFp) (const EC_GROUP *,
94                                                   EC_POINT *, const BIGNUM *x,
95                                                   const BIGNUM *y,
96                                                   const BIGNUM *z, BN_CTX *);
97     int (*point_get_Jprojective_coordinates_GFp) (const EC_GROUP *,
98                                                   const EC_POINT *, BIGNUM *x,
99                                                   BIGNUM *y, BIGNUM *z,
100                                                   BN_CTX *);
101     int (*point_set_affine_coordinates) (const EC_GROUP *, EC_POINT *,
102                                          const BIGNUM *x, const BIGNUM *y,
103                                          BN_CTX *);
104     int (*point_get_affine_coordinates) (const EC_GROUP *, const EC_POINT *,
105                                          BIGNUM *x, BIGNUM *y, BN_CTX *);
106     int (*point_set_compressed_coordinates) (const EC_GROUP *, EC_POINT *,
107                                              const BIGNUM *x, int y_bit,
108                                              BN_CTX *);
109     /* used by EC_POINT_point2oct, EC_POINT_oct2point: */
110     size_t (*point2oct) (const EC_GROUP *, const EC_POINT *,
111                          point_conversion_form_t form, unsigned char *buf,
112                          size_t len, BN_CTX *);
113     int (*oct2point) (const EC_GROUP *, EC_POINT *, const unsigned char *buf,
114                       size_t len, BN_CTX *);
115     /* used by EC_POINT_add, EC_POINT_dbl, ECP_POINT_invert: */
116     int (*add) (const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
117                 const EC_POINT *b, BN_CTX *);
118     int (*dbl) (const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
119     int (*invert) (const EC_GROUP *, EC_POINT *, BN_CTX *);
120     /*
121      * used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_cmp:
122      */
123     int (*is_at_infinity) (const EC_GROUP *, const EC_POINT *);
124     int (*is_on_curve) (const EC_GROUP *, const EC_POINT *, BN_CTX *);
125     int (*point_cmp) (const EC_GROUP *, const EC_POINT *a, const EC_POINT *b,
126                       BN_CTX *);
127     /* used by EC_POINT_make_affine, EC_POINTs_make_affine: */
128     int (*make_affine) (const EC_GROUP *, EC_POINT *, BN_CTX *);
129     int (*points_make_affine) (const EC_GROUP *, size_t num, EC_POINT *[],
130                                BN_CTX *);
131     /*
132      * used by EC_POINTs_mul, EC_POINT_mul, EC_POINT_precompute_mult,
133      * EC_POINT_have_precompute_mult (default implementations are used if the
134      * 'mul' pointer is 0):
135      */
136     int (*mul) (const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
137                 size_t num, const EC_POINT *points[], const BIGNUM *scalars[],
138                 BN_CTX *);
139     int (*precompute_mult) (EC_GROUP *group, BN_CTX *);
140     int (*have_precompute_mult) (const EC_GROUP *group);
141     /* internal functions */
142     /*
143      * 'field_mul', 'field_sqr', and 'field_div' can be used by 'add' and
144      * 'dbl' so that the same implementations of point operations can be used
145      * with different optimized implementations of expensive field
146      * operations:
147      */
148     int (*field_mul) (const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
149                       const BIGNUM *b, BN_CTX *);
150     int (*field_sqr) (const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
151     int (*field_div) (const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
152                       const BIGNUM *b, BN_CTX *);
153     /*-
154      * 'field_inv' computes the multipicative inverse of a in the field,
155      * storing the result in r.
156      *
157      * If 'a' is zero (or equivalent), you'll get an EC_R_CANNOT_INVERT error.
158      */
159     int (*field_inv) (const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
160     /* e.g. to Montgomery */
161     int (*field_encode) (const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
162                          BN_CTX *);
163     /* e.g. from Montgomery */
164     int (*field_decode) (const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
165                          BN_CTX *);
166     int (*field_set_to_one) (const EC_GROUP *, BIGNUM *r, BN_CTX *);
167     /* private key operations */
168     size_t (*priv2oct)(const EC_KEY *eckey, unsigned char *buf, size_t len);
169     int (*oct2priv)(EC_KEY *eckey, const unsigned char *buf, size_t len);
170     int (*set_private)(EC_KEY *eckey, const BIGNUM *priv_key);
171     int (*keygen)(EC_KEY *eckey);
172     int (*keycheck)(const EC_KEY *eckey);
173     int (*keygenpub)(EC_KEY *eckey);
174     int (*keycopy)(EC_KEY *dst, const EC_KEY *src);
175     void (*keyfinish)(EC_KEY *eckey);
176     /* custom ECDH operation */
177     int (*ecdh_compute_key)(unsigned char **pout, size_t *poutlen,
178                             const EC_POINT *pub_key, const EC_KEY *ecdh);
179     int (*blind_coordinates)(const EC_GROUP *group, EC_POINT *p, BN_CTX *ctx);
180 };
181
182 /*
183  * Types and functions to manipulate pre-computed values.
184  */
185 typedef struct nistp224_pre_comp_st NISTP224_PRE_COMP;
186 typedef struct nistp256_pre_comp_st NISTP256_PRE_COMP;
187 typedef struct nistp521_pre_comp_st NISTP521_PRE_COMP;
188 typedef struct nistz256_pre_comp_st NISTZ256_PRE_COMP;
189 typedef struct ec_pre_comp_st EC_PRE_COMP;
190
191 struct ec_group_st {
192     const EC_METHOD *meth;
193     EC_POINT *generator;        /* optional */
194     BIGNUM *order, *cofactor;
195     int curve_name;             /* optional NID for named curve */
196     int asn1_flag;              /* flag to control the asn1 encoding */
197     point_conversion_form_t asn1_form;
198     unsigned char *seed;        /* optional seed for parameters (appears in
199                                  * ASN1) */
200     size_t seed_len;
201     /*
202      * The following members are handled by the method functions, even if
203      * they appear generic
204      */
205     /*
206      * Field specification. For curves over GF(p), this is the modulus; for
207      * curves over GF(2^m), this is the irreducible polynomial defining the
208      * field.
209      */
210     BIGNUM *field;
211     /*
212      * Field specification for curves over GF(2^m). The irreducible f(t) is
213      * then of the form: t^poly[0] + t^poly[1] + ... + t^poly[k] where m =
214      * poly[0] > poly[1] > ... > poly[k] = 0. The array is terminated with
215      * poly[k+1]=-1. All elliptic curve irreducibles have at most 5 non-zero
216      * terms.
217      */
218     int poly[6];
219     /*
220      * Curve coefficients. (Here the assumption is that BIGNUMs can be used
221      * or abused for all kinds of fields, not just GF(p).) For characteristic
222      * > 3, the curve is defined by a Weierstrass equation of the form y^2 =
223      * x^3 + a*x + b. For characteristic 2, the curve is defined by an
224      * equation of the form y^2 + x*y = x^3 + a*x^2 + b.
225      */
226     BIGNUM *a, *b;
227     /* enable optimized point arithmetics for special case */
228     int a_is_minus3;
229     /* method-specific (e.g., Montgomery structure) */
230     void *field_data1;
231     /* method-specific */
232     void *field_data2;
233     /* method-specific */
234     int (*field_mod_func) (BIGNUM *, const BIGNUM *, const BIGNUM *,
235                            BN_CTX *);
236     /* data for ECDSA inverse */
237     BN_MONT_CTX *mont_data;
238
239     /*
240      * Precomputed values for speed. The PCT_xxx names match the
241      * pre_comp.xxx union names; see the SETPRECOMP and HAVEPRECOMP
242      * macros, below.
243      */
244     enum {
245         PCT_none,
246         PCT_nistp224, PCT_nistp256, PCT_nistp521, PCT_nistz256,
247         PCT_ec
248     } pre_comp_type;
249     union {
250         NISTP224_PRE_COMP *nistp224;
251         NISTP256_PRE_COMP *nistp256;
252         NISTP521_PRE_COMP *nistp521;
253         NISTZ256_PRE_COMP *nistz256;
254         EC_PRE_COMP *ec;
255     } pre_comp;
256 };
257
258 #define SETPRECOMP(g, type, pre) \
259     g->pre_comp_type = PCT_##type, g->pre_comp.type = pre
260 #define HAVEPRECOMP(g, type) \
261     g->pre_comp_type == PCT_##type && g->pre_comp.type != NULL
262
263 struct ec_key_st {
264     const EC_KEY_METHOD *meth;
265     ENGINE *engine;
266     int version;
267     EC_GROUP *group;
268     EC_POINT *pub_key;
269     BIGNUM *priv_key;
270     unsigned int enc_flag;
271     point_conversion_form_t conv_form;
272     int references;
273     int flags;
274     CRYPTO_EX_DATA ex_data;
275     CRYPTO_RWLOCK *lock;
276 };
277
278 struct ec_point_st {
279     const EC_METHOD *meth;
280     /* NID for the curve if known */
281     int curve_name;
282     /*
283      * All members except 'meth' are handled by the method functions, even if
284      * they appear generic
285      */
286     BIGNUM *X;
287     BIGNUM *Y;
288     BIGNUM *Z;                  /* Jacobian projective coordinates: * (X, Y,
289                                  * Z) represents (X/Z^2, Y/Z^3) if Z != 0 */
290     int Z_is_one;               /* enable optimized point arithmetics for
291                                  * special case */
292 };
293
294
295 static ossl_inline int ec_point_is_compat(const EC_POINT *point,
296                                           const EC_GROUP *group)
297 {
298     if (group->meth != point->meth
299         || (group->curve_name != 0
300             && point->curve_name != 0
301             && group->curve_name != point->curve_name))
302         return 0;
303
304     return 1;
305 }
306
307
308 NISTP224_PRE_COMP *EC_nistp224_pre_comp_dup(NISTP224_PRE_COMP *);
309 NISTP256_PRE_COMP *EC_nistp256_pre_comp_dup(NISTP256_PRE_COMP *);
310 NISTP521_PRE_COMP *EC_nistp521_pre_comp_dup(NISTP521_PRE_COMP *);
311 NISTZ256_PRE_COMP *EC_nistz256_pre_comp_dup(NISTZ256_PRE_COMP *);
312 NISTP256_PRE_COMP *EC_nistp256_pre_comp_dup(NISTP256_PRE_COMP *);
313 EC_PRE_COMP *EC_ec_pre_comp_dup(EC_PRE_COMP *);
314
315 void EC_pre_comp_free(EC_GROUP *group);
316 void EC_nistp224_pre_comp_free(NISTP224_PRE_COMP *);
317 void EC_nistp256_pre_comp_free(NISTP256_PRE_COMP *);
318 void EC_nistp521_pre_comp_free(NISTP521_PRE_COMP *);
319 void EC_nistz256_pre_comp_free(NISTZ256_PRE_COMP *);
320 void EC_ec_pre_comp_free(EC_PRE_COMP *);
321
322 /*
323  * method functions in ec_mult.c (ec_lib.c uses these as defaults if
324  * group->method->mul is 0)
325  */
326 int ec_wNAF_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
327                 size_t num, const EC_POINT *points[], const BIGNUM *scalars[],
328                 BN_CTX *);
329 int ec_wNAF_precompute_mult(EC_GROUP *group, BN_CTX *);
330 int ec_wNAF_have_precompute_mult(const EC_GROUP *group);
331
332 /* method functions in ecp_smpl.c */
333 int ec_GFp_simple_group_init(EC_GROUP *);
334 void ec_GFp_simple_group_finish(EC_GROUP *);
335 void ec_GFp_simple_group_clear_finish(EC_GROUP *);
336 int ec_GFp_simple_group_copy(EC_GROUP *, const EC_GROUP *);
337 int ec_GFp_simple_group_set_curve(EC_GROUP *, const BIGNUM *p,
338                                   const BIGNUM *a, const BIGNUM *b, BN_CTX *);
339 int ec_GFp_simple_group_get_curve(const EC_GROUP *, BIGNUM *p, BIGNUM *a,
340                                   BIGNUM *b, BN_CTX *);
341 int ec_GFp_simple_group_get_degree(const EC_GROUP *);
342 int ec_GFp_simple_group_check_discriminant(const EC_GROUP *, BN_CTX *);
343 int ec_GFp_simple_point_init(EC_POINT *);
344 void ec_GFp_simple_point_finish(EC_POINT *);
345 void ec_GFp_simple_point_clear_finish(EC_POINT *);
346 int ec_GFp_simple_point_copy(EC_POINT *, const EC_POINT *);
347 int ec_GFp_simple_point_set_to_infinity(const EC_GROUP *, EC_POINT *);
348 int ec_GFp_simple_set_Jprojective_coordinates_GFp(const EC_GROUP *,
349                                                   EC_POINT *, const BIGNUM *x,
350                                                   const BIGNUM *y,
351                                                   const BIGNUM *z, BN_CTX *);
352 int ec_GFp_simple_get_Jprojective_coordinates_GFp(const EC_GROUP *,
353                                                   const EC_POINT *, BIGNUM *x,
354                                                   BIGNUM *y, BIGNUM *z,
355                                                   BN_CTX *);
356 int ec_GFp_simple_point_set_affine_coordinates(const EC_GROUP *, EC_POINT *,
357                                                const BIGNUM *x,
358                                                const BIGNUM *y, BN_CTX *);
359 int ec_GFp_simple_point_get_affine_coordinates(const EC_GROUP *,
360                                                const EC_POINT *, BIGNUM *x,
361                                                BIGNUM *y, BN_CTX *);
362 int ec_GFp_simple_set_compressed_coordinates(const EC_GROUP *, EC_POINT *,
363                                              const BIGNUM *x, int y_bit,
364                                              BN_CTX *);
365 size_t ec_GFp_simple_point2oct(const EC_GROUP *, const EC_POINT *,
366                                point_conversion_form_t form,
367                                unsigned char *buf, size_t len, BN_CTX *);
368 int ec_GFp_simple_oct2point(const EC_GROUP *, EC_POINT *,
369                             const unsigned char *buf, size_t len, BN_CTX *);
370 int ec_GFp_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
371                       const EC_POINT *b, BN_CTX *);
372 int ec_GFp_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
373                       BN_CTX *);
374 int ec_GFp_simple_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
375 int ec_GFp_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
376 int ec_GFp_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
377 int ec_GFp_simple_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b,
378                       BN_CTX *);
379 int ec_GFp_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
380 int ec_GFp_simple_points_make_affine(const EC_GROUP *, size_t num,
381                                      EC_POINT *[], BN_CTX *);
382 int ec_GFp_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
383                             const BIGNUM *b, BN_CTX *);
384 int ec_GFp_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
385                             BN_CTX *);
386 int ec_GFp_simple_field_inv(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
387                             BN_CTX *);
388 int ec_GFp_simple_blind_coordinates(const EC_GROUP *group, EC_POINT *p,
389                                     BN_CTX *ctx);
390
391 /* method functions in ecp_mont.c */
392 int ec_GFp_mont_group_init(EC_GROUP *);
393 int ec_GFp_mont_group_set_curve(EC_GROUP *, const BIGNUM *p, const BIGNUM *a,
394                                 const BIGNUM *b, BN_CTX *);
395 void ec_GFp_mont_group_finish(EC_GROUP *);
396 void ec_GFp_mont_group_clear_finish(EC_GROUP *);
397 int ec_GFp_mont_group_copy(EC_GROUP *, const EC_GROUP *);
398 int ec_GFp_mont_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
399                           const BIGNUM *b, BN_CTX *);
400 int ec_GFp_mont_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
401                           BN_CTX *);
402 int ec_GFp_mont_field_inv(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
403                           BN_CTX *);
404 int ec_GFp_mont_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
405                              BN_CTX *);
406 int ec_GFp_mont_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
407                              BN_CTX *);
408 int ec_GFp_mont_field_set_to_one(const EC_GROUP *, BIGNUM *r, BN_CTX *);
409
410 /* method functions in ecp_nist.c */
411 int ec_GFp_nist_group_copy(EC_GROUP *dest, const EC_GROUP *src);
412 int ec_GFp_nist_group_set_curve(EC_GROUP *, const BIGNUM *p, const BIGNUM *a,
413                                 const BIGNUM *b, BN_CTX *);
414 int ec_GFp_nist_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
415                           const BIGNUM *b, BN_CTX *);
416 int ec_GFp_nist_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
417                           BN_CTX *);
418
419 /* method functions in ec2_smpl.c */
420 int ec_GF2m_simple_group_init(EC_GROUP *);
421 void ec_GF2m_simple_group_finish(EC_GROUP *);
422 void ec_GF2m_simple_group_clear_finish(EC_GROUP *);
423 int ec_GF2m_simple_group_copy(EC_GROUP *, const EC_GROUP *);
424 int ec_GF2m_simple_group_set_curve(EC_GROUP *, const BIGNUM *p,
425                                    const BIGNUM *a, const BIGNUM *b,
426                                    BN_CTX *);
427 int ec_GF2m_simple_group_get_curve(const EC_GROUP *, BIGNUM *p, BIGNUM *a,
428                                    BIGNUM *b, BN_CTX *);
429 int ec_GF2m_simple_group_get_degree(const EC_GROUP *);
430 int ec_GF2m_simple_group_check_discriminant(const EC_GROUP *, BN_CTX *);
431 int ec_GF2m_simple_point_init(EC_POINT *);
432 void ec_GF2m_simple_point_finish(EC_POINT *);
433 void ec_GF2m_simple_point_clear_finish(EC_POINT *);
434 int ec_GF2m_simple_point_copy(EC_POINT *, const EC_POINT *);
435 int ec_GF2m_simple_point_set_to_infinity(const EC_GROUP *, EC_POINT *);
436 int ec_GF2m_simple_point_set_affine_coordinates(const EC_GROUP *, EC_POINT *,
437                                                 const BIGNUM *x,
438                                                 const BIGNUM *y, BN_CTX *);
439 int ec_GF2m_simple_point_get_affine_coordinates(const EC_GROUP *,
440                                                 const EC_POINT *, BIGNUM *x,
441                                                 BIGNUM *y, BN_CTX *);
442 int ec_GF2m_simple_set_compressed_coordinates(const EC_GROUP *, EC_POINT *,
443                                               const BIGNUM *x, int y_bit,
444                                               BN_CTX *);
445 size_t ec_GF2m_simple_point2oct(const EC_GROUP *, const EC_POINT *,
446                                 point_conversion_form_t form,
447                                 unsigned char *buf, size_t len, BN_CTX *);
448 int ec_GF2m_simple_oct2point(const EC_GROUP *, EC_POINT *,
449                              const unsigned char *buf, size_t len, BN_CTX *);
450 int ec_GF2m_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
451                        const EC_POINT *b, BN_CTX *);
452 int ec_GF2m_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a,
453                        BN_CTX *);
454 int ec_GF2m_simple_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
455 int ec_GF2m_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
456 int ec_GF2m_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
457 int ec_GF2m_simple_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b,
458                        BN_CTX *);
459 int ec_GF2m_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
460 int ec_GF2m_simple_points_make_affine(const EC_GROUP *, size_t num,
461                                       EC_POINT *[], BN_CTX *);
462 int ec_GF2m_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
463                              const BIGNUM *b, BN_CTX *);
464 int ec_GF2m_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
465                              BN_CTX *);
466 int ec_GF2m_simple_field_div(const EC_GROUP *, BIGNUM *r, const BIGNUM *a,
467                              const BIGNUM *b, BN_CTX *);
468
469 /* method functions in ec2_mult.c */
470 int ec_GF2m_simple_mul(const EC_GROUP *group, EC_POINT *r,
471                        const BIGNUM *scalar, size_t num,
472                        const EC_POINT *points[], const BIGNUM *scalars[],
473                        BN_CTX *);
474 int ec_GF2m_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
475 int ec_GF2m_have_precompute_mult(const EC_GROUP *group);
476
477 #ifndef OPENSSL_NO_EC_NISTP_64_GCC_128
478 /* method functions in ecp_nistp224.c */
479 int ec_GFp_nistp224_group_init(EC_GROUP *group);
480 int ec_GFp_nistp224_group_set_curve(EC_GROUP *group, const BIGNUM *p,
481                                     const BIGNUM *a, const BIGNUM *n,
482                                     BN_CTX *);
483 int ec_GFp_nistp224_point_get_affine_coordinates(const EC_GROUP *group,
484                                                  const EC_POINT *point,
485                                                  BIGNUM *x, BIGNUM *y,
486                                                  BN_CTX *ctx);
487 int ec_GFp_nistp224_mul(const EC_GROUP *group, EC_POINT *r,
488                         const BIGNUM *scalar, size_t num,
489                         const EC_POINT *points[], const BIGNUM *scalars[],
490                         BN_CTX *);
491 int ec_GFp_nistp224_points_mul(const EC_GROUP *group, EC_POINT *r,
492                                const BIGNUM *scalar, size_t num,
493                                const EC_POINT *points[],
494                                const BIGNUM *scalars[], BN_CTX *ctx);
495 int ec_GFp_nistp224_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
496 int ec_GFp_nistp224_have_precompute_mult(const EC_GROUP *group);
497
498 /* method functions in ecp_nistp256.c */
499 int ec_GFp_nistp256_group_init(EC_GROUP *group);
500 int ec_GFp_nistp256_group_set_curve(EC_GROUP *group, const BIGNUM *p,
501                                     const BIGNUM *a, const BIGNUM *n,
502                                     BN_CTX *);
503 int ec_GFp_nistp256_point_get_affine_coordinates(const EC_GROUP *group,
504                                                  const EC_POINT *point,
505                                                  BIGNUM *x, BIGNUM *y,
506                                                  BN_CTX *ctx);
507 int ec_GFp_nistp256_mul(const EC_GROUP *group, EC_POINT *r,
508                         const BIGNUM *scalar, size_t num,
509                         const EC_POINT *points[], const BIGNUM *scalars[],
510                         BN_CTX *);
511 int ec_GFp_nistp256_points_mul(const EC_GROUP *group, EC_POINT *r,
512                                const BIGNUM *scalar, size_t num,
513                                const EC_POINT *points[],
514                                const BIGNUM *scalars[], BN_CTX *ctx);
515 int ec_GFp_nistp256_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
516 int ec_GFp_nistp256_have_precompute_mult(const EC_GROUP *group);
517
518 /* method functions in ecp_nistp521.c */
519 int ec_GFp_nistp521_group_init(EC_GROUP *group);
520 int ec_GFp_nistp521_group_set_curve(EC_GROUP *group, const BIGNUM *p,
521                                     const BIGNUM *a, const BIGNUM *n,
522                                     BN_CTX *);
523 int ec_GFp_nistp521_point_get_affine_coordinates(const EC_GROUP *group,
524                                                  const EC_POINT *point,
525                                                  BIGNUM *x, BIGNUM *y,
526                                                  BN_CTX *ctx);
527 int ec_GFp_nistp521_mul(const EC_GROUP *group, EC_POINT *r,
528                         const BIGNUM *scalar, size_t num,
529                         const EC_POINT *points[], const BIGNUM *scalars[],
530                         BN_CTX *);
531 int ec_GFp_nistp521_points_mul(const EC_GROUP *group, EC_POINT *r,
532                                const BIGNUM *scalar, size_t num,
533                                const EC_POINT *points[],
534                                const BIGNUM *scalars[], BN_CTX *ctx);
535 int ec_GFp_nistp521_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
536 int ec_GFp_nistp521_have_precompute_mult(const EC_GROUP *group);
537
538 /* utility functions in ecp_nistputil.c */
539 void ec_GFp_nistp_points_make_affine_internal(size_t num, void *point_array,
540                                               size_t felem_size,
541                                               void *tmp_felems,
542                                               void (*felem_one) (void *out),
543                                               int (*felem_is_zero) (const void
544                                                                     *in),
545                                               void (*felem_assign) (void *out,
546                                                                     const void
547                                                                     *in),
548                                               void (*felem_square) (void *out,
549                                                                     const void
550                                                                     *in),
551                                               void (*felem_mul) (void *out,
552                                                                  const void
553                                                                  *in1,
554                                                                  const void
555                                                                  *in2),
556                                               void (*felem_inv) (void *out,
557                                                                  const void
558                                                                  *in),
559                                               void (*felem_contract) (void
560                                                                       *out,
561                                                                       const
562                                                                       void
563                                                                       *in));
564 void ec_GFp_nistp_recode_scalar_bits(unsigned char *sign,
565                                      unsigned char *digit, unsigned char in);
566 #endif
567 int ec_precompute_mont_data(EC_GROUP *);
568 int ec_group_simple_order_bits(const EC_GROUP *group);
569
570 #ifdef ECP_NISTZ256_ASM
571 /** Returns GFp methods using montgomery multiplication, with x86-64 optimized
572  * P256. See http://eprint.iacr.org/2013/816.
573  *  \return  EC_METHOD object
574  */
575 const EC_METHOD *EC_GFp_nistz256_method(void);
576 #endif
577
578 size_t ec_key_simple_priv2oct(const EC_KEY *eckey,
579                               unsigned char *buf, size_t len);
580 int ec_key_simple_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len);
581 int ec_key_simple_generate_key(EC_KEY *eckey);
582 int ec_key_simple_generate_public_key(EC_KEY *eckey);
583 int ec_key_simple_check_key(const EC_KEY *eckey);
584
585 /* EC_METHOD definitions */
586
587 struct ec_key_method_st {
588     const char *name;
589     int32_t flags;
590     int (*init)(EC_KEY *key);
591     void (*finish)(EC_KEY *key);
592     int (*copy)(EC_KEY *dest, const EC_KEY *src);
593     int (*set_group)(EC_KEY *key, const EC_GROUP *grp);
594     int (*set_private)(EC_KEY *key, const BIGNUM *priv_key);
595     int (*set_public)(EC_KEY *key, const EC_POINT *pub_key);
596     int (*keygen)(EC_KEY *key);
597     int (*compute_key)(unsigned char **pout, size_t *poutlen,
598                        const EC_POINT *pub_key, const EC_KEY *ecdh);
599     int (*sign)(int type, const unsigned char *dgst, int dlen, unsigned char
600                 *sig, unsigned int *siglen, const BIGNUM *kinv,
601                 const BIGNUM *r, EC_KEY *eckey);
602     int (*sign_setup)(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp,
603                       BIGNUM **rp);
604     ECDSA_SIG *(*sign_sig)(const unsigned char *dgst, int dgst_len,
605                            const BIGNUM *in_kinv, const BIGNUM *in_r,
606                            EC_KEY *eckey);
607
608     int (*verify)(int type, const unsigned char *dgst, int dgst_len,
609                   const unsigned char *sigbuf, int sig_len, EC_KEY *eckey);
610     int (*verify_sig)(const unsigned char *dgst, int dgst_len,
611                       const ECDSA_SIG *sig, EC_KEY *eckey);
612 };
613
614 #define EC_KEY_METHOD_DYNAMIC   1
615
616 int ossl_ec_key_gen(EC_KEY *eckey);
617 int ossl_ecdh_compute_key(unsigned char **pout, size_t *poutlen,
618                           const EC_POINT *pub_key, const EC_KEY *ecdh);
619 int ecdh_simple_compute_key(unsigned char **pout, size_t *poutlen,
620                             const EC_POINT *pub_key, const EC_KEY *ecdh);
621
622 struct ECDSA_SIG_st {
623     BIGNUM *r;
624     BIGNUM *s;
625 };
626
627 int ossl_ecdsa_sign_setup(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp,
628                           BIGNUM **rp);
629 int ossl_ecdsa_sign(int type, const unsigned char *dgst, int dlen,
630                     unsigned char *sig, unsigned int *siglen,
631                     const BIGNUM *kinv, const BIGNUM *r, EC_KEY *eckey);
632 ECDSA_SIG *ossl_ecdsa_sign_sig(const unsigned char *dgst, int dgst_len,
633                                const BIGNUM *in_kinv, const BIGNUM *in_r,
634                                EC_KEY *eckey);
635 int ossl_ecdsa_verify(int type, const unsigned char *dgst, int dgst_len,
636                       const unsigned char *sigbuf, int sig_len, EC_KEY *eckey);
637 int ossl_ecdsa_verify_sig(const unsigned char *dgst, int dgst_len,
638                           const ECDSA_SIG *sig, EC_KEY *eckey);
639
640 int X25519(uint8_t out_shared_key[32], const uint8_t private_key[32],
641            const uint8_t peer_public_value[32]);
642 void X25519_public_from_private(uint8_t out_public_value[32],
643                                 const uint8_t private_key[32]);
644
645 int ec_point_blind_coordinates(const EC_GROUP *group, EC_POINT *p, BN_CTX *ctx);