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