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