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