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