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