Update source files for pre-3.0 deprecation
[openssl.git] / include / openssl / ec.h
1 /*
2  * Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10
11 #ifndef OPENSSL_EC_H
12 # define OPENSSL_EC_H
13 # pragma once
14
15 # include <openssl/macros.h>
16 # ifndef OPENSSL_NO_DEPRECATED_3_0
17 #  define HEADER_EC_H
18 # endif
19
20 # include <openssl/opensslconf.h>
21
22 # ifndef OPENSSL_NO_EC
23 # include <openssl/asn1.h>
24 # include <openssl/symhacks.h>
25 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
26 #  include <openssl/bn.h>
27 # endif
28 # include <openssl/ecerr.h>
29 # ifdef  __cplusplus
30 extern "C" {
31 # endif
32
33 # ifndef OPENSSL_ECC_MAX_FIELD_BITS
34 #  define OPENSSL_ECC_MAX_FIELD_BITS 661
35 # endif
36
37 /** Enum for the point conversion form as defined in X9.62 (ECDSA)
38  *  for the encoding of a elliptic curve point (x,y) */
39 typedef enum {
40         /** the point is encoded as z||x, where the octet z specifies
41          *  which solution of the quadratic equation y is  */
42     POINT_CONVERSION_COMPRESSED = 2,
43         /** the point is encoded as z||x||y, where z is the octet 0x04  */
44     POINT_CONVERSION_UNCOMPRESSED = 4,
45         /** the point is encoded as z||x||y, where the octet z specifies
46          *  which solution of the quadratic equation y is  */
47     POINT_CONVERSION_HYBRID = 6
48 } point_conversion_form_t;
49
50 typedef struct ec_method_st EC_METHOD;
51 typedef struct ec_group_st EC_GROUP;
52 typedef struct ec_point_st EC_POINT;
53 typedef struct ecpk_parameters_st ECPKPARAMETERS;
54 typedef struct ec_parameters_st ECPARAMETERS;
55
56 /********************************************************************/
57 /*               EC_METHODs for curves over GF(p)                   */
58 /********************************************************************/
59
60 /** Returns the basic GFp ec methods which provides the basis for the
61  *  optimized methods.
62  *  \return  EC_METHOD object
63  */
64 const EC_METHOD *EC_GFp_simple_method(void);
65
66 /** Returns GFp methods using montgomery multiplication.
67  *  \return  EC_METHOD object
68  */
69 const EC_METHOD *EC_GFp_mont_method(void);
70
71 /** Returns GFp methods using optimized methods for NIST recommended curves
72  *  \return  EC_METHOD object
73  */
74 const EC_METHOD *EC_GFp_nist_method(void);
75
76 # ifndef OPENSSL_NO_EC_NISTP_64_GCC_128
77 /** Returns 64-bit optimized methods for nistp224
78  *  \return  EC_METHOD object
79  */
80 const EC_METHOD *EC_GFp_nistp224_method(void);
81
82 /** Returns 64-bit optimized methods for nistp256
83  *  \return  EC_METHOD object
84  */
85 const EC_METHOD *EC_GFp_nistp256_method(void);
86
87 /** Returns 64-bit optimized methods for nistp521
88  *  \return  EC_METHOD object
89  */
90 const EC_METHOD *EC_GFp_nistp521_method(void);
91 # endif
92
93 # ifndef OPENSSL_NO_EC2M
94 /********************************************************************/
95 /*           EC_METHOD for curves over GF(2^m)                      */
96 /********************************************************************/
97
98 /** Returns the basic GF2m ec method
99  *  \return  EC_METHOD object
100  */
101 const EC_METHOD *EC_GF2m_simple_method(void);
102
103 # endif
104
105 /********************************************************************/
106 /*                   EC_GROUP functions                             */
107 /********************************************************************/
108
109 /**
110  *  Creates a new EC_GROUP object
111  *  \param   libctx The associated library context or NULL for the default
112  *                  library context
113  *  \param   meth   EC_METHOD to use
114  *  \return  newly created EC_GROUP object or NULL in case of an error.
115  */
116 EC_GROUP *EC_GROUP_new_ex(OPENSSL_CTX *libctx, const EC_METHOD *meth);
117
118 /**
119  *  Creates a new EC_GROUP object. Same as EC_GROUP_new_ex with NULL for the
120  *  library context.
121  *  \param   meth   EC_METHOD to use
122  *  \return  newly created EC_GROUP object or NULL in case of an error.
123  */
124 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth);
125
126 /** Frees a EC_GROUP object
127  *  \param  group  EC_GROUP object to be freed.
128  */
129 void EC_GROUP_free(EC_GROUP *group);
130
131 /** Clears and frees a EC_GROUP object
132  *  \param  group  EC_GROUP object to be cleared and freed.
133  */
134 DEPRECATEDIN_3_0(void EC_GROUP_clear_free(EC_GROUP *group))
135
136 /** Copies EC_GROUP objects. Note: both EC_GROUPs must use the same EC_METHOD.
137  *  \param  dst  destination EC_GROUP object
138  *  \param  src  source EC_GROUP object
139  *  \return 1 on success and 0 if an error occurred.
140  */
141 int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
142
143 /** Creates a new EC_GROUP object and copies the content
144  *  form src to the newly created EC_KEY object
145  *  \param  src  source EC_GROUP object
146  *  \return newly created EC_GROUP object or NULL in case of an error.
147  */
148 EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
149
150 /** Returns the EC_METHOD of the EC_GROUP object.
151  *  \param  group  EC_GROUP object
152  *  \return EC_METHOD used in this EC_GROUP object.
153  */
154 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
155
156 /** Returns the field type of the EC_METHOD.
157  *  \param  meth  EC_METHOD object
158  *  \return NID of the underlying field type OID.
159  */
160 int EC_METHOD_get_field_type(const EC_METHOD *meth);
161
162 /** Sets the generator and its order/cofactor of a EC_GROUP object.
163  *  \param  group      EC_GROUP object
164  *  \param  generator  EC_POINT object with the generator.
165  *  \param  order      the order of the group generated by the generator.
166  *  \param  cofactor   the index of the sub-group generated by the generator
167  *                     in the group of all points on the elliptic curve.
168  *  \return 1 on success and 0 if an error occurred
169  */
170 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator,
171                            const BIGNUM *order, const BIGNUM *cofactor);
172
173 /** Returns the generator of a EC_GROUP object.
174  *  \param  group  EC_GROUP object
175  *  \return the currently used generator (possibly NULL).
176  */
177 const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
178
179 /** Returns the montgomery data for order(Generator)
180  *  \param  group  EC_GROUP object
181  *  \return the currently used montgomery data (possibly NULL).
182 */
183 BN_MONT_CTX *EC_GROUP_get_mont_data(const EC_GROUP *group);
184
185 /** Gets the order of a EC_GROUP
186  *  \param  group  EC_GROUP object
187  *  \param  order  BIGNUM to which the order is copied
188  *  \param  ctx    unused
189  *  \return 1 on success and 0 if an error occurred
190  */
191 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
192
193 /** Gets the order of an EC_GROUP
194  *  \param  group  EC_GROUP object
195  *  \return the group order
196  */
197 const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);
198
199 /** Gets the number of bits of the order of an EC_GROUP
200  *  \param  group  EC_GROUP object
201  *  \return number of bits of group order.
202  */
203 int EC_GROUP_order_bits(const EC_GROUP *group);
204
205 /** Gets the cofactor of a EC_GROUP
206  *  \param  group     EC_GROUP object
207  *  \param  cofactor  BIGNUM to which the cofactor is copied
208  *  \param  ctx       unused
209  *  \return 1 on success and 0 if an error occurred
210  */
211 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor,
212                           BN_CTX *ctx);
213
214 /** Gets the cofactor of an EC_GROUP
215  *  \param  group  EC_GROUP object
216  *  \return the group cofactor
217  */
218 const BIGNUM *EC_GROUP_get0_cofactor(const EC_GROUP *group);
219
220 /** Sets the name of a EC_GROUP object
221  *  \param  group  EC_GROUP object
222  *  \param  nid    NID of the curve name OID
223  */
224 void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
225
226 /** Returns the curve name of a EC_GROUP object
227  *  \param  group  EC_GROUP object
228  *  \return NID of the curve name OID or 0 if not set.
229  */
230 int EC_GROUP_get_curve_name(const EC_GROUP *group);
231
232 /** Gets the field of an EC_GROUP
233  *  \param  group  EC_GROUP object
234  *  \return the group field
235  */
236 const BIGNUM *EC_GROUP_get0_field(const EC_GROUP *group);
237
238 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
239 int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
240
241 void EC_GROUP_set_point_conversion_form(EC_GROUP *group,
242                                         point_conversion_form_t form);
243 point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
244
245 unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
246 size_t EC_GROUP_get_seed_len(const EC_GROUP *);
247 size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
248
249 /** Sets the parameters of a ec curve defined by y^2 = x^3 + a*x + b (for GFp)
250  *  or y^2 + x*y = x^3 + a*x^2 + b (for GF2m)
251  *  \param  group  EC_GROUP object
252  *  \param  p      BIGNUM with the prime number (GFp) or the polynomial
253  *                 defining the underlying field (GF2m)
254  *  \param  a      BIGNUM with parameter a of the equation
255  *  \param  b      BIGNUM with parameter b of the equation
256  *  \param  ctx    BN_CTX object (optional)
257  *  \return 1 on success and 0 if an error occurred
258  */
259 int EC_GROUP_set_curve(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,
260                        const BIGNUM *b, BN_CTX *ctx);
261
262 /** Gets the parameters of the ec curve defined by y^2 = x^3 + a*x + b (for GFp)
263  *  or y^2 + x*y = x^3 + a*x^2 + b (for GF2m)
264  *  \param  group  EC_GROUP object
265  *  \param  p      BIGNUM with the prime number (GFp) or the polynomial
266  *                 defining the underlying field (GF2m)
267  *  \param  a      BIGNUM for parameter a of the equation
268  *  \param  b      BIGNUM for parameter b of the equation
269  *  \param  ctx    BN_CTX object (optional)
270  *  \return 1 on success and 0 if an error occurred
271  */
272 int EC_GROUP_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b,
273                        BN_CTX *ctx);
274
275 /** Sets the parameters of an ec curve. Synonym for EC_GROUP_set_curve
276  *  \param  group  EC_GROUP object
277  *  \param  p      BIGNUM with the prime number (GFp) or the polynomial
278  *                 defining the underlying field (GF2m)
279  *  \param  a      BIGNUM with parameter a of the equation
280  *  \param  b      BIGNUM with parameter b of the equation
281  *  \param  ctx    BN_CTX object (optional)
282  *  \return 1 on success and 0 if an error occurred
283  */
284 DEPRECATEDIN_3_0(int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p,
285                                           const BIGNUM *a, const BIGNUM *b,
286                                           BN_CTX *ctx))
287
288 /** Gets the parameters of an ec curve. Synonym for EC_GROUP_get_curve
289  *  \param  group  EC_GROUP object
290  *  \param  p      BIGNUM with the prime number (GFp) or the polynomial
291  *                 defining the underlying field (GF2m)
292  *  \param  a      BIGNUM for parameter a of the equation
293  *  \param  b      BIGNUM for parameter b of the equation
294  *  \param  ctx    BN_CTX object (optional)
295  *  \return 1 on success and 0 if an error occurred
296  */
297 DEPRECATEDIN_3_0(int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p,
298                                           BIGNUM *a, BIGNUM *b,
299                                           BN_CTX *ctx))
300
301 # ifndef OPENSSL_NO_EC2M
302 /** Sets the parameter of an ec curve. Synonym for EC_GROUP_set_curve
303  *  \param  group  EC_GROUP object
304  *  \param  p      BIGNUM with the prime number (GFp) or the polynomial
305  *                 defining the underlying field (GF2m)
306  *  \param  a      BIGNUM with parameter a of the equation
307  *  \param  b      BIGNUM with parameter b of the equation
308  *  \param  ctx    BN_CTX object (optional)
309  *  \return 1 on success and 0 if an error occurred
310  */
311 DEPRECATEDIN_3_0(int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p,
312                                            const BIGNUM *a, const BIGNUM *b,
313                                            BN_CTX *ctx))
314
315 /** Gets the parameters of an ec curve. Synonym for EC_GROUP_get_curve
316  *  \param  group  EC_GROUP object
317  *  \param  p      BIGNUM with the prime number (GFp) or the polynomial
318  *                 defining the underlying field (GF2m)
319  *  \param  a      BIGNUM for parameter a of the equation
320  *  \param  b      BIGNUM for parameter b of the equation
321  *  \param  ctx    BN_CTX object (optional)
322  *  \return 1 on success and 0 if an error occurred
323  */
324 DEPRECATEDIN_3_0(int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p,
325                                            BIGNUM *a, BIGNUM *b,
326                                            BN_CTX *ctx))
327 # endif
328 /** Returns the number of bits needed to represent a field element
329  *  \param  group  EC_GROUP object
330  *  \return number of bits needed to represent a field element
331  */
332 int EC_GROUP_get_degree(const EC_GROUP *group);
333
334 /** Checks whether the parameter in the EC_GROUP define a valid ec group
335  *  \param  group  EC_GROUP object
336  *  \param  ctx    BN_CTX object (optional)
337  *  \return 1 if group is a valid ec group and 0 otherwise
338  */
339 int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
340
341 /** Checks whether the discriminant of the elliptic curve is zero or not
342  *  \param  group  EC_GROUP object
343  *  \param  ctx    BN_CTX object (optional)
344  *  \return 1 if the discriminant is not zero and 0 otherwise
345  */
346 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
347
348 /** Compares two EC_GROUP objects
349  *  \param  a    first EC_GROUP object
350  *  \param  b    second EC_GROUP object
351  *  \param  ctx  BN_CTX object (optional)
352  *  \return 0 if the groups are equal, 1 if not, or -1 on error
353  */
354 int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
355
356 /*
357  * EC_GROUP_new_GF*() calls EC_GROUP_new() and EC_GROUP_set_GF*() after
358  * choosing an appropriate EC_METHOD
359  */
360
361 /** Creates a new EC_GROUP object with the specified parameters defined
362  *  over GFp (defined by the equation y^2 = x^3 + a*x + b)
363  *  \param  p    BIGNUM with the prime number
364  *  \param  a    BIGNUM with the parameter a of the equation
365  *  \param  b    BIGNUM with the parameter b of the equation
366  *  \param  ctx  BN_CTX object (optional)
367  *  \return newly created EC_GROUP object with the specified parameters
368  */
369 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a,
370                                  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,
381                                   const BIGNUM *b, BN_CTX *ctx);
382 # endif
383
384 /**
385  * Creates a EC_GROUP object with a curve specified by a NID
386  *  \param  libctx The associated library context or NULL for the default
387  *                 context
388  *  \param  nid    NID of the OID of the curve name
389  *  \return newly created EC_GROUP object with specified curve or NULL
390  *          if an error occurred
391  */
392 EC_GROUP *EC_GROUP_new_by_curve_name_ex(OPENSSL_CTX *libctx, int nid);
393
394 /**
395  * Creates a EC_GROUP object with a curve specified by a NID. Same as
396  * EC_GROUP_new_by_curve_name_ex but the libctx is always NULL.
397  *  \param  nid    NID of the OID of the curve name
398  *  \return newly created EC_GROUP object with specified curve or NULL
399  *          if an error occurred
400  */
401 EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
402
403 /** Creates a new EC_GROUP object from an ECPARAMETERS object
404  *  \param  params  pointer to the ECPARAMETERS object
405  *  \return newly created EC_GROUP object with specified curve or NULL
406  *          if an error occurred
407  */
408 EC_GROUP *EC_GROUP_new_from_ecparameters(const ECPARAMETERS *params);
409
410 /** Creates an ECPARAMETERS object for the given EC_GROUP object.
411  *  \param  group   pointer to the EC_GROUP object
412  *  \param  params  pointer to an existing ECPARAMETERS object or NULL
413  *  \return pointer to the new ECPARAMETERS object or NULL
414  *          if an error occurred.
415  */
416 ECPARAMETERS *EC_GROUP_get_ecparameters(const EC_GROUP *group,
417                                         ECPARAMETERS *params);
418
419 /** Creates a new EC_GROUP object from an ECPKPARAMETERS object
420  *  \param  params  pointer to an existing ECPKPARAMETERS object, or NULL
421  *  \return newly created EC_GROUP object with specified curve, or NULL
422  *          if an error occurred
423  */
424 EC_GROUP *EC_GROUP_new_from_ecpkparameters(const ECPKPARAMETERS *params);
425
426 /** Creates an ECPKPARAMETERS object for the given EC_GROUP object.
427  *  \param  group   pointer to the EC_GROUP object
428  *  \param  params  pointer to an existing ECPKPARAMETERS object or NULL
429  *  \return pointer to the new ECPKPARAMETERS object or NULL
430  *          if an error occurred.
431  */
432 ECPKPARAMETERS *EC_GROUP_get_ecpkparameters(const EC_GROUP *group,
433                                             ECPKPARAMETERS *params);
434
435 /********************************************************************/
436 /*               handling of internal curves                        */
437 /********************************************************************/
438
439 typedef struct {
440     int nid;
441     const char *comment;
442 } EC_builtin_curve;
443
444 /*
445  * EC_builtin_curves(EC_builtin_curve *r, size_t size) returns number of all
446  * available curves or zero if a error occurred. In case r is not zero,
447  * nitems EC_builtin_curve structures are filled with the data of the first
448  * nitems internal groups
449  */
450 size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems);
451
452 const char *EC_curve_nid2nist(int nid);
453 int EC_curve_nist2nid(const char *name);
454 int EC_GROUP_check_named_curve(const EC_GROUP *group, int nist_only,
455                                BN_CTX *ctx);
456
457 /********************************************************************/
458 /*                    EC_POINT functions                            */
459 /********************************************************************/
460
461 /** Creates a new EC_POINT object for the specified EC_GROUP
462  *  \param  group  EC_GROUP the underlying EC_GROUP object
463  *  \return newly created EC_POINT object or NULL if an error occurred
464  */
465 EC_POINT *EC_POINT_new(const EC_GROUP *group);
466
467 /** Frees a EC_POINT object
468  *  \param  point  EC_POINT object to be freed
469  */
470 void EC_POINT_free(EC_POINT *point);
471
472 /** Clears and frees a EC_POINT object
473  *  \param  point  EC_POINT object to be cleared and freed
474  */
475 void EC_POINT_clear_free(EC_POINT *point);
476
477 /** Copies EC_POINT object
478  *  \param  dst  destination EC_POINT object
479  *  \param  src  source EC_POINT object
480  *  \return 1 on success and 0 if an error occurred
481  */
482 int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
483
484 /** Creates a new EC_POINT object and copies the content of the supplied
485  *  EC_POINT
486  *  \param  src    source EC_POINT object
487  *  \param  group  underlying the EC_GROUP object
488  *  \return newly created EC_POINT object or NULL if an error occurred
489  */
490 EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
491
492 /** Returns the EC_METHOD used in EC_POINT object
493  *  \param  point  EC_POINT object
494  *  \return the EC_METHOD used
495  */
496 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
497
498 /** Sets a point to infinity (neutral element)
499  *  \param  group  underlying EC_GROUP object
500  *  \param  point  EC_POINT to set to infinity
501  *  \return 1 on success and 0 if an error occurred
502  */
503 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
504
505 /** Sets the jacobian projective coordinates of a EC_POINT over GFp
506  *  \param  group  underlying EC_GROUP object
507  *  \param  p      EC_POINT object
508  *  \param  x      BIGNUM with the x-coordinate
509  *  \param  y      BIGNUM with the y-coordinate
510  *  \param  z      BIGNUM with the z-coordinate
511  *  \param  ctx    BN_CTX object (optional)
512  *  \return 1 on success and 0 if an error occurred
513  */
514 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group,
515                                              EC_POINT *p, const BIGNUM *x,
516                                              const BIGNUM *y, const BIGNUM *z,
517                                              BN_CTX *ctx);
518
519 /** Gets the jacobian projective coordinates of a EC_POINT over GFp
520  *  \param  group  underlying EC_GROUP object
521  *  \param  p      EC_POINT object
522  *  \param  x      BIGNUM for the x-coordinate
523  *  \param  y      BIGNUM for the y-coordinate
524  *  \param  z      BIGNUM for the z-coordinate
525  *  \param  ctx    BN_CTX object (optional)
526  *  \return 1 on success and 0 if an error occurred
527  */
528 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
529                                              const EC_POINT *p, BIGNUM *x,
530                                              BIGNUM *y, BIGNUM *z,
531                                              BN_CTX *ctx);
532
533 /** Sets the affine coordinates of an EC_POINT
534  *  \param  group  underlying EC_GROUP object
535  *  \param  p      EC_POINT object
536  *  \param  x      BIGNUM with the x-coordinate
537  *  \param  y      BIGNUM with the y-coordinate
538  *  \param  ctx    BN_CTX object (optional)
539  *  \return 1 on success and 0 if an error occurred
540  */
541 int EC_POINT_set_affine_coordinates(const EC_GROUP *group, EC_POINT *p,
542                                     const BIGNUM *x, const BIGNUM *y,
543                                     BN_CTX *ctx);
544
545 /** Gets the affine coordinates of an EC_POINT.
546  *  \param  group  underlying EC_GROUP object
547  *  \param  p      EC_POINT object
548  *  \param  x      BIGNUM for the x-coordinate
549  *  \param  y      BIGNUM for the y-coordinate
550  *  \param  ctx    BN_CTX object (optional)
551  *  \return 1 on success and 0 if an error occurred
552  */
553 int EC_POINT_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *p,
554                                     BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
555
556 /** Sets the affine coordinates of an EC_POINT. A synonym of
557  *  EC_POINT_set_affine_coordinates
558  *  \param  group  underlying EC_GROUP object
559  *  \param  p      EC_POINT object
560  *  \param  x      BIGNUM with the x-coordinate
561  *  \param  y      BIGNUM with the y-coordinate
562  *  \param  ctx    BN_CTX object (optional)
563  *  \return 1 on success and 0 if an error occurred
564  */
565 DEPRECATEDIN_3_0(int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group,
566                                                        EC_POINT *p,
567                                                        const BIGNUM *x,
568                                                        const BIGNUM *y,
569                                                        BN_CTX *ctx))
570
571 /** Gets the affine coordinates of an EC_POINT. A synonym of
572  *  EC_POINT_get_affine_coordinates
573  *  \param  group  underlying EC_GROUP object
574  *  \param  p      EC_POINT object
575  *  \param  x      BIGNUM for the x-coordinate
576  *  \param  y      BIGNUM for the y-coordinate
577  *  \param  ctx    BN_CTX object (optional)
578  *  \return 1 on success and 0 if an error occurred
579  */
580 DEPRECATEDIN_3_0(int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
581                                                        const EC_POINT *p,
582                                                        BIGNUM *x,
583                                                        BIGNUM *y,
584                                                        BN_CTX *ctx))
585
586 /** Sets the x9.62 compressed coordinates of a EC_POINT
587  *  \param  group  underlying EC_GROUP object
588  *  \param  p      EC_POINT object
589  *  \param  x      BIGNUM with x-coordinate
590  *  \param  y_bit  integer with the y-Bit (either 0 or 1)
591  *  \param  ctx    BN_CTX object (optional)
592  *  \return 1 on success and 0 if an error occurred
593  */
594 int EC_POINT_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *p,
595                                         const BIGNUM *x, int y_bit,
596                                         BN_CTX *ctx);
597
598 /** Sets the x9.62 compressed coordinates of a EC_POINT. A synonym of
599  *  EC_POINT_set_compressed_coordinates
600  *  \param  group  underlying EC_GROUP object
601  *  \param  p      EC_POINT object
602  *  \param  x      BIGNUM with x-coordinate
603  *  \param  y_bit  integer with the y-Bit (either 0 or 1)
604  *  \param  ctx    BN_CTX object (optional)
605  *  \return 1 on success and 0 if an error occurred
606  */
607 DEPRECATEDIN_3_0(int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group,
608                                                            EC_POINT *p,
609                                                            const BIGNUM *x,
610                                                            int y_bit,
611                                                            BN_CTX *ctx))
612 # ifndef OPENSSL_NO_EC2M
613 /** Sets the affine coordinates of an EC_POINT. A synonym of
614  *  EC_POINT_set_affine_coordinates
615  *  \param  group  underlying EC_GROUP object
616  *  \param  p      EC_POINT object
617  *  \param  x      BIGNUM with the x-coordinate
618  *  \param  y      BIGNUM with the y-coordinate
619  *  \param  ctx    BN_CTX object (optional)
620  *  \return 1 on success and 0 if an error occurred
621  */
622 DEPRECATEDIN_3_0(int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group,
623                                                         EC_POINT *p,
624                                                         const BIGNUM *x,
625                                                         const BIGNUM *y,
626                                                         BN_CTX *ctx))
627
628 /** Gets the affine coordinates of an EC_POINT. A synonym of
629  *  EC_POINT_get_affine_coordinates
630  *  \param  group  underlying EC_GROUP object
631  *  \param  p      EC_POINT object
632  *  \param  x      BIGNUM for the x-coordinate
633  *  \param  y      BIGNUM for the y-coordinate
634  *  \param  ctx    BN_CTX object (optional)
635  *  \return 1 on success and 0 if an error occurred
636  */
637 DEPRECATEDIN_3_0(int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,
638                                                         const EC_POINT *p,
639                                                         BIGNUM *x,
640                                                         BIGNUM *y,
641                                                         BN_CTX *ctx))
642
643 /** Sets the x9.62 compressed coordinates of a EC_POINT. A synonym of
644  *  EC_POINT_set_compressed_coordinates
645  *  \param  group  underlying EC_GROUP object
646  *  \param  p      EC_POINT object
647  *  \param  x      BIGNUM with x-coordinate
648  *  \param  y_bit  integer with the y-Bit (either 0 or 1)
649  *  \param  ctx    BN_CTX object (optional)
650  *  \return 1 on success and 0 if an error occurred
651  */
652 DEPRECATEDIN_3_0(int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group,
653                                                             EC_POINT *p,
654                                                             const BIGNUM *x,
655                                                             int y_bit,
656                                                             BN_CTX *ctx))
657 # endif
658 /** Encodes a EC_POINT object to a octet string
659  *  \param  group  underlying EC_GROUP object
660  *  \param  p      EC_POINT object
661  *  \param  form   point conversion form
662  *  \param  buf    memory buffer for the result. If NULL the function returns
663  *                 required buffer size.
664  *  \param  len    length of the memory buffer
665  *  \param  ctx    BN_CTX object (optional)
666  *  \return the length of the encoded octet string or 0 if an error occurred
667  */
668 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
669                           point_conversion_form_t form,
670                           unsigned char *buf, size_t len, BN_CTX *ctx);
671
672 /** Decodes a EC_POINT from a octet string
673  *  \param  group  underlying EC_GROUP object
674  *  \param  p      EC_POINT object
675  *  \param  buf    memory buffer with the encoded ec point
676  *  \param  len    length of the encoded ec point
677  *  \param  ctx    BN_CTX object (optional)
678  *  \return 1 on success and 0 if an error occurred
679  */
680 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
681                        const unsigned char *buf, size_t len, BN_CTX *ctx);
682
683 /** Encodes an EC_POINT object to an allocated octet string
684  *  \param  group  underlying EC_GROUP object
685  *  \param  point  EC_POINT object
686  *  \param  form   point conversion form
687  *  \param  pbuf   returns pointer to allocated buffer
688  *  \param  ctx    BN_CTX object (optional)
689  *  \return the length of the encoded octet string or 0 if an error occurred
690  */
691 size_t EC_POINT_point2buf(const EC_GROUP *group, const EC_POINT *point,
692                           point_conversion_form_t form,
693                           unsigned char **pbuf, BN_CTX *ctx);
694
695 /* other interfaces to point2oct/oct2point: */
696 BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *,
697                           point_conversion_form_t form, BIGNUM *, BN_CTX *);
698 EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *,
699                             EC_POINT *, BN_CTX *);
700 char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *,
701                          point_conversion_form_t form, BN_CTX *);
702 EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *,
703                              EC_POINT *, BN_CTX *);
704
705 /********************************************************************/
706 /*         functions for doing EC_POINT arithmetic                  */
707 /********************************************************************/
708
709 /** Computes the sum of two EC_POINT
710  *  \param  group  underlying EC_GROUP object
711  *  \param  r      EC_POINT object for the result (r = a + b)
712  *  \param  a      EC_POINT object with the first summand
713  *  \param  b      EC_POINT object with the second summand
714  *  \param  ctx    BN_CTX object (optional)
715  *  \return 1 on success and 0 if an error occurred
716  */
717 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
718                  const EC_POINT *b, BN_CTX *ctx);
719
720 /** Computes the double of a EC_POINT
721  *  \param  group  underlying EC_GROUP object
722  *  \param  r      EC_POINT object for the result (r = 2 * a)
723  *  \param  a      EC_POINT object
724  *  \param  ctx    BN_CTX object (optional)
725  *  \return 1 on success and 0 if an error occurred
726  */
727 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
728                  BN_CTX *ctx);
729
730 /** Computes the inverse of a EC_POINT
731  *  \param  group  underlying EC_GROUP object
732  *  \param  a      EC_POINT object to be inverted (it's used for the result as well)
733  *  \param  ctx    BN_CTX object (optional)
734  *  \return 1 on success and 0 if an error occurred
735  */
736 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx);
737
738 /** Checks whether the point is the neutral element of the group
739  *  \param  group  the underlying EC_GROUP object
740  *  \param  p      EC_POINT object
741  *  \return 1 if the point is the neutral element and 0 otherwise
742  */
743 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p);
744
745 /** Checks whether the point is on the curve
746  *  \param  group  underlying EC_GROUP object
747  *  \param  point  EC_POINT object to check
748  *  \param  ctx    BN_CTX object (optional)
749  *  \return 1 if the point is on the curve, 0 if not, or -1 on error
750  */
751 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point,
752                          BN_CTX *ctx);
753
754 /** Compares two EC_POINTs
755  *  \param  group  underlying EC_GROUP object
756  *  \param  a      first EC_POINT object
757  *  \param  b      second EC_POINT object
758  *  \param  ctx    BN_CTX object (optional)
759  *  \return 1 if the points are not equal, 0 if they are, or -1 on error
760  */
761 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b,
762                  BN_CTX *ctx);
763
764 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx);
765 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num,
766                           EC_POINT *points[], BN_CTX *ctx);
767
768 /** Computes r = generator * n + sum_{i=0}^{num-1} p[i] * m[i]
769  *  \param  group  underlying EC_GROUP object
770  *  \param  r      EC_POINT object for the result
771  *  \param  n      BIGNUM with the multiplier for the group generator (optional)
772  *  \param  num    number further summands
773  *  \param  p      array of size num of EC_POINT objects
774  *  \param  m      array of size num of BIGNUM objects
775  *  \param  ctx    BN_CTX object (optional)
776  *  \return 1 on success and 0 if an error occurred
777  */
778 int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
779                   size_t num, const EC_POINT *p[], const BIGNUM *m[],
780                   BN_CTX *ctx);
781
782 /** Computes r = generator * n + q * m
783  *  \param  group  underlying EC_GROUP object
784  *  \param  r      EC_POINT object for the result
785  *  \param  n      BIGNUM with the multiplier for the group generator (optional)
786  *  \param  q      EC_POINT object with the first factor of the second summand
787  *  \param  m      BIGNUM with the second factor of the second summand
788  *  \param  ctx    BN_CTX object (optional)
789  *  \return 1 on success and 0 if an error occurred
790  */
791 int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
792                  const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);
793
794 /** Stores multiples of generator for faster point multiplication
795  *  \param  group  EC_GROUP object
796  *  \param  ctx    BN_CTX object (optional)
797  *  \return 1 on success and 0 if an error occurred
798  */
799 int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
800
801 /** Reports whether a precomputation has been done
802  *  \param  group  EC_GROUP object
803  *  \return 1 if a pre-computation has been done and 0 otherwise
804  */
805 int EC_GROUP_have_precompute_mult(const EC_GROUP *group);
806
807 /********************************************************************/
808 /*                       ASN1 stuff                                 */
809 /********************************************************************/
810
811 DECLARE_ASN1_ITEM(ECPKPARAMETERS)
812 DECLARE_ASN1_ALLOC_FUNCTIONS(ECPKPARAMETERS)
813 DECLARE_ASN1_ITEM(ECPARAMETERS)
814 DECLARE_ASN1_ALLOC_FUNCTIONS(ECPARAMETERS)
815
816 /*
817  * EC_GROUP_get_basis_type() returns the NID of the basis type used to
818  * represent the field elements
819  */
820 int EC_GROUP_get_basis_type(const EC_GROUP *);
821 # ifndef OPENSSL_NO_EC2M
822 int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
823 int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1,
824                                    unsigned int *k2, unsigned int *k3);
825 # endif
826
827 # define OPENSSL_EC_EXPLICIT_CURVE  0x000
828 # define OPENSSL_EC_NAMED_CURVE     0x001
829
830 EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len);
831 int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out);
832
833 # define d2i_ECPKParameters_bio(bp,x) ASN1_d2i_bio_of(EC_GROUP,NULL,d2i_ECPKParameters,bp,x)
834 # define i2d_ECPKParameters_bio(bp,x) ASN1_i2d_bio_of(EC_GROUP,i2d_ECPKParameters,bp,x)
835 # define d2i_ECPKParameters_fp(fp,x) (EC_GROUP *)ASN1_d2i_fp(NULL, \
836                 (char *(*)())d2i_ECPKParameters,(fp),(unsigned char **)(x))
837 # define i2d_ECPKParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECPKParameters,(fp), \
838                 (unsigned char *)(x))
839
840 int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off);
841 # ifndef OPENSSL_NO_STDIO
842 int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off);
843 # endif
844
845 /********************************************************************/
846 /*                      EC_KEY functions                            */
847 /********************************************************************/
848
849 /* some values for the encoding_flag */
850 # define EC_PKEY_NO_PARAMETERS   0x001
851 # define EC_PKEY_NO_PUBKEY       0x002
852
853 /* some values for the flags field */
854 # define EC_FLAG_NON_FIPS_ALLOW  0x1
855 # define EC_FLAG_FIPS_CHECKED    0x2
856 # define EC_FLAG_COFACTOR_ECDH   0x1000
857
858 /**
859  *  Creates a new EC_KEY object.
860  *  \param  ctx  The library context for to use for this EC_KEY. May be NULL in
861  *               which case the default library context is used.
862  *  \return EC_KEY object or NULL if an error occurred.
863  */
864 EC_KEY *EC_KEY_new_ex(OPENSSL_CTX *ctx);
865
866 /**
867  *  Creates a new EC_KEY object. Same as calling EC_KEY_new_ex with a NULL
868  *  library context
869  *  \return EC_KEY object or NULL if an error occurred.
870  */
871 EC_KEY *EC_KEY_new(void);
872
873 int EC_KEY_get_flags(const EC_KEY *key);
874
875 void EC_KEY_set_flags(EC_KEY *key, int flags);
876
877 void EC_KEY_clear_flags(EC_KEY *key, int flags);
878
879 /**
880  *  Creates a new EC_KEY object using a named curve as underlying
881  *  EC_GROUP object.
882  *  \param  ctx  The library context for to use for this EC_KEY. May be NULL in
883  *               which case the default library context is used.
884  *  \param  nid  NID of the named curve.
885  *  \return EC_KEY object or NULL if an error occurred.
886  */
887 EC_KEY *EC_KEY_new_by_curve_name_ex(OPENSSL_CTX *ctx, int nid);
888
889 /**
890  *  Creates a new EC_KEY object using a named curve as underlying
891  *  EC_GROUP object. Same as calling EC_KEY_new_by_curve_name_ex with a NULL
892  *  library context.
893  *  \param  nid  NID of the named curve.
894  *  \return EC_KEY object or NULL if an error occurred.
895  */
896 EC_KEY *EC_KEY_new_by_curve_name(int nid);
897
898
899 /** Frees a EC_KEY object.
900  *  \param  key  EC_KEY object to be freed.
901  */
902 void EC_KEY_free(EC_KEY *key);
903
904 /** Copies a EC_KEY object.
905  *  \param  dst  destination EC_KEY object
906  *  \param  src  src EC_KEY object
907  *  \return dst or NULL if an error occurred.
908  */
909 EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
910
911 /** Creates a new EC_KEY object and copies the content from src to it.
912  *  \param  src  the source EC_KEY object
913  *  \return newly created EC_KEY object or NULL if an error occurred.
914  */
915 EC_KEY *EC_KEY_dup(const EC_KEY *src);
916
917 /** Increases the internal reference count of a EC_KEY object.
918  *  \param  key  EC_KEY object
919  *  \return 1 on success and 0 if an error occurred.
920  */
921 int EC_KEY_up_ref(EC_KEY *key);
922
923 /** Returns the ENGINE object of a EC_KEY object
924  *  \param  eckey  EC_KEY object
925  *  \return the ENGINE object (possibly NULL).
926  */
927 ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey);
928
929 /** Returns the EC_GROUP object of a EC_KEY object
930  *  \param  key  EC_KEY object
931  *  \return the EC_GROUP object (possibly NULL).
932  */
933 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
934
935 /** Sets the EC_GROUP of a EC_KEY object.
936  *  \param  key    EC_KEY object
937  *  \param  group  EC_GROUP to use in the EC_KEY object (note: the EC_KEY
938  *                 object will use an own copy of the EC_GROUP).
939  *  \return 1 on success and 0 if an error occurred.
940  */
941 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
942
943 /** Returns the private key of a EC_KEY object.
944  *  \param  key  EC_KEY object
945  *  \return a BIGNUM with the private key (possibly NULL).
946  */
947 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
948
949 /** Sets the private key of a EC_KEY object.
950  *  \param  key  EC_KEY object
951  *  \param  prv  BIGNUM with the private key (note: the EC_KEY object
952  *               will use an own copy of the BIGNUM).
953  *  \return 1 on success and 0 if an error occurred.
954  */
955 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
956
957 /** Returns the public key of a EC_KEY object.
958  *  \param  key  the EC_KEY object
959  *  \return a EC_POINT object with the public key (possibly NULL)
960  */
961 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
962
963 /** Sets the public key of a EC_KEY object.
964  *  \param  key  EC_KEY object
965  *  \param  pub  EC_POINT object with the public key (note: the EC_KEY object
966  *               will use an own copy of the EC_POINT object).
967  *  \return 1 on success and 0 if an error occurred.
968  */
969 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
970
971 unsigned EC_KEY_get_enc_flags(const EC_KEY *key);
972 void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);
973 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
974 void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
975
976 #define EC_KEY_get_ex_new_index(l, p, newf, dupf, freef) \
977     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_EC_KEY, l, p, newf, dupf, freef)
978 int EC_KEY_set_ex_data(EC_KEY *key, int idx, void *arg);
979 void *EC_KEY_get_ex_data(const EC_KEY *key, int idx);
980
981 /* wrapper functions for the underlying EC_GROUP object */
982 void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
983
984 /** Creates a table of pre-computed multiples of the generator to
985  *  accelerate further EC_KEY operations.
986  *  \param  key  EC_KEY object
987  *  \param  ctx  BN_CTX object (optional)
988  *  \return 1 on success and 0 if an error occurred.
989  */
990 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
991
992 /** Creates a new ec private (and optional a new public) key.
993  *  \param  key  EC_KEY object
994  *  \return 1 on success and 0 if an error occurred.
995  */
996 int EC_KEY_generate_key(EC_KEY *key);
997
998 /** Verifies that a private and/or public key is valid.
999  *  \param  key  the EC_KEY object
1000  *  \return 1 on success and 0 otherwise.
1001  */
1002 int EC_KEY_check_key(const EC_KEY *key);
1003
1004 /** Indicates if an EC_KEY can be used for signing.
1005  *  \param  eckey  the EC_KEY object
1006  *  \return 1 if can can sign and 0 otherwise.
1007  */
1008 int EC_KEY_can_sign(const EC_KEY *eckey);
1009
1010 /** Sets a public key from affine coordinates performing
1011  *  necessary NIST PKV tests.
1012  *  \param  key  the EC_KEY object
1013  *  \param  x    public key x coordinate
1014  *  \param  y    public key y coordinate
1015  *  \return 1 on success and 0 otherwise.
1016  */
1017 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
1018                                              BIGNUM *y);
1019
1020 /** Encodes an EC_KEY public key to an allocated octet string
1021  *  \param  key    key to encode
1022  *  \param  form   point conversion form
1023  *  \param  pbuf   returns pointer to allocated buffer
1024  *  \param  ctx    BN_CTX object (optional)
1025  *  \return the length of the encoded octet string or 0 if an error occurred
1026  */
1027 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
1028                       unsigned char **pbuf, BN_CTX *ctx);
1029
1030 /** Decodes a EC_KEY public key from a octet string
1031  *  \param  key    key to decode
1032  *  \param  buf    memory buffer with the encoded ec point
1033  *  \param  len    length of the encoded ec point
1034  *  \param  ctx    BN_CTX object (optional)
1035  *  \return 1 on success and 0 if an error occurred
1036  */
1037
1038 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
1039                    BN_CTX *ctx);
1040
1041 /** Decodes an EC_KEY private key from an octet string
1042  *  \param  key    key to decode
1043  *  \param  buf    memory buffer with the encoded private key
1044  *  \param  len    length of the encoded key
1045  *  \return 1 on success and 0 if an error occurred
1046  */
1047
1048 int EC_KEY_oct2priv(EC_KEY *key, const unsigned char *buf, size_t len);
1049
1050 /** Encodes a EC_KEY private key to an octet string
1051  *  \param  key    key to encode
1052  *  \param  buf    memory buffer for the result. If NULL the function returns
1053  *                 required buffer size.
1054  *  \param  len    length of the memory buffer
1055  *  \return the length of the encoded octet string or 0 if an error occurred
1056  */
1057
1058 size_t EC_KEY_priv2oct(const EC_KEY *key, unsigned char *buf, size_t len);
1059
1060 /** Encodes an EC_KEY private key to an allocated octet string
1061  *  \param  eckey  key to encode
1062  *  \param  pbuf   returns pointer to allocated buffer
1063  *  \return the length of the encoded octet string or 0 if an error occurred
1064  */
1065 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf);
1066
1067 /********************************************************************/
1068 /*        de- and encoding functions for SEC1 ECPrivateKey          */
1069 /********************************************************************/
1070
1071 /** Decodes a private key from a memory buffer.
1072  *  \param  key  a pointer to a EC_KEY object which should be used (or NULL)
1073  *  \param  in   pointer to memory with the DER encoded private key
1074  *  \param  len  length of the DER encoded private key
1075  *  \return the decoded private key or NULL if an error occurred.
1076  */
1077 EC_KEY *d2i_ECPrivateKey(EC_KEY **key, const unsigned char **in, long len);
1078
1079 /** Encodes a private key object and stores the result in a buffer.
1080  *  \param  key  the EC_KEY object to encode
1081  *  \param  out  the buffer for the result (if NULL the function returns number
1082  *               of bytes needed).
1083  *  \return 1 on success and 0 if an error occurred.
1084  */
1085 int i2d_ECPrivateKey(const EC_KEY *key, unsigned char **out);
1086
1087 /********************************************************************/
1088 /*        de- and encoding functions for EC parameters              */
1089 /********************************************************************/
1090
1091 /** Decodes ec parameter from a memory buffer.
1092  *  \param  key  a pointer to a EC_KEY object which should be used (or NULL)
1093  *  \param  in   pointer to memory with the DER encoded ec parameters
1094  *  \param  len  length of the DER encoded ec parameters
1095  *  \return a EC_KEY object with the decoded parameters or NULL if an error
1096  *          occurred.
1097  */
1098 EC_KEY *d2i_ECParameters(EC_KEY **key, const unsigned char **in, long len);
1099
1100 /** Encodes ec parameter and stores the result in a buffer.
1101  *  \param  key  the EC_KEY object with ec parameters to encode
1102  *  \param  out  the buffer for the result (if NULL the function returns number
1103  *               of bytes needed).
1104  *  \return 1 on success and 0 if an error occurred.
1105  */
1106 int i2d_ECParameters(const EC_KEY *key, unsigned char **out);
1107
1108 /********************************************************************/
1109 /*         de- and encoding functions for EC public key             */
1110 /*         (octet string, not DER -- hence 'o2i' and 'i2o')         */
1111 /********************************************************************/
1112
1113 /** Decodes a ec public key from a octet string.
1114  *  \param  key  a pointer to a EC_KEY object which should be used
1115  *  \param  in   memory buffer with the encoded public key
1116  *  \param  len  length of the encoded public key
1117  *  \return EC_KEY object with decoded public key or NULL if an error
1118  *          occurred.
1119  */
1120 EC_KEY *o2i_ECPublicKey(EC_KEY **key, const unsigned char **in, long len);
1121
1122 /** Encodes a ec public key in an octet string.
1123  *  \param  key  the EC_KEY object with the public key
1124  *  \param  out  the buffer for the result (if NULL the function returns number
1125  *               of bytes needed).
1126  *  \return 1 on success and 0 if an error occurred
1127  */
1128 int i2o_ECPublicKey(const EC_KEY *key, unsigned char **out);
1129
1130 /** Prints out the ec parameters on human readable form.
1131  *  \param  bp   BIO object to which the information is printed
1132  *  \param  key  EC_KEY object
1133  *  \return 1 on success and 0 if an error occurred
1134  */
1135 int ECParameters_print(BIO *bp, const EC_KEY *key);
1136
1137 /** Prints out the contents of a EC_KEY object
1138  *  \param  bp   BIO object to which the information is printed
1139  *  \param  key  EC_KEY object
1140  *  \param  off  line offset
1141  *  \return 1 on success and 0 if an error occurred
1142  */
1143 int EC_KEY_print(BIO *bp, const EC_KEY *key, int off);
1144
1145 # ifndef OPENSSL_NO_STDIO
1146 /** Prints out the ec parameters on human readable form.
1147  *  \param  fp   file descriptor to which the information is printed
1148  *  \param  key  EC_KEY object
1149  *  \return 1 on success and 0 if an error occurred
1150  */
1151 int ECParameters_print_fp(FILE *fp, const EC_KEY *key);
1152
1153 /** Prints out the contents of a EC_KEY object
1154  *  \param  fp   file descriptor to which the information is printed
1155  *  \param  key  EC_KEY object
1156  *  \param  off  line offset
1157  *  \return 1 on success and 0 if an error occurred
1158  */
1159 int EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off);
1160
1161 # endif
1162
1163 const EC_KEY_METHOD *EC_KEY_OpenSSL(void);
1164 const EC_KEY_METHOD *EC_KEY_get_default_method(void);
1165 void EC_KEY_set_default_method(const EC_KEY_METHOD *meth);
1166 const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
1167 int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
1168 EC_KEY *EC_KEY_new_method(ENGINE *engine);
1169
1170 /** The old name for ecdh_KDF_X9_63
1171  *  The ECDH KDF specification has been mistakingly attributed to ANSI X9.62,
1172  *  it is actually specified in ANSI X9.63.
1173  *  This identifier is retained for backwards compatibility
1174  */
1175 DEPRECATEDIN_3_0(int ECDH_KDF_X9_62(unsigned char *out, size_t outlen,
1176                                     const unsigned char *Z, size_t Zlen,
1177                                     const unsigned char *sinfo, size_t sinfolen,
1178                                     const EVP_MD *md))
1179
1180 int ECDH_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
1181                      const EC_KEY *ecdh,
1182                      void *(*KDF) (const void *in, size_t inlen,
1183                                    void *out, size_t *outlen));
1184
1185 typedef struct ECDSA_SIG_st ECDSA_SIG;
1186
1187 /** Allocates and initialize a ECDSA_SIG structure
1188  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
1189  */
1190 ECDSA_SIG *ECDSA_SIG_new(void);
1191
1192 /** frees a ECDSA_SIG structure
1193  *  \param  sig  pointer to the ECDSA_SIG structure
1194  */
1195 void ECDSA_SIG_free(ECDSA_SIG *sig);
1196
1197 /** i2d_ECDSA_SIG encodes content of ECDSA_SIG (note: this function modifies *pp
1198  *  (*pp += length of the DER encoded signature)).
1199  *  \param  sig  pointer to the ECDSA_SIG object
1200  *  \param  pp   pointer to a unsigned char pointer for the output or NULL
1201  *  \return the length of the DER encoded ECDSA_SIG object or a negative value
1202  *          on error
1203  */
1204 DECLARE_ASN1_ENCODE_FUNCTIONS_only(ECDSA_SIG, ECDSA_SIG)
1205
1206 /** d2i_ECDSA_SIG decodes an ECDSA signature (note: this function modifies *pp
1207  *  (*pp += len)).
1208  *  \param  sig  pointer to ECDSA_SIG pointer (may be NULL)
1209  *  \param  pp   memory buffer with the DER encoded signature
1210  *  \param  len  length of the buffer
1211  *  \return pointer to the decoded ECDSA_SIG structure (or NULL)
1212  */
1213
1214 /** Accessor for r and s fields of ECDSA_SIG
1215  *  \param  sig  pointer to ECDSA_SIG structure
1216  *  \param  pr   pointer to BIGNUM pointer for r (may be NULL)
1217  *  \param  ps   pointer to BIGNUM pointer for s (may be NULL)
1218  */
1219 void ECDSA_SIG_get0(const ECDSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
1220
1221 /** Accessor for r field of ECDSA_SIG
1222  *  \param  sig  pointer to ECDSA_SIG structure
1223  */
1224 const BIGNUM *ECDSA_SIG_get0_r(const ECDSA_SIG *sig);
1225
1226 /** Accessor for s field of ECDSA_SIG
1227  *  \param  sig  pointer to ECDSA_SIG structure
1228  */
1229 const BIGNUM *ECDSA_SIG_get0_s(const ECDSA_SIG *sig);
1230
1231 /** Setter for r and s fields of ECDSA_SIG
1232  *  \param  sig  pointer to ECDSA_SIG structure
1233  *  \param  r    pointer to BIGNUM for r (may be NULL)
1234  *  \param  s    pointer to BIGNUM for s (may be NULL)
1235  */
1236 int ECDSA_SIG_set0(ECDSA_SIG *sig, BIGNUM *r, BIGNUM *s);
1237
1238 /** Computes the ECDSA signature of the given hash value using
1239  *  the supplied private key and returns the created signature.
1240  *  \param  dgst      pointer to the hash value
1241  *  \param  dgst_len  length of the hash value
1242  *  \param  eckey     EC_KEY object containing a private EC key
1243  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
1244  */
1245 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
1246                          EC_KEY *eckey);
1247
1248 /** Computes ECDSA signature of a given hash value using the supplied
1249  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
1250  *  \param  dgst     pointer to the hash value to sign
1251  *  \param  dgstlen  length of the hash value
1252  *  \param  kinv     BIGNUM with a pre-computed inverse k (optional)
1253  *  \param  rp       BIGNUM with a pre-computed rp value (optional),
1254  *                   see ECDSA_sign_setup
1255  *  \param  eckey    EC_KEY object containing a private EC key
1256  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
1257  */
1258 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
1259                             const BIGNUM *kinv, const BIGNUM *rp,
1260                             EC_KEY *eckey);
1261
1262 /** Verifies that the supplied signature is a valid ECDSA
1263  *  signature of the supplied hash value using the supplied public key.
1264  *  \param  dgst      pointer to the hash value
1265  *  \param  dgst_len  length of the hash value
1266  *  \param  sig       ECDSA_SIG structure
1267  *  \param  eckey     EC_KEY object containing a public EC key
1268  *  \return 1 if the signature is valid, 0 if the signature is invalid
1269  *          and -1 on error
1270  */
1271 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
1272                     const ECDSA_SIG *sig, EC_KEY *eckey);
1273
1274 /** Precompute parts of the signing operation
1275  *  \param  eckey  EC_KEY object containing a private EC key
1276  *  \param  ctx    BN_CTX object (optional)
1277  *  \param  kinv   BIGNUM pointer for the inverse of k
1278  *  \param  rp     BIGNUM pointer for x coordinate of k * generator
1279  *  \return 1 on success and 0 otherwise
1280  */
1281 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
1282
1283 /** Computes ECDSA signature of a given hash value using the supplied
1284  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
1285  *  \param  type     this parameter is ignored
1286  *  \param  dgst     pointer to the hash value to sign
1287  *  \param  dgstlen  length of the hash value
1288  *  \param  sig      memory for the DER encoded created signature
1289  *  \param  siglen   pointer to the length of the returned signature
1290  *  \param  eckey    EC_KEY object containing a private EC key
1291  *  \return 1 on success and 0 otherwise
1292  */
1293 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
1294                unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
1295
1296 /** Computes ECDSA signature of a given hash value using the supplied
1297  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
1298  *  \param  type     this parameter is ignored
1299  *  \param  dgst     pointer to the hash value to sign
1300  *  \param  dgstlen  length of the hash value
1301  *  \param  sig      buffer to hold the DER encoded signature
1302  *  \param  siglen   pointer to the length of the returned signature
1303  *  \param  kinv     BIGNUM with a pre-computed inverse k (optional)
1304  *  \param  rp       BIGNUM with a pre-computed rp value (optional),
1305  *                   see ECDSA_sign_setup
1306  *  \param  eckey    EC_KEY object containing a private EC key
1307  *  \return 1 on success and 0 otherwise
1308  */
1309 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
1310                   unsigned char *sig, unsigned int *siglen,
1311                   const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
1312
1313 /** Verifies that the given signature is valid ECDSA signature
1314  *  of the supplied hash value using the specified public key.
1315  *  \param  type     this parameter is ignored
1316  *  \param  dgst     pointer to the hash value
1317  *  \param  dgstlen  length of the hash value
1318  *  \param  sig      pointer to the DER encoded signature
1319  *  \param  siglen   length of the DER encoded signature
1320  *  \param  eckey    EC_KEY object containing a public EC key
1321  *  \return 1 if the signature is valid, 0 if the signature is invalid
1322  *          and -1 on error
1323  */
1324 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
1325                  const unsigned char *sig, int siglen, EC_KEY *eckey);
1326
1327 /** Returns the maximum length of the DER encoded signature
1328  *  \param  eckey  EC_KEY object
1329  *  \return numbers of bytes required for the DER encoded signature
1330  */
1331 int ECDSA_size(const EC_KEY *eckey);
1332
1333 /********************************************************************/
1334 /*  EC_KEY_METHOD constructors, destructors, writers and accessors  */
1335 /********************************************************************/
1336
1337 EC_KEY_METHOD *EC_KEY_METHOD_new(const EC_KEY_METHOD *meth);
1338 void EC_KEY_METHOD_free(EC_KEY_METHOD *meth);
1339 void EC_KEY_METHOD_set_init(EC_KEY_METHOD *meth,
1340                             int (*init)(EC_KEY *key),
1341                             void (*finish)(EC_KEY *key),
1342                             int (*copy)(EC_KEY *dest, const EC_KEY *src),
1343                             int (*set_group)(EC_KEY *key, const EC_GROUP *grp),
1344                             int (*set_private)(EC_KEY *key,
1345                                                const BIGNUM *priv_key),
1346                             int (*set_public)(EC_KEY *key,
1347                                               const EC_POINT *pub_key));
1348
1349 void EC_KEY_METHOD_set_keygen(EC_KEY_METHOD *meth,
1350                               int (*keygen)(EC_KEY *key));
1351
1352 void EC_KEY_METHOD_set_compute_key(EC_KEY_METHOD *meth,
1353                                    int (*ckey)(unsigned char **psec,
1354                                                size_t *pseclen,
1355                                                const EC_POINT *pub_key,
1356                                                const EC_KEY *ecdh));
1357
1358 void EC_KEY_METHOD_set_sign(EC_KEY_METHOD *meth,
1359                             int (*sign)(int type, const unsigned char *dgst,
1360                                         int dlen, unsigned char *sig,
1361                                         unsigned int *siglen,
1362                                         const BIGNUM *kinv, const BIGNUM *r,
1363                                         EC_KEY *eckey),
1364                             int (*sign_setup)(EC_KEY *eckey, BN_CTX *ctx_in,
1365                                               BIGNUM **kinvp, BIGNUM **rp),
1366                             ECDSA_SIG *(*sign_sig)(const unsigned char *dgst,
1367                                                    int dgst_len,
1368                                                    const BIGNUM *in_kinv,
1369                                                    const BIGNUM *in_r,
1370                                                    EC_KEY *eckey));
1371
1372 void EC_KEY_METHOD_set_verify(EC_KEY_METHOD *meth,
1373                               int (*verify)(int type, const unsigned
1374                                             char *dgst, int dgst_len,
1375                                             const unsigned char *sigbuf,
1376                                             int sig_len, EC_KEY *eckey),
1377                               int (*verify_sig)(const unsigned char *dgst,
1378                                                 int dgst_len,
1379                                                 const ECDSA_SIG *sig,
1380                                                 EC_KEY *eckey));
1381
1382 void EC_KEY_METHOD_get_init(const EC_KEY_METHOD *meth,
1383                             int (**pinit)(EC_KEY *key),
1384                             void (**pfinish)(EC_KEY *key),
1385                             int (**pcopy)(EC_KEY *dest, const EC_KEY *src),
1386                             int (**pset_group)(EC_KEY *key,
1387                                                const EC_GROUP *grp),
1388                             int (**pset_private)(EC_KEY *key,
1389                                                  const BIGNUM *priv_key),
1390                             int (**pset_public)(EC_KEY *key,
1391                                                 const EC_POINT *pub_key));
1392
1393 void EC_KEY_METHOD_get_keygen(const EC_KEY_METHOD *meth,
1394                               int (**pkeygen)(EC_KEY *key));
1395
1396 void EC_KEY_METHOD_get_compute_key(const EC_KEY_METHOD *meth,
1397                                    int (**pck)(unsigned char **psec,
1398                                                size_t *pseclen,
1399                                                const EC_POINT *pub_key,
1400                                                const EC_KEY *ecdh));
1401
1402 void EC_KEY_METHOD_get_sign(const EC_KEY_METHOD *meth,
1403                             int (**psign)(int type, const unsigned char *dgst,
1404                                           int dlen, unsigned char *sig,
1405                                           unsigned int *siglen,
1406                                           const BIGNUM *kinv, const BIGNUM *r,
1407                                           EC_KEY *eckey),
1408                             int (**psign_setup)(EC_KEY *eckey, BN_CTX *ctx_in,
1409                                                 BIGNUM **kinvp, BIGNUM **rp),
1410                             ECDSA_SIG *(**psign_sig)(const unsigned char *dgst,
1411                                                      int dgst_len,
1412                                                      const BIGNUM *in_kinv,
1413                                                      const BIGNUM *in_r,
1414                                                      EC_KEY *eckey));
1415
1416 void EC_KEY_METHOD_get_verify(const EC_KEY_METHOD *meth,
1417                               int (**pverify)(int type, const unsigned
1418                                               char *dgst, int dgst_len,
1419                                               const unsigned char *sigbuf,
1420                                               int sig_len, EC_KEY *eckey),
1421                               int (**pverify_sig)(const unsigned char *dgst,
1422                                                   int dgst_len,
1423                                                   const ECDSA_SIG *sig,
1424                                                   EC_KEY *eckey));
1425
1426 # define ECParameters_dup(x) ASN1_dup_of(EC_KEY,i2d_ECParameters,d2i_ECParameters,x)
1427
1428 # ifndef __cplusplus
1429 #  if defined(__SUNPRO_C)
1430 #   if __SUNPRO_C >= 0x520
1431 #    pragma error_messages (default,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
1432 #   endif
1433 #  endif
1434 # endif
1435
1436 # define EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid) \
1437         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1438                                 EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
1439                                 EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, nid, NULL)
1440
1441 # define EVP_PKEY_CTX_set_ec_param_enc(ctx, flag) \
1442         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1443                                 EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
1444                                 EVP_PKEY_CTRL_EC_PARAM_ENC, flag, NULL)
1445
1446 # define EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, flag) \
1447         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1448                                 EVP_PKEY_OP_DERIVE, \
1449                                 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, flag, NULL)
1450
1451 # define EVP_PKEY_CTX_get_ecdh_cofactor_mode(ctx) \
1452         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1453                                 EVP_PKEY_OP_DERIVE, \
1454                                 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, -2, NULL)
1455
1456 # define EVP_PKEY_CTX_set_ecdh_kdf_type(ctx, kdf) \
1457         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1458                                 EVP_PKEY_OP_DERIVE, \
1459                                 EVP_PKEY_CTRL_EC_KDF_TYPE, kdf, NULL)
1460
1461 # define EVP_PKEY_CTX_get_ecdh_kdf_type(ctx) \
1462         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1463                                 EVP_PKEY_OP_DERIVE, \
1464                                 EVP_PKEY_CTRL_EC_KDF_TYPE, -2, NULL)
1465
1466 # define EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md) \
1467         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1468                                 EVP_PKEY_OP_DERIVE, \
1469                                 EVP_PKEY_CTRL_EC_KDF_MD, 0, (void *)(md))
1470
1471 # define EVP_PKEY_CTX_get_ecdh_kdf_md(ctx, pmd) \
1472         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1473                                 EVP_PKEY_OP_DERIVE, \
1474                                 EVP_PKEY_CTRL_GET_EC_KDF_MD, 0, (void *)(pmd))
1475
1476 # define EVP_PKEY_CTX_set_ecdh_kdf_outlen(ctx, len) \
1477         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1478                                 EVP_PKEY_OP_DERIVE, \
1479                                 EVP_PKEY_CTRL_EC_KDF_OUTLEN, len, NULL)
1480
1481 # define EVP_PKEY_CTX_get_ecdh_kdf_outlen(ctx, plen) \
1482         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1483                                 EVP_PKEY_OP_DERIVE, \
1484                                 EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, 0, \
1485                                 (void *)(plen))
1486
1487 # define EVP_PKEY_CTX_set0_ecdh_kdf_ukm(ctx, p, plen) \
1488         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1489                                 EVP_PKEY_OP_DERIVE, \
1490                                 EVP_PKEY_CTRL_EC_KDF_UKM, plen, (void *)(p))
1491
1492 # define EVP_PKEY_CTX_get0_ecdh_kdf_ukm(ctx, p) \
1493         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1494                                 EVP_PKEY_OP_DERIVE, \
1495                                 EVP_PKEY_CTRL_GET_EC_KDF_UKM, 0, (void *)(p))
1496
1497 /* SM2 will skip the operation check so no need to pass operation here */
1498 # define EVP_PKEY_CTX_set1_id(ctx, id, id_len) \
1499         EVP_PKEY_CTX_ctrl(ctx, -1, -1, \
1500                                 EVP_PKEY_CTRL_SET1_ID, (int)id_len, (void*)(id))
1501 # define EVP_PKEY_CTX_get1_id(ctx, id) \
1502         EVP_PKEY_CTX_ctrl(ctx, -1, -1, \
1503                                 EVP_PKEY_CTRL_GET1_ID, 0, (void*)(id))
1504
1505 # define EVP_PKEY_CTX_get1_id_len(ctx, id_len) \
1506         EVP_PKEY_CTX_ctrl(ctx, -1, -1, \
1507                                 EVP_PKEY_CTRL_GET1_ID_LEN, 0, (void*)(id_len))
1508
1509 # define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID             (EVP_PKEY_ALG_CTRL + 1)
1510 # define EVP_PKEY_CTRL_EC_PARAM_ENC                      (EVP_PKEY_ALG_CTRL + 2)
1511 # define EVP_PKEY_CTRL_EC_ECDH_COFACTOR                  (EVP_PKEY_ALG_CTRL + 3)
1512 # define EVP_PKEY_CTRL_EC_KDF_TYPE                       (EVP_PKEY_ALG_CTRL + 4)
1513 # define EVP_PKEY_CTRL_EC_KDF_MD                         (EVP_PKEY_ALG_CTRL + 5)
1514 # define EVP_PKEY_CTRL_GET_EC_KDF_MD                     (EVP_PKEY_ALG_CTRL + 6)
1515 # define EVP_PKEY_CTRL_EC_KDF_OUTLEN                     (EVP_PKEY_ALG_CTRL + 7)
1516 # define EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN                 (EVP_PKEY_ALG_CTRL + 8)
1517 # define EVP_PKEY_CTRL_EC_KDF_UKM                        (EVP_PKEY_ALG_CTRL + 9)
1518 # define EVP_PKEY_CTRL_GET_EC_KDF_UKM                    (EVP_PKEY_ALG_CTRL + 10)
1519 # define EVP_PKEY_CTRL_SET1_ID                           (EVP_PKEY_ALG_CTRL + 11)
1520 # define EVP_PKEY_CTRL_GET1_ID                           (EVP_PKEY_ALG_CTRL + 12)
1521 # define EVP_PKEY_CTRL_GET1_ID_LEN                       (EVP_PKEY_ALG_CTRL + 13)
1522 /* KDF types */
1523 # define EVP_PKEY_ECDH_KDF_NONE                          1
1524 # define EVP_PKEY_ECDH_KDF_X9_63                         2
1525 /** The old name for EVP_PKEY_ECDH_KDF_X9_63
1526  *  The ECDH KDF specification has been mistakingly attributed to ANSI X9.62,
1527  *  it is actually specified in ANSI X9.63.
1528  *  This identifier is retained for backwards compatibility
1529  */
1530 # define EVP_PKEY_ECDH_KDF_X9_62   EVP_PKEY_ECDH_KDF_X9_63
1531
1532
1533 #  ifdef  __cplusplus
1534 }
1535 #  endif
1536 # endif
1537 #endif