|
|
|||
File indexing completed on 2026-09-24 09:17:57
0001 /* 0002 * Copyright 2002-2023 The OpenSSL Project Authors. All Rights Reserved. 0003 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved 0004 * 0005 * Licensed under the Apache License 2.0 (the "License"). You may not use 0006 * this file except in compliance with the License. You can obtain a copy 0007 * in the file LICENSE in the source distribution or at 0008 * https://www.openssl.org/source/license.html 0009 */ 0010 0011 #ifndef OPENSSL_EC_H 0012 #define OPENSSL_EC_H 0013 #pragma once 0014 0015 #include <openssl/macros.h> 0016 #ifndef OPENSSL_NO_DEPRECATED_3_0 0017 #define HEADER_EC_H 0018 #endif 0019 0020 #include <openssl/opensslconf.h> 0021 #include <openssl/types.h> 0022 0023 #include <string.h> 0024 0025 #ifdef __cplusplus 0026 extern "C" { 0027 #endif 0028 0029 /* Values for EVP_PKEY_CTX_set_ec_param_enc() */ 0030 #define OPENSSL_EC_EXPLICIT_CURVE 0x000 0031 #define OPENSSL_EC_NAMED_CURVE 0x001 0032 0033 int EVP_PKEY_CTX_set_ec_paramgen_curve_nid(EVP_PKEY_CTX *ctx, int nid); 0034 int EVP_PKEY_CTX_set_ec_param_enc(EVP_PKEY_CTX *ctx, int param_enc); 0035 int EVP_PKEY_CTX_set_ecdh_cofactor_mode(EVP_PKEY_CTX *ctx, int cofactor_mode); 0036 int EVP_PKEY_CTX_get_ecdh_cofactor_mode(EVP_PKEY_CTX *ctx); 0037 0038 int EVP_PKEY_CTX_set_ecdh_kdf_type(EVP_PKEY_CTX *ctx, int kdf); 0039 int EVP_PKEY_CTX_get_ecdh_kdf_type(EVP_PKEY_CTX *ctx); 0040 0041 int EVP_PKEY_CTX_set_ecdh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md); 0042 int EVP_PKEY_CTX_get_ecdh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md); 0043 0044 int EVP_PKEY_CTX_set_ecdh_kdf_outlen(EVP_PKEY_CTX *ctx, int len); 0045 int EVP_PKEY_CTX_get_ecdh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len); 0046 0047 int EVP_PKEY_CTX_set0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, 0048 int len); 0049 #ifndef OPENSSL_NO_DEPRECATED_3_0 0050 OSSL_DEPRECATEDIN_3_0 0051 int EVP_PKEY_CTX_get0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm); 0052 #endif 0053 0054 #define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID (EVP_PKEY_ALG_CTRL + 1) 0055 #define EVP_PKEY_CTRL_EC_PARAM_ENC (EVP_PKEY_ALG_CTRL + 2) 0056 #define EVP_PKEY_CTRL_EC_ECDH_COFACTOR (EVP_PKEY_ALG_CTRL + 3) 0057 #define EVP_PKEY_CTRL_EC_KDF_TYPE (EVP_PKEY_ALG_CTRL + 4) 0058 #define EVP_PKEY_CTRL_EC_KDF_MD (EVP_PKEY_ALG_CTRL + 5) 0059 #define EVP_PKEY_CTRL_GET_EC_KDF_MD (EVP_PKEY_ALG_CTRL + 6) 0060 #define EVP_PKEY_CTRL_EC_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 7) 0061 #define EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 8) 0062 #define EVP_PKEY_CTRL_EC_KDF_UKM (EVP_PKEY_ALG_CTRL + 9) 0063 #define EVP_PKEY_CTRL_GET_EC_KDF_UKM (EVP_PKEY_ALG_CTRL + 10) 0064 0065 /* KDF types */ 0066 #define EVP_PKEY_ECDH_KDF_NONE 1 0067 #define EVP_PKEY_ECDH_KDF_X9_63 2 0068 /* 0069 * The old name for EVP_PKEY_ECDH_KDF_X9_63 0070 * The ECDH KDF specification has been mistakenly attributed to ANSI X9.62, 0071 * it is actually specified in ANSI X9.63. 0072 * This identifier is retained for backwards compatibility 0073 */ 0074 #define EVP_PKEY_ECDH_KDF_X9_62 EVP_PKEY_ECDH_KDF_X9_63 0075 0076 /** Enum for the point conversion form as defined in X9.62 (ECDSA) 0077 * for the encoding of a elliptic curve point (x,y) */ 0078 typedef enum { 0079 /** the point is encoded as z||x, where the octet z specifies 0080 * which solution of the quadratic equation y is */ 0081 POINT_CONVERSION_COMPRESSED = 2, 0082 /** the point is encoded as z||x||y, where z is the octet 0x04 */ 0083 POINT_CONVERSION_UNCOMPRESSED = 4, 0084 /** the point is encoded as z||x||y, where the octet z specifies 0085 * which solution of the quadratic equation y is */ 0086 POINT_CONVERSION_HYBRID = 6 0087 } point_conversion_form_t; 0088 0089 const char *OSSL_EC_curve_nid2name(int nid); 0090 0091 #ifndef OPENSSL_NO_STDIO 0092 #include <stdio.h> 0093 #endif 0094 #ifndef OPENSSL_NO_EC 0095 #include <openssl/asn1.h> 0096 #include <openssl/symhacks.h> 0097 #ifndef OPENSSL_NO_DEPRECATED_1_1_0 0098 #include <openssl/bn.h> 0099 #endif 0100 #include <openssl/ecerr.h> 0101 0102 #ifndef OPENSSL_ECC_MAX_FIELD_BITS 0103 #define OPENSSL_ECC_MAX_FIELD_BITS 661 0104 #endif 0105 0106 #include <openssl/params.h> 0107 #ifndef OPENSSL_NO_DEPRECATED_3_0 0108 typedef struct ec_method_st EC_METHOD; 0109 #endif 0110 typedef struct ec_group_st EC_GROUP; 0111 typedef struct ec_point_st EC_POINT; 0112 typedef struct ecpk_parameters_st ECPKPARAMETERS; 0113 typedef struct ec_parameters_st ECPARAMETERS; 0114 0115 /********************************************************************/ 0116 /* EC_METHODs for curves over GF(p) */ 0117 /********************************************************************/ 0118 0119 #ifndef OPENSSL_NO_DEPRECATED_3_0 0120 /** Returns the basic GFp ec methods which provides the basis for the 0121 * optimized methods. 0122 * \return EC_METHOD object 0123 */ 0124 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GFp_simple_method(void); 0125 0126 /** Returns GFp methods using montgomery multiplication. 0127 * \return EC_METHOD object 0128 */ 0129 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GFp_mont_method(void); 0130 0131 /** Returns GFp methods using optimized methods for NIST recommended curves 0132 * \return EC_METHOD object 0133 */ 0134 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GFp_nist_method(void); 0135 0136 #ifndef OPENSSL_NO_EC_NISTP_64_GCC_128 0137 /** Returns 64-bit optimized methods for nistp224 0138 * \return EC_METHOD object 0139 */ 0140 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GFp_nistp224_method(void); 0141 0142 /** Returns 64-bit optimized methods for nistp256 0143 * \return EC_METHOD object 0144 */ 0145 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GFp_nistp256_method(void); 0146 0147 /** Returns 64-bit optimized methods for nistp521 0148 * \return EC_METHOD object 0149 */ 0150 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GFp_nistp521_method(void); 0151 #endif /* OPENSSL_NO_EC_NISTP_64_GCC_128 */ 0152 0153 #ifndef OPENSSL_NO_EC2M 0154 /********************************************************************/ 0155 /* EC_METHOD for curves over GF(2^m) */ 0156 /********************************************************************/ 0157 0158 /** Returns the basic GF2m ec method 0159 * \return EC_METHOD object 0160 */ 0161 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GF2m_simple_method(void); 0162 0163 #endif 0164 0165 /********************************************************************/ 0166 /* EC_GROUP functions */ 0167 /********************************************************************/ 0168 0169 /** 0170 * Creates a new EC_GROUP object 0171 * \param meth EC_METHOD to use 0172 * \return newly created EC_GROUP object or NULL in case of an error. 0173 */ 0174 OSSL_DEPRECATEDIN_3_0 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth); 0175 0176 /** Clears and frees a EC_GROUP object 0177 * \param group EC_GROUP object to be cleared and freed. 0178 */ 0179 OSSL_DEPRECATEDIN_3_0 void EC_GROUP_clear_free(EC_GROUP *group); 0180 0181 /** Returns the EC_METHOD of the EC_GROUP object. 0182 * \param group EC_GROUP object 0183 * \return EC_METHOD used in this EC_GROUP object. 0184 */ 0185 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group); 0186 0187 /** Returns the field type of the EC_METHOD. 0188 * \param meth EC_METHOD object 0189 * \return NID of the underlying field type OID. 0190 */ 0191 OSSL_DEPRECATEDIN_3_0 int EC_METHOD_get_field_type(const EC_METHOD *meth); 0192 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0193 0194 /** Frees a EC_GROUP object 0195 * \param group EC_GROUP object to be freed. 0196 */ 0197 void EC_GROUP_free(EC_GROUP *group); 0198 0199 /** Copies EC_GROUP objects. Note: both EC_GROUPs must use the same EC_METHOD. 0200 * \param dst destination EC_GROUP object 0201 * \param src source EC_GROUP object 0202 * \return 1 on success and 0 if an error occurred. 0203 */ 0204 int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src); 0205 0206 /** Creates a new EC_GROUP object and copies the content 0207 * form src to the newly created EC_KEY object 0208 * \param src source EC_GROUP object 0209 * \return newly created EC_GROUP object or NULL in case of an error. 0210 */ 0211 EC_GROUP *EC_GROUP_dup(const EC_GROUP *src); 0212 0213 /** Sets the generator and its order/cofactor of a EC_GROUP object. 0214 * \param group EC_GROUP object 0215 * \param generator EC_POINT object with the generator. 0216 * \param order the order of the group generated by the generator. 0217 * \param cofactor the index of the sub-group generated by the generator 0218 * in the group of all points on the elliptic curve. 0219 * \return 1 on success and 0 if an error occurred 0220 */ 0221 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, 0222 const BIGNUM *order, const BIGNUM *cofactor); 0223 0224 /** Returns the generator of a EC_GROUP object. 0225 * \param group EC_GROUP object 0226 * \return the currently used generator (possibly NULL). 0227 */ 0228 const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group); 0229 0230 /** Returns the montgomery data for order(Generator) 0231 * \param group EC_GROUP object 0232 * \return the currently used montgomery data (possibly NULL). 0233 */ 0234 BN_MONT_CTX *EC_GROUP_get_mont_data(const EC_GROUP *group); 0235 0236 /** Gets the order of a EC_GROUP 0237 * \param group EC_GROUP object 0238 * \param order BIGNUM to which the order is copied 0239 * \param ctx unused 0240 * \return 1 on success and 0 if an error occurred 0241 */ 0242 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx); 0243 0244 /** Gets the order of an EC_GROUP 0245 * \param group EC_GROUP object 0246 * \return the group order 0247 */ 0248 const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group); 0249 0250 /** Gets the number of bits of the order of an EC_GROUP 0251 * \param group EC_GROUP object 0252 * \return number of bits of group order. 0253 */ 0254 int EC_GROUP_order_bits(const EC_GROUP *group); 0255 0256 /** Gets the cofactor of a EC_GROUP 0257 * \param group EC_GROUP object 0258 * \param cofactor BIGNUM to which the cofactor is copied 0259 * \param ctx unused 0260 * \return 1 on success and 0 if an error occurred 0261 */ 0262 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, 0263 BN_CTX *ctx); 0264 0265 /** Gets the cofactor of an EC_GROUP 0266 * \param group EC_GROUP object 0267 * \return the group cofactor 0268 */ 0269 const BIGNUM *EC_GROUP_get0_cofactor(const EC_GROUP *group); 0270 0271 /** Sets the name of a EC_GROUP object 0272 * \param group EC_GROUP object 0273 * \param nid NID of the curve name OID 0274 */ 0275 void EC_GROUP_set_curve_name(EC_GROUP *group, int nid); 0276 0277 /** Returns the curve name of a EC_GROUP object 0278 * \param group EC_GROUP object 0279 * \return NID of the curve name OID or 0 if not set. 0280 */ 0281 int EC_GROUP_get_curve_name(const EC_GROUP *group); 0282 0283 /** Gets the field of an EC_GROUP 0284 * \param group EC_GROUP object 0285 * \return the group field 0286 */ 0287 const BIGNUM *EC_GROUP_get0_field(const EC_GROUP *group); 0288 0289 /** Returns the field type of the EC_GROUP. 0290 * \param group EC_GROUP object 0291 * \return NID of the underlying field type OID. 0292 */ 0293 int EC_GROUP_get_field_type(const EC_GROUP *group); 0294 0295 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag); 0296 int EC_GROUP_get_asn1_flag(const EC_GROUP *group); 0297 0298 void EC_GROUP_set_point_conversion_form(EC_GROUP *group, 0299 point_conversion_form_t form); 0300 point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *); 0301 0302 unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x); 0303 size_t EC_GROUP_get_seed_len(const EC_GROUP *); 0304 size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len); 0305 0306 /** Sets the parameters of an ec curve defined by y^2 = x^3 + a*x + b (for GFp) 0307 * or y^2 + x*y = x^3 + a*x^2 + b (for GF2m) 0308 * \param group EC_GROUP object 0309 * \param p BIGNUM with the prime number (GFp) or the polynomial 0310 * defining the underlying field (GF2m) 0311 * \param a BIGNUM with parameter a of the equation 0312 * \param b BIGNUM with parameter b of the equation 0313 * \param ctx BN_CTX object (optional) 0314 * \return 1 on success and 0 if an error occurred 0315 */ 0316 int EC_GROUP_set_curve(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, 0317 const BIGNUM *b, BN_CTX *ctx); 0318 0319 /** Gets the parameters of the ec curve defined by y^2 = x^3 + a*x + b (for GFp) 0320 * or y^2 + x*y = x^3 + a*x^2 + b (for GF2m) 0321 * \param group EC_GROUP object 0322 * \param p BIGNUM with the prime number (GFp) or the polynomial 0323 * defining the underlying field (GF2m) 0324 * \param a BIGNUM for parameter a of the equation 0325 * \param b BIGNUM for parameter b of the equation 0326 * \param ctx BN_CTX object (optional) 0327 * \return 1 on success and 0 if an error occurred 0328 */ 0329 int EC_GROUP_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, 0330 BN_CTX *ctx); 0331 0332 #ifndef OPENSSL_NO_DEPRECATED_3_0 0333 /** Sets the parameters of an ec curve. Synonym for EC_GROUP_set_curve 0334 * \param group EC_GROUP object 0335 * \param p BIGNUM with the prime number (GFp) or the polynomial 0336 * defining the underlying field (GF2m) 0337 * \param a BIGNUM with parameter a of the equation 0338 * \param b BIGNUM with parameter b of the equation 0339 * \param ctx BN_CTX object (optional) 0340 * \return 1 on success and 0 if an error occurred 0341 */ 0342 OSSL_DEPRECATEDIN_3_0 int EC_GROUP_set_curve_GFp(EC_GROUP *group, 0343 const BIGNUM *p, 0344 const BIGNUM *a, 0345 const BIGNUM *b, 0346 BN_CTX *ctx); 0347 0348 /** Gets the parameters of an ec curve. Synonym for EC_GROUP_get_curve 0349 * \param group EC_GROUP object 0350 * \param p BIGNUM with the prime number (GFp) or the polynomial 0351 * defining the underlying field (GF2m) 0352 * \param a BIGNUM for parameter a of the equation 0353 * \param b BIGNUM for parameter b of the equation 0354 * \param ctx BN_CTX object (optional) 0355 * \return 1 on success and 0 if an error occurred 0356 */ 0357 OSSL_DEPRECATEDIN_3_0 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, 0358 BIGNUM *p, 0359 BIGNUM *a, BIGNUM *b, 0360 BN_CTX *ctx); 0361 0362 #ifndef OPENSSL_NO_EC2M 0363 /** Sets the parameter of an ec curve. Synonym for EC_GROUP_set_curve 0364 * \param group EC_GROUP object 0365 * \param p BIGNUM with the prime number (GFp) or the polynomial 0366 * defining the underlying field (GF2m) 0367 * \param a BIGNUM with parameter a of the equation 0368 * \param b BIGNUM with parameter b of the equation 0369 * \param ctx BN_CTX object (optional) 0370 * \return 1 on success and 0 if an error occurred 0371 */ 0372 OSSL_DEPRECATEDIN_3_0 int EC_GROUP_set_curve_GF2m(EC_GROUP *group, 0373 const BIGNUM *p, 0374 const BIGNUM *a, 0375 const BIGNUM *b, 0376 BN_CTX *ctx); 0377 0378 /** Gets the parameters of an ec curve. Synonym for EC_GROUP_get_curve 0379 * \param group EC_GROUP object 0380 * \param p BIGNUM with the prime number (GFp) or the polynomial 0381 * defining the underlying field (GF2m) 0382 * \param a BIGNUM for parameter a of the equation 0383 * \param b BIGNUM for parameter b of the equation 0384 * \param ctx BN_CTX object (optional) 0385 * \return 1 on success and 0 if an error occurred 0386 */ 0387 OSSL_DEPRECATEDIN_3_0 int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, 0388 BIGNUM *p, 0389 BIGNUM *a, BIGNUM *b, 0390 BN_CTX *ctx); 0391 #endif /* OPENSSL_NO_EC2M */ 0392 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0393 0394 /** Returns the number of bits needed to represent a field element 0395 * \param group EC_GROUP object 0396 * \return number of bits needed to represent a field element 0397 */ 0398 int EC_GROUP_get_degree(const EC_GROUP *group); 0399 0400 /** Checks whether the parameter in the EC_GROUP define a valid ec group 0401 * \param group EC_GROUP object 0402 * \param ctx BN_CTX object (optional) 0403 * \return 1 if group is a valid ec group and 0 otherwise 0404 */ 0405 int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx); 0406 0407 /** Checks whether the discriminant of the elliptic curve is zero or not 0408 * \param group EC_GROUP object 0409 * \param ctx BN_CTX object (optional) 0410 * \return 1 if the discriminant is not zero and 0 otherwise 0411 */ 0412 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx); 0413 0414 /** Compares two EC_GROUP objects 0415 * \param a first EC_GROUP object 0416 * \param b second EC_GROUP object 0417 * \param ctx BN_CTX object (optional) 0418 * \return 0 if the groups are equal, 1 if not, or -1 on error 0419 */ 0420 int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx); 0421 0422 /* 0423 * EC_GROUP_new_GF*() calls EC_GROUP_new() and EC_GROUP_set_GF*() after 0424 * choosing an appropriate EC_METHOD 0425 */ 0426 0427 /** Creates a new EC_GROUP object with the specified parameters defined 0428 * over GFp (defined by the equation y^2 = x^3 + a*x + b) 0429 * \param p BIGNUM with the prime number 0430 * \param a BIGNUM with the parameter a of the equation 0431 * \param b BIGNUM with the parameter b of the equation 0432 * \param ctx BN_CTX object (optional) 0433 * \return newly created EC_GROUP object with the specified parameters 0434 */ 0435 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, 0436 const BIGNUM *b, BN_CTX *ctx); 0437 #ifndef OPENSSL_NO_EC2M 0438 /** Creates a new EC_GROUP object with the specified parameters defined 0439 * over GF2m (defined by the equation y^2 + x*y = x^3 + a*x^2 + b) 0440 * \param p BIGNUM with the polynomial defining the underlying field 0441 * \param a BIGNUM with the parameter a of the equation 0442 * \param b BIGNUM with the parameter b of the equation 0443 * \param ctx BN_CTX object (optional) 0444 * \return newly created EC_GROUP object with the specified parameters 0445 */ 0446 EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a, 0447 const BIGNUM *b, BN_CTX *ctx); 0448 #endif 0449 0450 /** 0451 * Creates a EC_GROUP object with a curve specified by parameters. 0452 * The parameters may be explicit or a named curve, 0453 * \param params A list of parameters describing the group. 0454 * \param libctx The associated library context or NULL for the default 0455 * context 0456 * \param propq A property query string 0457 * \return newly created EC_GROUP object with specified parameters or NULL 0458 * if an error occurred 0459 */ 0460 EC_GROUP *EC_GROUP_new_from_params(const OSSL_PARAM params[], 0461 OSSL_LIB_CTX *libctx, const char *propq); 0462 0463 /** 0464 * Creates an OSSL_PARAM array with the parameters describing the given 0465 * EC_GROUP. 0466 * The resulting parameters may contain an explicit or a named curve depending 0467 * on the EC_GROUP. 0468 * \param group pointer to the EC_GROUP object 0469 * \param libctx The associated library context or NULL for the default 0470 * context 0471 * \param propq A property query string 0472 * \param bnctx BN_CTX object (optional) 0473 * \return newly created OSSL_PARAM array with the parameters 0474 * describing the given EC_GROUP or NULL if an error occurred 0475 */ 0476 OSSL_PARAM *EC_GROUP_to_params(const EC_GROUP *group, OSSL_LIB_CTX *libctx, 0477 const char *propq, BN_CTX *bnctx); 0478 0479 /** 0480 * Creates a EC_GROUP object with a curve specified by a NID 0481 * \param libctx The associated library context or NULL for the default 0482 * context 0483 * \param propq A property query string 0484 * \param nid NID of the OID of the curve name 0485 * \return newly created EC_GROUP object with specified curve or NULL 0486 * if an error occurred 0487 */ 0488 EC_GROUP *EC_GROUP_new_by_curve_name_ex(OSSL_LIB_CTX *libctx, const char *propq, 0489 int nid); 0490 0491 /** 0492 * Creates a EC_GROUP object with a curve specified by a NID. Same as 0493 * EC_GROUP_new_by_curve_name_ex but the libctx and propq are always 0494 * NULL. 0495 * \param nid NID of the OID of the curve name 0496 * \return newly created EC_GROUP object with specified curve or NULL 0497 * if an error occurred 0498 */ 0499 EC_GROUP *EC_GROUP_new_by_curve_name(int nid); 0500 0501 /** Creates a new EC_GROUP object from an ECPARAMETERS object 0502 * \param params pointer to the ECPARAMETERS object 0503 * \return newly created EC_GROUP object with specified curve or NULL 0504 * if an error occurred 0505 */ 0506 EC_GROUP *EC_GROUP_new_from_ecparameters(const ECPARAMETERS *params); 0507 0508 /** Creates an ECPARAMETERS object for the given EC_GROUP object. 0509 * \param group pointer to the EC_GROUP object 0510 * \param params pointer to an existing ECPARAMETERS object or NULL 0511 * \return pointer to the new ECPARAMETERS object or NULL 0512 * if an error occurred. 0513 */ 0514 ECPARAMETERS *EC_GROUP_get_ecparameters(const EC_GROUP *group, 0515 ECPARAMETERS *params); 0516 0517 /** Creates a new EC_GROUP object from an ECPKPARAMETERS object 0518 * \param params pointer to an existing ECPKPARAMETERS object, or NULL 0519 * \return newly created EC_GROUP object with specified curve, or NULL 0520 * if an error occurred 0521 */ 0522 EC_GROUP *EC_GROUP_new_from_ecpkparameters(const ECPKPARAMETERS *params); 0523 0524 /** Creates an ECPKPARAMETERS object for the given EC_GROUP object. 0525 * \param group pointer to the EC_GROUP object 0526 * \param params pointer to an existing ECPKPARAMETERS object or NULL 0527 * \return pointer to the new ECPKPARAMETERS object or NULL 0528 * if an error occurred. 0529 */ 0530 ECPKPARAMETERS *EC_GROUP_get_ecpkparameters(const EC_GROUP *group, 0531 ECPKPARAMETERS *params); 0532 0533 /********************************************************************/ 0534 /* handling of internal curves */ 0535 /********************************************************************/ 0536 0537 typedef struct { 0538 int nid; 0539 const char *comment; 0540 } EC_builtin_curve; 0541 0542 /* 0543 * EC_builtin_curves(EC_builtin_curve *r, size_t size) returns number of all 0544 * available curves or zero if a error occurred. In case r is not zero, 0545 * nitems EC_builtin_curve structures are filled with the data of the first 0546 * nitems internal groups 0547 */ 0548 size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems); 0549 0550 const char *EC_curve_nid2nist(int nid); 0551 int EC_curve_nist2nid(const char *name); 0552 int EC_GROUP_check_named_curve(const EC_GROUP *group, int nist_only, 0553 BN_CTX *ctx); 0554 0555 /********************************************************************/ 0556 /* EC_POINT functions */ 0557 /********************************************************************/ 0558 0559 /** Creates a new EC_POINT object for the specified EC_GROUP 0560 * \param group EC_GROUP the underlying EC_GROUP object 0561 * \return newly created EC_POINT object or NULL if an error occurred 0562 */ 0563 EC_POINT *EC_POINT_new(const EC_GROUP *group); 0564 0565 /** Frees a EC_POINT object 0566 * \param point EC_POINT object to be freed 0567 */ 0568 void EC_POINT_free(EC_POINT *point); 0569 0570 /** Clears and frees a EC_POINT object 0571 * \param point EC_POINT object to be cleared and freed 0572 */ 0573 void EC_POINT_clear_free(EC_POINT *point); 0574 0575 /** Copies EC_POINT object 0576 * \param dst destination EC_POINT object 0577 * \param src source EC_POINT object 0578 * \return 1 on success and 0 if an error occurred 0579 */ 0580 int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src); 0581 0582 /** Creates a new EC_POINT object and copies the content of the supplied 0583 * EC_POINT 0584 * \param src source EC_POINT object 0585 * \param group underlying the EC_GROUP object 0586 * \return newly created EC_POINT object or NULL if an error occurred 0587 */ 0588 EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group); 0589 0590 /** Sets a point to infinity (neutral element) 0591 * \param group underlying EC_GROUP object 0592 * \param point EC_POINT to set to infinity 0593 * \return 1 on success and 0 if an error occurred 0594 */ 0595 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point); 0596 0597 #ifndef OPENSSL_NO_DEPRECATED_3_0 0598 /** Returns the EC_METHOD used in EC_POINT object 0599 * \param point EC_POINT object 0600 * \return the EC_METHOD used 0601 */ 0602 OSSL_DEPRECATEDIN_3_0 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point); 0603 0604 /** Sets the jacobian projective coordinates of a EC_POINT over GFp 0605 * \param group underlying EC_GROUP object 0606 * \param p EC_POINT object 0607 * \param x BIGNUM with the x-coordinate 0608 * \param y BIGNUM with the y-coordinate 0609 * \param z BIGNUM with the z-coordinate 0610 * \param ctx BN_CTX object (optional) 0611 * \return 1 on success and 0 if an error occurred 0612 */ 0613 OSSL_DEPRECATEDIN_3_0 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, 0614 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, 0615 BN_CTX *ctx); 0616 0617 /** Gets the jacobian projective coordinates of a EC_POINT over GFp 0618 * \param group underlying EC_GROUP object 0619 * \param p EC_POINT object 0620 * \param x BIGNUM for the x-coordinate 0621 * \param y BIGNUM for the y-coordinate 0622 * \param z BIGNUM for the z-coordinate 0623 * \param ctx BN_CTX object (optional) 0624 * \return 1 on success and 0 if an error occurred 0625 */ 0626 OSSL_DEPRECATEDIN_3_0 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group, const EC_POINT *p, 0627 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx); 0628 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0629 0630 /** Sets the affine coordinates of an EC_POINT 0631 * \param group underlying EC_GROUP object 0632 * \param p EC_POINT object 0633 * \param x BIGNUM with the x-coordinate 0634 * \param y BIGNUM with the y-coordinate 0635 * \param ctx BN_CTX object (optional) 0636 * \return 1 on success and 0 if an error occurred 0637 */ 0638 int EC_POINT_set_affine_coordinates(const EC_GROUP *group, EC_POINT *p, 0639 const BIGNUM *x, const BIGNUM *y, 0640 BN_CTX *ctx); 0641 0642 /** Gets the affine coordinates of an EC_POINT. 0643 * \param group underlying EC_GROUP object 0644 * \param p EC_POINT object 0645 * \param x BIGNUM for the x-coordinate 0646 * \param y BIGNUM for the y-coordinate 0647 * \param ctx BN_CTX object (optional) 0648 * \return 1 on success and 0 if an error occurred 0649 */ 0650 int EC_POINT_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *p, 0651 BIGNUM *x, BIGNUM *y, BN_CTX *ctx); 0652 0653 #ifndef OPENSSL_NO_DEPRECATED_3_0 0654 /** Sets the affine coordinates of an EC_POINT. A synonym of 0655 * EC_POINT_set_affine_coordinates 0656 * \param group underlying EC_GROUP object 0657 * \param p EC_POINT object 0658 * \param x BIGNUM with the x-coordinate 0659 * \param y BIGNUM with the y-coordinate 0660 * \param ctx BN_CTX object (optional) 0661 * \return 1 on success and 0 if an error occurred 0662 */ 0663 OSSL_DEPRECATEDIN_3_0 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, 0664 const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx); 0665 0666 /** Gets the affine coordinates of an EC_POINT. A synonym of 0667 * EC_POINT_get_affine_coordinates 0668 * \param group underlying EC_GROUP object 0669 * \param p EC_POINT object 0670 * \param x BIGNUM for the x-coordinate 0671 * \param y BIGNUM for the y-coordinate 0672 * \param ctx BN_CTX object (optional) 0673 * \return 1 on success and 0 if an error occurred 0674 */ 0675 OSSL_DEPRECATEDIN_3_0 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, const EC_POINT *p, 0676 BIGNUM *x, BIGNUM *y, BN_CTX *ctx); 0677 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0678 0679 /** Sets the x9.62 compressed coordinates of a EC_POINT 0680 * \param group underlying EC_GROUP object 0681 * \param p EC_POINT object 0682 * \param x BIGNUM with x-coordinate 0683 * \param y_bit integer with the y-Bit (either 0 or 1) 0684 * \param ctx BN_CTX object (optional) 0685 * \return 1 on success and 0 if an error occurred 0686 */ 0687 int EC_POINT_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *p, 0688 const BIGNUM *x, int y_bit, 0689 BN_CTX *ctx); 0690 0691 #ifndef OPENSSL_NO_DEPRECATED_3_0 0692 /** Sets the x9.62 compressed coordinates of a EC_POINT. A synonym of 0693 * EC_POINT_set_compressed_coordinates 0694 * \param group underlying EC_GROUP object 0695 * \param p EC_POINT object 0696 * \param x BIGNUM with x-coordinate 0697 * \param y_bit integer with the y-Bit (either 0 or 1) 0698 * \param ctx BN_CTX object (optional) 0699 * \return 1 on success and 0 if an error occurred 0700 */ 0701 OSSL_DEPRECATEDIN_3_0 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, 0702 const BIGNUM *x, int y_bit, BN_CTX *ctx); 0703 #ifndef OPENSSL_NO_EC2M 0704 /** Sets the affine coordinates of an EC_POINT. A synonym of 0705 * EC_POINT_set_affine_coordinates 0706 * \param group underlying EC_GROUP object 0707 * \param p EC_POINT object 0708 * \param x BIGNUM with the x-coordinate 0709 * \param y BIGNUM with the y-coordinate 0710 * \param ctx BN_CTX object (optional) 0711 * \return 1 on success and 0 if an error occurred 0712 */ 0713 OSSL_DEPRECATEDIN_3_0 int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, 0714 const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx); 0715 0716 /** Gets the affine coordinates of an EC_POINT. A synonym of 0717 * EC_POINT_get_affine_coordinates 0718 * \param group underlying EC_GROUP object 0719 * \param p EC_POINT object 0720 * \param x BIGNUM for the x-coordinate 0721 * \param y BIGNUM for the y-coordinate 0722 * \param ctx BN_CTX object (optional) 0723 * \return 1 on success and 0 if an error occurred 0724 */ 0725 OSSL_DEPRECATEDIN_3_0 int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group, const EC_POINT *p, 0726 BIGNUM *x, BIGNUM *y, BN_CTX *ctx); 0727 0728 /** Sets the x9.62 compressed coordinates of a EC_POINT. A synonym of 0729 * EC_POINT_set_compressed_coordinates 0730 * \param group underlying EC_GROUP object 0731 * \param p EC_POINT object 0732 * \param x BIGNUM with x-coordinate 0733 * \param y_bit integer with the y-Bit (either 0 or 1) 0734 * \param ctx BN_CTX object (optional) 0735 * \return 1 on success and 0 if an error occurred 0736 */ 0737 OSSL_DEPRECATEDIN_3_0 int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, 0738 const BIGNUM *x, int y_bit, BN_CTX *ctx); 0739 #endif 0740 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0741 0742 /** Encodes a EC_POINT object to a octet string 0743 * \param group underlying EC_GROUP object 0744 * \param p EC_POINT object 0745 * \param form point conversion form 0746 * \param buf memory buffer for the result. If NULL the function returns 0747 * required buffer size. 0748 * \param len length of the memory buffer 0749 * \param ctx BN_CTX object (optional) 0750 * \return the length of the encoded octet string or 0 if an error occurred 0751 */ 0752 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p, 0753 point_conversion_form_t form, 0754 unsigned char *buf, size_t len, BN_CTX *ctx); 0755 0756 /** Decodes a EC_POINT from a octet string 0757 * \param group underlying EC_GROUP object 0758 * \param p EC_POINT object 0759 * \param buf memory buffer with the encoded ec point 0760 * \param len length of the encoded ec point 0761 * \param ctx BN_CTX object (optional) 0762 * \return 1 on success and 0 if an error occurred 0763 */ 0764 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p, 0765 const unsigned char *buf, size_t len, BN_CTX *ctx); 0766 0767 /** Encodes an EC_POINT object to an allocated octet string 0768 * \param group underlying EC_GROUP object 0769 * \param point EC_POINT object 0770 * \param form point conversion form 0771 * \param pbuf returns pointer to allocated buffer 0772 * \param ctx BN_CTX object (optional) 0773 * \return the length of the encoded octet string or 0 if an error occurred 0774 */ 0775 size_t EC_POINT_point2buf(const EC_GROUP *group, const EC_POINT *point, 0776 point_conversion_form_t form, 0777 unsigned char **pbuf, BN_CTX *ctx); 0778 0779 /* other interfaces to point2oct/oct2point: */ 0780 #ifndef OPENSSL_NO_DEPRECATED_3_0 0781 OSSL_DEPRECATEDIN_3_0 BIGNUM *EC_POINT_point2bn(const EC_GROUP *, 0782 const EC_POINT *, 0783 point_conversion_form_t form, 0784 BIGNUM *, BN_CTX *); 0785 OSSL_DEPRECATEDIN_3_0 EC_POINT *EC_POINT_bn2point(const EC_GROUP *, 0786 const BIGNUM *, 0787 EC_POINT *, BN_CTX *); 0788 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0789 0790 char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *, 0791 point_conversion_form_t form, BN_CTX *); 0792 EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *, 0793 EC_POINT *, BN_CTX *); 0794 0795 /********************************************************************/ 0796 /* functions for doing EC_POINT arithmetic */ 0797 /********************************************************************/ 0798 0799 /** Computes the sum of two EC_POINT 0800 * \param group underlying EC_GROUP object 0801 * \param r EC_POINT object for the result (r = a + b) 0802 * \param a EC_POINT object with the first summand 0803 * \param b EC_POINT object with the second summand 0804 * \param ctx BN_CTX object (optional) 0805 * \return 1 on success and 0 if an error occurred 0806 */ 0807 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, 0808 const EC_POINT *b, BN_CTX *ctx); 0809 0810 /** Computes the double of a EC_POINT 0811 * \param group underlying EC_GROUP object 0812 * \param r EC_POINT object for the result (r = 2 * a) 0813 * \param a EC_POINT object 0814 * \param ctx BN_CTX object (optional) 0815 * \return 1 on success and 0 if an error occurred 0816 */ 0817 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, 0818 BN_CTX *ctx); 0819 0820 /** Computes the inverse of a EC_POINT 0821 * \param group underlying EC_GROUP object 0822 * \param a EC_POINT object to be inverted (it's used for the result as well) 0823 * \param ctx BN_CTX object (optional) 0824 * \return 1 on success and 0 if an error occurred 0825 */ 0826 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx); 0827 0828 /** Checks whether the point is the neutral element of the group 0829 * \param group the underlying EC_GROUP object 0830 * \param p EC_POINT object 0831 * \return 1 if the point is the neutral element and 0 otherwise 0832 */ 0833 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p); 0834 0835 /** Checks whether the point is on the curve 0836 * \param group underlying EC_GROUP object 0837 * \param point EC_POINT object to check 0838 * \param ctx BN_CTX object (optional) 0839 * \return 1 if the point is on the curve, 0 if not, or -1 on error 0840 */ 0841 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, 0842 BN_CTX *ctx); 0843 0844 /** Compares two EC_POINTs 0845 * \param group underlying EC_GROUP object 0846 * \param a first EC_POINT object 0847 * \param b second EC_POINT object 0848 * \param ctx BN_CTX object (optional) 0849 * \return 1 if the points are not equal, 0 if they are, or -1 on error 0850 */ 0851 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, 0852 BN_CTX *ctx); 0853 0854 #ifndef OPENSSL_NO_DEPRECATED_3_0 0855 OSSL_DEPRECATEDIN_3_0 int EC_POINT_make_affine(const EC_GROUP *group, 0856 EC_POINT *point, BN_CTX *ctx); 0857 OSSL_DEPRECATEDIN_3_0 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, 0858 EC_POINT *points[], BN_CTX *ctx); 0859 0860 /** Computes r = generator * n + sum_{i=0}^{num-1} p[i] * m[i] 0861 * \param group underlying EC_GROUP object 0862 * \param r EC_POINT object for the result 0863 * \param n BIGNUM with the multiplier for the group generator (optional) 0864 * \param num number further summands 0865 * \param p array of size num of EC_POINT objects 0866 * \param m array of size num of BIGNUM objects 0867 * \param ctx BN_CTX object (optional) 0868 * \return 1 on success and 0 if an error occurred 0869 */ 0870 OSSL_DEPRECATEDIN_3_0 int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, 0871 const BIGNUM *n, size_t num, 0872 const EC_POINT *p[], const BIGNUM *m[], 0873 BN_CTX *ctx); 0874 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0875 0876 /** Computes r = generator * n + q * m 0877 * \param group underlying EC_GROUP object 0878 * \param r EC_POINT object for the result 0879 * \param n BIGNUM with the multiplier for the group generator (optional) 0880 * \param q EC_POINT object with the first factor of the second summand 0881 * \param m BIGNUM with the second factor of the second summand 0882 * \param ctx BN_CTX object (optional) 0883 * \return 1 on success and 0 if an error occurred 0884 */ 0885 int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, 0886 const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx); 0887 0888 #ifndef OPENSSL_NO_DEPRECATED_3_0 0889 /** Stores multiples of generator for faster point multiplication 0890 * \param group EC_GROUP object 0891 * \param ctx BN_CTX object (optional) 0892 * \return 1 on success and 0 if an error occurred 0893 */ 0894 OSSL_DEPRECATEDIN_3_0 int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx); 0895 0896 /** Reports whether a precomputation has been done 0897 * \param group EC_GROUP object 0898 * \return 1 if a pre-computation has been done and 0 otherwise 0899 */ 0900 OSSL_DEPRECATEDIN_3_0 int EC_GROUP_have_precompute_mult(const EC_GROUP *group); 0901 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0902 0903 /********************************************************************/ 0904 /* ASN1 stuff */ 0905 /********************************************************************/ 0906 0907 DECLARE_ASN1_ITEM(ECPKPARAMETERS) 0908 DECLARE_ASN1_ALLOC_FUNCTIONS(ECPKPARAMETERS) 0909 DECLARE_ASN1_ITEM(ECPARAMETERS) 0910 DECLARE_ASN1_ALLOC_FUNCTIONS(ECPARAMETERS) 0911 0912 /* 0913 * EC_GROUP_get_basis_type() returns the NID of the basis type used to 0914 * represent the field elements 0915 */ 0916 int EC_GROUP_get_basis_type(const EC_GROUP *); 0917 #ifndef OPENSSL_NO_EC2M 0918 int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k); 0919 int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1, 0920 unsigned int *k2, unsigned int *k3); 0921 #endif 0922 0923 EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len); 0924 int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out); 0925 0926 #define d2i_ECPKParameters_bio(bp, x) \ 0927 ASN1_d2i_bio_of(EC_GROUP, NULL, d2i_ECPKParameters, bp, x) 0928 #define i2d_ECPKParameters_bio(bp, x) \ 0929 ASN1_i2d_bio_of(EC_GROUP, i2d_ECPKParameters, bp, x) 0930 #define d2i_ECPKParameters_fp(fp, x) \ 0931 (EC_GROUP *)ASN1_d2i_fp(NULL, (d2i_of_void *)d2i_ECPKParameters, (fp), \ 0932 (void **)(x)) 0933 #define i2d_ECPKParameters_fp(fp, x) \ 0934 ASN1_i2d_fp((i2d_of_void *)i2d_ECPKParameters, (fp), (void *)(x)) 0935 0936 #ifndef OPENSSL_NO_DEPRECATED_3_0 0937 OSSL_DEPRECATEDIN_3_0 int ECPKParameters_print(BIO *bp, const EC_GROUP *x, 0938 int off); 0939 #ifndef OPENSSL_NO_STDIO 0940 OSSL_DEPRECATEDIN_3_0 int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, 0941 int off); 0942 #endif 0943 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 0944 0945 /********************************************************************/ 0946 /* EC_KEY functions */ 0947 /********************************************************************/ 0948 0949 /* some values for the encoding_flag */ 0950 #define EC_PKEY_NO_PARAMETERS 0x001 0951 #define EC_PKEY_NO_PUBKEY 0x002 0952 0953 /* some values for the flags field */ 0954 #define EC_FLAG_SM2_RANGE 0x0004 0955 #define EC_FLAG_COFACTOR_ECDH 0x1000 0956 #define EC_FLAG_CHECK_NAMED_GROUP 0x2000 0957 #define EC_FLAG_CHECK_NAMED_GROUP_NIST 0x4000 0958 #define EC_FLAG_CHECK_NAMED_GROUP_MASK \ 0959 (EC_FLAG_CHECK_NAMED_GROUP | EC_FLAG_CHECK_NAMED_GROUP_NIST) 0960 0961 /* Deprecated flags - it was using 0x01..0x02 */ 0962 #define EC_FLAG_NON_FIPS_ALLOW 0x0000 0963 #define EC_FLAG_FIPS_CHECKED 0x0000 0964 0965 #ifndef OPENSSL_NO_DEPRECATED_3_0 0966 /** 0967 * Creates a new EC_KEY object. 0968 * \param ctx The library context for to use for this EC_KEY. May be NULL in 0969 * which case the default library context is used. 0970 * \return EC_KEY object or NULL if an error occurred. 0971 */ 0972 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_new_ex(OSSL_LIB_CTX *ctx, const char *propq); 0973 0974 /** 0975 * Creates a new EC_KEY object. Same as calling EC_KEY_new_ex with a 0976 * NULL library context 0977 * \return EC_KEY object or NULL if an error occurred. 0978 */ 0979 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_new(void); 0980 0981 OSSL_DEPRECATEDIN_3_0 int EC_KEY_get_flags(const EC_KEY *key); 0982 0983 OSSL_DEPRECATEDIN_3_0 void EC_KEY_set_flags(EC_KEY *key, int flags); 0984 0985 OSSL_DEPRECATEDIN_3_0 void EC_KEY_clear_flags(EC_KEY *key, int flags); 0986 0987 OSSL_DEPRECATEDIN_3_0 int EC_KEY_decoded_from_explicit_params(const EC_KEY *key); 0988 0989 /** 0990 * Creates a new EC_KEY object using a named curve as underlying 0991 * EC_GROUP object. 0992 * \param ctx The library context for to use for this EC_KEY. May be NULL in 0993 * which case the default library context is used. 0994 * \param propq Any property query string 0995 * \param nid NID of the named curve. 0996 * \return EC_KEY object or NULL if an error occurred. 0997 */ 0998 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_new_by_curve_name_ex(OSSL_LIB_CTX *ctx, 0999 const char *propq, 1000 int nid); 1001 1002 /** 1003 * Creates a new EC_KEY object using a named curve as underlying 1004 * EC_GROUP object. Same as calling EC_KEY_new_by_curve_name_ex with a NULL 1005 * library context and property query string. 1006 * \param nid NID of the named curve. 1007 * \return EC_KEY object or NULL if an error occurred. 1008 */ 1009 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_new_by_curve_name(int nid); 1010 1011 /** Frees a EC_KEY object. 1012 * \param key EC_KEY object to be freed. 1013 */ 1014 OSSL_DEPRECATEDIN_3_0 void EC_KEY_free(EC_KEY *key); 1015 1016 /** Copies a EC_KEY object. 1017 * \param dst destination EC_KEY object 1018 * \param src src EC_KEY object 1019 * \return dst or NULL if an error occurred. 1020 */ 1021 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src); 1022 1023 /** Creates a new EC_KEY object and copies the content from src to it. 1024 * \param src the source EC_KEY object 1025 * \return newly created EC_KEY object or NULL if an error occurred. 1026 */ 1027 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_dup(const EC_KEY *src); 1028 1029 /** Increases the internal reference count of a EC_KEY object. 1030 * \param key EC_KEY object 1031 * \return 1 on success and 0 if an error occurred. 1032 */ 1033 OSSL_DEPRECATEDIN_3_0 int EC_KEY_up_ref(EC_KEY *key); 1034 1035 /** Returns the ENGINE object of a EC_KEY object 1036 * \param eckey EC_KEY object 1037 * \return the ENGINE object (possibly NULL). 1038 */ 1039 OSSL_DEPRECATEDIN_3_0 ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey); 1040 1041 /** Returns the EC_GROUP object of a EC_KEY object 1042 * \param key EC_KEY object 1043 * \return the EC_GROUP object (possibly NULL). 1044 */ 1045 OSSL_DEPRECATEDIN_3_0 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key); 1046 1047 /** Sets the EC_GROUP of a EC_KEY object. 1048 * \param key EC_KEY object 1049 * \param group EC_GROUP to use in the EC_KEY object (note: the EC_KEY 1050 * object will use an own copy of the EC_GROUP). 1051 * \return 1 on success and 0 if an error occurred. 1052 */ 1053 OSSL_DEPRECATEDIN_3_0 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group); 1054 1055 /** Returns the private key of a EC_KEY object. 1056 * \param key EC_KEY object 1057 * \return a BIGNUM with the private key (possibly NULL). 1058 */ 1059 OSSL_DEPRECATEDIN_3_0 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key); 1060 1061 /** Sets the private key of a EC_KEY object. 1062 * \param key EC_KEY object 1063 * \param prv BIGNUM with the private key (note: the EC_KEY object 1064 * will use an own copy of the BIGNUM). 1065 * \return 1 on success and 0 if an error occurred. 1066 */ 1067 OSSL_DEPRECATEDIN_3_0 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv); 1068 1069 /** Returns the public key of a EC_KEY object. 1070 * \param key the EC_KEY object 1071 * \return a EC_POINT object with the public key (possibly NULL) 1072 */ 1073 OSSL_DEPRECATEDIN_3_0 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key); 1074 1075 /** Sets the public key of a EC_KEY object. 1076 * \param key EC_KEY object 1077 * \param pub EC_POINT object with the public key (note: the EC_KEY object 1078 * will use an own copy of the EC_POINT object). 1079 * \return 1 on success and 0 if an error occurred. 1080 */ 1081 OSSL_DEPRECATEDIN_3_0 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub); 1082 1083 OSSL_DEPRECATEDIN_3_0 unsigned EC_KEY_get_enc_flags(const EC_KEY *key); 1084 OSSL_DEPRECATEDIN_3_0 void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags); 1085 OSSL_DEPRECATEDIN_3_0 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key); 1086 OSSL_DEPRECATEDIN_3_0 void EC_KEY_set_conv_form(EC_KEY *eckey, 1087 point_conversion_form_t cform); 1088 #endif /*OPENSSL_NO_DEPRECATED_3_0 */ 1089 1090 #define EC_KEY_get_ex_new_index(l, p, newf, dupf, freef) \ 1091 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_EC_KEY, l, p, newf, dupf, freef) 1092 1093 #ifndef OPENSSL_NO_DEPRECATED_3_0 1094 OSSL_DEPRECATEDIN_3_0 int EC_KEY_set_ex_data(EC_KEY *key, int idx, void *arg); 1095 OSSL_DEPRECATEDIN_3_0 void *EC_KEY_get_ex_data(const EC_KEY *key, int idx); 1096 1097 /* wrapper functions for the underlying EC_GROUP object */ 1098 OSSL_DEPRECATEDIN_3_0 void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag); 1099 1100 /** Creates a table of pre-computed multiples of the generator to 1101 * accelerate further EC_KEY operations. 1102 * \param key EC_KEY object 1103 * \param ctx BN_CTX object (optional) 1104 * \return 1 on success and 0 if an error occurred. 1105 */ 1106 OSSL_DEPRECATEDIN_3_0 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx); 1107 1108 /** Creates a new ec private (and optional a new public) key. 1109 * \param key EC_KEY object 1110 * \return 1 on success and 0 if an error occurred. 1111 */ 1112 OSSL_DEPRECATEDIN_3_0 int EC_KEY_generate_key(EC_KEY *key); 1113 1114 /** Verifies that a private and/or public key is valid. 1115 * \param key the EC_KEY object 1116 * \return 1 on success and 0 otherwise. 1117 */ 1118 OSSL_DEPRECATEDIN_3_0 int EC_KEY_check_key(const EC_KEY *key); 1119 1120 /** Indicates if an EC_KEY can be used for signing. 1121 * \param eckey the EC_KEY object 1122 * \return 1 if can sign and 0 otherwise. 1123 */ 1124 OSSL_DEPRECATEDIN_3_0 int EC_KEY_can_sign(const EC_KEY *eckey); 1125 1126 /** Sets a public key from affine coordinates performing 1127 * necessary NIST PKV tests. 1128 * \param key the EC_KEY object 1129 * \param x public key x coordinate 1130 * \param y public key y coordinate 1131 * \return 1 on success and 0 otherwise. 1132 */ 1133 OSSL_DEPRECATEDIN_3_0 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, 1134 BIGNUM *x, 1135 BIGNUM *y); 1136 1137 /** Encodes an EC_KEY public key to an allocated octet string 1138 * \param key key to encode 1139 * \param form point conversion form 1140 * \param pbuf returns pointer to allocated buffer 1141 * \param ctx BN_CTX object (optional) 1142 * \return the length of the encoded octet string or 0 if an error occurred 1143 */ 1144 OSSL_DEPRECATEDIN_3_0 size_t EC_KEY_key2buf(const EC_KEY *key, 1145 point_conversion_form_t form, 1146 unsigned char **pbuf, BN_CTX *ctx); 1147 1148 /** Decodes a EC_KEY public key from a octet string 1149 * \param key key to decode 1150 * \param buf memory buffer with the encoded ec point 1151 * \param len length of the encoded ec point 1152 * \param ctx BN_CTX object (optional) 1153 * \return 1 on success and 0 if an error occurred 1154 */ 1155 1156 OSSL_DEPRECATEDIN_3_0 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, 1157 size_t len, BN_CTX *ctx); 1158 1159 /** Decodes an EC_KEY private key from an octet string 1160 * \param key key to decode 1161 * \param buf memory buffer with the encoded private key 1162 * \param len length of the encoded key 1163 * \return 1 on success and 0 if an error occurred 1164 */ 1165 1166 OSSL_DEPRECATEDIN_3_0 int EC_KEY_oct2priv(EC_KEY *key, const unsigned char *buf, 1167 size_t len); 1168 1169 /** Encodes a EC_KEY private key to an octet string 1170 * \param key key to encode 1171 * \param buf memory buffer for the result. If NULL the function returns 1172 * required buffer size. 1173 * \param len length of the memory buffer 1174 * \return the length of the encoded octet string or 0 if an error occurred 1175 */ 1176 1177 OSSL_DEPRECATEDIN_3_0 size_t EC_KEY_priv2oct(const EC_KEY *key, 1178 unsigned char *buf, size_t len); 1179 1180 /** Encodes an EC_KEY private key to an allocated octet string 1181 * \param eckey key to encode 1182 * \param pbuf returns pointer to allocated buffer 1183 * \return the length of the encoded octet string or 0 if an error occurred 1184 */ 1185 OSSL_DEPRECATEDIN_3_0 size_t EC_KEY_priv2buf(const EC_KEY *eckey, 1186 unsigned char **pbuf); 1187 1188 /********************************************************************/ 1189 /* de- and encoding functions for SEC1 ECPrivateKey */ 1190 /********************************************************************/ 1191 1192 /** Decodes a private key from a memory buffer. 1193 * \param key a pointer to a EC_KEY object which should be used (or NULL) 1194 * \param in pointer to memory with the DER encoded private key 1195 * \param len length of the DER encoded private key 1196 * \return the decoded private key or NULL if an error occurred. 1197 */ 1198 OSSL_DEPRECATEDIN_3_0 EC_KEY *d2i_ECPrivateKey(EC_KEY **key, 1199 const unsigned char **in, 1200 long len); 1201 1202 /** Encodes a private key object and stores the result in a buffer. 1203 * \param key the EC_KEY object to encode 1204 * \param out the buffer for the result (if NULL the function returns number 1205 * of bytes needed). 1206 * \return 1 on success and 0 if an error occurred. 1207 */ 1208 OSSL_DEPRECATEDIN_3_0 int i2d_ECPrivateKey(const EC_KEY *key, 1209 unsigned char **out); 1210 1211 /********************************************************************/ 1212 /* de- and encoding functions for EC parameters */ 1213 /********************************************************************/ 1214 1215 /** Decodes ec parameter from a memory buffer. 1216 * \param key a pointer to a EC_KEY object which should be used (or NULL) 1217 * \param in pointer to memory with the DER encoded ec parameters 1218 * \param len length of the DER encoded ec parameters 1219 * \return a EC_KEY object with the decoded parameters or NULL if an error 1220 * occurred. 1221 */ 1222 OSSL_DEPRECATEDIN_3_0 EC_KEY *d2i_ECParameters(EC_KEY **key, 1223 const unsigned char **in, 1224 long len); 1225 1226 /** Encodes ec parameter and stores the result in a buffer. 1227 * \param key the EC_KEY object with ec parameters to encode 1228 * \param out the buffer for the result (if NULL the function returns number 1229 * of bytes needed). 1230 * \return 1 on success and 0 if an error occurred. 1231 */ 1232 OSSL_DEPRECATEDIN_3_0 int i2d_ECParameters(const EC_KEY *key, 1233 unsigned char **out); 1234 1235 /********************************************************************/ 1236 /* de- and encoding functions for EC public key */ 1237 /* (octet string, not DER -- hence 'o2i' and 'i2o') */ 1238 /********************************************************************/ 1239 1240 /** Decodes an ec public key from a octet string. 1241 * \param key a pointer to a EC_KEY object which should be used 1242 * \param in memory buffer with the encoded public key 1243 * \param len length of the encoded public key 1244 * \return EC_KEY object with decoded public key or NULL if an error 1245 * occurred. 1246 */ 1247 OSSL_DEPRECATEDIN_3_0 EC_KEY *o2i_ECPublicKey(EC_KEY **key, 1248 const unsigned char **in, long len); 1249 1250 /** Encodes an ec public key in an octet string. 1251 * \param key the EC_KEY object with the public key 1252 * \param out the buffer for the result (if NULL the function returns number 1253 * of bytes needed). 1254 * \return 1 on success and 0 if an error occurred 1255 */ 1256 OSSL_DEPRECATEDIN_3_0 int i2o_ECPublicKey(const EC_KEY *key, unsigned char **out); 1257 1258 /** Prints out the ec parameters on human readable form. 1259 * \param bp BIO object to which the information is printed 1260 * \param key EC_KEY object 1261 * \return 1 on success and 0 if an error occurred 1262 */ 1263 OSSL_DEPRECATEDIN_3_0 int ECParameters_print(BIO *bp, const EC_KEY *key); 1264 1265 /** Prints out the contents of a EC_KEY object 1266 * \param bp BIO object to which the information is printed 1267 * \param key EC_KEY object 1268 * \param off line offset 1269 * \return 1 on success and 0 if an error occurred 1270 */ 1271 OSSL_DEPRECATEDIN_3_0 int EC_KEY_print(BIO *bp, const EC_KEY *key, int off); 1272 1273 #ifndef OPENSSL_NO_STDIO 1274 /** Prints out the ec parameters on human readable form. 1275 * \param fp file descriptor to which the information is printed 1276 * \param key EC_KEY object 1277 * \return 1 on success and 0 if an error occurred 1278 */ 1279 OSSL_DEPRECATEDIN_3_0 int ECParameters_print_fp(FILE *fp, const EC_KEY *key); 1280 1281 /** Prints out the contents of a EC_KEY object 1282 * \param fp file descriptor to which the information is printed 1283 * \param key EC_KEY object 1284 * \param off line offset 1285 * \return 1 on success and 0 if an error occurred 1286 */ 1287 OSSL_DEPRECATEDIN_3_0 int EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off); 1288 #endif /* OPENSSL_NO_STDIO */ 1289 1290 OSSL_DEPRECATEDIN_3_0 const EC_KEY_METHOD *EC_KEY_OpenSSL(void); 1291 OSSL_DEPRECATEDIN_3_0 const EC_KEY_METHOD *EC_KEY_get_default_method(void); 1292 OSSL_DEPRECATEDIN_3_0 void EC_KEY_set_default_method(const EC_KEY_METHOD *meth); 1293 OSSL_DEPRECATEDIN_3_0 const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key); 1294 OSSL_DEPRECATEDIN_3_0 int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth); 1295 OSSL_DEPRECATEDIN_3_0 EC_KEY *EC_KEY_new_method(ENGINE *engine); 1296 1297 /** The old name for ecdh_KDF_X9_63 1298 * The ECDH KDF specification has been mistakenly attributed to ANSI X9.62, 1299 * it is actually specified in ANSI X9.63. 1300 * This identifier is retained for backwards compatibility 1301 */ 1302 OSSL_DEPRECATEDIN_3_0 int ECDH_KDF_X9_62(unsigned char *out, size_t outlen, 1303 const unsigned char *Z, size_t Zlen, 1304 const unsigned char *sinfo, 1305 size_t sinfolen, const EVP_MD *md); 1306 1307 OSSL_DEPRECATEDIN_3_0 int ECDH_compute_key(void *out, size_t outlen, 1308 const EC_POINT *pub_key, 1309 const EC_KEY *ecdh, 1310 void *(*KDF)(const void *in, 1311 size_t inlen, void *out, 1312 size_t *outlen)); 1313 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 1314 1315 typedef struct ECDSA_SIG_st ECDSA_SIG; 1316 1317 /** Allocates and initialize a ECDSA_SIG structure 1318 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred 1319 */ 1320 ECDSA_SIG *ECDSA_SIG_new(void); 1321 1322 /** frees a ECDSA_SIG structure 1323 * \param sig pointer to the ECDSA_SIG structure 1324 */ 1325 void ECDSA_SIG_free(ECDSA_SIG *sig); 1326 1327 /** i2d_ECDSA_SIG encodes content of ECDSA_SIG (note: this function modifies *pp 1328 * (*pp += length of the DER encoded signature)). 1329 * \param sig pointer to the ECDSA_SIG object 1330 * \param pp pointer to a unsigned char pointer for the output or NULL 1331 * \return the length of the DER encoded ECDSA_SIG object or a negative value 1332 * on error 1333 */ 1334 DECLARE_ASN1_ENCODE_FUNCTIONS_only(ECDSA_SIG, ECDSA_SIG) 1335 1336 /** d2i_ECDSA_SIG decodes an ECDSA signature (note: this function modifies *pp 1337 * (*pp += len)). 1338 * \param sig pointer to ECDSA_SIG pointer (may be NULL) 1339 * \param pp memory buffer with the DER encoded signature 1340 * \param len length of the buffer 1341 * \return pointer to the decoded ECDSA_SIG structure (or NULL) 1342 */ 1343 1344 /** Accessor for r and s fields of ECDSA_SIG 1345 * \param sig pointer to ECDSA_SIG structure 1346 * \param pr pointer to BIGNUM pointer for r (may be NULL) 1347 * \param ps pointer to BIGNUM pointer for s (may be NULL) 1348 */ 1349 void ECDSA_SIG_get0(const ECDSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps); 1350 1351 /** Accessor for r field of ECDSA_SIG 1352 * \param sig pointer to ECDSA_SIG structure 1353 */ 1354 const BIGNUM *ECDSA_SIG_get0_r(const ECDSA_SIG *sig); 1355 1356 /** Accessor for s field of ECDSA_SIG 1357 * \param sig pointer to ECDSA_SIG structure 1358 */ 1359 const BIGNUM *ECDSA_SIG_get0_s(const ECDSA_SIG *sig); 1360 1361 /** Setter for r and s fields of ECDSA_SIG 1362 * \param sig pointer to ECDSA_SIG structure 1363 * \param r pointer to BIGNUM for r 1364 * \param s pointer to BIGNUM for s 1365 */ 1366 int ECDSA_SIG_set0(ECDSA_SIG *sig, BIGNUM *r, BIGNUM *s); 1367 1368 #ifndef OPENSSL_NO_DEPRECATED_3_0 1369 /** Computes the ECDSA signature of the given hash value using 1370 * the supplied private key and returns the created signature. 1371 * \param dgst pointer to the hash value 1372 * \param dgst_len length of the hash value 1373 * \param eckey EC_KEY object containing a private EC key 1374 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred 1375 */ 1376 OSSL_DEPRECATEDIN_3_0 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, 1377 int dgst_len, EC_KEY *eckey); 1378 1379 /** Computes ECDSA signature of a given hash value using the supplied 1380 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory). 1381 * \param dgst pointer to the hash value to sign 1382 * \param dgstlen length of the hash value 1383 * \param kinv BIGNUM with a pre-computed inverse k (optional) 1384 * \param rp BIGNUM with a pre-computed rp value (optional), 1385 * see ECDSA_sign_setup 1386 * \param eckey EC_KEY object containing a private EC key 1387 * \return pointer to a ECDSA_SIG structure or NULL if an error occurred 1388 */ 1389 OSSL_DEPRECATEDIN_3_0 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, 1390 int dgstlen, const BIGNUM *kinv, 1391 const BIGNUM *rp, EC_KEY *eckey); 1392 1393 /** Verifies that the supplied signature is a valid ECDSA 1394 * signature of the supplied hash value using the supplied public key. 1395 * \param dgst pointer to the hash value 1396 * \param dgst_len length of the hash value 1397 * \param sig ECDSA_SIG structure 1398 * \param eckey EC_KEY object containing a public EC key 1399 * \return 1 if the signature is valid, 0 if the signature is invalid 1400 * and -1 on error 1401 */ 1402 OSSL_DEPRECATEDIN_3_0 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len, 1403 const ECDSA_SIG *sig, EC_KEY *eckey); 1404 1405 /** Precompute parts of the signing operation 1406 * \param eckey EC_KEY object containing a private EC key 1407 * \param ctx BN_CTX object (optional) 1408 * \param kinv BIGNUM pointer for the inverse of k 1409 * \param rp BIGNUM pointer for x coordinate of k * generator 1410 * \return 1 on success and 0 otherwise 1411 */ 1412 OSSL_DEPRECATEDIN_3_0 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, 1413 BIGNUM **kinv, BIGNUM **rp); 1414 1415 /** Computes ECDSA signature of a given hash value using the supplied 1416 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory). 1417 * \param type this parameter is ignored 1418 * \param dgst pointer to the hash value to sign 1419 * \param dgstlen length of the hash value 1420 * \param sig memory for the DER encoded created signature 1421 * \param siglen pointer to the length of the returned signature 1422 * \param eckey EC_KEY object containing a private EC key 1423 * \return 1 on success and 0 otherwise 1424 */ 1425 OSSL_DEPRECATEDIN_3_0 int ECDSA_sign(int type, const unsigned char *dgst, 1426 int dgstlen, unsigned char *sig, 1427 unsigned int *siglen, EC_KEY *eckey); 1428 1429 /** Computes ECDSA signature of a given hash value using the supplied 1430 * private key (note: sig must point to ECDSA_size(eckey) bytes of memory). 1431 * \param type this parameter is ignored 1432 * \param dgst pointer to the hash value to sign 1433 * \param dgstlen length of the hash value 1434 * \param sig buffer to hold the DER encoded signature 1435 * \param siglen pointer to the length of the returned signature 1436 * \param kinv BIGNUM with a pre-computed inverse k (optional) 1437 * \param rp BIGNUM with a pre-computed rp value (optional), 1438 * see ECDSA_sign_setup 1439 * \param eckey EC_KEY object containing a private EC key 1440 * \return 1 on success and 0 otherwise 1441 */ 1442 OSSL_DEPRECATEDIN_3_0 int ECDSA_sign_ex(int type, const unsigned char *dgst, 1443 int dgstlen, unsigned char *sig, 1444 unsigned int *siglen, const BIGNUM *kinv, 1445 const BIGNUM *rp, EC_KEY *eckey); 1446 1447 /** Verifies that the given signature is valid ECDSA signature 1448 * of the supplied hash value using the specified public key. 1449 * \param type this parameter is ignored 1450 * \param dgst pointer to the hash value 1451 * \param dgstlen length of the hash value 1452 * \param sig pointer to the DER encoded signature 1453 * \param siglen length of the DER encoded signature 1454 * \param eckey EC_KEY object containing a public EC key 1455 * \return 1 if the signature is valid, 0 if the signature is invalid 1456 * and -1 on error 1457 */ 1458 OSSL_DEPRECATEDIN_3_0 int ECDSA_verify(int type, const unsigned char *dgst, 1459 int dgstlen, const unsigned char *sig, 1460 int siglen, EC_KEY *eckey); 1461 1462 /** Returns the maximum length of the DER encoded signature 1463 * \param eckey EC_KEY object 1464 * \return numbers of bytes required for the DER encoded signature 1465 */ 1466 OSSL_DEPRECATEDIN_3_0 int ECDSA_size(const EC_KEY *eckey); 1467 1468 /********************************************************************/ 1469 /* EC_KEY_METHOD constructors, destructors, writers and accessors */ 1470 /********************************************************************/ 1471 1472 OSSL_DEPRECATEDIN_3_0 EC_KEY_METHOD *EC_KEY_METHOD_new(const EC_KEY_METHOD *meth); 1473 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_free(EC_KEY_METHOD *meth); 1474 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_set_init(EC_KEY_METHOD *meth, 1475 int (*init)(EC_KEY *key), 1476 void (*finish)(EC_KEY *key), 1477 int (*copy)(EC_KEY *dest, const EC_KEY *src), 1478 int (*set_group)(EC_KEY *key, const EC_GROUP *grp), 1479 int (*set_private)(EC_KEY *key, const BIGNUM *priv_key), 1480 int (*set_public)(EC_KEY *key, const EC_POINT *pub_key)); 1481 1482 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_set_keygen(EC_KEY_METHOD *meth, 1483 int (*keygen)(EC_KEY *key)); 1484 1485 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_set_compute_key(EC_KEY_METHOD *meth, 1486 int (*ckey)(unsigned char **psec, size_t *pseclen, 1487 const EC_POINT *pub_key, const EC_KEY *ecdh)); 1488 1489 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_set_sign(EC_KEY_METHOD *meth, 1490 int (*sign)(int type, const unsigned char *dgst, 1491 int dlen, unsigned char *sig, 1492 unsigned int *siglen, 1493 const BIGNUM *kinv, const BIGNUM *r, 1494 EC_KEY *eckey), 1495 int (*sign_setup)(EC_KEY *eckey, BN_CTX *ctx_in, 1496 BIGNUM **kinvp, BIGNUM **rp), 1497 ECDSA_SIG *(*sign_sig)(const unsigned char *dgst, 1498 int dgst_len, 1499 const BIGNUM *in_kinv, 1500 const BIGNUM *in_r, 1501 EC_KEY *eckey)); 1502 1503 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_set_verify(EC_KEY_METHOD *meth, 1504 int (*verify)(int type, const unsigned char *dgst, int dgst_len, 1505 const unsigned char *sigbuf, 1506 int sig_len, EC_KEY *eckey), 1507 int (*verify_sig)(const unsigned char *dgst, 1508 int dgst_len, const ECDSA_SIG *sig, 1509 EC_KEY *eckey)); 1510 1511 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_get_init(const EC_KEY_METHOD *meth, 1512 int (**pinit)(EC_KEY *key), 1513 void (**pfinish)(EC_KEY *key), 1514 int (**pcopy)(EC_KEY *dest, const EC_KEY *src), 1515 int (**pset_group)(EC_KEY *key, const EC_GROUP *grp), 1516 int (**pset_private)(EC_KEY *key, const BIGNUM *priv_key), 1517 int (**pset_public)(EC_KEY *key, const EC_POINT *pub_key)); 1518 1519 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_get_keygen(const EC_KEY_METHOD *meth, int (**pkeygen)(EC_KEY *key)); 1520 1521 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_get_compute_key(const EC_KEY_METHOD *meth, 1522 int (**pck)(unsigned char **psec, 1523 size_t *pseclen, 1524 const EC_POINT *pub_key, 1525 const EC_KEY *ecdh)); 1526 1527 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_get_sign(const EC_KEY_METHOD *meth, 1528 int (**psign)(int type, const unsigned char *dgst, 1529 int dlen, unsigned char *sig, 1530 unsigned int *siglen, 1531 const BIGNUM *kinv, const BIGNUM *r, 1532 EC_KEY *eckey), 1533 int (**psign_setup)(EC_KEY *eckey, BN_CTX *ctx_in, 1534 BIGNUM **kinvp, BIGNUM **rp), 1535 ECDSA_SIG *(**psign_sig)(const unsigned char *dgst, 1536 int dgst_len, 1537 const BIGNUM *in_kinv, 1538 const BIGNUM *in_r, 1539 EC_KEY *eckey)); 1540 1541 OSSL_DEPRECATEDIN_3_0 void EC_KEY_METHOD_get_verify(const EC_KEY_METHOD *meth, 1542 int (**pverify)(int type, const unsigned char *dgst, int dgst_len, 1543 const unsigned char *sigbuf, 1544 int sig_len, EC_KEY *eckey), 1545 int (**pverify_sig)(const unsigned char *dgst, 1546 int dgst_len, 1547 const ECDSA_SIG *sig, 1548 EC_KEY *eckey)); 1549 #endif /* OPENSSL_NO_DEPRECATED_3_0 */ 1550 1551 #define EVP_EC_gen(curve) \ 1552 EVP_PKEY_Q_keygen(NULL, NULL, "EC", (char *)(strstr(curve, ""))) 1553 /* strstr is used to enable type checking for the variadic string arg */ 1554 #define ECParameters_dup(x) ASN1_dup_of(EC_KEY, i2d_ECParameters, \ 1555 d2i_ECParameters, x) 1556 1557 #ifndef __cplusplus 1558 #if defined(__SUNPRO_C) 1559 #if __SUNPRO_C >= 0x520 1560 #pragma error_messages(default, E_ARRAY_OF_INCOMPLETE_NONAME, E_ARRAY_OF_INCOMPLETE) 1561 #endif 1562 #endif 1563 #endif 1564 1565 #endif 1566 #ifdef __cplusplus 1567 } 1568 #endif 1569 #endif
| [ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
|
This page was automatically generated by the 2.3.7 LXR engine. The LXR team |
|