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