Gitiles
Code Review Sign In
192.168.1.100 / R306 / 824eb0c6ade808c4501e62fbcf0025f4e694cd11 / . / ap / lib / libwolfssl / install / include / wolfssl / openssl / ec.h
blob: aed85c63aae1a80729d2cf75618bb4c7f5bfa212 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -0700[diff] [blame^]1/* ec.h
2 *
3 * Copyright (C) 2006-2021 wolfSSL Inc.
4 *
5 * This file is part of wolfSSL.
6 *
7 * wolfSSL is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * wolfSSL is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
20 */
21
22/* ec.h for openssl */
23
24#ifndef WOLFSSL_EC_H_
25#define WOLFSSL_EC_H_
26
27#include <wolfssl/openssl/bn.h>
28#include <wolfssl/wolfcrypt/asn.h>
29#include <wolfssl/wolfcrypt/ecc.h>
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35/* Map OpenSSL NID value */
36enum {
37 POINT_CONVERSION_COMPRESSED = 2,
38 POINT_CONVERSION_UNCOMPRESSED = 4,
39
40#ifdef HAVE_ECC
41 /* Use OpenSSL NIDs. NIDs can be mapped to ecc_curve_id enum values by
42 calling NIDToEccEnum() in ssl.c */
43 NID_X9_62_prime192v1 = 409,
44 NID_X9_62_prime192v2 = 410,
45 NID_X9_62_prime192v3 = 411,
46 NID_X9_62_prime239v1 = 412,
47 NID_X9_62_prime239v2 = 413,
48 NID_X9_62_prime239v3 = 414,
49 NID_X9_62_prime256v1 = 415,
50 NID_secp112r1 = 704,
51 NID_secp112r2 = 705,
52 NID_secp128r1 = 706,
53 NID_secp128r2 = 707,
54 NID_secp160r1 = 709,
55 NID_secp160r2 = 710,
56 NID_secp224r1 = 713,
57 NID_secp384r1 = 715,
58 NID_secp521r1 = 716,
59 NID_secp160k1 = 708,
60 NID_secp192k1 = 711,
61 NID_secp224k1 = 712,
62 NID_secp256k1 = 714,
63 NID_brainpoolP160r1 = 921,
64 NID_brainpoolP192r1 = 923,
65 NID_brainpoolP224r1 = 925,
66 NID_brainpoolP256r1 = 927,
67 NID_brainpoolP320r1 = 929,
68 NID_brainpoolP384r1 = 931,
69 NID_brainpoolP512r1 = 933,
70#endif
71
72#ifdef HAVE_ED448
73 NID_ED448 = ED448k,
74#endif
75#ifdef HAVE_ED25519
76 NID_ED25519 = ED25519k,
77#endif
78
79 OPENSSL_EC_NAMED_CURVE = 0x001
80};
81
82#ifndef WOLFSSL_EC_TYPE_DEFINED /* guard on redeclaration */
83typedef struct WOLFSSL_EC_KEY WOLFSSL_EC_KEY;
84typedef struct WOLFSSL_EC_POINT WOLFSSL_EC_POINT;
85typedef struct WOLFSSL_EC_GROUP WOLFSSL_EC_GROUP;
86typedef struct WOLFSSL_EC_BUILTIN_CURVE WOLFSSL_EC_BUILTIN_CURVE;
87/* WOLFSSL_EC_METHOD is just an alias of WOLFSSL_EC_GROUP for now */
88typedef struct WOLFSSL_EC_GROUP WOLFSSL_EC_METHOD;
89#define WOLFSSL_EC_TYPE_DEFINED
90#endif
91
92typedef WOLFSSL_EC_KEY EC_KEY;
93typedef WOLFSSL_EC_GROUP EC_GROUP;
94typedef WOLFSSL_EC_GROUP EC_METHOD;
95typedef WOLFSSL_EC_POINT EC_POINT;
96typedef WOLFSSL_EC_BUILTIN_CURVE EC_builtin_curve;
97
98struct WOLFSSL_EC_POINT {
99 WOLFSSL_BIGNUM *X;
100 WOLFSSL_BIGNUM *Y;
101 WOLFSSL_BIGNUM *Z;
102
103 void* internal; /* our ECC point */
104 char inSet; /* internal set from external ? */
105 char exSet; /* external set from internal ? */
106};
107
108struct WOLFSSL_EC_GROUP {
109 int curve_idx; /* index of curve, used by WolfSSL as reference */
110 int curve_nid; /* NID of curve, used by OpenSSL/OpenSSH as reference */
111 int curve_oid; /* OID of curve, used by OpenSSL/OpenSSH as reference */
112};
113
114struct WOLFSSL_EC_KEY {
115 WOLFSSL_EC_GROUP *group;
116 WOLFSSL_EC_POINT *pub_key;
117 WOLFSSL_BIGNUM *priv_key;
118
119 void* internal; /* our ECC Key */
120 char inSet; /* internal set from external ? */
121 char exSet; /* external set from internal ? */
122 char form; /* Either POINT_CONVERSION_UNCOMPRESSED or
123 * POINT_CONVERSION_COMPRESSED */
124};
125
126struct WOLFSSL_EC_BUILTIN_CURVE {
127 int nid;
128 const char *comment;
129};
130
131#define WOLFSSL_EC_KEY_LOAD_PRIVATE 1
132#define WOLFSSL_EC_KEY_LOAD_PUBLIC 2
133
134WOLFSSL_API
135size_t wolfSSL_EC_get_builtin_curves(WOLFSSL_EC_BUILTIN_CURVE *r,size_t nitems);
136
137WOLFSSL_API
138WOLFSSL_EC_KEY *wolfSSL_EC_KEY_dup(const WOLFSSL_EC_KEY *src);
139
140WOLFSSL_API
141int wolfSSL_ECPoint_i2d(const WOLFSSL_EC_GROUP *curve,
142 const WOLFSSL_EC_POINT *p,
143 unsigned char *out, unsigned int *len);
144WOLFSSL_API
145int wolfSSL_ECPoint_d2i(unsigned char *in, unsigned int len,
146 const WOLFSSL_EC_GROUP *curve, WOLFSSL_EC_POINT *p);
147WOLFSSL_API
148size_t wolfSSL_EC_POINT_point2oct(const WOLFSSL_EC_GROUP *group,
149 const WOLFSSL_EC_POINT *p,
150 char form,
151 byte *buf, size_t len, WOLFSSL_BN_CTX *ctx);
152WOLFSSL_API
153int wolfSSL_EC_POINT_oct2point(const WOLFSSL_EC_GROUP *group,
154 WOLFSSL_EC_POINT *p, const unsigned char *buf,
155 size_t len, WOLFSSL_BN_CTX *ctx);
156WOLFSSL_API
157int wolfSSL_i2o_ECPublicKey(const WOLFSSL_EC_KEY *in, unsigned char **out);
158WOLFSSL_API
159WOLFSSL_EC_KEY *wolfSSL_d2i_ECPrivateKey(WOLFSSL_EC_KEY **key, const unsigned char **in,
160 long len);
161WOLFSSL_API
162int wolfSSL_i2d_ECPrivateKey(const WOLFSSL_EC_KEY *in, unsigned char **out);
163WOLFSSL_API
164void wolfSSL_EC_KEY_set_conv_form(WOLFSSL_EC_KEY *eckey, char form);
165WOLFSSL_API
166WOLFSSL_BIGNUM *wolfSSL_EC_POINT_point2bn(const WOLFSSL_EC_GROUP *group,
167 const WOLFSSL_EC_POINT *p,
168 char form,
169 WOLFSSL_BIGNUM *in, WOLFSSL_BN_CTX *ctx);
170WOLFSSL_API
171int wolfSSL_EC_POINT_is_on_curve(const WOLFSSL_EC_GROUP *group,
172 const WOLFSSL_EC_POINT *point,
173 WOLFSSL_BN_CTX *ctx);
174
175WOLFSSL_API
176int wolfSSL_EC_KEY_LoadDer(WOLFSSL_EC_KEY* key,
177 const unsigned char* der, int derSz);
178WOLFSSL_API
179int wolfSSL_EC_KEY_LoadDer_ex(WOLFSSL_EC_KEY* key,
180 const unsigned char* der, int derSz, int opt);
181WOLFSSL_API
182void wolfSSL_EC_KEY_free(WOLFSSL_EC_KEY *key);
183WOLFSSL_API
184WOLFSSL_EC_POINT *wolfSSL_EC_KEY_get0_public_key(const WOLFSSL_EC_KEY *key);
185WOLFSSL_API
186const WOLFSSL_EC_GROUP *wolfSSL_EC_KEY_get0_group(const WOLFSSL_EC_KEY *key);
187WOLFSSL_API
188int wolfSSL_EC_KEY_set_private_key(WOLFSSL_EC_KEY *key,
189 const WOLFSSL_BIGNUM *priv_key);
190WOLFSSL_API
191WOLFSSL_BIGNUM *wolfSSL_EC_KEY_get0_private_key(const WOLFSSL_EC_KEY *key);
192WOLFSSL_API
193WOLFSSL_EC_KEY *wolfSSL_EC_KEY_new_by_curve_name(int nid);
194WOLFSSL_API const char* wolfSSL_EC_curve_nid2nist(int nid);
195WOLFSSL_API int wolfSSL_EC_curve_nist2nid(const char* name);
196WOLFSSL_API
197WOLFSSL_EC_KEY *wolfSSL_EC_KEY_new(void);
198WOLFSSL_API
199int wolfSSL_EC_KEY_set_group(WOLFSSL_EC_KEY *key, WOLFSSL_EC_GROUP *group);
200WOLFSSL_API
201int wolfSSL_EC_KEY_generate_key(WOLFSSL_EC_KEY *key);
202WOLFSSL_API
203void wolfSSL_EC_KEY_set_asn1_flag(WOLFSSL_EC_KEY *key, int asn1_flag);
204WOLFSSL_API
205int wolfSSL_EC_KEY_set_public_key(WOLFSSL_EC_KEY *key,
206 const WOLFSSL_EC_POINT *pub);
207WOLFSSL_API int wolfSSL_ECDSA_size(const WOLFSSL_EC_KEY *key);
208WOLFSSL_API int wolfSSL_ECDSA_sign(int type, const unsigned char *digest,
209 int digestSz, unsigned char *sig,
210 unsigned int *sigSz, WOLFSSL_EC_KEY *key);
211WOLFSSL_API
212void wolfSSL_EC_GROUP_set_asn1_flag(WOLFSSL_EC_GROUP *group, int flag);
213WOLFSSL_API
214WOLFSSL_EC_GROUP *wolfSSL_EC_GROUP_new_by_curve_name(int nid);
215WOLFSSL_API
216int wolfSSL_EC_GROUP_cmp(const WOLFSSL_EC_GROUP *a, const WOLFSSL_EC_GROUP *b,
217 WOLFSSL_BN_CTX *ctx);
218WOLFSSL_API
219WOLFSSL_EC_GROUP *wolfSSL_EC_GROUP_dup(const WOLFSSL_EC_GROUP *src);
220WOLFSSL_API
221int wolfSSL_EC_GROUP_get_curve_name(const WOLFSSL_EC_GROUP *group);
222WOLFSSL_API
223int wolfSSL_EC_GROUP_get_degree(const WOLFSSL_EC_GROUP *group);
224WOLFSSL_API
225int wolfSSL_EC_GROUP_get_order(const WOLFSSL_EC_GROUP *group,
226 WOLFSSL_BIGNUM *order, WOLFSSL_BN_CTX *ctx);
227WOLFSSL_API
228int wolfSSL_EC_GROUP_order_bits(const WOLFSSL_EC_GROUP *group);
229WOLFSSL_API
230void wolfSSL_EC_GROUP_free(WOLFSSL_EC_GROUP *group);
231WOLFSSL_API
232const WOLFSSL_EC_METHOD* wolfSSL_EC_GROUP_method_of(
233 const WOLFSSL_EC_GROUP *group);
234WOLFSSL_API
235int wolfSSL_EC_METHOD_get_field_type(const WOLFSSL_EC_METHOD *meth);
236WOLFSSL_API
237WOLFSSL_EC_POINT *wolfSSL_EC_POINT_new(const WOLFSSL_EC_GROUP *group);
238WOLFSSL_API
239int wolfSSL_EC_POINT_get_affine_coordinates_GFp(const WOLFSSL_EC_GROUP *group,
240 const WOLFSSL_EC_POINT *p,
241 WOLFSSL_BIGNUM *x,
242 WOLFSSL_BIGNUM *y,
243 WOLFSSL_BN_CTX *ctx);
244WOLFSSL_API
245int wolfSSL_EC_POINT_set_affine_coordinates_GFp(const WOLFSSL_EC_GROUP *group,
246 WOLFSSL_EC_POINT *point,
247 const WOLFSSL_BIGNUM *x,
248 const WOLFSSL_BIGNUM *y,
249 WOLFSSL_BN_CTX *ctx);
250WOLFSSL_API
251int wolfSSL_EC_POINT_add(const WOLFSSL_EC_GROUP *group, WOLFSSL_EC_POINT *r,
252 const WOLFSSL_EC_POINT *p1,
253 const WOLFSSL_EC_POINT *p2, WOLFSSL_BN_CTX *ctx);
254WOLFSSL_API
255int wolfSSL_EC_POINT_mul(const WOLFSSL_EC_GROUP *group, WOLFSSL_EC_POINT *r,
256 const WOLFSSL_BIGNUM *n,
257 const WOLFSSL_EC_POINT *q, const WOLFSSL_BIGNUM *m,
258 WOLFSSL_BN_CTX *ctx);
259WOLFSSL_API
260int wolfSSL_EC_POINT_invert(const WOLFSSL_EC_GROUP *group, WOLFSSL_EC_POINT *a,
261 WOLFSSL_BN_CTX *ctx);
262WOLFSSL_API
263void wolfSSL_EC_POINT_clear_free(WOLFSSL_EC_POINT *point);
264WOLFSSL_API
265int wolfSSL_EC_POINT_cmp(const WOLFSSL_EC_GROUP *group,
266 const WOLFSSL_EC_POINT *a, const WOLFSSL_EC_POINT *b,
267 WOLFSSL_BN_CTX *ctx);
268WOLFSSL_API int wolfSSL_EC_POINT_copy(WOLFSSL_EC_POINT *dest,
269 const WOLFSSL_EC_POINT *src);
270WOLFSSL_API
271void wolfSSL_EC_POINT_free(WOLFSSL_EC_POINT *point);
272WOLFSSL_API
273int wolfSSL_EC_POINT_is_at_infinity(const WOLFSSL_EC_GROUP *group,
274 const WOLFSSL_EC_POINT *a);
275
276#ifndef HAVE_SELFTEST
277WOLFSSL_API
278char* wolfSSL_EC_POINT_point2hex(const WOLFSSL_EC_GROUP* group,
279 const WOLFSSL_EC_POINT* point, int form,
280 WOLFSSL_BN_CTX* ctx);
281#endif
282
283#ifndef HAVE_ECC
284#define OPENSSL_NO_EC
285#endif
286
287#define EC_KEY_new wolfSSL_EC_KEY_new
288#define EC_KEY_free wolfSSL_EC_KEY_free
289#define EC_KEY_dup wolfSSL_EC_KEY_dup
290#define EC_KEY_get0_public_key wolfSSL_EC_KEY_get0_public_key
291#define EC_KEY_get0_group wolfSSL_EC_KEY_get0_group
292#define EC_KEY_set_private_key wolfSSL_EC_KEY_set_private_key
293#define EC_KEY_get0_private_key wolfSSL_EC_KEY_get0_private_key
294#define EC_KEY_new_by_curve_name wolfSSL_EC_KEY_new_by_curve_name
295#define EC_KEY_set_group wolfSSL_EC_KEY_set_group
296#define EC_KEY_generate_key wolfSSL_EC_KEY_generate_key
297#define EC_KEY_set_asn1_flag wolfSSL_EC_KEY_set_asn1_flag
298#define EC_KEY_set_public_key wolfSSL_EC_KEY_set_public_key
299
300#define ECDSA_size wolfSSL_ECDSA_size
301#define ECDSA_sign wolfSSL_ECDSA_sign
302
303#define EC_GROUP_free wolfSSL_EC_GROUP_free
304#define EC_GROUP_set_asn1_flag wolfSSL_EC_GROUP_set_asn1_flag
305#define EC_GROUP_new_by_curve_name wolfSSL_EC_GROUP_new_by_curve_name
306#define EC_GROUP_cmp wolfSSL_EC_GROUP_cmp
307#define EC_GROUP_dup wolfSSL_EC_GROUP_dup
308#define EC_GROUP_get_curve_name wolfSSL_EC_GROUP_get_curve_name
309#define EC_GROUP_get_degree wolfSSL_EC_GROUP_get_degree
310#define EC_GROUP_get_order wolfSSL_EC_GROUP_get_order
311#define EC_GROUP_order_bits wolfSSL_EC_GROUP_order_bits
312#define EC_GROUP_method_of wolfSSL_EC_GROUP_method_of
313#ifndef NO_WOLFSSL_STUB
314#define EC_GROUP_set_point_conversion_form(...)
315#endif
316
317#define EC_METHOD_get_field_type wolfSSL_EC_METHOD_get_field_type
318
319#define EC_POINT_new wolfSSL_EC_POINT_new
320#define EC_POINT_free wolfSSL_EC_POINT_free
321#define EC_POINT_get_affine_coordinates_GFp \
322 wolfSSL_EC_POINT_get_affine_coordinates_GFp
323#define EC_POINT_set_affine_coordinates_GFp \
324 wolfSSL_EC_POINT_set_affine_coordinates_GFp
325#define EC_POINT_add wolfSSL_EC_POINT_add
326#define EC_POINT_mul wolfSSL_EC_POINT_mul
327#define EC_POINT_invert wolfSSL_EC_POINT_invert
328#define EC_POINT_clear_free wolfSSL_EC_POINT_clear_free
329#define EC_POINT_cmp wolfSSL_EC_POINT_cmp
330#define EC_POINT_copy wolfSSL_EC_POINT_copy
331#define EC_POINT_is_at_infinity wolfSSL_EC_POINT_is_at_infinity
332
333#define EC_get_builtin_curves wolfSSL_EC_get_builtin_curves
334
335#define ECPoint_i2d wolfSSL_ECPoint_i2d
336#define ECPoint_d2i wolfSSL_ECPoint_d2i
337#define EC_POINT_point2oct wolfSSL_EC_POINT_point2oct
338#define EC_POINT_oct2point wolfSSL_EC_POINT_oct2point
339#define EC_POINT_point2bn wolfSSL_EC_POINT_point2bn
340#define EC_POINT_is_on_curve wolfSSL_EC_POINT_is_on_curve
341#define i2o_ECPublicKey wolfSSL_i2o_ECPublicKey
342#define i2d_EC_PUBKEY wolfSSL_i2o_ECPublicKey
343#define d2i_ECPrivateKey wolfSSL_d2i_ECPrivateKey
344#define i2d_ECPrivateKey wolfSSL_i2d_ECPrivateKey
345#define EC_KEY_set_conv_form wolfSSL_EC_KEY_set_conv_form
346
347#ifndef HAVE_SELFTEST
348 #define EC_POINT_point2hex wolfSSL_EC_POINT_point2hex
349#endif
350
351#define EC_POINT_dump wolfSSL_EC_POINT_dump
352#define EC_get_builtin_curves wolfSSL_EC_get_builtin_curves
353
354#define EC_curve_nid2nist wolfSSL_EC_curve_nid2nist
355#define EC_curve_nist2nid wolfSSL_EC_curve_nist2nid
356
357#ifdef __cplusplus
358} /* extern "C" */
359#endif
360
361#endif /* header */