Reserve option to use BN_mod_exp_mont_consttime in ECDSA.
[openssl.git] / crypto / ec / ec.h
1 /* crypto/ec/ec.h */
2 /*
3  * Originally written by Bodo Moeller for the OpenSSL project.
4  */
5 /**
6  * \file crypto/ec/ec.h Include file for the OpenSSL EC functions
7  * \author Originally written by Bodo Moeller for the OpenSSL project
8  */
9 /* ====================================================================
10  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  *
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer. 
18  *
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in
21  *    the documentation and/or other materials provided with the
22  *    distribution.
23  *
24  * 3. All advertising materials mentioning features or use of this
25  *    software must display the following acknowledgment:
26  *    "This product includes software developed by the OpenSSL Project
27  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
28  *
29  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
30  *    endorse or promote products derived from this software without
31  *    prior written permission. For written permission, please contact
32  *    openssl-core@openssl.org.
33  *
34  * 5. Products derived from this software may not be called "OpenSSL"
35  *    nor may "OpenSSL" appear in their names without prior written
36  *    permission of the OpenSSL Project.
37  *
38  * 6. Redistributions of any form whatsoever must retain the following
39  *    acknowledgment:
40  *    "This product includes software developed by the OpenSSL Project
41  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
44  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
46  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
47  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
49  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
50  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
52  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
54  * OF THE POSSIBILITY OF SUCH DAMAGE.
55  * ====================================================================
56  *
57  * This product includes cryptographic software written by Eric Young
58  * (eay@cryptsoft.com).  This product includes software written by Tim
59  * Hudson (tjh@cryptsoft.com).
60  *
61  */
62 /* ====================================================================
63  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
64  *
65  * Portions of the attached software ("Contribution") are developed by 
66  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
67  *
68  * The Contribution is licensed pursuant to the OpenSSL open source
69  * license provided above.
70  *
71  * The elliptic curve binary polynomial software is originally written by 
72  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
73  *
74  */
75
76 #ifndef HEADER_EC_H
77 #define HEADER_EC_H
78
79 #include <openssl/opensslconf.h>
80
81 #ifdef OPENSSL_NO_EC
82 #error EC is disabled.
83 #endif
84
85 #include <openssl/asn1.h>
86 #include <openssl/symhacks.h>
87 #ifndef OPENSSL_NO_DEPRECATED
88 #include <openssl/bn.h>
89 #endif
90
91 #ifdef  __cplusplus
92 extern "C" {
93 #elif defined(__SUNPRO_C)
94 # if __SUNPRO_C >= 0x520
95 # pragma error_messages (off,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
96 # endif
97 #endif
98
99   
100 #ifndef OPENSSL_ECC_MAX_FIELD_BITS
101 # define OPENSSL_ECC_MAX_FIELD_BITS 661
102 #endif
103
104 /** Enum for the point conversion form as defined in X9.62 (ECDSA)
105  *  for the encoding of a elliptic curve point (x,y) */
106 typedef enum {
107         /** the point is encoded as z||x, where the octet z specifies 
108          *  which solution of the quadratic equation y is  */
109         POINT_CONVERSION_COMPRESSED = 2,
110         /** the point is encoded as z||x||y, where z is the octet 0x02  */
111         POINT_CONVERSION_UNCOMPRESSED = 4,
112         /** the point is encoded as z||x||y, where the octet z specifies
113          *  which solution of the quadratic equation y is  */
114         POINT_CONVERSION_HYBRID = 6
115 } point_conversion_form_t;
116
117
118 typedef struct ec_method_st EC_METHOD;
119
120 typedef struct ec_group_st
121         /*
122          EC_METHOD *meth;
123          -- field definition
124          -- curve coefficients
125          -- optional generator with associated information (order, cofactor)
126          -- optional extra data (precomputed table for fast computation of multiples of generator)
127          -- ASN1 stuff
128         */
129         EC_GROUP;
130
131 typedef struct ec_point_st EC_POINT;
132
133
134 /********************************************************************/
135 /*               EC_METHODs for curves over GF(p)                   */       
136 /********************************************************************/
137
138 /** Returns the basic GFp ec methods which provides the basis for the
139  *  optimized methods. 
140  *  \return  EC_METHOD object
141  */
142 const EC_METHOD *EC_GFp_simple_method(void);
143
144 /** Returns GFp methods using montgomery multiplication.
145  *  \return  EC_METHOD object
146  */
147 const EC_METHOD *EC_GFp_mont_method(void);
148
149 /** Returns GFp methods using optimized methods for NIST recommended curves
150  *  \return  EC_METHOD object
151  */
152 const EC_METHOD *EC_GFp_nist_method(void);
153
154 #ifndef OPENSSL_NO_EC_NISTP_64_GCC_128
155 /** Returns 64-bit optimized methods for nistp224
156  *  \return  EC_METHOD object
157  */
158 const EC_METHOD *EC_GFp_nistp224_method(void);
159
160 /** Returns 64-bit optimized methods for nistp256
161  *  \return  EC_METHOD object
162  */
163 const EC_METHOD *EC_GFp_nistp256_method(void);
164
165 /** Returns 64-bit optimized methods for nistp521
166  *  \return  EC_METHOD object
167  */
168 const EC_METHOD *EC_GFp_nistp521_method(void);
169 #endif
170
171 #ifndef OPENSSL_NO_EC2M
172 /********************************************************************/ 
173 /*           EC_METHOD for curves over GF(2^m)                      */
174 /********************************************************************/
175
176 /** Returns the basic GF2m ec method 
177  *  \return  EC_METHOD object
178  */
179 const EC_METHOD *EC_GF2m_simple_method(void);
180
181 #endif
182
183
184 /********************************************************************/
185 /*                   EC_GROUP functions                             */
186 /********************************************************************/
187
188 /** Creates a new EC_GROUP object
189  *  \param   meth  EC_METHOD to use
190  *  \return  newly created EC_GROUP object or NULL in case of an error.
191  */
192 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth);
193
194 /** Frees a EC_GROUP object
195  *  \param  group  EC_GROUP object to be freed.
196  */
197 void EC_GROUP_free(EC_GROUP *group);
198
199 /** Clears and frees a EC_GROUP object
200  *  \param  group  EC_GROUP object to be cleared and freed.
201  */
202 void EC_GROUP_clear_free(EC_GROUP *group);
203
204 /** Copies EC_GROUP objects. Note: both EC_GROUPs must use the same EC_METHOD.
205  *  \param  dst  destination EC_GROUP object
206  *  \param  src  source EC_GROUP object
207  *  \return 1 on success and 0 if an error occurred.
208  */
209 int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
210
211 /** Creates a new EC_GROUP object and copies the copies the content
212  *  form src to the newly created EC_KEY object
213  *  \param  src  source EC_GROUP object
214  *  \return newly created EC_GROUP object or NULL in case of an error.
215  */
216 EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
217
218 /** Returns the EC_METHOD of the EC_GROUP object.
219  *  \param  group  EC_GROUP object 
220  *  \return EC_METHOD used in this EC_GROUP object.
221  */
222 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
223
224 /** Returns the field type of the EC_METHOD.
225  *  \param  meth  EC_METHOD object
226  *  \return NID of the underlying field type OID.
227  */
228 int EC_METHOD_get_field_type(const EC_METHOD *meth);
229
230 /** Sets the generator and it's order/cofactor of a EC_GROUP object.
231  *  \param  group      EC_GROUP object 
232  *  \param  generator  EC_POINT object with the generator.
233  *  \param  order      the order of the group generated by the generator.
234  *  \param  cofactor   the index of the sub-group generated by the generator
235  *                     in the group of all points on the elliptic curve.
236  *  \return 1 on success and 0 if an error occured
237  */
238 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
239
240 /** Returns the generator of a EC_GROUP object.
241  *  \param  group  EC_GROUP object
242  *  \return the currently used generator (possibly NULL).
243  */
244 const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
245
246 /** Returns the montgomery data for order(Generator)
247  *  \param  group  EC_GROUP object
248  *  \return the currently used generator (possibly NULL).
249 */
250 BN_MONT_CTX *EC_GROUP_get_mont_data(const EC_GROUP *group);
251
252 /** Gets the order of a EC_GROUP
253  *  \param  group  EC_GROUP object
254  *  \param  order  BIGNUM to which the order is copied
255  *  \param  ctx    BN_CTX object (optional)
256  *  \return 1 on success and 0 if an error occured
257  */
258 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
259
260 /** Gets the cofactor of a EC_GROUP
261  *  \param  group     EC_GROUP object
262  *  \param  cofactor  BIGNUM to which the cofactor is copied
263  *  \param  ctx       BN_CTX object (optional)
264  *  \return 1 on success and 0 if an error occured
265  */
266 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);
267
268 /** Sets the name of a EC_GROUP object
269  *  \param  group  EC_GROUP object
270  *  \param  nid    NID of the curve name OID
271  */
272 void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
273
274 /** Returns the curve name of a EC_GROUP object
275  *  \param  group  EC_GROUP object
276  *  \return NID of the curve name OID or 0 if not set.
277  */
278 int EC_GROUP_get_curve_name(const EC_GROUP *group);
279
280 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
281 int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
282
283 void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form);
284 point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
285
286 unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
287 size_t EC_GROUP_get_seed_len(const EC_GROUP *);
288 size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
289
290 /** Sets the parameter of a ec over GFp defined by y^2 = x^3 + a*x + b
291  *  \param  group  EC_GROUP object
292  *  \param  p      BIGNUM with the prime number
293  *  \param  a      BIGNUM with parameter a of the equation
294  *  \param  b      BIGNUM with parameter b of the equation
295  *  \param  ctx    BN_CTX object (optional)
296  *  \return 1 on success and 0 if an error occured
297  */
298 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
299
300 /** Gets the parameter of the ec over GFp defined by y^2 = x^3 + a*x + b
301  *  \param  group  EC_GROUP object
302  *  \param  p      BIGNUM for the prime number
303  *  \param  a      BIGNUM for parameter a of the equation
304  *  \param  b      BIGNUM for parameter b of the equation
305  *  \param  ctx    BN_CTX object (optional)
306  *  \return 1 on success and 0 if an error occured
307  */
308 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
309
310 #ifndef OPENSSL_NO_EC2M
311 /** Sets the parameter of a ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b
312  *  \param  group  EC_GROUP object
313  *  \param  p      BIGNUM with the polynomial defining the underlying field
314  *  \param  a      BIGNUM with parameter a of the equation
315  *  \param  b      BIGNUM with parameter b of the equation
316  *  \param  ctx    BN_CTX object (optional)
317  *  \return 1 on success and 0 if an error occured
318  */
319 int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
320
321 /** Gets the parameter of the ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b
322  *  \param  group  EC_GROUP object
323  *  \param  p      BIGNUM for the polynomial defining the underlying field
324  *  \param  a      BIGNUM for parameter a of the equation
325  *  \param  b      BIGNUM for parameter b of the equation
326  *  \param  ctx    BN_CTX object (optional)
327  *  \return 1 on success and 0 if an error occured
328  */
329 int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
330 #endif
331 /** Returns the number of bits needed to represent a field element 
332  *  \param  group  EC_GROUP object
333  *  \return number of bits needed to represent a field element
334  */
335 int EC_GROUP_get_degree(const EC_GROUP *group);
336
337 /** Checks whether the parameter in the EC_GROUP define a valid ec group
338  *  \param  group  EC_GROUP object
339  *  \param  ctx    BN_CTX object (optional)
340  *  \return 1 if group is a valid ec group and 0 otherwise
341  */
342 int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
343
344 /** Checks whether the discriminant of the elliptic curve is zero or not
345  *  \param  group  EC_GROUP object
346  *  \param  ctx    BN_CTX object (optional)
347  *  \return 1 if the discriminant is not zero and 0 otherwise
348  */
349 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
350
351 /** Compares two EC_GROUP objects
352  *  \param  a    first EC_GROUP object
353  *  \param  b    second EC_GROUP object
354  *  \param  ctx  BN_CTX object (optional)
355  *  \return 0 if both groups are equal and 1 otherwise
356  */
357 int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
358
359 /* EC_GROUP_new_GF*() calls EC_GROUP_new() and EC_GROUP_set_GF*()
360  * after choosing an appropriate EC_METHOD */
361
362 /** Creates a new EC_GROUP object with the specified parameters defined
363  *  over GFp (defined by the equation y^2 = x^3 + a*x + b)
364  *  \param  p    BIGNUM with the prime number
365  *  \param  a    BIGNUM with the parameter a of the equation
366  *  \param  b    BIGNUM with the parameter b of the equation
367  *  \param  ctx  BN_CTX object (optional)
368  *  \return newly created EC_GROUP object with the specified parameters
369  */
370 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
371 #ifndef OPENSSL_NO_EC2M
372 /** Creates a new EC_GROUP object with the specified parameters defined
373  *  over GF2m (defined by the equation y^2 + x*y = x^3 + a*x^2 + b)
374  *  \param  p    BIGNUM with the polynomial defining the underlying field
375  *  \param  a    BIGNUM with the parameter a of the equation
376  *  \param  b    BIGNUM with the parameter b of the equation
377  *  \param  ctx  BN_CTX object (optional)
378  *  \return newly created EC_GROUP object with the specified parameters
379  */
380 EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
381 #endif
382 /** Creates a EC_GROUP object with a curve specified by a NID
383  *  \param  nid  NID of the OID of the curve name
384  *  \return newly created EC_GROUP object with specified curve or NULL
385  *          if an error occurred
386  */
387 EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
388
389
390 /********************************************************************/
391 /*               handling of internal curves                        */
392 /********************************************************************/
393
394 typedef struct { 
395         int nid;
396         const char *comment;
397         } EC_builtin_curve;
398
399 /* EC_builtin_curves(EC_builtin_curve *r, size_t size) returns number 
400  * of all available curves or zero if a error occurred. 
401  * In case r ist not zero nitems EC_builtin_curve structures 
402  * are filled with the data of the first nitems internal groups */
403 size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems);
404
405 const char *EC_curve_nid2nist(int nid);
406 int EC_curve_nist2nid(const char *name);
407
408 /********************************************************************/
409 /*                    EC_POINT functions                            */
410 /********************************************************************/
411
412 /** Creates a new EC_POINT object for the specified EC_GROUP
413  *  \param  group  EC_GROUP the underlying EC_GROUP object
414  *  \return newly created EC_POINT object or NULL if an error occurred
415  */
416 EC_POINT *EC_POINT_new(const EC_GROUP *group);
417
418 /** Frees a EC_POINT object
419  *  \param  point  EC_POINT object to be freed
420  */
421 void EC_POINT_free(EC_POINT *point);
422
423 /** Clears and frees a EC_POINT object
424  *  \param  point  EC_POINT object to be cleared and freed
425  */
426 void EC_POINT_clear_free(EC_POINT *point);
427
428 /** Copies EC_POINT object
429  *  \param  dst  destination EC_POINT object
430  *  \param  src  source EC_POINT object
431  *  \return 1 on success and 0 if an error occured
432  */
433 int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
434
435 /** Creates a new EC_POINT object and copies the content of the supplied
436  *  EC_POINT
437  *  \param  src    source EC_POINT object
438  *  \param  group  underlying the EC_GROUP object
439  *  \return newly created EC_POINT object or NULL if an error occurred 
440  */
441 EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
442  
443 /** Returns the EC_METHOD used in EC_POINT object 
444  *  \param  point  EC_POINT object
445  *  \return the EC_METHOD used
446  */
447 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
448
449 /** Sets a point to infinity (neutral element)
450  *  \param  group  underlying EC_GROUP object
451  *  \param  point  EC_POINT to set to infinity
452  *  \return 1 on success and 0 if an error occured
453  */
454 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
455
456 /** Sets the jacobian projective coordinates of a EC_POINT over GFp
457  *  \param  group  underlying EC_GROUP object
458  *  \param  p      EC_POINT object
459  *  \param  x      BIGNUM with the x-coordinate
460  *  \param  y      BIGNUM with the y-coordinate
461  *  \param  z      BIGNUM with the z-coordinate
462  *  \param  ctx    BN_CTX object (optional)
463  *  \return 1 on success and 0 if an error occured
464  */
465 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
466         const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx);
467
468 /** Gets the jacobian projective coordinates of a EC_POINT over GFp
469  *  \param  group  underlying EC_GROUP object
470  *  \param  p      EC_POINT object
471  *  \param  x      BIGNUM for the x-coordinate
472  *  \param  y      BIGNUM for the y-coordinate
473  *  \param  z      BIGNUM for the z-coordinate
474  *  \param  ctx    BN_CTX object (optional)
475  *  \return 1 on success and 0 if an error occured
476  */
477 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
478         const EC_POINT *p, BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx);
479
480 /** Sets the affine coordinates of a EC_POINT over GFp
481  *  \param  group  underlying EC_GROUP object
482  *  \param  p      EC_POINT object
483  *  \param  x      BIGNUM with the x-coordinate
484  *  \param  y      BIGNUM with the y-coordinate
485  *  \param  ctx    BN_CTX object (optional)
486  *  \return 1 on success and 0 if an error occured
487  */
488 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
489         const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
490
491 /** Gets the affine coordinates of a EC_POINT over GFp
492  *  \param  group  underlying EC_GROUP object
493  *  \param  p      EC_POINT object
494  *  \param  x      BIGNUM for the x-coordinate
495  *  \param  y      BIGNUM for the y-coordinate
496  *  \param  ctx    BN_CTX object (optional)
497  *  \return 1 on success and 0 if an error occured
498  */
499 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
500         const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
501
502 /** Sets the x9.62 compressed coordinates of a EC_POINT over GFp
503  *  \param  group  underlying EC_GROUP object
504  *  \param  p      EC_POINT object
505  *  \param  x      BIGNUM with x-coordinate
506  *  \param  y_bit  integer with the y-Bit (either 0 or 1)
507  *  \param  ctx    BN_CTX object (optional)
508  *  \return 1 on success and 0 if an error occured
509  */
510 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
511         const BIGNUM *x, int y_bit, BN_CTX *ctx);
512 #ifndef OPENSSL_NO_EC2M
513 /** Sets the affine coordinates of a EC_POINT over GF2m
514  *  \param  group  underlying EC_GROUP object
515  *  \param  p      EC_POINT object
516  *  \param  x      BIGNUM with the x-coordinate
517  *  \param  y      BIGNUM with the y-coordinate
518  *  \param  ctx    BN_CTX object (optional)
519  *  \return 1 on success and 0 if an error occured
520  */
521 int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
522         const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
523
524 /** Gets the affine coordinates of a EC_POINT over GF2m
525  *  \param  group  underlying EC_GROUP object
526  *  \param  p      EC_POINT object
527  *  \param  x      BIGNUM for the x-coordinate
528  *  \param  y      BIGNUM for the y-coordinate
529  *  \param  ctx    BN_CTX object (optional)
530  *  \return 1 on success and 0 if an error occured
531  */
532 int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,
533         const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
534
535 /** Sets the x9.62 compressed coordinates of a EC_POINT over GF2m
536  *  \param  group  underlying EC_GROUP object
537  *  \param  p      EC_POINT object
538  *  \param  x      BIGNUM with x-coordinate
539  *  \param  y_bit  integer with the y-Bit (either 0 or 1)
540  *  \param  ctx    BN_CTX object (optional)
541  *  \return 1 on success and 0 if an error occured
542  */
543 int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
544         const BIGNUM *x, int y_bit, BN_CTX *ctx);
545 #endif
546 /** Encodes a EC_POINT object to a octet string
547  *  \param  group  underlying EC_GROUP object
548  *  \param  p      EC_POINT object
549  *  \param  form   point conversion form
550  *  \param  buf    memory buffer for the result. If NULL the function returns
551  *                 required buffer size.
552  *  \param  len    length of the memory buffer
553  *  \param  ctx    BN_CTX object (optional)
554  *  \return the length of the encoded octet string or 0 if an error occurred
555  */
556 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
557         point_conversion_form_t form,
558         unsigned char *buf, size_t len, BN_CTX *ctx);
559
560 /** Decodes a EC_POINT from a octet string
561  *  \param  group  underlying EC_GROUP object
562  *  \param  p      EC_POINT object
563  *  \param  buf    memory buffer with the encoded ec point
564  *  \param  len    length of the encoded ec point
565  *  \param  ctx    BN_CTX object (optional)
566  *  \return 1 on success and 0 if an error occured
567  */
568 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
569         const unsigned char *buf, size_t len, BN_CTX *ctx);
570
571 /* other interfaces to point2oct/oct2point: */
572 BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *,
573         point_conversion_form_t form, BIGNUM *, BN_CTX *);
574 EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *,
575         EC_POINT *, BN_CTX *);
576 char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *,
577         point_conversion_form_t form, BN_CTX *);
578 EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *,
579         EC_POINT *, BN_CTX *);
580
581
582 /********************************************************************/
583 /*         functions for doing EC_POINT arithmetic                  */
584 /********************************************************************/
585
586 /** Computes the sum of two EC_POINT 
587  *  \param  group  underlying EC_GROUP object
588  *  \param  r      EC_POINT object for the result (r = a + b)
589  *  \param  a      EC_POINT object with the first summand
590  *  \param  b      EC_POINT object with the second summand
591  *  \param  ctx    BN_CTX object (optional)
592  *  \return 1 on success and 0 if an error occured
593  */
594 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx);
595
596 /** Computes the double of a EC_POINT
597  *  \param  group  underlying EC_GROUP object
598  *  \param  r      EC_POINT object for the result (r = 2 * a)
599  *  \param  a      EC_POINT object 
600  *  \param  ctx    BN_CTX object (optional)
601  *  \return 1 on success and 0 if an error occured
602  */
603 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx);
604
605 /** Computes the inverse of a EC_POINT
606  *  \param  group  underlying EC_GROUP object
607  *  \param  a      EC_POINT object to be inverted (it's used for the result as well)
608  *  \param  ctx    BN_CTX object (optional)
609  *  \return 1 on success and 0 if an error occured
610  */
611 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx);
612
613 /** Checks whether the point is the neutral element of the group
614  *  \param  group  the underlying EC_GROUP object
615  *  \param  p      EC_POINT object
616  *  \return 1 if the point is the neutral element and 0 otherwise
617  */
618 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p);
619
620 /** Checks whether the point is on the curve 
621  *  \param  group  underlying EC_GROUP object
622  *  \param  point  EC_POINT object to check
623  *  \param  ctx    BN_CTX object (optional)
624  *  \return 1 if point if on the curve and 0 otherwise
625  */
626 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx);
627
628 /** Compares two EC_POINTs 
629  *  \param  group  underlying EC_GROUP object
630  *  \param  a      first EC_POINT object
631  *  \param  b      second EC_POINT object
632  *  \param  ctx    BN_CTX object (optional)
633  *  \return 0 if both points are equal and a value != 0 otherwise
634  */
635 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx);
636
637 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx);
638 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx);
639
640 /** Computes r = generator * n sum_{i=0}^{num-1} p[i] * m[i]
641  *  \param  group  underlying EC_GROUP object
642  *  \param  r      EC_POINT object for the result
643  *  \param  n      BIGNUM with the multiplier for the group generator (optional)
644  *  \param  num    number futher summands
645  *  \param  p      array of size num of EC_POINT objects
646  *  \param  m      array of size num of BIGNUM objects
647  *  \param  ctx    BN_CTX object (optional)
648  *  \return 1 on success and 0 if an error occured
649  */
650 int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, size_t num, const EC_POINT *p[], const BIGNUM *m[], BN_CTX *ctx);
651
652 /** Computes r = generator * n + q * m
653  *  \param  group  underlying EC_GROUP object
654  *  \param  r      EC_POINT object for the result
655  *  \param  n      BIGNUM with the multiplier for the group generator (optional)
656  *  \param  q      EC_POINT object with the first factor of the second summand
657  *  \param  m      BIGNUM with the second factor of the second summand
658  *  \param  ctx    BN_CTX object (optional)
659  *  \return 1 on success and 0 if an error occured
660  */
661 int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);
662
663 /** Stores multiples of generator for faster point multiplication
664  *  \param  group  EC_GROUP object
665  *  \param  ctx    BN_CTX object (optional)
666  *  \return 1 on success and 0 if an error occured
667  */
668 int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
669
670 /** Reports whether a precomputation has been done
671  *  \param  group  EC_GROUP object
672  *  \return 1 if a pre-computation has been done and 0 otherwise
673  */
674 int EC_GROUP_have_precompute_mult(const EC_GROUP *group);
675
676
677 /********************************************************************/
678 /*                       ASN1 stuff                                 */
679 /********************************************************************/
680
681 /* EC_GROUP_get_basis_type() returns the NID of the basis type
682  * used to represent the field elements */
683 int EC_GROUP_get_basis_type(const EC_GROUP *);
684 #ifndef OPENSSL_NO_EC2M
685 int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
686 int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1, 
687         unsigned int *k2, unsigned int *k3);
688 #endif
689
690 #define OPENSSL_EC_NAMED_CURVE  0x001
691
692 typedef struct ecpk_parameters_st ECPKPARAMETERS;
693
694 EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len);
695 int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out);
696
697 #define d2i_ECPKParameters_bio(bp,x) ASN1_d2i_bio_of(EC_GROUP,NULL,d2i_ECPKParameters,bp,x)
698 #define i2d_ECPKParameters_bio(bp,x) ASN1_i2d_bio_of_const(EC_GROUP,i2d_ECPKParameters,bp,x)
699 #define d2i_ECPKParameters_fp(fp,x) (EC_GROUP *)ASN1_d2i_fp(NULL, \
700                 (char *(*)())d2i_ECPKParameters,(fp),(unsigned char **)(x))
701 #define i2d_ECPKParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECPKParameters,(fp), \
702                 (unsigned char *)(x))
703
704 #ifndef OPENSSL_NO_BIO
705 int     ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off);
706 #endif
707 #ifndef OPENSSL_NO_FP_API
708 int     ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off);
709 #endif
710
711
712 /********************************************************************/
713 /*                      EC_KEY functions                            */
714 /********************************************************************/
715
716 typedef struct ec_key_st EC_KEY;
717
718 /* some values for the encoding_flag */
719 #define EC_PKEY_NO_PARAMETERS   0x001
720 #define EC_PKEY_NO_PUBKEY       0x002
721
722 /* some values for the flags field */
723 #define EC_FLAG_NON_FIPS_ALLOW  0x1
724 #define EC_FLAG_FIPS_CHECKED    0x2
725
726 /** Creates a new EC_KEY object.
727  *  \return EC_KEY object or NULL if an error occurred.
728  */
729 EC_KEY *EC_KEY_new(void);
730
731 int EC_KEY_get_flags(const EC_KEY *key);
732
733 void EC_KEY_set_flags(EC_KEY *key, int flags);
734
735 void EC_KEY_clear_flags(EC_KEY *key, int flags);
736
737 /** Creates a new EC_KEY object using a named curve as underlying
738  *  EC_GROUP object.
739  *  \param  nid  NID of the named curve.
740  *  \return EC_KEY object or NULL if an error occurred. 
741  */
742 EC_KEY *EC_KEY_new_by_curve_name(int nid);
743
744 /** Frees a EC_KEY object.
745  *  \param  key  EC_KEY object to be freed.
746  */
747 void EC_KEY_free(EC_KEY *key);
748
749 /** Copies a EC_KEY object.
750  *  \param  dst  destination EC_KEY object
751  *  \param  src  src EC_KEY object
752  *  \return dst or NULL if an error occurred.
753  */
754 EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
755
756 /** Creates a new EC_KEY object and copies the content from src to it.
757  *  \param  src  the source EC_KEY object
758  *  \return newly created EC_KEY object or NULL if an error occurred.
759  */
760 EC_KEY *EC_KEY_dup(const EC_KEY *src);
761
762 /** Increases the internal reference count of a EC_KEY object.
763  *  \param  key  EC_KEY object
764  *  \return 1 on success and 0 if an error occurred.
765  */
766 int EC_KEY_up_ref(EC_KEY *key);
767
768 /** Returns the EC_GROUP object of a EC_KEY object
769  *  \param  key  EC_KEY object
770  *  \return the EC_GROUP object (possibly NULL).
771  */
772 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
773
774 /** Sets the EC_GROUP of a EC_KEY object.
775  *  \param  key    EC_KEY object
776  *  \param  group  EC_GROUP to use in the EC_KEY object (note: the EC_KEY
777  *                 object will use an own copy of the EC_GROUP).
778  *  \return 1 on success and 0 if an error occurred.
779  */
780 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
781
782 /** Returns the private key of a EC_KEY object.
783  *  \param  key  EC_KEY object
784  *  \return a BIGNUM with the private key (possibly NULL).
785  */
786 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
787
788 /** Sets the private key of a EC_KEY object.
789  *  \param  key  EC_KEY object
790  *  \param  prv  BIGNUM with the private key (note: the EC_KEY object
791  *               will use an own copy of the BIGNUM).
792  *  \return 1 on success and 0 if an error occurred.
793  */
794 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
795
796 /** Returns the public key of a EC_KEY object.
797  *  \param  key  the EC_KEY object
798  *  \return a EC_POINT object with the public key (possibly NULL)
799  */
800 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
801
802 /** Sets the public key of a EC_KEY object.
803  *  \param  key  EC_KEY object
804  *  \param  pub  EC_POINT object with the public key (note: the EC_KEY object
805  *               will use an own copy of the EC_POINT object).
806  *  \return 1 on success and 0 if an error occurred.
807  */
808 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
809
810 unsigned EC_KEY_get_enc_flags(const EC_KEY *key);
811 void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);
812 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
813 void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
814 /* functions to set/get method specific data  */
815 void *EC_KEY_get_key_method_data(EC_KEY *key, 
816         void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *));
817 /** Sets the key method data of an EC_KEY object, if none has yet been set.
818  *  \param  key              EC_KEY object
819  *  \param  data             opaque data to install.
820  *  \param  dup_func         a function that duplicates |data|.
821  *  \param  free_func        a function that frees |data|.
822  *  \param  clear_free_func  a function that wipes and frees |data|.
823  *  \return the previously set data pointer, or NULL if |data| was inserted.
824  */
825 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
826         void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *));
827 /* wrapper functions for the underlying EC_GROUP object */
828 void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
829
830 /** Creates a table of pre-computed multiples of the generator to 
831  *  accelerate further EC_KEY operations.
832  *  \param  key  EC_KEY object
833  *  \param  ctx  BN_CTX object (optional)
834  *  \return 1 on success and 0 if an error occurred.
835  */
836 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
837
838 /** Creates a new ec private (and optional a new public) key.
839  *  \param  key  EC_KEY object
840  *  \return 1 on success and 0 if an error occurred.
841  */
842 int EC_KEY_generate_key(EC_KEY *key);
843
844 /** Verifies that a private and/or public key is valid.
845  *  \param  key  the EC_KEY object
846  *  \return 1 on success and 0 otherwise.
847  */
848 int EC_KEY_check_key(const EC_KEY *key);
849
850 /** Sets a public key from affine coordindates performing
851  *  neccessary NIST PKV tests.
852  *  \param  key  the EC_KEY object
853  *  \param  x    public key x coordinate
854  *  \param  y    public key y coordinate
855  *  \return 1 on success and 0 otherwise.
856  */
857 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
858
859
860 /********************************************************************/
861 /*        de- and encoding functions for SEC1 ECPrivateKey          */
862 /********************************************************************/
863
864 /** Decodes a private key from a memory buffer.
865  *  \param  key  a pointer to a EC_KEY object which should be used (or NULL)
866  *  \param  in   pointer to memory with the DER encoded private key
867  *  \param  len  length of the DER encoded private key
868  *  \return the decoded private key or NULL if an error occurred.
869  */
870 EC_KEY *d2i_ECPrivateKey(EC_KEY **key, const unsigned char **in, long len);
871
872 /** Encodes a private key object and stores the result in a buffer.
873  *  \param  key  the EC_KEY object to encode
874  *  \param  out  the buffer for the result (if NULL the function returns number
875  *               of bytes needed).
876  *  \return 1 on success and 0 if an error occurred.
877  */
878 int i2d_ECPrivateKey(EC_KEY *key, unsigned char **out);
879
880
881 /********************************************************************/
882 /*        de- and encoding functions for EC parameters              */
883 /********************************************************************/
884
885 /** Decodes ec parameter from a memory buffer.
886  *  \param  key  a pointer to a EC_KEY object which should be used (or NULL)
887  *  \param  in   pointer to memory with the DER encoded ec parameters
888  *  \param  len  length of the DER encoded ec parameters
889  *  \return a EC_KEY object with the decoded parameters or NULL if an error
890  *          occurred.
891  */
892 EC_KEY *d2i_ECParameters(EC_KEY **key, const unsigned char **in, long len);
893
894 /** Encodes ec parameter and stores the result in a buffer.
895  *  \param  key  the EC_KEY object with ec paramters to encode
896  *  \param  out  the buffer for the result (if NULL the function returns number
897  *               of bytes needed).
898  *  \return 1 on success and 0 if an error occurred.
899  */
900 int i2d_ECParameters(EC_KEY *key, unsigned char **out);
901
902
903 /********************************************************************/
904 /*         de- and encoding functions for EC public key             */
905 /*         (octet string, not DER -- hence 'o2i' and 'i2o')         */
906 /********************************************************************/
907
908 /** Decodes a ec public key from a octet string.
909  *  \param  key  a pointer to a EC_KEY object which should be used
910  *  \param  in   memory buffer with the encoded public key
911  *  \param  len  length of the encoded public key
912  *  \return EC_KEY object with decoded public key or NULL if an error
913  *          occurred.
914  */
915 EC_KEY *o2i_ECPublicKey(EC_KEY **key, const unsigned char **in, long len);
916
917 /** Encodes a ec public key in an octet string.
918  *  \param  key  the EC_KEY object with the public key
919  *  \param  out  the buffer for the result (if NULL the function returns number
920  *               of bytes needed).
921  *  \return 1 on success and 0 if an error occurred
922  */
923 int i2o_ECPublicKey(EC_KEY *key, unsigned char **out);
924
925 #ifndef OPENSSL_NO_BIO
926 /** Prints out the ec parameters on human readable form.
927  *  \param  bp   BIO object to which the information is printed
928  *  \param  key  EC_KEY object
929  *  \return 1 on success and 0 if an error occurred
930  */
931 int     ECParameters_print(BIO *bp, const EC_KEY *key);
932
933 /** Prints out the contents of a EC_KEY object
934  *  \param  bp   BIO object to which the information is printed
935  *  \param  key  EC_KEY object
936  *  \param  off  line offset 
937  *  \return 1 on success and 0 if an error occurred
938  */
939 int     EC_KEY_print(BIO *bp, const EC_KEY *key, int off);
940
941 #endif
942 #ifndef OPENSSL_NO_FP_API
943 /** Prints out the ec parameters on human readable form.
944  *  \param  fp   file descriptor to which the information is printed
945  *  \param  key  EC_KEY object
946  *  \return 1 on success and 0 if an error occurred
947  */
948 int     ECParameters_print_fp(FILE *fp, const EC_KEY *key);
949
950 /** Prints out the contents of a EC_KEY object
951  *  \param  fp   file descriptor to which the information is printed
952  *  \param  key  EC_KEY object
953  *  \param  off  line offset 
954  *  \return 1 on success and 0 if an error occurred
955  */
956 int     EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off);
957
958 #endif
959
960 #define ECParameters_dup(x) ASN1_dup_of(EC_KEY,i2d_ECParameters,d2i_ECParameters,x)
961
962 #ifndef __cplusplus
963 #if defined(__SUNPRO_C)
964 #  if __SUNPRO_C >= 0x520
965 # pragma error_messages (default,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
966 #  endif
967 # endif
968 #endif
969
970 #define EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid) \
971         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
972                                 EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
973                                 EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, nid, NULL)
974
975 #define EVP_PKEY_CTX_set_ec_param_enc(ctx, flag) \
976         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
977                                 EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
978                                 EVP_PKEY_CTRL_EC_PARAM_ENC, flag, NULL)
979
980 #define EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, flag) \
981         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
982                                 EVP_PKEY_OP_DERIVE, \
983                                 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, flag, NULL)
984
985 #define EVP_PKEY_CTX_get_ecdh_cofactor_mode(ctx) \
986         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
987                                 EVP_PKEY_OP_DERIVE, \
988                                 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, -2, NULL)
989
990 #define EVP_PKEY_CTX_set_ecdh_kdf_type(ctx, kdf) \
991         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
992                                 EVP_PKEY_OP_DERIVE, \
993                                 EVP_PKEY_CTRL_EC_KDF_TYPE, kdf, NULL)
994
995 #define EVP_PKEY_CTX_get_ecdh_kdf_type(ctx) \
996         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
997                                 EVP_PKEY_OP_DERIVE, \
998                                 EVP_PKEY_CTRL_EC_KDF_TYPE, -2, NULL)
999
1000 #define EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md) \
1001         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1002                                 EVP_PKEY_OP_DERIVE, \
1003                                 EVP_PKEY_CTRL_EC_KDF_MD, 0, (void *)md)
1004
1005 #define EVP_PKEY_CTX_get_ecdh_kdf_md(ctx, pmd) \
1006         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1007                                 EVP_PKEY_OP_DERIVE, \
1008                                 EVP_PKEY_CTRL_GET_EC_KDF_MD, 0, (void *)pmd)
1009
1010 #define EVP_PKEY_CTX_set_ecdh_kdf_outlen(ctx, len) \
1011         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1012                                 EVP_PKEY_OP_DERIVE, \
1013                                 EVP_PKEY_CTRL_EC_KDF_OUTLEN, len, NULL)
1014
1015 #define EVP_PKEY_CTX_get_ecdh_kdf_outlen(ctx, plen) \
1016         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1017                                 EVP_PKEY_OP_DERIVE, \
1018                         EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, 0, (void *)plen)
1019
1020 #define EVP_PKEY_CTX_set0_ecdh_kdf_ukm(ctx, p, plen) \
1021         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1022                                 EVP_PKEY_OP_DERIVE, \
1023                                 EVP_PKEY_CTRL_EC_KDF_UKM, plen, (void *)p)
1024
1025 #define EVP_PKEY_CTX_get0_ecdh_kdf_ukm(ctx, p) \
1026         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1027                                 EVP_PKEY_OP_DERIVE, \
1028                                 EVP_PKEY_CTRL_GET_EC_KDF_UKM, 0, (void *)p)
1029
1030 #define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID             (EVP_PKEY_ALG_CTRL + 1)
1031 #define EVP_PKEY_CTRL_EC_PARAM_ENC                      (EVP_PKEY_ALG_CTRL + 2)
1032 #define EVP_PKEY_CTRL_EC_ECDH_COFACTOR                  (EVP_PKEY_ALG_CTRL + 3)
1033 #define EVP_PKEY_CTRL_EC_KDF_TYPE                       (EVP_PKEY_ALG_CTRL + 4)
1034 #define EVP_PKEY_CTRL_EC_KDF_MD                         (EVP_PKEY_ALG_CTRL + 5)
1035 #define EVP_PKEY_CTRL_GET_EC_KDF_MD                     (EVP_PKEY_ALG_CTRL + 6)
1036 #define EVP_PKEY_CTRL_EC_KDF_OUTLEN                     (EVP_PKEY_ALG_CTRL + 7)
1037 #define EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN                 (EVP_PKEY_ALG_CTRL + 8)
1038 #define EVP_PKEY_CTRL_EC_KDF_UKM                        (EVP_PKEY_ALG_CTRL + 9)
1039 #define EVP_PKEY_CTRL_GET_EC_KDF_UKM                    (EVP_PKEY_ALG_CTRL + 10)
1040 /* KDF types */
1041 #define EVP_PKEY_ECDH_KDF_NONE                          1
1042 #define EVP_PKEY_ECDH_KDF_X9_62                         2
1043
1044 /* BEGIN ERROR CODES */
1045 /* The following lines are auto generated by the script mkerr.pl. Any changes
1046  * made after this point may be overwritten when the script is next run.
1047  */
1048 void ERR_load_EC_strings(void);
1049
1050 /* Error codes for the EC functions. */
1051
1052 /* Function codes. */
1053 #define EC_F_BN_TO_FELEM                                 224
1054 #define EC_F_COMPUTE_WNAF                                143
1055 #define EC_F_D2I_ECPARAMETERS                            144
1056 #define EC_F_D2I_ECPKPARAMETERS                          145
1057 #define EC_F_D2I_ECPRIVATEKEY                            146
1058 #define EC_F_DO_EC_KEY_PRINT                             221
1059 #define EC_F_ECDH_CMS_DECRYPT                            238
1060 #define EC_F_ECDH_CMS_SET_SHARED_INFO                    239
1061 #define EC_F_ECKEY_PARAM2TYPE                            223
1062 #define EC_F_ECKEY_PARAM_DECODE                          212
1063 #define EC_F_ECKEY_PRIV_DECODE                           213
1064 #define EC_F_ECKEY_PRIV_ENCODE                           214
1065 #define EC_F_ECKEY_PUB_DECODE                            215
1066 #define EC_F_ECKEY_PUB_ENCODE                            216
1067 #define EC_F_ECKEY_TYPE2PARAM                            220
1068 #define EC_F_ECPARAMETERS_PRINT                          147
1069 #define EC_F_ECPARAMETERS_PRINT_FP                       148
1070 #define EC_F_ECPKPARAMETERS_PRINT                        149
1071 #define EC_F_ECPKPARAMETERS_PRINT_FP                     150
1072 #define EC_F_ECP_NIST_MOD_192                            203
1073 #define EC_F_ECP_NIST_MOD_224                            204
1074 #define EC_F_ECP_NIST_MOD_256                            205
1075 #define EC_F_ECP_NIST_MOD_521                            206
1076 #define EC_F_EC_ASN1_GROUP2CURVE                         153
1077 #define EC_F_EC_ASN1_GROUP2FIELDID                       154
1078 #define EC_F_EC_ASN1_GROUP2PARAMETERS                    155
1079 #define EC_F_EC_ASN1_GROUP2PKPARAMETERS                  156
1080 #define EC_F_EC_ASN1_PARAMETERS2GROUP                    157
1081 #define EC_F_EC_ASN1_PKPARAMETERS2GROUP                  158
1082 #define EC_F_EC_EX_DATA_SET_DATA                         211
1083 #define EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY           208
1084 #define EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT     159
1085 #define EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE              195
1086 #define EC_F_EC_GF2M_SIMPLE_OCT2POINT                    160
1087 #define EC_F_EC_GF2M_SIMPLE_POINT2OCT                    161
1088 #define EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES 162
1089 #define EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES 163
1090 #define EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES   164
1091 #define EC_F_EC_GFP_MONT_FIELD_DECODE                    133
1092 #define EC_F_EC_GFP_MONT_FIELD_ENCODE                    134
1093 #define EC_F_EC_GFP_MONT_FIELD_MUL                       131
1094 #define EC_F_EC_GFP_MONT_FIELD_SET_TO_ONE                209
1095 #define EC_F_EC_GFP_MONT_FIELD_SQR                       132
1096 #define EC_F_EC_GFP_MONT_GROUP_SET_CURVE                 189
1097 #define EC_F_EC_GFP_MONT_GROUP_SET_CURVE_GFP             135
1098 #define EC_F_EC_GFP_NISTP224_GROUP_SET_CURVE             225
1099 #define EC_F_EC_GFP_NISTP224_POINTS_MUL                  228
1100 #define EC_F_EC_GFP_NISTP224_POINT_GET_AFFINE_COORDINATES 226
1101 #define EC_F_EC_GFP_NISTP256_GROUP_SET_CURVE             230
1102 #define EC_F_EC_GFP_NISTP256_POINTS_MUL                  231
1103 #define EC_F_EC_GFP_NISTP256_POINT_GET_AFFINE_COORDINATES 232
1104 #define EC_F_EC_GFP_NISTP521_GROUP_SET_CURVE             233
1105 #define EC_F_EC_GFP_NISTP521_POINTS_MUL                  234
1106 #define EC_F_EC_GFP_NISTP521_POINT_GET_AFFINE_COORDINATES 235
1107 #define EC_F_EC_GFP_NIST_FIELD_MUL                       200
1108 #define EC_F_EC_GFP_NIST_FIELD_SQR                       201
1109 #define EC_F_EC_GFP_NIST_GROUP_SET_CURVE                 202
1110 #define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT      165
1111 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE               166
1112 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP           100
1113 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR           101
1114 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE                   102
1115 #define EC_F_EC_GFP_SIMPLE_OCT2POINT                     103
1116 #define EC_F_EC_GFP_SIMPLE_POINT2OCT                     104
1117 #define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE            137
1118 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES  167
1119 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
1120 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES  168
1121 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
1122 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES    169
1123 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
1124 #define EC_F_EC_GROUP_CHECK                              170
1125 #define EC_F_EC_GROUP_CHECK_DISCRIMINANT                 171
1126 #define EC_F_EC_GROUP_COPY                               106
1127 #define EC_F_EC_GROUP_GET0_GENERATOR                     139
1128 #define EC_F_EC_GROUP_GET_COFACTOR                       140
1129 #define EC_F_EC_GROUP_GET_CURVE_GF2M                     172
1130 #define EC_F_EC_GROUP_GET_CURVE_GFP                      130
1131 #define EC_F_EC_GROUP_GET_DEGREE                         173
1132 #define EC_F_EC_GROUP_GET_ORDER                          141
1133 #define EC_F_EC_GROUP_GET_PENTANOMIAL_BASIS              193
1134 #define EC_F_EC_GROUP_GET_TRINOMIAL_BASIS                194
1135 #define EC_F_EC_GROUP_NEW                                108
1136 #define EC_F_EC_GROUP_NEW_BY_CURVE_NAME                  174
1137 #define EC_F_EC_GROUP_NEW_FROM_DATA                      175
1138 #define EC_F_EC_GROUP_PRECOMPUTE_MULT                    142
1139 #define EC_F_EC_GROUP_SET_CURVE_GF2M                     176
1140 #define EC_F_EC_GROUP_SET_CURVE_GFP                      109
1141 #define EC_F_EC_GROUP_SET_EXTRA_DATA                     110
1142 #define EC_F_EC_GROUP_SET_GENERATOR                      111
1143 #define EC_F_EC_KEY_CHECK_KEY                            177
1144 #define EC_F_EC_KEY_COPY                                 178
1145 #define EC_F_EC_KEY_GENERATE_KEY                         179
1146 #define EC_F_EC_KEY_NEW                                  182
1147 #define EC_F_EC_KEY_PRINT                                180
1148 #define EC_F_EC_KEY_PRINT_FP                             181
1149 #define EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES    229
1150 #define EC_F_EC_POINTS_MAKE_AFFINE                       136
1151 #define EC_F_EC_POINT_ADD                                112
1152 #define EC_F_EC_POINT_CMP                                113
1153 #define EC_F_EC_POINT_COPY                               114
1154 #define EC_F_EC_POINT_DBL                                115
1155 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M        183
1156 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP         116
1157 #define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP    117
1158 #define EC_F_EC_POINT_INVERT                             210
1159 #define EC_F_EC_POINT_IS_AT_INFINITY                     118
1160 #define EC_F_EC_POINT_IS_ON_CURVE                        119
1161 #define EC_F_EC_POINT_MAKE_AFFINE                        120
1162 #define EC_F_EC_POINT_MUL                                184
1163 #define EC_F_EC_POINT_NEW                                121
1164 #define EC_F_EC_POINT_OCT2POINT                          122
1165 #define EC_F_EC_POINT_POINT2OCT                          123
1166 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M        185
1167 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP         124
1168 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M    186
1169 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP     125
1170 #define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP    126
1171 #define EC_F_EC_POINT_SET_TO_INFINITY                    127
1172 #define EC_F_EC_PRE_COMP_DUP                             207
1173 #define EC_F_EC_PRE_COMP_NEW                             196
1174 #define EC_F_EC_WNAF_MUL                                 187
1175 #define EC_F_EC_WNAF_PRECOMPUTE_MULT                     188
1176 #define EC_F_I2D_ECPARAMETERS                            190
1177 #define EC_F_I2D_ECPKPARAMETERS                          191
1178 #define EC_F_I2D_ECPRIVATEKEY                            192
1179 #define EC_F_I2O_ECPUBLICKEY                             151
1180 #define EC_F_NISTP224_PRE_COMP_NEW                       227
1181 #define EC_F_NISTP256_PRE_COMP_NEW                       236
1182 #define EC_F_NISTP521_PRE_COMP_NEW                       237
1183 #define EC_F_O2I_ECPUBLICKEY                             152
1184 #define EC_F_OLD_EC_PRIV_DECODE                          222
1185 #define EC_F_PKEY_EC_CTRL                                197
1186 #define EC_F_PKEY_EC_CTRL_STR                            198
1187 #define EC_F_PKEY_EC_DERIVE                              217
1188 #define EC_F_PKEY_EC_KEYGEN                              199
1189 #define EC_F_PKEY_EC_PARAMGEN                            219
1190 #define EC_F_PKEY_EC_SIGN                                218
1191
1192 /* Reason codes. */
1193 #define EC_R_ASN1_ERROR                                  115
1194 #define EC_R_ASN1_UNKNOWN_FIELD                          116
1195 #define EC_R_BIGNUM_OUT_OF_RANGE                         144
1196 #define EC_R_BUFFER_TOO_SMALL                            100
1197 #define EC_R_COORDINATES_OUT_OF_RANGE                    146
1198 #define EC_R_D2I_ECPKPARAMETERS_FAILURE                  117
1199 #define EC_R_DECODE_ERROR                                142
1200 #define EC_R_DISCRIMINANT_IS_ZERO                        118
1201 #define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE                119
1202 #define EC_R_FIELD_TOO_LARGE                             143
1203 #define EC_R_GF2M_NOT_SUPPORTED                          147
1204 #define EC_R_GROUP2PKPARAMETERS_FAILURE                  120
1205 #define EC_R_I2D_ECPKPARAMETERS_FAILURE                  121
1206 #define EC_R_INCOMPATIBLE_OBJECTS                        101
1207 #define EC_R_INVALID_ARGUMENT                            112
1208 #define EC_R_INVALID_COMPRESSED_POINT                    110
1209 #define EC_R_INVALID_COMPRESSION_BIT                     109
1210 #define EC_R_INVALID_CURVE                               141
1211 #define EC_R_INVALID_DIGEST                              151
1212 #define EC_R_INVALID_DIGEST_TYPE                         138
1213 #define EC_R_INVALID_ENCODING                            102
1214 #define EC_R_INVALID_FIELD                               103
1215 #define EC_R_INVALID_FORM                                104
1216 #define EC_R_INVALID_GROUP_ORDER                         122
1217 #define EC_R_INVALID_PENTANOMIAL_BASIS                   132
1218 #define EC_R_INVALID_PRIVATE_KEY                         123
1219 #define EC_R_INVALID_TRINOMIAL_BASIS                     137
1220 #define EC_R_KDF_PARAMETER_ERROR                         148
1221 #define EC_R_KEYS_NOT_SET                                140
1222 #define EC_R_MISSING_PARAMETERS                          124
1223 #define EC_R_MISSING_PRIVATE_KEY                         125
1224 #define EC_R_NOT_A_NIST_PRIME                            135
1225 #define EC_R_NOT_A_SUPPORTED_NIST_PRIME                  136
1226 #define EC_R_NOT_IMPLEMENTED                             126
1227 #define EC_R_NOT_INITIALIZED                             111
1228 #define EC_R_NO_FIELD_MOD                                133
1229 #define EC_R_NO_PARAMETERS_SET                           139
1230 #define EC_R_PASSED_NULL_PARAMETER                       134
1231 #define EC_R_PEER_KEY_ERROR                              149
1232 #define EC_R_PKPARAMETERS2GROUP_FAILURE                  127
1233 #define EC_R_POINT_AT_INFINITY                           106
1234 #define EC_R_POINT_IS_NOT_ON_CURVE                       107
1235 #define EC_R_SHARED_INFO_ERROR                           150
1236 #define EC_R_SLOT_FULL                                   108
1237 #define EC_R_UNDEFINED_GENERATOR                         113
1238 #define EC_R_UNDEFINED_ORDER                             128
1239 #define EC_R_UNKNOWN_GROUP                               129
1240 #define EC_R_UNKNOWN_ORDER                               114
1241 #define EC_R_UNSUPPORTED_FIELD                           131
1242 #define EC_R_WRONG_CURVE_PARAMETERS                      145
1243 #define EC_R_WRONG_ORDER                                 130
1244
1245 #ifdef  __cplusplus
1246 }
1247 #endif
1248 #endif