ec.h
1 /* ec.h
2  *
3  * Copyright (C) 2006-2020 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/ecc.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /* Map OpenSSL NID value */
35 enum {
36  POINT_CONVERSION_COMPRESSED = 2,
37  POINT_CONVERSION_UNCOMPRESSED = 4,
38 
39 #ifdef HAVE_ECC
40  /* Use OpenSSL NIDs. NIDs can be mapped to ecc_curve_id enum values by
41  calling NIDToEccEnum() in ssl.c */
42  NID_X9_62_prime192v1 = 409,
43  NID_X9_62_prime192v2 = 410,
44  NID_X9_62_prime192v3 = 411,
45  NID_X9_62_prime239v1 = 412,
46  NID_X9_62_prime239v2 = 413,
47  NID_X9_62_prime239v3 = 414,
48  NID_X9_62_prime256v1 = 415,
49  NID_secp112r1 = 704,
50  NID_secp112r2 = 705,
51  NID_secp128r1 = 706,
52  NID_secp128r2 = 707,
53  NID_secp160r1 = 709,
54  NID_secp160r2 = 710,
55  NID_secp224r1 = 713,
56  NID_secp384r1 = 715,
57  NID_secp521r1 = 716,
58  NID_secp160k1 = 708,
59  NID_secp192k1 = 711,
60  NID_secp224k1 = 712,
61  NID_secp256k1 = 714,
62  NID_brainpoolP160r1 = 921,
63  NID_brainpoolP192r1 = 923,
64  NID_brainpoolP224r1 = 925,
65  NID_brainpoolP256r1 = 927,
66  NID_brainpoolP320r1 = 929,
67  NID_brainpoolP384r1 = 931,
68  NID_brainpoolP512r1 = 933,
69 #endif
70 
71  OPENSSL_EC_NAMED_CURVE = 0x001
72 };
73 
74 #ifndef WOLFSSL_EC_TYPE_DEFINED /* guard on redeclaration */
75 typedef struct WOLFSSL_EC_KEY WOLFSSL_EC_KEY;
76 typedef struct WOLFSSL_EC_POINT WOLFSSL_EC_POINT;
77 typedef struct WOLFSSL_EC_GROUP WOLFSSL_EC_GROUP;
78 typedef struct WOLFSSL_EC_BUILTIN_CURVE WOLFSSL_EC_BUILTIN_CURVE;
79 /* WOLFSSL_EC_METHOD is just an alias of WOLFSSL_EC_GROUP for now */
80 typedef struct WOLFSSL_EC_GROUP WOLFSSL_EC_METHOD;
81 #define WOLFSSL_EC_TYPE_DEFINED
82 #endif
83 
84 typedef WOLFSSL_EC_KEY EC_KEY;
85 typedef WOLFSSL_EC_GROUP EC_GROUP;
86 typedef WOLFSSL_EC_GROUP EC_METHOD;
87 typedef WOLFSSL_EC_POINT EC_POINT;
88 typedef WOLFSSL_EC_BUILTIN_CURVE EC_builtin_curve;
89 
90 struct WOLFSSL_EC_POINT {
91  WOLFSSL_BIGNUM *X;
92  WOLFSSL_BIGNUM *Y;
93  WOLFSSL_BIGNUM *Z;
94 
95  void* internal; /* our ECC point */
96  char inSet; /* internal set from external ? */
97  char exSet; /* external set from internal ? */
98 };
99 
100 struct WOLFSSL_EC_GROUP {
101  int curve_idx; /* index of curve, used by WolfSSL as reference */
102  int curve_nid; /* NID of curve, used by OpenSSL/OpenSSH as reference */
103  int curve_oid; /* OID of curve, used by OpenSSL/OpenSSH as reference */
104 };
105 
106 struct WOLFSSL_EC_KEY {
107  WOLFSSL_EC_GROUP *group;
108  WOLFSSL_EC_POINT *pub_key;
109  WOLFSSL_BIGNUM *priv_key;
110 
111  void* internal; /* our ECC Key */
112  char inSet; /* internal set from external ? */
113  char exSet; /* external set from internal ? */
114  char form; /* Either POINT_CONVERSION_UNCOMPRESSED or
115  * POINT_CONVERSION_COMPRESSED */
116 };
117 
118 struct WOLFSSL_EC_BUILTIN_CURVE {
119  int nid;
120  const char *comment;
121 };
122 
123 #define WOLFSSL_EC_KEY_LOAD_PRIVATE 1
124 #define WOLFSSL_EC_KEY_LOAD_PUBLIC 2
125 
126 WOLFSSL_API
127 size_t wolfSSL_EC_get_builtin_curves(WOLFSSL_EC_BUILTIN_CURVE *r,size_t nitems);
128 
129 WOLFSSL_API
130 WOLFSSL_EC_KEY *wolfSSL_EC_KEY_dup(const WOLFSSL_EC_KEY *src);
131 
132 WOLFSSL_API
133 int wolfSSL_ECPoint_i2d(const WOLFSSL_EC_GROUP *curve,
134  const WOLFSSL_EC_POINT *p,
135  unsigned char *out, unsigned int *len);
136 WOLFSSL_API
137 int wolfSSL_ECPoint_d2i(unsigned char *in, unsigned int len,
138  const WOLFSSL_EC_GROUP *curve, WOLFSSL_EC_POINT *p);
139 WOLFSSL_API
140 size_t wolfSSL_EC_POINT_point2oct(const WOLFSSL_EC_GROUP *group,
141  const WOLFSSL_EC_POINT *p,
142  char form,
143  byte *buf, size_t len, WOLFSSL_BN_CTX *ctx);
144 WOLFSSL_API
145 int wolfSSL_EC_POINT_oct2point(const WOLFSSL_EC_GROUP *group,
146  WOLFSSL_EC_POINT *p, const unsigned char *buf,
147  size_t len, WOLFSSL_BN_CTX *ctx);
148 WOLFSSL_API
149 int wolfSSL_i2o_ECPublicKey(const WOLFSSL_EC_KEY *in, unsigned char **out);
150 WOLFSSL_API
151 void wolfSSL_EC_KEY_set_conv_form(WOLFSSL_EC_KEY *eckey, char form);
152 WOLFSSL_API
153 WOLFSSL_BIGNUM *wolfSSL_EC_POINT_point2bn(const WOLFSSL_EC_GROUP *group,
154  const WOLFSSL_EC_POINT *p,
155  char form,
156  WOLFSSL_BIGNUM *in, WOLFSSL_BN_CTX *ctx);
157 
158 WOLFSSL_API
159 int wolfSSL_EC_KEY_LoadDer(WOLFSSL_EC_KEY* key,
160  const unsigned char* der, int derSz);
161 WOLFSSL_API
162 int wolfSSL_EC_KEY_LoadDer_ex(WOLFSSL_EC_KEY* key,
163  const unsigned char* der, int derSz, int opt);
164 WOLFSSL_API
165 void wolfSSL_EC_KEY_free(WOLFSSL_EC_KEY *key);
166 WOLFSSL_API
167 WOLFSSL_EC_POINT *wolfSSL_EC_KEY_get0_public_key(const WOLFSSL_EC_KEY *key);
168 WOLFSSL_API
169 const WOLFSSL_EC_GROUP *wolfSSL_EC_KEY_get0_group(const WOLFSSL_EC_KEY *key);
170 WOLFSSL_API
171 int wolfSSL_EC_KEY_set_private_key(WOLFSSL_EC_KEY *key,
172  const WOLFSSL_BIGNUM *priv_key);
173 WOLFSSL_API
174 WOLFSSL_BIGNUM *wolfSSL_EC_KEY_get0_private_key(const WOLFSSL_EC_KEY *key);
175 WOLFSSL_API
176 WOLFSSL_EC_KEY *wolfSSL_EC_KEY_new_by_curve_name(int nid);
177 WOLFSSL_API const char* wolfSSL_EC_curve_nid2nist(int nid);
178 WOLFSSL_API
179 WOLFSSL_EC_KEY *wolfSSL_EC_KEY_new(void);
180 WOLFSSL_API
181 int wolfSSL_EC_KEY_set_group(WOLFSSL_EC_KEY *key, WOLFSSL_EC_GROUP *group);
182 WOLFSSL_API
183 int wolfSSL_EC_KEY_generate_key(WOLFSSL_EC_KEY *key);
184 WOLFSSL_API
185 void wolfSSL_EC_KEY_set_asn1_flag(WOLFSSL_EC_KEY *key, int asn1_flag);
186 WOLFSSL_API
187 int wolfSSL_EC_KEY_set_public_key(WOLFSSL_EC_KEY *key,
188  const WOLFSSL_EC_POINT *pub);
189 WOLFSSL_API int wolfSSL_ECDSA_size(const WOLFSSL_EC_KEY *key);
190 WOLFSSL_API int wolfSSL_ECDSA_sign(int type, const unsigned char *digest,
191  int digestSz, unsigned char *sig,
192  unsigned int *sigSz, WOLFSSL_EC_KEY *key);
193 WOLFSSL_API
194 void wolfSSL_EC_GROUP_set_asn1_flag(WOLFSSL_EC_GROUP *group, int flag);
195 WOLFSSL_API
196 WOLFSSL_EC_GROUP *wolfSSL_EC_GROUP_new_by_curve_name(int nid);
197 WOLFSSL_API
198 int wolfSSL_EC_GROUP_cmp(const WOLFSSL_EC_GROUP *a, const WOLFSSL_EC_GROUP *b,
199  WOLFSSL_BN_CTX *ctx);
200 WOLFSSL_API
201 int wolfSSL_EC_GROUP_get_curve_name(const WOLFSSL_EC_GROUP *group);
202 WOLFSSL_API
203 int wolfSSL_EC_GROUP_get_degree(const WOLFSSL_EC_GROUP *group);
204 WOLFSSL_API
205 int wolfSSL_EC_GROUP_get_order(const WOLFSSL_EC_GROUP *group,
206  WOLFSSL_BIGNUM *order, WOLFSSL_BN_CTX *ctx);
207 WOLFSSL_API
208 int wolfSSL_EC_GROUP_order_bits(const WOLFSSL_EC_GROUP *group);
209 WOLFSSL_API
210 void wolfSSL_EC_GROUP_free(WOLFSSL_EC_GROUP *group);
211 WOLFSSL_API
212 const WOLFSSL_EC_METHOD* wolfSSL_EC_GROUP_method_of(
213  const WOLFSSL_EC_GROUP *group);
214 WOLFSSL_API
215 int wolfSSL_EC_METHOD_get_field_type(const WOLFSSL_EC_METHOD *meth);
216 WOLFSSL_API
217 WOLFSSL_EC_POINT *wolfSSL_EC_POINT_new(const WOLFSSL_EC_GROUP *group);
218 WOLFSSL_API
219 int wolfSSL_EC_POINT_get_affine_coordinates_GFp(const WOLFSSL_EC_GROUP *group,
220  const WOLFSSL_EC_POINT *p,
221  WOLFSSL_BIGNUM *x,
222  WOLFSSL_BIGNUM *y,
223  WOLFSSL_BN_CTX *ctx);
224 WOLFSSL_API
225 int wolfSSL_EC_POINT_set_affine_coordinates_GFp(const WOLFSSL_EC_GROUP *group,
226  WOLFSSL_EC_POINT *point,
227  const WOLFSSL_BIGNUM *x,
228  const WOLFSSL_BIGNUM *y,
229  WOLFSSL_BN_CTX *ctx);
230 WOLFSSL_API
231 int wolfSSL_EC_POINT_mul(const WOLFSSL_EC_GROUP *group, WOLFSSL_EC_POINT *r,
232  const WOLFSSL_BIGNUM *n,
233  const WOLFSSL_EC_POINT *q, const WOLFSSL_BIGNUM *m,
234  WOLFSSL_BN_CTX *ctx);
235 WOLFSSL_API
236 void wolfSSL_EC_POINT_clear_free(WOLFSSL_EC_POINT *point);
237 WOLFSSL_API
238 int wolfSSL_EC_POINT_cmp(const WOLFSSL_EC_GROUP *group,
239  const WOLFSSL_EC_POINT *a, const WOLFSSL_EC_POINT *b,
240  WOLFSSL_BN_CTX *ctx);
241 WOLFSSL_API int wolfSSL_EC_POINT_copy(WOLFSSL_EC_POINT *dest,
242  const WOLFSSL_EC_POINT *src);
243 WOLFSSL_API
244 void wolfSSL_EC_POINT_free(WOLFSSL_EC_POINT *point);
245 WOLFSSL_API
246 int wolfSSL_EC_POINT_is_at_infinity(const WOLFSSL_EC_GROUP *group,
247  const WOLFSSL_EC_POINT *a);
248 
249 #ifndef HAVE_SELFTEST
250 WOLFSSL_API
251 char* wolfSSL_EC_POINT_point2hex(const WOLFSSL_EC_GROUP* group,
252  const WOLFSSL_EC_POINT* point, int form,
253  WOLFSSL_BN_CTX* ctx);
254 #endif
255 
256 #ifndef HAVE_ECC
257 #define OPENSSL_NO_EC
258 #endif
259 
260 #define EC_KEY_new wolfSSL_EC_KEY_new
261 #define EC_KEY_free wolfSSL_EC_KEY_free
262 #define EC_KEY_dup wolfSSL_EC_KEY_dup
263 #define EC_KEY_get0_public_key wolfSSL_EC_KEY_get0_public_key
264 #define EC_KEY_get0_group wolfSSL_EC_KEY_get0_group
265 #define EC_KEY_set_private_key wolfSSL_EC_KEY_set_private_key
266 #define EC_KEY_get0_private_key wolfSSL_EC_KEY_get0_private_key
267 #define EC_KEY_new_by_curve_name wolfSSL_EC_KEY_new_by_curve_name
268 #define EC_KEY_set_group wolfSSL_EC_KEY_set_group
269 #define EC_KEY_generate_key wolfSSL_EC_KEY_generate_key
270 #define EC_KEY_set_asn1_flag wolfSSL_EC_KEY_set_asn1_flag
271 #define EC_KEY_set_public_key wolfSSL_EC_KEY_set_public_key
272 
273 #define ECDSA_size wolfSSL_ECDSA_size
274 #define ECDSA_sign wolfSSL_ECDSA_sign
275 
276 #define EC_GROUP_free wolfSSL_EC_GROUP_free
277 #define EC_GROUP_set_asn1_flag wolfSSL_EC_GROUP_set_asn1_flag
278 #define EC_GROUP_new_by_curve_name wolfSSL_EC_GROUP_new_by_curve_name
279 #define EC_GROUP_cmp wolfSSL_EC_GROUP_cmp
280 #define EC_GROUP_get_curve_name wolfSSL_EC_GROUP_get_curve_name
281 #define EC_GROUP_get_degree wolfSSL_EC_GROUP_get_degree
282 #define EC_GROUP_get_order wolfSSL_EC_GROUP_get_order
283 #define EC_GROUP_order_bits wolfSSL_EC_GROUP_order_bits
284 #define EC_GROUP_method_of wolfSSL_EC_GROUP_method_of
285 
286 #define EC_METHOD_get_field_type wolfSSL_EC_METHOD_get_field_type
287 
288 #define EC_POINT_new wolfSSL_EC_POINT_new
289 #define EC_POINT_free wolfSSL_EC_POINT_free
290 #define EC_POINT_get_affine_coordinates_GFp \
291  wolfSSL_EC_POINT_get_affine_coordinates_GFp
292 #define EC_POINT_set_affine_coordinates_GFp \
293  wolfSSL_EC_POINT_set_affine_coordinates_GFp
294 #define EC_POINT_mul wolfSSL_EC_POINT_mul
295 #define EC_POINT_clear_free wolfSSL_EC_POINT_clear_free
296 #define EC_POINT_cmp wolfSSL_EC_POINT_cmp
297 #define EC_POINT_copy wolfSSL_EC_POINT_copy
298 #define EC_POINT_is_at_infinity wolfSSL_EC_POINT_is_at_infinity
299 
300 #define EC_get_builtin_curves wolfSSL_EC_get_builtin_curves
301 
302 #define ECPoint_i2d wolfSSL_ECPoint_i2d
303 #define ECPoint_d2i wolfSSL_ECPoint_d2i
304 #define EC_POINT_point2oct wolfSSL_EC_POINT_point2oct
305 #define EC_POINT_oct2point wolfSSL_EC_POINT_oct2point
306 #define EC_POINT_point2bn wolfSSL_EC_POINT_point2bn
307 #define i2o_ECPublicKey wolfSSL_i2o_ECPublicKey
308 #define EC_KEY_set_conv_form wolfSSL_EC_KEY_set_conv_form
309 
310 #ifndef HAVE_SELFTEST
311  #define EC_POINT_point2hex wolfSSL_EC_POINT_point2hex
312 #endif
313 
314 #define EC_POINT_dump wolfSSL_EC_POINT_dump
315 #define EC_get_builtin_curves wolfSSL_EC_get_builtin_curves
316 
317 #define EC_curve_nid2nist wolfSSL_EC_curve_nid2nist
318 
319 #ifdef __cplusplus
320 } /* extern "C" */
321 #endif
322 
323 #endif /* header */
WOLFSSL_EC_BUILTIN_CURVE
Definition: ec.h:118
bn.h
bn.h for openssl
WOLFSSL_EC_KEY
Definition: ec.h:106
WOLFSSL_EC_POINT
Definition: ec.h:90
WOLFSSL_EC_GROUP
Definition: ec.h:100