4 * Originally written by Bodo Moeller for the OpenSSL project.
7 * \file crypto/ec/ec.h Include file for the OpenSSL EC functions
8 * \author Originally written by Bodo Moeller for the OpenSSL project
10 /* ====================================================================
11 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
25 * 3. All advertising materials mentioning features or use of this
26 * software must display the following acknowledgment:
27 * "This product includes software developed by the OpenSSL Project
28 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
30 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
31 * endorse or promote products derived from this software without
32 * prior written permission. For written permission, please contact
33 * openssl-core@openssl.org.
35 * 5. Products derived from this software may not be called "OpenSSL"
36 * nor may "OpenSSL" appear in their names without prior written
37 * permission of the OpenSSL Project.
39 * 6. Redistributions of any form whatsoever must retain the following
41 * "This product includes software developed by the OpenSSL Project
42 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
44 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
45 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
47 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
48 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
51 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
53 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
55 * OF THE POSSIBILITY OF SUCH DAMAGE.
56 * ====================================================================
58 * This product includes cryptographic software written by Eric Young
59 * (eay@cryptsoft.com). This product includes software written by Tim
60 * Hudson (tjh@cryptsoft.com).
63 /* ====================================================================
64 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
66 * Portions of the attached software ("Contribution") are developed by
67 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
69 * The Contribution is licensed pursuant to the OpenSSL open source
70 * license provided above.
72 * The elliptic curve binary polynomial software is originally written by
73 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
80 # include <openssl/opensslconf.h>
83 # error EC is disabled.
86 # include <openssl/asn1.h>
87 # include <openssl/symhacks.h>
88 # ifdef OPENSSL_USE_DEPRECATED
89 # include <openssl/bn.h>
94 # elif defined(__SUNPRO_C)
95 # if __SUNPRO_C >= 0x520
96 # pragma error_messages (off,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
100 # ifndef OPENSSL_ECC_MAX_FIELD_BITS
101 # define OPENSSL_ECC_MAX_FIELD_BITS 661
104 /** Enum for the point conversion form as defined in X9.62 (ECDSA)
105 * for the encoding of a elliptic curve point (x,y) */
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 0x04 */
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;
117 typedef struct ec_method_st EC_METHOD;
119 typedef struct ec_group_st
123 -- curve coefficients
124 -- optional generator with associated information (order, cofactor)
125 -- optional extra data (precomputed table for fast computation of multiples of generator)
130 typedef struct ec_point_st EC_POINT;
132 /********************************************************************/
133 /* EC_METHODs for curves over GF(p) */
134 /********************************************************************/
136 /** Returns the basic GFp ec methods which provides the basis for the
138 * \return EC_METHOD object
140 const EC_METHOD *EC_GFp_simple_method(void);
142 /** Returns GFp methods using montgomery multiplication.
143 * \return EC_METHOD object
145 const EC_METHOD *EC_GFp_mont_method(void);
147 /** Returns GFp methods using optimized methods for NIST recommended curves
148 * \return EC_METHOD object
150 const EC_METHOD *EC_GFp_nist_method(void);
152 # ifndef OPENSSL_NO_EC_NISTP_64_GCC_128
153 # ifndef OPENSSL_SYS_WIN32
154 /** Returns 64-bit optimized methods for nistp224
155 * \return EC_METHOD object
157 const EC_METHOD *EC_GFp_nistp224_method(void);
159 /** Returns 64-bit optimized methods for nistp256
160 * \return EC_METHOD object
162 const EC_METHOD *EC_GFp_nistp256_method(void);
164 /** Returns 64-bit optimized methods for nistp521
165 * \return EC_METHOD object
167 const EC_METHOD *EC_GFp_nistp521_method(void);
171 # ifndef OPENSSL_NO_EC2M
172 /********************************************************************/
173 /* EC_METHOD for curves over GF(2^m) */
174 /********************************************************************/
176 /** Returns the basic GF2m ec method
177 * \return EC_METHOD object
179 const EC_METHOD *EC_GF2m_simple_method(void);
183 /********************************************************************/
184 /* EC_GROUP functions */
185 /********************************************************************/
187 /** Creates a new EC_GROUP object
188 * \param meth EC_METHOD to use
189 * \return newly created EC_GROUP object or NULL in case of an error.
191 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth);
193 /** Frees a EC_GROUP object
194 * \param group EC_GROUP object to be freed.
196 void EC_GROUP_free(EC_GROUP *group);
198 /** Clears and frees a EC_GROUP object
199 * \param group EC_GROUP object to be cleared and freed.
201 void EC_GROUP_clear_free(EC_GROUP *group);
203 /** Copies EC_GROUP objects. Note: both EC_GROUPs must use the same EC_METHOD.
204 * \param dst destination EC_GROUP object
205 * \param src source EC_GROUP object
206 * \return 1 on success and 0 if an error occurred.
208 int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
210 /** Creates a new EC_GROUP object and copies the copies the content
211 * form src to the newly created EC_KEY object
212 * \param src source EC_GROUP object
213 * \return newly created EC_GROUP object or NULL in case of an error.
215 EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
217 /** Returns the EC_METHOD of the EC_GROUP object.
218 * \param group EC_GROUP object
219 * \return EC_METHOD used in this EC_GROUP object.
221 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
223 /** Returns the field type of the EC_METHOD.
224 * \param meth EC_METHOD object
225 * \return NID of the underlying field type OID.
227 int EC_METHOD_get_field_type(const EC_METHOD *meth);
229 /** Sets the generator and it's order/cofactor of a EC_GROUP object.
230 * \param group EC_GROUP object
231 * \param generator EC_POINT object with the generator.
232 * \param order the order of the group generated by the generator.
233 * \param cofactor the index of the sub-group generated by the generator
234 * in the group of all points on the elliptic curve.
235 * \return 1 on success and 0 if an error occurred
237 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator,
238 const BIGNUM *order, const BIGNUM *cofactor);
240 /** Returns the generator of a EC_GROUP object.
241 * \param group EC_GROUP object
242 * \return the currently used generator (possibly NULL).
244 const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
246 /** Returns the montgomery data for order(Generator)
247 * \param group EC_GROUP object
248 * \return the currently used generator (possibly NULL).
250 BN_MONT_CTX *EC_GROUP_get_mont_data(const EC_GROUP *group);
252 /** Gets the order of a EC_GROUP
253 * \param group EC_GROUP object
254 * \param order BIGNUM to which the order is copied
255 * \param ctx BN_CTX object (optional)
256 * \return 1 on success and 0 if an error occurred
258 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
260 /** Gets the cofactor of a EC_GROUP
261 * \param group EC_GROUP object
262 * \param cofactor BIGNUM to which the cofactor is copied
263 * \param ctx BN_CTX object (optional)
264 * \return 1 on success and 0 if an error occurred
266 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor,
269 /** Sets the name of a EC_GROUP object
270 * \param group EC_GROUP object
271 * \param nid NID of the curve name OID
273 void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
275 /** Returns the curve name of a EC_GROUP object
276 * \param group EC_GROUP object
277 * \return NID of the curve name OID or 0 if not set.
279 int EC_GROUP_get_curve_name(const EC_GROUP *group);
281 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
282 int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
284 void EC_GROUP_set_point_conversion_form(EC_GROUP *group,
285 point_conversion_form_t form);
286 point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
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);
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
300 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,
301 const BIGNUM *b, BN_CTX *ctx);
303 /** Gets the parameter of the ec over GFp defined by y^2 = x^3 + a*x + b
304 * \param group EC_GROUP object
305 * \param p BIGNUM for the prime number
306 * \param a BIGNUM for parameter a of the equation
307 * \param b BIGNUM for parameter b of the equation
308 * \param ctx BN_CTX object (optional)
309 * \return 1 on success and 0 if an error occurred
311 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a,
312 BIGNUM *b, BN_CTX *ctx);
314 # ifndef OPENSSL_NO_EC2M
315 /** Sets the parameter of a ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b
316 * \param group EC_GROUP object
317 * \param p BIGNUM with the polynomial defining the underlying field
318 * \param a BIGNUM with parameter a of the equation
319 * \param b BIGNUM with parameter b of the equation
320 * \param ctx BN_CTX object (optional)
321 * \return 1 on success and 0 if an error occurred
323 int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,
324 const BIGNUM *b, BN_CTX *ctx);
326 /** Gets the parameter of the ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b
327 * \param group EC_GROUP object
328 * \param p BIGNUM for the polynomial defining the underlying field
329 * \param a BIGNUM for parameter a of the equation
330 * \param b BIGNUM for parameter b of the equation
331 * \param ctx BN_CTX object (optional)
332 * \return 1 on success and 0 if an error occurred
334 int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a,
335 BIGNUM *b, BN_CTX *ctx);
337 /** Returns the number of bits needed to represent a field element
338 * \param group EC_GROUP object
339 * \return number of bits needed to represent a field element
341 int EC_GROUP_get_degree(const EC_GROUP *group);
343 /** Checks whether the parameter in the EC_GROUP define a valid ec group
344 * \param group EC_GROUP object
345 * \param ctx BN_CTX object (optional)
346 * \return 1 if group is a valid ec group and 0 otherwise
348 int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
350 /** Checks whether the discriminant of the elliptic curve is zero or not
351 * \param group EC_GROUP object
352 * \param ctx BN_CTX object (optional)
353 * \return 1 if the discriminant is not zero and 0 otherwise
355 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
357 /** Compares two EC_GROUP objects
358 * \param a first EC_GROUP object
359 * \param b second EC_GROUP object
360 * \param ctx BN_CTX object (optional)
361 * \return 0 if both groups are equal and 1 otherwise
363 int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
366 * EC_GROUP_new_GF*() calls EC_GROUP_new() and EC_GROUP_set_GF*() after
367 * choosing an appropriate EC_METHOD
370 /** Creates a new EC_GROUP object with the specified parameters defined
371 * over GFp (defined by the equation y^2 = x^3 + a*x + b)
372 * \param p BIGNUM with the prime number
373 * \param a BIGNUM with the parameter a of the equation
374 * \param b BIGNUM with the parameter b of the equation
375 * \param ctx BN_CTX object (optional)
376 * \return newly created EC_GROUP object with the specified parameters
378 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a,
379 const BIGNUM *b, BN_CTX *ctx);
380 # ifndef OPENSSL_NO_EC2M
381 /** Creates a new EC_GROUP object with the specified parameters defined
382 * over GF2m (defined by the equation y^2 + x*y = x^3 + a*x^2 + b)
383 * \param p BIGNUM with the polynomial defining the underlying field
384 * \param a BIGNUM with the parameter a of the equation
385 * \param b BIGNUM with the parameter b of the equation
386 * \param ctx BN_CTX object (optional)
387 * \return newly created EC_GROUP object with the specified parameters
389 EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a,
390 const BIGNUM *b, BN_CTX *ctx);
392 /** Creates a EC_GROUP object with a curve specified by a NID
393 * \param nid NID of the OID of the curve name
394 * \return newly created EC_GROUP object with specified curve or NULL
395 * if an error occurred
397 EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
399 /********************************************************************/
400 /* handling of internal curves */
401 /********************************************************************/
409 * EC_builtin_curves(EC_builtin_curve *r, size_t size) returns number of all
410 * available curves or zero if a error occurred. In case r ist not zero
411 * nitems EC_builtin_curve structures are filled with the data of the first
412 * nitems internal groups
414 size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems);
416 const char *EC_curve_nid2nist(int nid);
417 int EC_curve_nist2nid(const char *name);
419 /********************************************************************/
420 /* EC_POINT functions */
421 /********************************************************************/
423 /** Creates a new EC_POINT object for the specified EC_GROUP
424 * \param group EC_GROUP the underlying EC_GROUP object
425 * \return newly created EC_POINT object or NULL if an error occurred
427 EC_POINT *EC_POINT_new(const EC_GROUP *group);
429 /** Frees a EC_POINT object
430 * \param point EC_POINT object to be freed
432 void EC_POINT_free(EC_POINT *point);
434 /** Clears and frees a EC_POINT object
435 * \param point EC_POINT object to be cleared and freed
437 void EC_POINT_clear_free(EC_POINT *point);
439 /** Copies EC_POINT object
440 * \param dst destination EC_POINT object
441 * \param src source EC_POINT object
442 * \return 1 on success and 0 if an error occurred
444 int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
446 /** Creates a new EC_POINT object and copies the content of the supplied
448 * \param src source EC_POINT object
449 * \param group underlying the EC_GROUP object
450 * \return newly created EC_POINT object or NULL if an error occurred
452 EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
454 /** Returns the EC_METHOD used in EC_POINT object
455 * \param point EC_POINT object
456 * \return the EC_METHOD used
458 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
460 /** Sets a point to infinity (neutral element)
461 * \param group underlying EC_GROUP object
462 * \param point EC_POINT to set to infinity
463 * \return 1 on success and 0 if an error occurred
465 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
467 /** Sets the jacobian projective coordinates of a EC_POINT over GFp
468 * \param group underlying EC_GROUP object
469 * \param p EC_POINT object
470 * \param x BIGNUM with the x-coordinate
471 * \param y BIGNUM with the y-coordinate
472 * \param z BIGNUM with the z-coordinate
473 * \param ctx BN_CTX object (optional)
474 * \return 1 on success and 0 if an error occurred
476 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group,
477 EC_POINT *p, const BIGNUM *x,
478 const BIGNUM *y, const BIGNUM *z,
481 /** Gets the jacobian projective coordinates of a EC_POINT over GFp
482 * \param group underlying EC_GROUP object
483 * \param p EC_POINT object
484 * \param x BIGNUM for the x-coordinate
485 * \param y BIGNUM for the y-coordinate
486 * \param z BIGNUM for the z-coordinate
487 * \param ctx BN_CTX object (optional)
488 * \return 1 on success and 0 if an error occurred
490 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
491 const EC_POINT *p, BIGNUM *x,
492 BIGNUM *y, BIGNUM *z,
495 /** Sets the affine coordinates of a EC_POINT over GFp
496 * \param group underlying EC_GROUP object
497 * \param p EC_POINT object
498 * \param x BIGNUM with the x-coordinate
499 * \param y BIGNUM with the y-coordinate
500 * \param ctx BN_CTX object (optional)
501 * \return 1 on success and 0 if an error occurred
503 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
504 const BIGNUM *x, const BIGNUM *y,
507 /** Gets the affine coordinates of a EC_POINT over GFp
508 * \param group underlying EC_GROUP object
509 * \param p EC_POINT object
510 * \param x BIGNUM for the x-coordinate
511 * \param y BIGNUM for the y-coordinate
512 * \param ctx BN_CTX object (optional)
513 * \return 1 on success and 0 if an error occurred
515 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
516 const EC_POINT *p, BIGNUM *x,
517 BIGNUM *y, BN_CTX *ctx);
519 /** Sets the x9.62 compressed coordinates of a EC_POINT over GFp
520 * \param group underlying EC_GROUP object
521 * \param p EC_POINT object
522 * \param x BIGNUM with x-coordinate
523 * \param y_bit integer with the y-Bit (either 0 or 1)
524 * \param ctx BN_CTX object (optional)
525 * \return 1 on success and 0 if an error occurred
527 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group,
528 EC_POINT *p, const BIGNUM *x,
529 int y_bit, BN_CTX *ctx);
530 # ifndef OPENSSL_NO_EC2M
531 /** Sets the affine coordinates of a EC_POINT over GF2m
532 * \param group underlying EC_GROUP object
533 * \param p EC_POINT object
534 * \param x BIGNUM with the x-coordinate
535 * \param y BIGNUM with the y-coordinate
536 * \param ctx BN_CTX object (optional)
537 * \return 1 on success and 0 if an error occurred
539 int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
540 const BIGNUM *x, const BIGNUM *y,
543 /** Gets the affine coordinates of a EC_POINT over GF2m
544 * \param group underlying EC_GROUP object
545 * \param p EC_POINT object
546 * \param x BIGNUM for the x-coordinate
547 * \param y BIGNUM for the y-coordinate
548 * \param ctx BN_CTX object (optional)
549 * \return 1 on success and 0 if an error occurred
551 int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,
552 const EC_POINT *p, BIGNUM *x,
553 BIGNUM *y, BN_CTX *ctx);
555 /** Sets the x9.62 compressed coordinates of a EC_POINT over GF2m
556 * \param group underlying EC_GROUP object
557 * \param p EC_POINT object
558 * \param x BIGNUM with x-coordinate
559 * \param y_bit integer with the y-Bit (either 0 or 1)
560 * \param ctx BN_CTX object (optional)
561 * \return 1 on success and 0 if an error occurred
563 int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group,
564 EC_POINT *p, const BIGNUM *x,
565 int y_bit, BN_CTX *ctx);
567 /** Encodes a EC_POINT object to a octet string
568 * \param group underlying EC_GROUP object
569 * \param p EC_POINT object
570 * \param form point conversion form
571 * \param buf memory buffer for the result. If NULL the function returns
572 * required buffer size.
573 * \param len length of the memory buffer
574 * \param ctx BN_CTX object (optional)
575 * \return the length of the encoded octet string or 0 if an error occurred
577 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
578 point_conversion_form_t form,
579 unsigned char *buf, size_t len, BN_CTX *ctx);
581 /** Decodes a EC_POINT from a octet string
582 * \param group underlying EC_GROUP object
583 * \param p EC_POINT object
584 * \param buf memory buffer with the encoded ec point
585 * \param len length of the encoded ec point
586 * \param ctx BN_CTX object (optional)
587 * \return 1 on success and 0 if an error occurred
589 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
590 const unsigned char *buf, size_t len, BN_CTX *ctx);
592 /* other interfaces to point2oct/oct2point: */
593 BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *,
594 point_conversion_form_t form, BIGNUM *, BN_CTX *);
595 EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *,
596 EC_POINT *, BN_CTX *);
597 char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *,
598 point_conversion_form_t form, BN_CTX *);
599 EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *,
600 EC_POINT *, BN_CTX *);
602 /********************************************************************/
603 /* functions for doing EC_POINT arithmetic */
604 /********************************************************************/
606 /** Computes the sum of two EC_POINT
607 * \param group underlying EC_GROUP object
608 * \param r EC_POINT object for the result (r = a + b)
609 * \param a EC_POINT object with the first summand
610 * \param b EC_POINT object with the second summand
611 * \param ctx BN_CTX object (optional)
612 * \return 1 on success and 0 if an error occurred
614 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
615 const EC_POINT *b, BN_CTX *ctx);
617 /** Computes the double of a EC_POINT
618 * \param group underlying EC_GROUP object
619 * \param r EC_POINT object for the result (r = 2 * a)
620 * \param a EC_POINT object
621 * \param ctx BN_CTX object (optional)
622 * \return 1 on success and 0 if an error occurred
624 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
627 /** Computes the inverse of a EC_POINT
628 * \param group underlying EC_GROUP object
629 * \param a EC_POINT object to be inverted (it's used for the result as well)
630 * \param ctx BN_CTX object (optional)
631 * \return 1 on success and 0 if an error occurred
633 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx);
635 /** Checks whether the point is the neutral element of the group
636 * \param group the underlying EC_GROUP object
637 * \param p EC_POINT object
638 * \return 1 if the point is the neutral element and 0 otherwise
640 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p);
642 /** Checks whether the point is on the curve
643 * \param group underlying EC_GROUP object
644 * \param point EC_POINT object to check
645 * \param ctx BN_CTX object (optional)
646 * \return 1 if point if on the curve and 0 otherwise
648 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point,
651 /** Compares two EC_POINTs
652 * \param group underlying EC_GROUP object
653 * \param a first EC_POINT object
654 * \param b second EC_POINT object
655 * \param ctx BN_CTX object (optional)
656 * \return 0 if both points are equal and a value != 0 otherwise
658 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b,
661 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx);
662 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num,
663 EC_POINT *points[], BN_CTX *ctx);
665 /** Computes r = generator * n sum_{i=0}^{num-1} p[i] * m[i]
666 * \param group underlying EC_GROUP object
667 * \param r EC_POINT object for the result
668 * \param n BIGNUM with the multiplier for the group generator (optional)
669 * \param num number futher summands
670 * \param p array of size num of EC_POINT objects
671 * \param m array of size num of BIGNUM objects
672 * \param ctx BN_CTX object (optional)
673 * \return 1 on success and 0 if an error occurred
675 int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
676 size_t num, const EC_POINT *p[], const BIGNUM *m[],
679 /** Computes r = generator * n + q * m
680 * \param group underlying EC_GROUP object
681 * \param r EC_POINT object for the result
682 * \param n BIGNUM with the multiplier for the group generator (optional)
683 * \param q EC_POINT object with the first factor of the second summand
684 * \param m BIGNUM with the second factor of the second summand
685 * \param ctx BN_CTX object (optional)
686 * \return 1 on success and 0 if an error occurred
688 int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
689 const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);
691 /** Stores multiples of generator for faster point multiplication
692 * \param group EC_GROUP object
693 * \param ctx BN_CTX object (optional)
694 * \return 1 on success and 0 if an error occurred
696 int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
698 /** Reports whether a precomputation has been done
699 * \param group EC_GROUP object
700 * \return 1 if a pre-computation has been done and 0 otherwise
702 int EC_GROUP_have_precompute_mult(const EC_GROUP *group);
704 /********************************************************************/
706 /********************************************************************/
709 * EC_GROUP_get_basis_type() returns the NID of the basis type used to
710 * represent the field elements
712 int EC_GROUP_get_basis_type(const EC_GROUP *);
713 # ifndef OPENSSL_NO_EC2M
714 int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
715 int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1,
716 unsigned int *k2, unsigned int *k3);
719 # define OPENSSL_EC_EXPLICIT_CURVE 0x000
720 # define OPENSSL_EC_NAMED_CURVE 0x001
722 typedef struct ecpk_parameters_st ECPKPARAMETERS;
724 EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len);
725 int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out);
727 # define d2i_ECPKParameters_bio(bp,x) ASN1_d2i_bio_of(EC_GROUP,NULL,d2i_ECPKParameters,bp,x)
728 # define i2d_ECPKParameters_bio(bp,x) ASN1_i2d_bio_of_const(EC_GROUP,i2d_ECPKParameters,bp,x)
729 # define d2i_ECPKParameters_fp(fp,x) (EC_GROUP *)ASN1_d2i_fp(NULL, \
730 (char *(*)())d2i_ECPKParameters,(fp),(unsigned char **)(x))
731 # define i2d_ECPKParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECPKParameters,(fp), \
732 (unsigned char *)(x))
734 int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off);
735 # ifndef OPENSSL_NO_STDIO
736 int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off);
739 /********************************************************************/
740 /* EC_KEY functions */
741 /********************************************************************/
743 typedef struct ec_key_st EC_KEY;
744 typedef struct ec_key_method_st EC_KEY_METHOD;
746 /* some values for the encoding_flag */
747 # define EC_PKEY_NO_PARAMETERS 0x001
748 # define EC_PKEY_NO_PUBKEY 0x002
750 /* some values for the flags field */
751 # define EC_FLAG_NON_FIPS_ALLOW 0x1
752 # define EC_FLAG_FIPS_CHECKED 0x2
753 # define EC_FLAG_COFACTOR_ECDH 0x1000
755 /** Creates a new EC_KEY object.
756 * \return EC_KEY object or NULL if an error occurred.
758 EC_KEY *EC_KEY_new(void);
760 int EC_KEY_get_flags(const EC_KEY *key);
762 void EC_KEY_set_flags(EC_KEY *key, int flags);
764 void EC_KEY_clear_flags(EC_KEY *key, int flags);
766 /** Creates a new EC_KEY object using a named curve as underlying
768 * \param nid NID of the named curve.
769 * \return EC_KEY object or NULL if an error occurred.
771 EC_KEY *EC_KEY_new_by_curve_name(int nid);
773 /** Frees a EC_KEY object.
774 * \param key EC_KEY object to be freed.
776 void EC_KEY_free(EC_KEY *key);
778 /** Copies a EC_KEY object.
779 * \param dst destination EC_KEY object
780 * \param src src EC_KEY object
781 * \return dst or NULL if an error occurred.
783 EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
785 /** Creates a new EC_KEY object and copies the content from src to it.
786 * \param src the source EC_KEY object
787 * \return newly created EC_KEY object or NULL if an error occurred.
789 EC_KEY *EC_KEY_dup(const EC_KEY *src);
791 /** Increases the internal reference count of a EC_KEY object.
792 * \param key EC_KEY object
793 * \return 1 on success and 0 if an error occurred.
795 int EC_KEY_up_ref(EC_KEY *key);
797 /** Returns the EC_GROUP object of a EC_KEY object
798 * \param key EC_KEY object
799 * \return the EC_GROUP object (possibly NULL).
801 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
803 /** Sets the EC_GROUP of a EC_KEY object.
804 * \param key EC_KEY object
805 * \param group EC_GROUP to use in the EC_KEY object (note: the EC_KEY
806 * object will use an own copy of the EC_GROUP).
807 * \return 1 on success and 0 if an error occurred.
809 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
811 /** Returns the private key of a EC_KEY object.
812 * \param key EC_KEY object
813 * \return a BIGNUM with the private key (possibly NULL).
815 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
817 /** Sets the private key of a EC_KEY object.
818 * \param key EC_KEY object
819 * \param prv BIGNUM with the private key (note: the EC_KEY object
820 * will use an own copy of the BIGNUM).
821 * \return 1 on success and 0 if an error occurred.
823 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
825 /** Returns the public key of a EC_KEY object.
826 * \param key the EC_KEY object
827 * \return a EC_POINT object with the public key (possibly NULL)
829 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
831 /** Sets the public key of a EC_KEY object.
832 * \param key EC_KEY object
833 * \param pub EC_POINT object with the public key (note: the EC_KEY object
834 * will use an own copy of the EC_POINT object).
835 * \return 1 on success and 0 if an error occurred.
837 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
839 unsigned EC_KEY_get_enc_flags(const EC_KEY *key);
840 void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);
841 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
842 void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
843 /* functions to set/get method specific data */
844 void *EC_KEY_get_key_method_data(EC_KEY *key,
845 void *(*dup_func) (void *),
846 void (*free_func) (void *),
847 void (*clear_free_func) (void *));
848 /** Sets the key method data of an EC_KEY object, if none has yet been set.
849 * \param key EC_KEY object
850 * \param data opaque data to install.
851 * \param dup_func a function that duplicates |data|.
852 * \param free_func a function that frees |data|.
853 * \param clear_free_func a function that wipes and frees |data|.
854 * \return the previously set data pointer, or NULL if |data| was inserted.
856 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
857 void *(*dup_func) (void *),
858 void (*free_func) (void *),
859 void (*clear_free_func) (void *));
860 /* wrapper functions for the underlying EC_GROUP object */
861 void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
863 /** Creates a table of pre-computed multiples of the generator to
864 * accelerate further EC_KEY operations.
865 * \param key EC_KEY object
866 * \param ctx BN_CTX object (optional)
867 * \return 1 on success and 0 if an error occurred.
869 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
871 /** Creates a new ec private (and optional a new public) key.
872 * \param key EC_KEY object
873 * \return 1 on success and 0 if an error occurred.
875 int EC_KEY_generate_key(EC_KEY *key);
877 /** Verifies that a private and/or public key is valid.
878 * \param key the EC_KEY object
879 * \return 1 on success and 0 otherwise.
881 int EC_KEY_check_key(const EC_KEY *key);
883 /** Sets a public key from affine coordindates performing
884 * necessary NIST PKV tests.
885 * \param key the EC_KEY object
886 * \param x public key x coordinate
887 * \param y public key y coordinate
888 * \return 1 on success and 0 otherwise.
890 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
893 /********************************************************************/
894 /* de- and encoding functions for SEC1 ECPrivateKey */
895 /********************************************************************/
897 /** Decodes a private key from a memory buffer.
898 * \param key a pointer to a EC_KEY object which should be used (or NULL)
899 * \param in pointer to memory with the DER encoded private key
900 * \param len length of the DER encoded private key
901 * \return the decoded private key or NULL if an error occurred.
903 EC_KEY *d2i_ECPrivateKey(EC_KEY **key, const unsigned char **in, long len);
905 /** Encodes a private key object and stores the result in a buffer.
906 * \param key the EC_KEY object to encode
907 * \param out the buffer for the result (if NULL the function returns number
909 * \return 1 on success and 0 if an error occurred.
911 int i2d_ECPrivateKey(EC_KEY *key, unsigned char **out);
913 /********************************************************************/
914 /* de- and encoding functions for EC parameters */
915 /********************************************************************/
917 /** Decodes ec parameter from a memory buffer.
918 * \param key a pointer to a EC_KEY object which should be used (or NULL)
919 * \param in pointer to memory with the DER encoded ec parameters
920 * \param len length of the DER encoded ec parameters
921 * \return a EC_KEY object with the decoded parameters or NULL if an error
924 EC_KEY *d2i_ECParameters(EC_KEY **key, const unsigned char **in, long len);
926 /** Encodes ec parameter and stores the result in a buffer.
927 * \param key the EC_KEY object with ec parameters to encode
928 * \param out the buffer for the result (if NULL the function returns number
930 * \return 1 on success and 0 if an error occurred.
932 int i2d_ECParameters(EC_KEY *key, unsigned char **out);
934 /********************************************************************/
935 /* de- and encoding functions for EC public key */
936 /* (octet string, not DER -- hence 'o2i' and 'i2o') */
937 /********************************************************************/
939 /** Decodes a ec public key from a octet string.
940 * \param key a pointer to a EC_KEY object which should be used
941 * \param in memory buffer with the encoded public key
942 * \param len length of the encoded public key
943 * \return EC_KEY object with decoded public key or NULL if an error
946 EC_KEY *o2i_ECPublicKey(EC_KEY **key, const unsigned char **in, long len);
948 /** Encodes a ec public key in an octet string.
949 * \param key the EC_KEY object with the public key
950 * \param out the buffer for the result (if NULL the function returns number
952 * \return 1 on success and 0 if an error occurred
954 int i2o_ECPublicKey(EC_KEY *key, unsigned char **out);
956 /** Prints out the ec parameters on human readable form.
957 * \param bp BIO object to which the information is printed
958 * \param key EC_KEY object
959 * \return 1 on success and 0 if an error occurred
961 int ECParameters_print(BIO *bp, const EC_KEY *key);
963 /** Prints out the contents of a EC_KEY object
964 * \param bp BIO object to which the information is printed
965 * \param key EC_KEY object
966 * \param off line offset
967 * \return 1 on success and 0 if an error occurred
969 int EC_KEY_print(BIO *bp, const EC_KEY *key, int off);
971 # ifndef OPENSSL_NO_STDIO
972 /** Prints out the ec parameters on human readable form.
973 * \param fp file descriptor to which the information is printed
974 * \param key EC_KEY object
975 * \return 1 on success and 0 if an error occurred
977 int ECParameters_print_fp(FILE *fp, const EC_KEY *key);
979 /** Prints out the contents of a EC_KEY object
980 * \param fp file descriptor to which the information is printed
981 * \param key EC_KEY object
982 * \param off line offset
983 * \return 1 on success and 0 if an error occurred
985 int EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off);
989 const EC_KEY_METHOD *EC_KEY_OpenSSL(void);
990 const EC_KEY_METHOD *EC_KEY_get_default_method(void);
991 void EC_KEY_set_default_method(const EC_KEY_METHOD *meth);
992 EC_KEY *EC_KEY_new_method(ENGINE *engine);
994 int ECDH_KDF_X9_62(unsigned char *out, size_t outlen,
995 const unsigned char *Z, size_t Zlen,
996 const unsigned char *sinfo, size_t sinfolen,
999 int ECDH_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
1000 EC_KEY *ecdh, void *(*KDF) (const void *in, size_t inlen,
1001 void *out, size_t *outlen));
1003 typedef struct ECDSA_SIG_st ECDSA_SIG;
1005 /** Allocates and initialize a ECDSA_SIG structure
1006 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
1008 ECDSA_SIG *ECDSA_SIG_new(void);
1010 /** frees a ECDSA_SIG structure
1011 * \param sig pointer to the ECDSA_SIG structure
1013 void ECDSA_SIG_free(ECDSA_SIG *sig);
1015 /** DER encode content of ECDSA_SIG object (note: this function modifies *pp
1016 * (*pp += length of the DER encoded signature)).
1017 * \param sig pointer to the ECDSA_SIG object
1018 * \param pp pointer to a unsigned char pointer for the output or NULL
1019 * \return the length of the DER encoded ECDSA_SIG object or 0
1021 int i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp);
1023 /** Decodes a DER encoded ECDSA signature (note: this function changes *pp
1025 * \param sig pointer to ECDSA_SIG pointer (may be NULL)
1026 * \param pp memory buffer with the DER encoded signature
1027 * \param len length of the buffer
1028 * \return pointer to the decoded ECDSA_SIG structure (or NULL)
1030 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, long len);
1032 /** Accessor for r and s fields of ECDSA_SIG
1033 * \param sig pointer to ECDSA_SIG pointer
1034 * \param pr pointer to BIGNUM pointer for r (may be NULL)
1035 * \param ps pointer to BIGNUM pointer for s (may be NULL)
1037 void ECDSA_SIG_get0(BIGNUM **pr, BIGNUM **ps, ECDSA_SIG *sig);
1039 /** Computes the ECDSA signature of the given hash value using
1040 * the supplied private key and returns the created signature.
1041 * \param dgst pointer to the hash value
1042 * \param dgst_len length of the hash value
1043 * \param eckey EC_KEY object containing a private EC key
1044 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
1046 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
1049 /** Computes ECDSA signature of a given hash value using the supplied
1050 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
1051 * \param dgst pointer to the hash value to sign
1052 * \param dgstlen length of the hash value
1053 * \param kinv BIGNUM with a pre-computed inverse k (optional)
1054 * \param rp BIGNUM with a pre-computed rp value (optioanl),
1055 * see ECDSA_sign_setup
1056 * \param eckey EC_KEY object containing a private EC key
1057 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
1059 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
1060 const BIGNUM *kinv, const BIGNUM *rp,
1063 /** Verifies that the supplied signature is a valid ECDSA
1064 * signature of the supplied hash value using the supplied public key.
1065 * \param dgst pointer to the hash value
1066 * \param dgst_len length of the hash value
1067 * \param sig ECDSA_SIG structure
1068 * \param eckey EC_KEY object containing a public EC key
1069 * \return 1 if the signature is valid, 0 if the signature is invalid
1072 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
1073 const ECDSA_SIG *sig, EC_KEY *eckey);
1075 /** Precompute parts of the signing operation
1076 * \param eckey EC_KEY object containing a private EC key
1077 * \param ctx BN_CTX object (optional)
1078 * \param kinv BIGNUM pointer for the inverse of k
1079 * \param rp BIGNUM pointer for x coordinate of k * generator
1080 * \return 1 on success and 0 otherwise
1082 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
1084 /** Computes ECDSA signature of a given hash value using the supplied
1085 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
1086 * \param type this parameter is ignored
1087 * \param dgst pointer to the hash value to sign
1088 * \param dgstlen length of the hash value
1089 * \param sig memory for the DER encoded created signature
1090 * \param siglen pointer to the length of the returned signature
1091 * \param eckey EC_KEY object containing a private EC key
1092 * \return 1 on success and 0 otherwise
1094 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
1095 unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
1097 /** Computes ECDSA signature of a given hash value using the supplied
1098 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
1099 * \param type this parameter is ignored
1100 * \param dgst pointer to the hash value to sign
1101 * \param dgstlen length of the hash value
1102 * \param sig buffer to hold the DER encoded signature
1103 * \param siglen pointer to the length of the returned signature
1104 * \param kinv BIGNUM with a pre-computed inverse k (optional)
1105 * \param rp BIGNUM with a pre-computed rp value (optioanl),
1106 * see ECDSA_sign_setup
1107 * \param eckey EC_KEY object containing a private EC key
1108 * \return 1 on success and 0 otherwise
1110 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
1111 unsigned char *sig, unsigned int *siglen,
1112 const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
1114 /** Verifies that the given signature is valid ECDSA signature
1115 * of the supplied hash value using the specified public key.
1116 * \param type this parameter is ignored
1117 * \param dgst pointer to the hash value
1118 * \param dgstlen length of the hash value
1119 * \param sig pointer to the DER encoded signature
1120 * \param siglen length of the DER encoded signature
1121 * \param eckey EC_KEY object containing a public EC key
1122 * \return 1 if the signature is valid, 0 if the signature is invalid
1125 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
1126 const unsigned char *sig, int siglen, EC_KEY *eckey);
1128 /** Returns the maximum length of the DER encoded signature
1129 * \param eckey EC_KEY object
1130 * \return numbers of bytes required for the DER encoded signature
1132 int ECDSA_size(const EC_KEY *eckey);
1134 /********************************************************************/
1135 /* EC_KEY_METHOD constructors, destructors, writers and accessors */
1136 /********************************************************************/
1138 EC_KEY_METHOD *EC_KEY_METHOD_new(const EC_KEY_METHOD *meth);
1139 void EC_KEY_METHOD_free(EC_KEY_METHOD *meth);
1140 void EC_KEY_METHOD_set_init(EC_KEY_METHOD *meth,
1141 int (*init)(EC_KEY *key),
1142 void (*finish)(EC_KEY *key),
1143 int (*copy)(EC_KEY *dest, const EC_KEY *src),
1144 int (*set_group)(EC_KEY *key, const EC_GROUP *grp),
1145 int (*set_private)(EC_KEY *key,
1146 const BIGNUM *priv_key),
1147 int (*set_public)(EC_KEY *key,
1148 const EC_POINT *pub_key));
1150 void EC_KEY_METHOD_set_keygen(EC_KEY_METHOD *meth,
1151 int (*keygen)(EC_KEY *key));
1153 void EC_KEY_METHOD_set_compute_key(EC_KEY_METHOD *meth,
1154 int (*ckey)(void *out,
1156 const EC_POINT *pub_key,
1158 void *(*KDF) (const void *in,
1163 void EC_KEY_METHOD_set_sign(EC_KEY_METHOD *meth,
1164 int (*sign)(int type, const unsigned char *dgst,
1165 int dlen, unsigned char *sig,
1166 unsigned int *siglen,
1167 const BIGNUM *kinv, const BIGNUM *r,
1169 int (*sign_setup)(EC_KEY *eckey, BN_CTX *ctx_in,
1170 BIGNUM **kinvp, BIGNUM **rp),
1171 ECDSA_SIG *(*sign_sig)(const unsigned char *dgst,
1173 const BIGNUM *in_kinv,
1177 void EC_KEY_METHOD_set_verify(EC_KEY_METHOD *meth,
1178 int (*verify)(int type, const unsigned
1179 char *dgst, int dgst_len,
1180 const unsigned char *sigbuf,
1181 int sig_len, EC_KEY *eckey),
1182 int (*verify_sig)(const unsigned char *dgst,
1184 const ECDSA_SIG *sig,
1187 void EC_KEY_METHOD_get_init(EC_KEY_METHOD *meth,
1188 int (**pinit)(EC_KEY *key),
1189 void (**pfinish)(EC_KEY *key),
1190 int (**pcopy)(EC_KEY *dest, const EC_KEY *src),
1191 int (**pset_group)(EC_KEY *key,
1192 const EC_GROUP *grp),
1193 int (**pset_private)(EC_KEY *key,
1194 const BIGNUM *priv_key),
1195 int (**pset_public)(EC_KEY *key,
1196 const EC_POINT *pub_key));
1198 void EC_KEY_METHOD_get_keygen(EC_KEY_METHOD *meth,
1199 int (**pkeygen)(EC_KEY *key));
1201 void EC_KEY_METHOD_get_compute_key(EC_KEY_METHOD *meth,
1202 int (**pck)(void *out,
1204 const EC_POINT *pub_key,
1206 void *(*KDF) (const void *in,
1211 void EC_KEY_METHOD_get_sign(EC_KEY_METHOD *meth,
1212 int (**psign)(int type, const unsigned char *dgst,
1213 int dlen, unsigned char *sig,
1214 unsigned int *siglen,
1215 const BIGNUM *kinv, const BIGNUM *r,
1217 int (**psign_setup)(EC_KEY *eckey, BN_CTX *ctx_in,
1218 BIGNUM **kinvp, BIGNUM **rp),
1219 ECDSA_SIG *(**psign_sig)(const unsigned char *dgst,
1221 const BIGNUM *in_kinv,
1225 void EC_KEY_METHOD_get_verify(EC_KEY_METHOD *meth,
1226 int (**pverify)(int type, const unsigned
1227 char *dgst, int dgst_len,
1228 const unsigned char *sigbuf,
1229 int sig_len, EC_KEY *eckey),
1230 int (**pverify_sig)(const unsigned char *dgst,
1232 const ECDSA_SIG *sig,
1235 # define ECParameters_dup(x) ASN1_dup_of(EC_KEY,i2d_ECParameters,d2i_ECParameters,x)
1237 # ifndef __cplusplus
1238 # if defined(__SUNPRO_C)
1239 # if __SUNPRO_C >= 0x520
1240 # pragma error_messages (default,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
1245 # define EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid) \
1246 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1247 EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
1248 EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, nid, NULL)
1250 # define EVP_PKEY_CTX_set_ec_param_enc(ctx, flag) \
1251 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1252 EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
1253 EVP_PKEY_CTRL_EC_PARAM_ENC, flag, NULL)
1255 # define EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, flag) \
1256 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1257 EVP_PKEY_OP_DERIVE, \
1258 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, flag, NULL)
1260 # define EVP_PKEY_CTX_get_ecdh_cofactor_mode(ctx) \
1261 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1262 EVP_PKEY_OP_DERIVE, \
1263 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, -2, NULL)
1265 # define EVP_PKEY_CTX_set_ecdh_kdf_type(ctx, kdf) \
1266 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1267 EVP_PKEY_OP_DERIVE, \
1268 EVP_PKEY_CTRL_EC_KDF_TYPE, kdf, NULL)
1270 # define EVP_PKEY_CTX_get_ecdh_kdf_type(ctx) \
1271 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1272 EVP_PKEY_OP_DERIVE, \
1273 EVP_PKEY_CTRL_EC_KDF_TYPE, -2, NULL)
1275 # define EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md) \
1276 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1277 EVP_PKEY_OP_DERIVE, \
1278 EVP_PKEY_CTRL_EC_KDF_MD, 0, (void *)md)
1280 # define EVP_PKEY_CTX_get_ecdh_kdf_md(ctx, pmd) \
1281 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1282 EVP_PKEY_OP_DERIVE, \
1283 EVP_PKEY_CTRL_GET_EC_KDF_MD, 0, (void *)pmd)
1285 # define EVP_PKEY_CTX_set_ecdh_kdf_outlen(ctx, len) \
1286 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1287 EVP_PKEY_OP_DERIVE, \
1288 EVP_PKEY_CTRL_EC_KDF_OUTLEN, len, NULL)
1290 # define EVP_PKEY_CTX_get_ecdh_kdf_outlen(ctx, plen) \
1291 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1292 EVP_PKEY_OP_DERIVE, \
1293 EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, 0, (void *)plen)
1295 # define EVP_PKEY_CTX_set0_ecdh_kdf_ukm(ctx, p, plen) \
1296 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1297 EVP_PKEY_OP_DERIVE, \
1298 EVP_PKEY_CTRL_EC_KDF_UKM, plen, (void *)p)
1300 # define EVP_PKEY_CTX_get0_ecdh_kdf_ukm(ctx, p) \
1301 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
1302 EVP_PKEY_OP_DERIVE, \
1303 EVP_PKEY_CTRL_GET_EC_KDF_UKM, 0, (void *)p)
1305 # define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID (EVP_PKEY_ALG_CTRL + 1)
1306 # define EVP_PKEY_CTRL_EC_PARAM_ENC (EVP_PKEY_ALG_CTRL + 2)
1307 # define EVP_PKEY_CTRL_EC_ECDH_COFACTOR (EVP_PKEY_ALG_CTRL + 3)
1308 # define EVP_PKEY_CTRL_EC_KDF_TYPE (EVP_PKEY_ALG_CTRL + 4)
1309 # define EVP_PKEY_CTRL_EC_KDF_MD (EVP_PKEY_ALG_CTRL + 5)
1310 # define EVP_PKEY_CTRL_GET_EC_KDF_MD (EVP_PKEY_ALG_CTRL + 6)
1311 # define EVP_PKEY_CTRL_EC_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 7)
1312 # define EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 8)
1313 # define EVP_PKEY_CTRL_EC_KDF_UKM (EVP_PKEY_ALG_CTRL + 9)
1314 # define EVP_PKEY_CTRL_GET_EC_KDF_UKM (EVP_PKEY_ALG_CTRL + 10)
1316 # define EVP_PKEY_ECDH_KDF_NONE 1
1317 # define EVP_PKEY_ECDH_KDF_X9_62 2
1319 /* BEGIN ERROR CODES */
1321 * The following lines are auto generated by the script mkerr.pl. Any changes
1322 * made after this point may be overwritten when the script is next run.
1324 void ERR_load_EC_strings(void);
1326 /* Error codes for the EC functions. */
1328 /* Function codes. */
1329 # define EC_F_BN_TO_FELEM 224
1330 # define EC_F_COMPUTE_WNAF 143
1331 # define EC_F_D2I_ECPARAMETERS 144
1332 # define EC_F_D2I_ECPKPARAMETERS 145
1333 # define EC_F_D2I_ECPRIVATEKEY 146
1334 # define EC_F_DO_EC_KEY_PRINT 221
1335 # define EC_F_ECDH_CMS_DECRYPT 238
1336 # define EC_F_ECDH_CMS_SET_SHARED_INFO 239
1337 # define EC_F_ECDH_COMPUTE_KEY 246
1338 # define EC_F_ECDSA_DO_SIGN_EX 251
1339 # define EC_F_ECDSA_DO_VERIFY 252
1340 # define EC_F_ECDSA_SIGN_EX 254
1341 # define EC_F_ECDSA_SIGN_SETUP 248
1342 # define EC_F_ECDSA_VERIFY 253
1343 # define EC_F_ECKEY_PARAM2TYPE 223
1344 # define EC_F_ECKEY_PARAM_DECODE 212
1345 # define EC_F_ECKEY_PRIV_DECODE 213
1346 # define EC_F_ECKEY_PRIV_ENCODE 214
1347 # define EC_F_ECKEY_PUB_DECODE 215
1348 # define EC_F_ECKEY_PUB_ENCODE 216
1349 # define EC_F_ECKEY_TYPE2PARAM 220
1350 # define EC_F_ECPARAMETERS_PRINT 147
1351 # define EC_F_ECPARAMETERS_PRINT_FP 148
1352 # define EC_F_ECPKPARAMETERS_PRINT 149
1353 # define EC_F_ECPKPARAMETERS_PRINT_FP 150
1354 # define EC_F_ECP_NISTZ256_GET_AFFINE 240
1355 # define EC_F_ECP_NISTZ256_MULT_PRECOMPUTE 243
1356 # define EC_F_ECP_NISTZ256_POINTS_MUL 241
1357 # define EC_F_ECP_NISTZ256_PRE_COMP_NEW 244
1358 # define EC_F_ECP_NISTZ256_WINDOWED_MUL 242
1359 # define EC_F_ECP_NIST_MOD_192 203
1360 # define EC_F_ECP_NIST_MOD_224 204
1361 # define EC_F_ECP_NIST_MOD_256 205
1362 # define EC_F_ECP_NIST_MOD_521 206
1363 # define EC_F_EC_ASN1_GROUP2CURVE 153
1364 # define EC_F_EC_ASN1_GROUP2FIELDID 154
1365 # define EC_F_EC_ASN1_GROUP2PARAMETERS 155
1366 # define EC_F_EC_ASN1_GROUP2PKPARAMETERS 156
1367 # define EC_F_EC_ASN1_PARAMETERS2GROUP 157
1368 # define EC_F_EC_ASN1_PKPARAMETERS2GROUP 158
1369 # define EC_F_EC_EX_DATA_SET_DATA 211
1370 # define EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY 208
1371 # define EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT 159
1372 # define EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE 195
1373 # define EC_F_EC_GF2M_SIMPLE_OCT2POINT 160
1374 # define EC_F_EC_GF2M_SIMPLE_POINT2OCT 161
1375 # define EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES 162
1376 # define EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES 163
1377 # define EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES 164
1378 # define EC_F_EC_GFP_MONT_FIELD_DECODE 133
1379 # define EC_F_EC_GFP_MONT_FIELD_ENCODE 134
1380 # define EC_F_EC_GFP_MONT_FIELD_MUL 131
1381 # define EC_F_EC_GFP_MONT_FIELD_SET_TO_ONE 209
1382 # define EC_F_EC_GFP_MONT_FIELD_SQR 132
1383 # define EC_F_EC_GFP_MONT_GROUP_SET_CURVE 189
1384 # define EC_F_EC_GFP_MONT_GROUP_SET_CURVE_GFP 135
1385 # define EC_F_EC_GFP_NISTP224_GROUP_SET_CURVE 225
1386 # define EC_F_EC_GFP_NISTP224_POINTS_MUL 228
1387 # define EC_F_EC_GFP_NISTP224_POINT_GET_AFFINE_COORDINATES 226
1388 # define EC_F_EC_GFP_NISTP256_GROUP_SET_CURVE 230
1389 # define EC_F_EC_GFP_NISTP256_POINTS_MUL 231
1390 # define EC_F_EC_GFP_NISTP256_POINT_GET_AFFINE_COORDINATES 232
1391 # define EC_F_EC_GFP_NISTP521_GROUP_SET_CURVE 233
1392 # define EC_F_EC_GFP_NISTP521_POINTS_MUL 234
1393 # define EC_F_EC_GFP_NISTP521_POINT_GET_AFFINE_COORDINATES 235
1394 # define EC_F_EC_GFP_NIST_FIELD_MUL 200
1395 # define EC_F_EC_GFP_NIST_FIELD_SQR 201
1396 # define EC_F_EC_GFP_NIST_GROUP_SET_CURVE 202
1397 # define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT 165
1398 # define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE 166
1399 # define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP 100
1400 # define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR 101
1401 # define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE 102
1402 # define EC_F_EC_GFP_SIMPLE_OCT2POINT 103
1403 # define EC_F_EC_GFP_SIMPLE_POINT2OCT 104
1404 # define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE 137
1405 # define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES 167
1406 # define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
1407 # define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES 168
1408 # define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
1409 # define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES 169
1410 # define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
1411 # define EC_F_EC_GROUP_CHECK 170
1412 # define EC_F_EC_GROUP_CHECK_DISCRIMINANT 171
1413 # define EC_F_EC_GROUP_COPY 106
1414 # define EC_F_EC_GROUP_GET0_GENERATOR 139
1415 # define EC_F_EC_GROUP_GET_COFACTOR 140
1416 # define EC_F_EC_GROUP_GET_CURVE_GF2M 172
1417 # define EC_F_EC_GROUP_GET_CURVE_GFP 130
1418 # define EC_F_EC_GROUP_GET_DEGREE 173
1419 # define EC_F_EC_GROUP_GET_ORDER 141
1420 # define EC_F_EC_GROUP_GET_PENTANOMIAL_BASIS 193
1421 # define EC_F_EC_GROUP_GET_TRINOMIAL_BASIS 194
1422 # define EC_F_EC_GROUP_NEW 108
1423 # define EC_F_EC_GROUP_NEW_BY_CURVE_NAME 174
1424 # define EC_F_EC_GROUP_NEW_FROM_DATA 175
1425 # define EC_F_EC_GROUP_PRECOMPUTE_MULT 142
1426 # define EC_F_EC_GROUP_SET_CURVE_GF2M 176
1427 # define EC_F_EC_GROUP_SET_CURVE_GFP 109
1428 # define EC_F_EC_GROUP_SET_EXTRA_DATA 110
1429 # define EC_F_EC_GROUP_SET_GENERATOR 111
1430 # define EC_F_EC_KEY_CHECK_KEY 177
1431 # define EC_F_EC_KEY_COPY 178
1432 # define EC_F_EC_KEY_GENERATE_KEY 179
1433 # define EC_F_EC_KEY_NEW 182
1434 # define EC_F_EC_KEY_NEW_METHOD 245
1435 # define EC_F_EC_KEY_PRINT 180
1436 # define EC_F_EC_KEY_PRINT_FP 181
1437 # define EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES 229
1438 # define EC_F_EC_POINTS_MAKE_AFFINE 136
1439 # define EC_F_EC_POINT_ADD 112
1440 # define EC_F_EC_POINT_CMP 113
1441 # define EC_F_EC_POINT_COPY 114
1442 # define EC_F_EC_POINT_DBL 115
1443 # define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M 183
1444 # define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP 116
1445 # define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP 117
1446 # define EC_F_EC_POINT_INVERT 210
1447 # define EC_F_EC_POINT_IS_AT_INFINITY 118
1448 # define EC_F_EC_POINT_IS_ON_CURVE 119
1449 # define EC_F_EC_POINT_MAKE_AFFINE 120
1450 # define EC_F_EC_POINT_MUL 184
1451 # define EC_F_EC_POINT_NEW 121
1452 # define EC_F_EC_POINT_OCT2POINT 122
1453 # define EC_F_EC_POINT_POINT2OCT 123
1454 # define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M 185
1455 # define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP 124
1456 # define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M 186
1457 # define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP 125
1458 # define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP 126
1459 # define EC_F_EC_POINT_SET_TO_INFINITY 127
1460 # define EC_F_EC_PRE_COMP_DUP 207
1461 # define EC_F_EC_PRE_COMP_NEW 196
1462 # define EC_F_EC_WNAF_MUL 187
1463 # define EC_F_EC_WNAF_PRECOMPUTE_MULT 188
1464 # define EC_F_I2D_ECPARAMETERS 190
1465 # define EC_F_I2D_ECPKPARAMETERS 191
1466 # define EC_F_I2D_ECPRIVATEKEY 192
1467 # define EC_F_I2O_ECPUBLICKEY 151
1468 # define EC_F_NISTP224_PRE_COMP_NEW 227
1469 # define EC_F_NISTP256_PRE_COMP_NEW 236
1470 # define EC_F_NISTP521_PRE_COMP_NEW 237
1471 # define EC_F_O2I_ECPUBLICKEY 152
1472 # define EC_F_OLD_EC_PRIV_DECODE 222
1473 # define EC_F_OSSL_ECDH_COMPUTE_KEY 247
1474 # define EC_F_OSSL_ECDSA_SIGN_SIG 249
1475 # define EC_F_OSSL_ECDSA_VERIFY_SIG 250
1476 # define EC_F_PKEY_EC_CTRL 197
1477 # define EC_F_PKEY_EC_CTRL_STR 198
1478 # define EC_F_PKEY_EC_DERIVE 217
1479 # define EC_F_PKEY_EC_KEYGEN 199
1480 # define EC_F_PKEY_EC_PARAMGEN 219
1481 # define EC_F_PKEY_EC_SIGN 218
1484 # define EC_R_ASN1_ERROR 115
1485 # define EC_R_ASN1_UNKNOWN_FIELD 116
1486 # define EC_R_BAD_SIGNATURE 156
1487 # define EC_R_BIGNUM_OUT_OF_RANGE 144
1488 # define EC_R_BUFFER_TOO_SMALL 100
1489 # define EC_R_COORDINATES_OUT_OF_RANGE 146
1490 # define EC_R_D2I_ECPKPARAMETERS_FAILURE 117
1491 # define EC_R_DECODE_ERROR 142
1492 # define EC_R_DISCRIMINANT_IS_ZERO 118
1493 # define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 119
1494 # define EC_R_FIELD_TOO_LARGE 143
1495 # define EC_R_GF2M_NOT_SUPPORTED 147
1496 # define EC_R_GROUP2PKPARAMETERS_FAILURE 120
1497 # define EC_R_I2D_ECPKPARAMETERS_FAILURE 121
1498 # define EC_R_INCOMPATIBLE_OBJECTS 101
1499 # define EC_R_INVALID_ARGUMENT 112
1500 # define EC_R_INVALID_COMPRESSED_POINT 110
1501 # define EC_R_INVALID_COMPRESSION_BIT 109
1502 # define EC_R_INVALID_CURVE 141
1503 # define EC_R_INVALID_DIGEST 151
1504 # define EC_R_INVALID_DIGEST_TYPE 138
1505 # define EC_R_INVALID_ENCODING 102
1506 # define EC_R_INVALID_FIELD 103
1507 # define EC_R_INVALID_FORM 104
1508 # define EC_R_INVALID_GROUP_ORDER 122
1509 # define EC_R_INVALID_PENTANOMIAL_BASIS 132
1510 # define EC_R_INVALID_PRIVATE_KEY 123
1511 # define EC_R_INVALID_TRINOMIAL_BASIS 137
1512 # define EC_R_KDF_FAILED 153
1513 # define EC_R_KDF_PARAMETER_ERROR 148
1514 # define EC_R_KEYS_NOT_SET 140
1515 # define EC_R_MISSING_PARAMETERS 124
1516 # define EC_R_MISSING_PRIVATE_KEY 125
1517 # define EC_R_NEED_NEW_SETUP_VALUES 157
1518 # define EC_R_NOT_A_NIST_PRIME 135
1519 # define EC_R_NOT_A_SUPPORTED_NIST_PRIME 136
1520 # define EC_R_NOT_IMPLEMENTED 126
1521 # define EC_R_NOT_INITIALIZED 111
1522 # define EC_R_NO_FIELD_MOD 133
1523 # define EC_R_NO_PARAMETERS_SET 139
1524 # define EC_R_NO_PRIVATE_VALUE 154
1525 # define EC_R_OPERATION_NOT_SUPPORTED 152
1526 # define EC_R_PASSED_NULL_PARAMETER 134
1527 # define EC_R_PEER_KEY_ERROR 149
1528 # define EC_R_PKPARAMETERS2GROUP_FAILURE 127
1529 # define EC_R_POINT_ARITHMETIC_FAILURE 155
1530 # define EC_R_POINT_AT_INFINITY 106
1531 # define EC_R_POINT_IS_NOT_ON_CURVE 107
1532 # define EC_R_RANDOM_NUMBER_GENERATION_FAILED 158
1533 # define EC_R_SHARED_INFO_ERROR 150
1534 # define EC_R_SLOT_FULL 108
1535 # define EC_R_UNDEFINED_GENERATOR 113
1536 # define EC_R_UNDEFINED_ORDER 128
1537 # define EC_R_UNKNOWN_GROUP 129
1538 # define EC_R_UNKNOWN_ORDER 114
1539 # define EC_R_UNSUPPORTED_FIELD 131
1540 # define EC_R_WRONG_CURVE_PARAMETERS 145
1541 # define EC_R_WRONG_ORDER 130