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