xref: /openbsd/lib/libcrypto/ec/ec.h (revision 3abceb25)
1 /* $OpenBSD: ec.h,v 1.48 2024/04/15 15:42:23 tb Exp $ */
2 /*
3  * Originally written by Bodo Moeller for the OpenSSL project.
4  */
5 /* ====================================================================
6  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    openssl-core@openssl.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58 /* ====================================================================
59  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60  *
61  * Portions of the attached software ("Contribution") are developed by
62  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
63  *
64  * The Contribution is licensed pursuant to the OpenSSL open source
65  * license provided above.
66  *
67  * The elliptic curve binary polynomial software is originally written by
68  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
69  */
70 
71 #ifndef HEADER_EC_H
72 #define HEADER_EC_H
73 
74 #include <openssl/opensslconf.h>
75 
76 #ifdef OPENSSL_NO_EC
77 #error EC is disabled.
78 #endif
79 
80 #include <openssl/asn1.h>
81 #include <openssl/bn.h>
82 
83 #ifdef  __cplusplus
84 extern "C" {
85 #elif defined(__SUNPRO_C)
86 # if __SUNPRO_C >= 0x520
87 # pragma error_messages (off,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
88 # endif
89 #endif
90 
91 #ifndef OPENSSL_ECC_MAX_FIELD_BITS
92 #define OPENSSL_ECC_MAX_FIELD_BITS 661
93 #endif
94 
95 /* Elliptic point conversion form as per X9.62, page 4 and section 4.4.2. */
96 typedef enum {
97 	POINT_CONVERSION_COMPRESSED = 2,
98 	POINT_CONVERSION_UNCOMPRESSED = 4,
99 	POINT_CONVERSION_HYBRID = 6
100 } point_conversion_form_t;
101 
102 typedef struct ec_method_st EC_METHOD;
103 typedef struct ec_group_st EC_GROUP;
104 typedef struct ec_point_st EC_POINT;
105 
106 const EC_METHOD *EC_GFp_simple_method(void);
107 const EC_METHOD *EC_GFp_mont_method(void);
108 
109 EC_GROUP *EC_GROUP_new(const EC_METHOD *meth);
110 void EC_GROUP_free(EC_GROUP *group);
111 void EC_GROUP_clear_free(EC_GROUP *group);
112 
113 int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
114 EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
115 
116 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
117 int EC_METHOD_get_field_type(const EC_METHOD *meth);
118 
119 int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator,
120     const BIGNUM *order, const BIGNUM *cofactor);
121 const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
122 
123 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
124 int EC_GROUP_order_bits(const EC_GROUP *group);
125 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);
126 
127 void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
128 int EC_GROUP_get_curve_name(const EC_GROUP *group);
129 
130 void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
131 int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
132 
133 void EC_GROUP_set_point_conversion_form(EC_GROUP *group,
134     point_conversion_form_t form);
135 point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
136 
137 unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
138 size_t EC_GROUP_get_seed_len(const EC_GROUP *);
139 size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
140 
141 int EC_GROUP_set_curve(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,
142     const BIGNUM *b, BN_CTX *ctx);
143 int EC_GROUP_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b,
144     BN_CTX *ctx);
145 
146 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,
147     const BIGNUM *b, BN_CTX *ctx);
148 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a,
149     BIGNUM *b, BN_CTX *ctx);
150 
151 int EC_GROUP_get_degree(const EC_GROUP *group);
152 
153 int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
154 int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
155 
156 /* Compare two EC_GROUPs. Returns 0 if both groups are equal, 1 otherwise. */
157 int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
158 
159 EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a,
160     const BIGNUM *b, BN_CTX *ctx);
161 EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
162 
163 typedef struct {
164 	int nid;
165 	const char *comment;
166 } EC_builtin_curve;
167 
168 size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems);
169 
170 const char *EC_curve_nid2nist(int nid);
171 int EC_curve_nist2nid(const char *name);
172 
173 EC_POINT *EC_POINT_new(const EC_GROUP *group);
174 void EC_POINT_free(EC_POINT *point);
175 void EC_POINT_clear_free(EC_POINT *point);
176 int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
177 EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
178 
179 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
180 
181 int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
182 
183 int EC_POINT_set_affine_coordinates(const EC_GROUP *group, EC_POINT *p,
184     const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
185 int EC_POINT_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *p,
186     BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
187 int EC_POINT_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *p,
188     const BIGNUM *x, int y_bit, BN_CTX *ctx);
189 
190 int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
191     const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx);
192 int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
193     const EC_POINT *p, BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx);
194 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
195     const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
196 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
197     const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
198 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
199     const BIGNUM *x, int y_bit, BN_CTX *ctx);
200 size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
201     point_conversion_form_t form, unsigned char *buf, size_t len, BN_CTX *ctx);
202 int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
203     const unsigned char *buf, size_t len, BN_CTX *ctx);
204 
205 BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *,
206     point_conversion_form_t form, BIGNUM *, BN_CTX *);
207 EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *, EC_POINT *,
208     BN_CTX *);
209 char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *,
210     point_conversion_form_t form, BN_CTX *);
211 EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *, EC_POINT *,
212     BN_CTX *);
213 
214 int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
215     const EC_POINT *b, BN_CTX *ctx);
216 int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,
217     BN_CTX *ctx);
218 int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx);
219 int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p);
220 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point,
221     BN_CTX *ctx);
222 int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b,
223     BN_CTX *ctx);
224 
225 int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx);
226 int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[],
227     BN_CTX *ctx);
228 int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
229     size_t num, const EC_POINT *p[], const BIGNUM *m[], BN_CTX *ctx);
230 int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
231     const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);
232 int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
233 int EC_GROUP_have_precompute_mult(const EC_GROUP *group);
234 
235 int EC_GROUP_get_basis_type(const EC_GROUP *);
236 
237 #define OPENSSL_EC_EXPLICIT_CURVE	0x000
238 #define OPENSSL_EC_NAMED_CURVE		0x001
239 
240 EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len);
241 int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out);
242 
243 #define d2i_ECPKParameters_bio(bp,x) ASN1_d2i_bio_of(EC_GROUP,NULL,d2i_ECPKParameters,bp,x)
244 #define i2d_ECPKParameters_bio(bp,x) ASN1_i2d_bio_of_const(EC_GROUP,i2d_ECPKParameters,bp,x)
245 #define d2i_ECPKParameters_fp(fp,x) (EC_GROUP *)ASN1_d2i_fp(NULL, \
246                 (char *(*)())d2i_ECPKParameters,(fp),(unsigned char **)(x))
247 #define i2d_ECPKParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECPKParameters,(fp), \
248 		(unsigned char *)(x))
249 
250 #ifndef OPENSSL_NO_BIO
251 int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off);
252 #endif
253 int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off);
254 
255 #define EC_PKEY_NO_PARAMETERS	0x001
256 #define EC_PKEY_NO_PUBKEY	0x002
257 
258 #define EC_FLAG_NON_FIPS_ALLOW	0x1
259 #define EC_FLAG_FIPS_CHECKED	0x2
260 #define EC_FLAG_COFACTOR_ECDH	0x1000
261 
262 EC_KEY *EC_KEY_new(void);
263 int EC_KEY_get_flags(const EC_KEY *key);
264 void EC_KEY_set_flags(EC_KEY *key, int flags);
265 void EC_KEY_clear_flags(EC_KEY *key, int flags);
266 EC_KEY *EC_KEY_new_by_curve_name(int nid);
267 void EC_KEY_free(EC_KEY *key);
268 EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
269 EC_KEY *EC_KEY_dup(const EC_KEY *src);
270 int EC_KEY_up_ref(EC_KEY *key);
271 
272 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
273 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
274 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
275 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
276 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
277 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
278 
279 unsigned EC_KEY_get_enc_flags(const EC_KEY *key);
280 void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);
281 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
282 void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
283 
284 void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
285 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
286 int EC_KEY_generate_key(EC_KEY *key);
287 int EC_KEY_check_key(const EC_KEY *key);
288 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
289 
290 EC_KEY *d2i_ECPrivateKey(EC_KEY **key, const unsigned char **in, long len);
291 int i2d_ECPrivateKey(EC_KEY *key, unsigned char **out);
292 EC_KEY *d2i_ECParameters(EC_KEY **key, const unsigned char **in, long len);
293 int i2d_ECParameters(EC_KEY *key, unsigned char **out);
294 
295 EC_KEY *o2i_ECPublicKey(EC_KEY **key, const unsigned char **in, long len);
296 int i2o_ECPublicKey(const EC_KEY *key, unsigned char **out);
297 
298 #ifndef OPENSSL_NO_BIO
299 int ECParameters_print(BIO *bp, const EC_KEY *key);
300 int EC_KEY_print(BIO *bp, const EC_KEY *key, int off);
301 #endif
302 int ECParameters_print_fp(FILE *fp, const EC_KEY *key);
303 int EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off);
304 
305 #define EC_KEY_get_ex_new_index(l, p, newf, dupf, freef) \
306     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_EC_KEY, l, p, newf, dupf, freef)
307 int EC_KEY_set_ex_data(EC_KEY *key, int idx, void *arg);
308 void *EC_KEY_get_ex_data(const EC_KEY *key, int idx);
309 
310 const EC_KEY_METHOD *EC_KEY_OpenSSL(void);
311 const EC_KEY_METHOD *EC_KEY_get_default_method(void);
312 void EC_KEY_set_default_method(const EC_KEY_METHOD *meth);
313 const EC_KEY_METHOD *EC_KEY_get_method(const EC_KEY *key);
314 int EC_KEY_set_method(EC_KEY *key, const EC_KEY_METHOD *meth);
315 EC_KEY *EC_KEY_new_method(ENGINE *engine);
316 
317 int ECDH_size(const EC_KEY *ecdh);
318 int ECDH_compute_key(void *out, size_t outlen, const EC_POINT *pub_key,
319     EC_KEY *ecdh,
320     void *(*KDF)(const void *in, size_t inlen, void *out, size_t *outlen));
321 
322 typedef struct ECDSA_SIG_st ECDSA_SIG;
323 
324 ECDSA_SIG *ECDSA_SIG_new(void);
325 void ECDSA_SIG_free(ECDSA_SIG *sig);
326 int i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp);
327 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, long len);
328 
329 const BIGNUM *ECDSA_SIG_get0_r(const ECDSA_SIG *sig);
330 const BIGNUM *ECDSA_SIG_get0_s(const ECDSA_SIG *sig);
331 void ECDSA_SIG_get0(const ECDSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
332 int ECDSA_SIG_set0(ECDSA_SIG *sig, BIGNUM *r, BIGNUM *s);
333 
334 int ECDSA_size(const EC_KEY *eckey);
335 
336 ECDSA_SIG *ECDSA_do_sign(const unsigned char *digest, int digest_len,
337     EC_KEY *eckey);
338 int ECDSA_do_verify(const unsigned char *digest, int digest_len,
339     const ECDSA_SIG *sig, EC_KEY *eckey);
340 
341 int ECDSA_sign(int type, const unsigned char *digest, int digest_len,
342     unsigned char *signature, unsigned int *signature_len, EC_KEY *eckey);
343 int ECDSA_verify(int type, const unsigned char *digest, int digest_len,
344     const unsigned char *signature, int signature_len, EC_KEY *eckey);
345 
346 EC_KEY_METHOD *EC_KEY_METHOD_new(const EC_KEY_METHOD *meth);
347 void EC_KEY_METHOD_free(EC_KEY_METHOD *meth);
348 void EC_KEY_METHOD_set_init(EC_KEY_METHOD *meth,
349     int (*init)(EC_KEY *key),
350     void (*finish)(EC_KEY *key),
351     int (*copy)(EC_KEY *dest, const EC_KEY *src),
352     int (*set_group)(EC_KEY *key, const EC_GROUP *grp),
353     int (*set_private)(EC_KEY *key, const BIGNUM *priv_key),
354     int (*set_public)(EC_KEY *key, const EC_POINT *pub_key));
355 void EC_KEY_METHOD_set_keygen(EC_KEY_METHOD *meth,
356     int (*keygen)(EC_KEY *key));
357 void EC_KEY_METHOD_set_compute_key(EC_KEY_METHOD *meth,
358     int (*ckey)(unsigned char **out, size_t *out_len, const EC_POINT *pub_key,
359         const EC_KEY *ecdh));
360 void EC_KEY_METHOD_set_sign(EC_KEY_METHOD *meth,
361     int (*sign)(int type, const unsigned char *digest, int digest_len,
362 	unsigned char *signature, unsigned int *signature_len,
363 	const BIGNUM *kinv, const BIGNUM *r, EC_KEY *eckey),
364     int (*sign_setup)(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp),
365     ECDSA_SIG *(*sign_sig)(const unsigned char *digest, int digest_len,
366         const BIGNUM *in_kinv, const BIGNUM *in_r, EC_KEY *eckey));
367 void EC_KEY_METHOD_set_verify(EC_KEY_METHOD *meth,
368     int (*verify)(int type, const unsigned char *digest, int digest_len,
369 	const unsigned char *signature, int signature_len, EC_KEY *eckey),
370     int (*verify_sig)(const unsigned char *digest, int digest_len,
371 	const ECDSA_SIG *sig, EC_KEY *eckey));
372 void EC_KEY_METHOD_get_init(const EC_KEY_METHOD *meth,
373     int (**pinit)(EC_KEY *key),
374     void (**pfinish)(EC_KEY *key),
375     int (**pcopy)(EC_KEY *dest, const EC_KEY *src),
376     int (**pset_group)(EC_KEY *key, const EC_GROUP *grp),
377     int (**pset_private)(EC_KEY *key, const BIGNUM *priv_key),
378     int (**pset_public)(EC_KEY *key, const EC_POINT *pub_key));
379 void EC_KEY_METHOD_get_keygen(const EC_KEY_METHOD *meth,
380     int (**pkeygen)(EC_KEY *key));
381 void EC_KEY_METHOD_get_compute_key(const EC_KEY_METHOD *meth,
382     int (**pck)(unsigned char **out, size_t *out_len, const EC_POINT *pub_key,
383         const EC_KEY *ecdh));
384 void EC_KEY_METHOD_get_sign(const EC_KEY_METHOD *meth,
385     int (**psign)(int type, const unsigned char *digest, int digest_len,
386         unsigned char *signature, unsigned int *signature_len,
387 	const BIGNUM *kinv, const BIGNUM *r, EC_KEY *eckey),
388     int (**psign_setup)(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp),
389     ECDSA_SIG *(**psign_sig)(const unsigned char *digest, int digest_len,
390         const BIGNUM *in_kinv, const BIGNUM *in_r, EC_KEY *eckey));
391 void EC_KEY_METHOD_get_verify(const EC_KEY_METHOD *meth,
392     int (**pverify)(int type, const unsigned char *digest, int digest_len,
393 	const unsigned char *signature, int signature_len, EC_KEY *eckey),
394     int (**pverify_sig)(const unsigned char *digest, int digest_len,
395 	const ECDSA_SIG *sig, EC_KEY *eckey));
396 
397 EC_KEY *ECParameters_dup(EC_KEY *key);
398 
399 #ifndef __cplusplus
400 #if defined(__SUNPRO_C)
401 #  if __SUNPRO_C >= 0x520
402 # pragma error_messages (default,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE)
403 #  endif
404 # endif
405 #endif
406 
407 #define EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid) \
408 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
409 	    EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
410 	    EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, nid, NULL)
411 
412 #define EVP_PKEY_CTX_set_ec_param_enc(ctx, flag) \
413 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
414 	    EVP_PKEY_OP_PARAMGEN|EVP_PKEY_OP_KEYGEN, \
415 	    EVP_PKEY_CTRL_EC_PARAM_ENC, flag, NULL)
416 
417 #define EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, flag) \
418 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
419 	    EVP_PKEY_OP_DERIVE, \
420 	    EVP_PKEY_CTRL_EC_ECDH_COFACTOR, flag, NULL)
421 
422 #define EVP_PKEY_CTX_get_ecdh_cofactor_mode(ctx) \
423 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
424 	    EVP_PKEY_OP_DERIVE, \
425 	    EVP_PKEY_CTRL_EC_ECDH_COFACTOR, -2, NULL)
426 
427 #define EVP_PKEY_CTX_set_ecdh_kdf_type(ctx, kdf) \
428 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
429 	    EVP_PKEY_OP_DERIVE, \
430 	    EVP_PKEY_CTRL_EC_KDF_TYPE, kdf, NULL)
431 
432 #define EVP_PKEY_CTX_get_ecdh_kdf_type(ctx) \
433 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
434 	    EVP_PKEY_OP_DERIVE, \
435 	    EVP_PKEY_CTRL_EC_KDF_TYPE, -2, NULL)
436 
437 #define EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md) \
438 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
439 	    EVP_PKEY_OP_DERIVE, \
440 	    EVP_PKEY_CTRL_EC_KDF_MD, 0, (void *)(md))
441 
442 #define EVP_PKEY_CTX_get_ecdh_kdf_md(ctx, pmd) \
443 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
444 	    EVP_PKEY_OP_DERIVE, \
445 	    EVP_PKEY_CTRL_GET_EC_KDF_MD, 0, (void *)(pmd))
446 
447 #define EVP_PKEY_CTX_set_ecdh_kdf_outlen(ctx, len) \
448 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
449 	    EVP_PKEY_OP_DERIVE, \
450 	    EVP_PKEY_CTRL_EC_KDF_OUTLEN, len, NULL)
451 
452 #define EVP_PKEY_CTX_get_ecdh_kdf_outlen(ctx, plen) \
453 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
454 	    EVP_PKEY_OP_DERIVE, \
455 	    EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, 0, \
456 	    (void *)(plen))
457 
458 #define EVP_PKEY_CTX_set0_ecdh_kdf_ukm(ctx, p, plen) \
459 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
460 	    EVP_PKEY_OP_DERIVE, \
461 	    EVP_PKEY_CTRL_EC_KDF_UKM, plen, (void *)(p))
462 
463 #define EVP_PKEY_CTX_get0_ecdh_kdf_ukm(ctx, p) \
464 	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, \
465 	    EVP_PKEY_OP_DERIVE, \
466 	    EVP_PKEY_CTRL_GET_EC_KDF_UKM, 0, (void *)(p))
467 
468 /* SM2 will skip the operation check so no need to pass operation here */
469 #define EVP_PKEY_CTX_set1_id(ctx, id, id_len) \
470 	EVP_PKEY_CTX_ctrl(ctx, -1, -1, \
471 	    EVP_PKEY_CTRL_SET1_ID, (int)id_len, (void*)(id))
472 
473 #define EVP_PKEY_CTX_get1_id(ctx, id) \
474 	EVP_PKEY_CTX_ctrl(ctx, -1, -1, \
475 	    EVP_PKEY_CTRL_GET1_ID, 0, (void*)(id))
476 
477 #define EVP_PKEY_CTX_get1_id_len(ctx, id_len) \
478 	EVP_PKEY_CTX_ctrl(ctx, -1, -1, \
479 	    EVP_PKEY_CTRL_GET1_ID_LEN, 0, (void*)(id_len))
480 
481 #define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID		(EVP_PKEY_ALG_CTRL + 1)
482 #define EVP_PKEY_CTRL_EC_PARAM_ENC			(EVP_PKEY_ALG_CTRL + 2)
483 #define EVP_PKEY_CTRL_EC_ECDH_COFACTOR			(EVP_PKEY_ALG_CTRL + 3)
484 #define EVP_PKEY_CTRL_EC_KDF_TYPE			(EVP_PKEY_ALG_CTRL + 4)
485 #define EVP_PKEY_CTRL_EC_KDF_MD				(EVP_PKEY_ALG_CTRL + 5)
486 #define EVP_PKEY_CTRL_GET_EC_KDF_MD			(EVP_PKEY_ALG_CTRL + 6)
487 #define EVP_PKEY_CTRL_EC_KDF_OUTLEN			(EVP_PKEY_ALG_CTRL + 7)
488 #define EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN			(EVP_PKEY_ALG_CTRL + 8)
489 #define EVP_PKEY_CTRL_EC_KDF_UKM			(EVP_PKEY_ALG_CTRL + 9)
490 #define EVP_PKEY_CTRL_GET_EC_KDF_UKM			(EVP_PKEY_ALG_CTRL + 10)
491 #define EVP_PKEY_CTRL_SET1_ID				(EVP_PKEY_ALG_CTRL + 11)
492 #define EVP_PKEY_CTRL_GET1_ID				(EVP_PKEY_ALG_CTRL + 12)
493 #define EVP_PKEY_CTRL_GET1_ID_LEN			(EVP_PKEY_ALG_CTRL + 13)
494 
495 /* KDF types */
496 #define EVP_PKEY_ECDH_KDF_NONE				1
497 #define EVP_PKEY_ECDH_KDF_X9_63				2
498 
499 void ERR_load_EC_strings(void);
500 
501 /* Error codes for the EC functions. */
502 
503 /* Function codes. */
504 #define EC_F_BN_TO_FELEM				 224
505 #define EC_F_COMPUTE_WNAF				 143
506 #define EC_F_D2I_ECPARAMETERS				 144
507 #define EC_F_D2I_ECPKPARAMETERS				 145
508 #define EC_F_D2I_ECPRIVATEKEY				 146
509 #define EC_F_DO_EC_KEY_PRINT				 221
510 #define EC_F_ECKEY_PARAM2TYPE				 223
511 #define EC_F_ECKEY_PARAM_DECODE				 212
512 #define EC_F_ECKEY_PRIV_DECODE				 213
513 #define EC_F_ECKEY_PRIV_ENCODE				 214
514 #define EC_F_ECKEY_PUB_DECODE				 215
515 #define EC_F_ECKEY_PUB_ENCODE				 216
516 #define EC_F_ECKEY_TYPE2PARAM				 220
517 #define EC_F_ECPARAMETERS_PRINT				 147
518 #define EC_F_ECPARAMETERS_PRINT_FP			 148
519 #define EC_F_ECPKPARAMETERS_PRINT			 149
520 #define EC_F_ECPKPARAMETERS_PRINT_FP			 150
521 #define EC_F_ECP_NIST_MOD_192				 203
522 #define EC_F_ECP_NIST_MOD_224				 204
523 #define EC_F_ECP_NIST_MOD_256				 205
524 #define EC_F_ECP_NIST_MOD_521				 206
525 #define EC_F_ECP_NISTZ256_GET_AFFINE			 240
526 #define EC_F_ECP_NISTZ256_MULT_PRECOMPUTE		 243
527 #define EC_F_ECP_NISTZ256_POINTS_MUL			 241
528 #define EC_F_ECP_NISTZ256_PRE_COMP_NEW			 244
529 #define EC_F_ECP_NISTZ256_SET_WORDS			 245
530 #define EC_F_ECP_NISTZ256_WINDOWED_MUL			 242
531 #define EC_F_EC_ASN1_GROUP2CURVE			 153
532 #define EC_F_EC_ASN1_GROUP2FIELDID			 154
533 #define EC_F_EC_ASN1_GROUP2PARAMETERS			 155
534 #define EC_F_EC_ASN1_GROUP2PKPARAMETERS			 156
535 #define EC_F_EC_ASN1_PARAMETERS2GROUP			 157
536 #define EC_F_EC_ASN1_PKPARAMETERS2GROUP			 158
537 #define EC_F_EC_EX_DATA_SET_DATA			 211
538 #define EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY		 208
539 #define EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT	 159
540 #define EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE		 195
541 #define EC_F_EC_GF2M_SIMPLE_OCT2POINT			 160
542 #define EC_F_EC_GF2M_SIMPLE_POINT2OCT			 161
543 #define EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES 162
544 #define EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES 163
545 #define EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES	 164
546 #define EC_F_EC_GFP_MONT_FIELD_DECODE			 133
547 #define EC_F_EC_GFP_MONT_FIELD_ENCODE			 134
548 #define EC_F_EC_GFP_MONT_FIELD_MUL			 131
549 #define EC_F_EC_GFP_MONT_FIELD_SET_TO_ONE		 209
550 #define EC_F_EC_GFP_MONT_FIELD_SQR			 132
551 #define EC_F_EC_GFP_MONT_GROUP_SET_CURVE		 189
552 #define EC_F_EC_GFP_MONT_GROUP_SET_CURVE_GFP		 135
553 #define EC_F_EC_GFP_NISTP224_GROUP_SET_CURVE		 225
554 #define EC_F_EC_GFP_NISTP224_POINTS_MUL			 228
555 #define EC_F_EC_GFP_NISTP224_POINT_GET_AFFINE_COORDINATES 226
556 #define EC_F_EC_GFP_NISTP256_GROUP_SET_CURVE		 230
557 #define EC_F_EC_GFP_NISTP256_POINTS_MUL			 231
558 #define EC_F_EC_GFP_NISTP256_POINT_GET_AFFINE_COORDINATES 232
559 #define EC_F_EC_GFP_NISTP521_GROUP_SET_CURVE		 233
560 #define EC_F_EC_GFP_NISTP521_POINTS_MUL			 234
561 #define EC_F_EC_GFP_NISTP521_POINT_GET_AFFINE_COORDINATES 235
562 #define EC_F_EC_GFP_NIST_FIELD_MUL			 200
563 #define EC_F_EC_GFP_NIST_FIELD_SQR			 201
564 #define EC_F_EC_GFP_NIST_GROUP_SET_CURVE		 202
565 #define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT	 165
566 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE		 166
567 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP		 100
568 #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR		 101
569 #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE			 102
570 #define EC_F_EC_GFP_SIMPLE_OCT2POINT			 103
571 #define EC_F_EC_GFP_SIMPLE_POINT2OCT			 104
572 #define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE		 137
573 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES	 167
574 #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
575 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES	 168
576 #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
577 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES	 169
578 #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
579 #define EC_F_EC_GROUP_CHECK				 170
580 #define EC_F_EC_GROUP_CHECK_DISCRIMINANT		 171
581 #define EC_F_EC_GROUP_COPY				 106
582 #define EC_F_EC_GROUP_GET0_GENERATOR			 139
583 #define EC_F_EC_GROUP_GET_COFACTOR			 140
584 #define EC_F_EC_GROUP_GET_CURVE_GF2M			 172
585 #define EC_F_EC_GROUP_GET_CURVE_GFP			 130
586 #define EC_F_EC_GROUP_GET_DEGREE			 173
587 #define EC_F_EC_GROUP_GET_ORDER				 141
588 #define EC_F_EC_GROUP_GET_PENTANOMIAL_BASIS		 193
589 #define EC_F_EC_GROUP_GET_TRINOMIAL_BASIS		 194
590 #define EC_F_EC_GROUP_NEW				 108
591 #define EC_F_EC_GROUP_NEW_BY_CURVE_NAME			 174
592 #define EC_F_EC_GROUP_NEW_FROM_DATA			 175
593 #define EC_F_EC_GROUP_PRECOMPUTE_MULT			 142
594 #define EC_F_EC_GROUP_SET_CURVE_GF2M			 176
595 #define EC_F_EC_GROUP_SET_CURVE_GFP			 109
596 #define EC_F_EC_GROUP_SET_EXTRA_DATA			 110
597 #define EC_F_EC_GROUP_SET_GENERATOR			 111
598 #define EC_F_EC_KEY_CHECK_KEY				 177
599 #define EC_F_EC_KEY_COPY				 178
600 #define EC_F_EC_KEY_GENERATE_KEY			 179
601 #define EC_F_EC_KEY_NEW					 182
602 #define EC_F_EC_KEY_PRINT				 180
603 #define EC_F_EC_KEY_PRINT_FP				 181
604 #define EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES	 229
605 #define EC_F_EC_POINTS_MAKE_AFFINE			 136
606 #define EC_F_EC_POINT_ADD				 112
607 #define EC_F_EC_POINT_CMP				 113
608 #define EC_F_EC_POINT_COPY				 114
609 #define EC_F_EC_POINT_DBL				 115
610 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M	 183
611 #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP	 116
612 #define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP	 117
613 #define EC_F_EC_POINT_INVERT				 210
614 #define EC_F_EC_POINT_IS_AT_INFINITY			 118
615 #define EC_F_EC_POINT_IS_ON_CURVE			 119
616 #define EC_F_EC_POINT_MAKE_AFFINE			 120
617 #define EC_F_EC_POINT_MUL				 184
618 #define EC_F_EC_POINT_NEW				 121
619 #define EC_F_EC_POINT_OCT2POINT				 122
620 #define EC_F_EC_POINT_POINT2OCT				 123
621 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M	 185
622 #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP	 124
623 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M	 186
624 #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP	 125
625 #define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP	 126
626 #define EC_F_EC_POINT_SET_TO_INFINITY			 127
627 #define EC_F_EC_PRE_COMP_DUP				 207
628 #define EC_F_EC_PRE_COMP_NEW				 196
629 #define EC_F_EC_WNAF_MUL				 187
630 #define EC_F_EC_WNAF_PRECOMPUTE_MULT			 188
631 #define EC_F_I2D_ECPARAMETERS				 190
632 #define EC_F_I2D_ECPKPARAMETERS				 191
633 #define EC_F_I2D_ECPRIVATEKEY				 192
634 #define EC_F_I2O_ECPUBLICKEY				 151
635 #define EC_F_NISTP224_PRE_COMP_NEW			 227
636 #define EC_F_NISTP256_PRE_COMP_NEW			 236
637 #define EC_F_NISTP521_PRE_COMP_NEW			 237
638 #define EC_F_O2I_ECPUBLICKEY				 152
639 #define EC_F_OLD_EC_PRIV_DECODE				 222
640 #define EC_F_PKEY_EC_CTRL				 197
641 #define EC_F_PKEY_EC_CTRL_STR				 198
642 #define EC_F_PKEY_EC_DERIVE				 217
643 #define EC_F_PKEY_EC_KEYGEN				 199
644 #define EC_F_PKEY_EC_PARAMGEN				 219
645 #define EC_F_PKEY_EC_SIGN				 218
646 
647 /* Reason codes. */
648 #define EC_R_ASN1_ERROR					 115
649 #define EC_R_ASN1_UNKNOWN_FIELD				 116
650 #define EC_R_BAD_SIGNATURE				 166
651 #define EC_R_BIGNUM_OUT_OF_RANGE			 144
652 #define EC_R_BUFFER_TOO_SMALL				 100
653 #define EC_R_COORDINATES_OUT_OF_RANGE			 146
654 #define EC_R_D2I_ECPKPARAMETERS_FAILURE			 117
655 #define EC_R_DECODE_ERROR				 142
656 #define EC_R_DISCRIMINANT_IS_ZERO			 118
657 #define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE		 119
658 #define EC_R_FIELD_TOO_LARGE				 143
659 #define EC_R_GF2M_NOT_SUPPORTED				 147
660 #define EC_R_GROUP2PKPARAMETERS_FAILURE			 120
661 #define EC_R_I2D_ECPKPARAMETERS_FAILURE			 121
662 #define EC_R_INCOMPATIBLE_OBJECTS			 101
663 #define EC_R_INVALID_ARGUMENT				 112
664 #define EC_R_INVALID_COMPRESSED_POINT			 110
665 #define EC_R_INVALID_COMPRESSION_BIT			 109
666 #define EC_R_INVALID_CURVE				 141
667 #define EC_R_INVALID_DIGEST				 151
668 #define EC_R_INVALID_DIGEST_TYPE			 138
669 #define EC_R_INVALID_ENCODING				 102
670 #define EC_R_INVALID_FIELD				 103
671 #define EC_R_INVALID_FORM				 104
672 #define EC_R_INVALID_GROUP_ORDER			 122
673 #define EC_R_INVALID_KEY				 165
674 #define EC_R_INVALID_OUTPUT_LENGTH			 171
675 #define EC_R_INVALID_PEER_KEY				 152
676 #define EC_R_INVALID_PENTANOMIAL_BASIS			 132
677 #define EC_R_INVALID_PRIVATE_KEY			 123
678 #define EC_R_INVALID_TRINOMIAL_BASIS			 137
679 #define EC_R_KDF_FAILED					 167
680 #define EC_R_KDF_PARAMETER_ERROR			 148
681 #define EC_R_KEY_TRUNCATION				 168
682 #define EC_R_KEYS_NOT_SET				 140
683 #define EC_R_MISSING_PARAMETERS				 124
684 #define EC_R_MISSING_PRIVATE_KEY			 125
685 #define EC_R_NEED_NEW_SETUP_VALUES			 170
686 #define EC_R_NOT_A_NIST_PRIME				 135
687 #define EC_R_NOT_A_SUPPORTED_NIST_PRIME			 136
688 #define EC_R_NOT_IMPLEMENTED				 126
689 #define EC_R_NOT_INITIALIZED				 111
690 #define EC_R_NO_FIELD_MOD				 133
691 #define EC_R_NO_PARAMETERS_SET				 139
692 #define EC_R_PASSED_NULL_PARAMETER			 134
693 #define EC_R_PEER_KEY_ERROR				 149
694 #define EC_R_PKPARAMETERS2GROUP_FAILURE			 127
695 #define EC_R_POINT_AT_INFINITY				 106
696 #define EC_R_POINT_ARITHMETIC_FAILURE			 169
697 #define EC_R_POINT_IS_NOT_ON_CURVE			 107
698 #define EC_R_SHARED_INFO_ERROR				 150
699 #define EC_R_SLOT_FULL					 108
700 #define EC_R_UNDEFINED_GENERATOR			 113
701 #define EC_R_UNDEFINED_ORDER				 128
702 #define EC_R_UNKNOWN_COFACTOR				 164
703 #define EC_R_UNKNOWN_GROUP				 129
704 #define EC_R_UNKNOWN_ORDER				 114
705 #define EC_R_UNSUPPORTED_FIELD				 131
706 #define EC_R_WRONG_CURVE_PARAMETERS			 145
707 #define EC_R_WRONG_ORDER				 130
708 
709 #ifdef  __cplusplus
710 }
711 #endif
712 #endif
713