]>
Commit | Line | Data |
---|---|---|
65e81670 | 1 | /* crypto/ec/ec.h */ |
35b73a1f BM |
2 | /* |
3 | * Originally written by Bodo Moeller for the OpenSSL project. | |
4 | */ | |
ba12070f NL |
5 | /** |
6 | * \file crypto/ec/ec.h Include file for the OpenSSL EC functions | |
7 | * \author Originally written by Bodo Moeller for the OpenSSL project | |
8 | */ | |
65e81670 | 9 | /* ==================================================================== |
ba12070f | 10 | * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved. |
6cc5e19d | 11 | * |
65e81670 BM |
12 | * Redistribution and use in source and binary forms, with or without |
13 | * modification, are permitted provided that the following conditions | |
14 | * are met: | |
6cc5e19d | 15 | * |
65e81670 BM |
16 | * 1. Redistributions of source code must retain the above copyright |
17 | * notice, this list of conditions and the following disclaimer. | |
6cc5e19d | 18 | * |
65e81670 BM |
19 | * 2. Redistributions in binary form must reproduce the above copyright |
20 | * notice, this list of conditions and the following disclaimer in | |
21 | * the documentation and/or other materials provided with the | |
22 | * distribution. | |
6cc5e19d | 23 | * |
65e81670 BM |
24 | * 3. All advertising materials mentioning features or use of this |
25 | * software must display the following acknowledgment: | |
26 | * "This product includes software developed by the OpenSSL Project | |
27 | * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | |
28 | * | |
29 | * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | |
30 | * endorse or promote products derived from this software without | |
31 | * prior written permission. For written permission, please contact | |
32 | * openssl-core@openssl.org. | |
33 | * | |
34 | * 5. Products derived from this software may not be called "OpenSSL" | |
35 | * nor may "OpenSSL" appear in their names without prior written | |
36 | * permission of the OpenSSL Project. | |
37 | * | |
38 | * 6. Redistributions of any form whatsoever must retain the following | |
39 | * acknowledgment: | |
40 | * "This product includes software developed by the OpenSSL Project | |
41 | * for use in the OpenSSL Toolkit (http://www.openssl.org/)" | |
42 | * | |
43 | * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | |
44 | * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
45 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |
46 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | |
47 | * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
48 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
49 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |
50 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
51 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
52 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
53 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | |
54 | * OF THE POSSIBILITY OF SUCH DAMAGE. | |
55 | * ==================================================================== | |
56 | * | |
57 | * This product includes cryptographic software written by Eric Young | |
58 | * (eay@cryptsoft.com). This product includes software written by Tim | |
59 | * Hudson (tjh@cryptsoft.com). | |
6cc5e19d BM |
60 | * |
61 | */ | |
7793f30e BM |
62 | /* ==================================================================== |
63 | * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. | |
64 | * | |
65 | * Portions of the attached software ("Contribution") are developed by | |
66 | * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project. | |
67 | * | |
68 | * The Contribution is licensed pursuant to the OpenSSL open source | |
69 | * license provided above. | |
70 | * | |
7793f30e BM |
71 | * The elliptic curve binary polynomial software is originally written by |
72 | * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories. | |
73 | * | |
74 | */ | |
6cc5e19d | 75 | |
6cc5e19d BM |
76 | #ifndef HEADER_EC_H |
77 | #define HEADER_EC_H | |
78 | ||
87c9c659 RL |
79 | #include <openssl/opensslconf.h> |
80 | ||
bb62a8b0 | 81 | #ifdef OPENSSL_NO_EC |
37da54b1 | 82 | #error EC is disabled. |
bb62a8b0 BM |
83 | #endif |
84 | ||
458c2917 | 85 | #include <openssl/asn1.h> |
0e995464 | 86 | #include <openssl/symhacks.h> |
0f814687 GT |
87 | #ifndef OPENSSL_NO_DEPRECATED |
88 | #include <openssl/bn.h> | |
89 | #endif | |
6cc5e19d | 90 | |
65e81670 BM |
91 | #ifdef __cplusplus |
92 | extern "C" { | |
7f24b1c3 AP |
93 | #elif defined(__SUNPRO_C) |
94 | # if __SUNPRO_C >= 0x520 | |
95 | # pragma error_messages (off,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE) | |
96 | # endif | |
65e81670 | 97 | #endif |
6cc5e19d | 98 | |
5e3225cc BM |
99 | |
100 | #ifndef OPENSSL_ECC_MAX_FIELD_BITS | |
101 | # define OPENSSL_ECC_MAX_FIELD_BITS 661 | |
102 | #endif | |
103 | ||
ba12070f NL |
104 | /** Enum for the point conversion form as defined in X9.62 (ECDSA) |
105 | * for the encoding of a elliptic curve point (x,y) */ | |
3a12ce01 | 106 | typedef enum { |
ba12070f NL |
107 | /** the point is encoded as z||x, where the octet z specifies |
108 | * which solution of the quadratic equation y is */ | |
3a12ce01 | 109 | POINT_CONVERSION_COMPRESSED = 2, |
ba12070f | 110 | /** the point is encoded as z||x||y, where z is the octet 0x02 */ |
3a12ce01 | 111 | POINT_CONVERSION_UNCOMPRESSED = 4, |
ba12070f NL |
112 | /** the point is encoded as z||x||y, where the octet z specifies |
113 | * which solution of the quadratic equation y is */ | |
3a12ce01 BM |
114 | POINT_CONVERSION_HYBRID = 6 |
115 | } point_conversion_form_t; | |
116 | ||
117 | ||
118 | typedef struct ec_method_st EC_METHOD; | |
119 | ||
120 | typedef struct ec_group_st | |
121 | /* | |
122 | EC_METHOD *meth; | |
123 | -- field definition | |
124 | -- curve coefficients | |
125 | -- optional generator with associated information (order, cofactor) | |
37c660ff | 126 | -- optional extra data (precomputed table for fast computation of multiples of generator) |
5f3d6f70 | 127 | -- ASN1 stuff |
3a12ce01 BM |
128 | */ |
129 | EC_GROUP; | |
130 | ||
131 | typedef struct ec_point_st EC_POINT; | |
132 | ||
133 | ||
ba12070f NL |
134 | /********************************************************************/ |
135 | /* EC_METHODs for curves over GF(p) */ | |
136 | /********************************************************************/ | |
137 | ||
138 | /** Returns the basic GFp ec methods which provides the basis for the | |
139 | * optimized methods. | |
140 | * \return EC_METHOD object | |
3a12ce01 | 141 | */ |
3a12ce01 | 142 | const EC_METHOD *EC_GFp_simple_method(void); |
ba12070f NL |
143 | |
144 | /** Returns GFp methods using montgomery multiplication. | |
145 | * \return EC_METHOD object | |
146 | */ | |
3a12ce01 | 147 | const EC_METHOD *EC_GFp_mont_method(void); |
ba12070f NL |
148 | |
149 | /** Returns GFp methods using optimized methods for NIST recommended curves | |
150 | * \return EC_METHOD object | |
151 | */ | |
5c6bf031 | 152 | const EC_METHOD *EC_GFp_nist_method(void); |
3a12ce01 | 153 | |
e0d6132b | 154 | #ifndef OPENSSL_NO_EC_NISTP_64_GCC_128 |
3e00b4c9 | 155 | #ifndef OPENSSL_SYS_WIN32 |
04daec86 BM |
156 | /** Returns 64-bit optimized methods for nistp224 |
157 | * \return EC_METHOD object | |
158 | */ | |
159 | const EC_METHOD *EC_GFp_nistp224_method(void); | |
3e00b4c9 BM |
160 | |
161 | /** Returns 64-bit optimized methods for nistp256 | |
162 | * \return EC_METHOD object | |
163 | */ | |
164 | const EC_METHOD *EC_GFp_nistp256_method(void); | |
165 | ||
166 | /** Returns 64-bit optimized methods for nistp521 | |
167 | * \return EC_METHOD object | |
168 | */ | |
169 | const EC_METHOD *EC_GFp_nistp521_method(void); | |
04daec86 | 170 | #endif |
65847ca3 | 171 | #endif |
ba12070f | 172 | |
b3310161 | 173 | #ifndef OPENSSL_NO_EC2M |
ba12070f NL |
174 | /********************************************************************/ |
175 | /* EC_METHOD for curves over GF(2^m) */ | |
176 | /********************************************************************/ | |
177 | ||
178 | /** Returns the basic GF2m ec method | |
179 | * \return EC_METHOD object | |
7793f30e BM |
180 | */ |
181 | const EC_METHOD *EC_GF2m_simple_method(void); | |
182 | ||
b3310161 DSH |
183 | #endif |
184 | ||
3a12ce01 | 185 | |
ba12070f NL |
186 | /********************************************************************/ |
187 | /* EC_GROUP functions */ | |
188 | /********************************************************************/ | |
189 | ||
190 | /** Creates a new EC_GROUP object | |
191 | * \param meth EC_METHOD to use | |
192 | * \return newly created EC_GROUP object or NULL in case of an error. | |
193 | */ | |
194 | EC_GROUP *EC_GROUP_new(const EC_METHOD *meth); | |
195 | ||
196 | /** Frees a EC_GROUP object | |
197 | * \param group EC_GROUP object to be freed. | |
198 | */ | |
199 | void EC_GROUP_free(EC_GROUP *group); | |
200 | ||
201 | /** Clears and frees a EC_GROUP object | |
202 | * \param group EC_GROUP object to be cleared and freed. | |
203 | */ | |
204 | void EC_GROUP_clear_free(EC_GROUP *group); | |
205 | ||
206 | /** Copies EC_GROUP objects. Note: both EC_GROUPs must use the same EC_METHOD. | |
207 | * \param dst destination EC_GROUP object | |
208 | * \param src source EC_GROUP object | |
209 | * \return 1 on success and 0 if an error occurred. | |
210 | */ | |
211 | int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src); | |
212 | ||
213 | /** Creates a new EC_GROUP object and copies the copies the content | |
214 | * form src to the newly created EC_KEY object | |
215 | * \param src source EC_GROUP object | |
216 | * \return newly created EC_GROUP object or NULL in case of an error. | |
217 | */ | |
218 | EC_GROUP *EC_GROUP_dup(const EC_GROUP *src); | |
219 | ||
220 | /** Returns the EC_METHOD of the EC_GROUP object. | |
221 | * \param group EC_GROUP object | |
222 | * \return EC_METHOD used in this EC_GROUP object. | |
223 | */ | |
224 | const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group); | |
225 | ||
226 | /** Returns the field type of the EC_METHOD. | |
227 | * \param meth EC_METHOD object | |
228 | * \return NID of the underlying field type OID. | |
229 | */ | |
230 | int EC_METHOD_get_field_type(const EC_METHOD *meth); | |
231 | ||
232 | /** Sets the generator and it's order/cofactor of a EC_GROUP object. | |
233 | * \param group EC_GROUP object | |
234 | * \param generator EC_POINT object with the generator. | |
235 | * \param order the order of the group generated by the generator. | |
236 | * \param cofactor the index of the sub-group generated by the generator | |
237 | * in the group of all points on the elliptic curve. | |
238 | * \return 1 on success and 0 if an error occured | |
239 | */ | |
240 | int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor); | |
241 | ||
242 | /** Returns the generator of a EC_GROUP object. | |
243 | * \param group EC_GROUP object | |
244 | * \return the currently used generator (possibly NULL). | |
245 | */ | |
246 | const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group); | |
247 | ||
248 | /** Gets the order of a EC_GROUP | |
249 | * \param group EC_GROUP object | |
250 | * \param order BIGNUM to which the order is copied | |
251 | * \param ctx BN_CTX object (optional) | |
252 | * \return 1 on success and 0 if an error occured | |
253 | */ | |
254 | int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx); | |
48fe4d62 | 255 | |
ba12070f NL |
256 | /** Gets the cofactor of a EC_GROUP |
257 | * \param group EC_GROUP object | |
258 | * \param cofactor BIGNUM to which the cofactor is copied | |
259 | * \param ctx BN_CTX object (optional) | |
260 | * \return 1 on success and 0 if an error occured | |
261 | */ | |
262 | int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx); | |
b6db386f | 263 | |
ba12070f NL |
264 | /** Sets the name of a EC_GROUP object |
265 | * \param group EC_GROUP object | |
266 | * \param nid NID of the curve name OID | |
267 | */ | |
268 | void EC_GROUP_set_curve_name(EC_GROUP *group, int nid); | |
b6db386f | 269 | |
ba12070f NL |
270 | /** Returns the curve name of a EC_GROUP object |
271 | * \param group EC_GROUP object | |
272 | * \return NID of the curve name OID or 0 if not set. | |
273 | */ | |
274 | int EC_GROUP_get_curve_name(const EC_GROUP *group); | |
945e15a2 | 275 | |
ba12070f NL |
276 | void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag); |
277 | int EC_GROUP_get_asn1_flag(const EC_GROUP *group); | |
5f3d6f70 | 278 | |
9945b460 | 279 | void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form); |
5f3d6f70 BM |
280 | point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *); |
281 | ||
9945b460 | 282 | unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x); |
5f3d6f70 BM |
283 | size_t EC_GROUP_get_seed_len(const EC_GROUP *); |
284 | size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len); | |
48fe4d62 | 285 | |
ba12070f NL |
286 | /** Sets the parameter of a ec over GFp defined by y^2 = x^3 + a*x + b |
287 | * \param group EC_GROUP object | |
288 | * \param p BIGNUM with the prime number | |
289 | * \param a BIGNUM with parameter a of the equation | |
290 | * \param b BIGNUM with parameter b of the equation | |
291 | * \param ctx BN_CTX object (optional) | |
292 | * \return 1 on success and 0 if an error occured | |
293 | */ | |
294 | int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); | |
295 | ||
296 | /** Gets the parameter of the ec over GFp defined by y^2 = x^3 + a*x + b | |
297 | * \param group EC_GROUP object | |
298 | * \param p BIGNUM for the prime number | |
299 | * \param a BIGNUM for parameter a of the equation | |
300 | * \param b BIGNUM for parameter b of the equation | |
301 | * \param ctx BN_CTX object (optional) | |
302 | * \return 1 on success and 0 if an error occured | |
303 | */ | |
304 | int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx); | |
305 | ||
b3310161 | 306 | #ifndef OPENSSL_NO_EC2M |
ba12070f NL |
307 | /** Sets the parameter of a ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b |
308 | * \param group EC_GROUP object | |
309 | * \param p BIGNUM with the polynomial defining the underlying field | |
310 | * \param a BIGNUM with parameter a of the equation | |
311 | * \param b BIGNUM with parameter b of the equation | |
312 | * \param ctx BN_CTX object (optional) | |
313 | * \return 1 on success and 0 if an error occured | |
314 | */ | |
315 | int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); | |
316 | ||
317 | /** Gets the parameter of the ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b | |
318 | * \param group EC_GROUP object | |
319 | * \param p BIGNUM for the polynomial defining the underlying field | |
320 | * \param a BIGNUM for parameter a of the equation | |
321 | * \param b BIGNUM for parameter b of the equation | |
322 | * \param ctx BN_CTX object (optional) | |
323 | * \return 1 on success and 0 if an error occured | |
324 | */ | |
325 | int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx); | |
b3310161 | 326 | #endif |
ba12070f NL |
327 | /** Returns the number of bits needed to represent a field element |
328 | * \param group EC_GROUP object | |
329 | * \return number of bits needed to represent a field element | |
330 | */ | |
331 | int EC_GROUP_get_degree(const EC_GROUP *group); | |
3a12ce01 | 332 | |
ba12070f NL |
333 | /** Checks whether the parameter in the EC_GROUP define a valid ec group |
334 | * \param group EC_GROUP object | |
335 | * \param ctx BN_CTX object (optional) | |
336 | * \return 1 if group is a valid ec group and 0 otherwise | |
337 | */ | |
af28dd6c | 338 | int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx); |
945e15a2 | 339 | |
ba12070f NL |
340 | /** Checks whether the discriminant of the elliptic curve is zero or not |
341 | * \param group EC_GROUP object | |
342 | * \param ctx BN_CTX object (optional) | |
343 | * \return 1 if the discriminant is not zero and 0 otherwise | |
344 | */ | |
345 | int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx); | |
346 | ||
347 | /** Compares two EC_GROUP objects | |
348 | * \param a first EC_GROUP object | |
349 | * \param b second EC_GROUP object | |
350 | * \param ctx BN_CTX object (optional) | |
351 | * \return 0 if both groups are equal and 1 otherwise | |
352 | */ | |
353 | int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx); | |
ada0e717 | 354 | |
7793f30e | 355 | /* EC_GROUP_new_GF*() calls EC_GROUP_new() and EC_GROUP_set_GF*() |
945e15a2 | 356 | * after choosing an appropriate EC_METHOD */ |
945e15a2 | 357 | |
ba12070f NL |
358 | /** Creates a new EC_GROUP object with the specified parameters defined |
359 | * over GFp (defined by the equation y^2 = x^3 + a*x + b) | |
360 | * \param p BIGNUM with the prime number | |
361 | * \param a BIGNUM with the parameter a of the equation | |
362 | * \param b BIGNUM with the parameter b of the equation | |
363 | * \param ctx BN_CTX object (optional) | |
364 | * \return newly created EC_GROUP object with the specified parameters | |
365 | */ | |
366 | EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); | |
b3310161 | 367 | #ifndef OPENSSL_NO_EC2M |
ba12070f NL |
368 | /** Creates a new EC_GROUP object with the specified parameters defined |
369 | * over GF2m (defined by the equation y^2 + x*y = x^3 + a*x^2 + b) | |
370 | * \param p BIGNUM with the polynomial defining the underlying field | |
371 | * \param a BIGNUM with the parameter a of the equation | |
372 | * \param b BIGNUM with the parameter b of the equation | |
373 | * \param ctx BN_CTX object (optional) | |
374 | * \return newly created EC_GROUP object with the specified parameters | |
375 | */ | |
376 | EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); | |
b3310161 | 377 | #endif |
ba12070f NL |
378 | /** Creates a EC_GROUP object with a curve specified by a NID |
379 | * \param nid NID of the OID of the curve name | |
380 | * \return newly created EC_GROUP object with specified curve or NULL | |
381 | * if an error occurred | |
382 | */ | |
8b15c740 | 383 | EC_GROUP *EC_GROUP_new_by_curve_name(int nid); |
ba12070f NL |
384 | |
385 | ||
386 | /********************************************************************/ | |
387 | /* handling of internal curves */ | |
388 | /********************************************************************/ | |
389 | ||
65b1d31d BM |
390 | typedef struct { |
391 | int nid; | |
392 | const char *comment; | |
393 | } EC_builtin_curve; | |
ba12070f | 394 | |
65b1d31d BM |
395 | /* EC_builtin_curves(EC_builtin_curve *r, size_t size) returns number |
396 | * of all available curves or zero if a error occurred. | |
397 | * In case r ist not zero nitems EC_builtin_curve structures | |
398 | * are filled with the data of the first nitems internal groups */ | |
399 | size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems); | |
7eb18f12 | 400 | |
64095ce9 DSH |
401 | const char *EC_curve_nid2nist(int nid); |
402 | int EC_curve_nist2nid(const char *name); | |
7e31164a | 403 | |
ba12070f NL |
404 | /********************************************************************/ |
405 | /* EC_POINT functions */ | |
406 | /********************************************************************/ | |
407 | ||
408 | /** Creates a new EC_POINT object for the specified EC_GROUP | |
409 | * \param group EC_GROUP the underlying EC_GROUP object | |
410 | * \return newly created EC_POINT object or NULL if an error occurred | |
411 | */ | |
412 | EC_POINT *EC_POINT_new(const EC_GROUP *group); | |
413 | ||
414 | /** Frees a EC_POINT object | |
415 | * \param point EC_POINT object to be freed | |
416 | */ | |
417 | void EC_POINT_free(EC_POINT *point); | |
418 | ||
419 | /** Clears and frees a EC_POINT object | |
420 | * \param point EC_POINT object to be cleared and freed | |
421 | */ | |
422 | void EC_POINT_clear_free(EC_POINT *point); | |
423 | ||
424 | /** Copies EC_POINT object | |
425 | * \param dst destination EC_POINT object | |
426 | * \param src source EC_POINT object | |
427 | * \return 1 on success and 0 if an error occured | |
428 | */ | |
429 | int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src); | |
945e15a2 | 430 | |
ba12070f NL |
431 | /** Creates a new EC_POINT object and copies the content of the supplied |
432 | * EC_POINT | |
433 | * \param src source EC_POINT object | |
434 | * \param group underlying the EC_GROUP object | |
435 | * \return newly created EC_POINT object or NULL if an error occurred | |
436 | */ | |
437 | EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group); | |
3a12ce01 | 438 | |
ba12070f NL |
439 | /** Returns the EC_METHOD used in EC_POINT object |
440 | * \param point EC_POINT object | |
441 | * \return the EC_METHOD used | |
442 | */ | |
443 | const EC_METHOD *EC_POINT_method_of(const EC_POINT *point); | |
444 | ||
445 | /** Sets a point to infinity (neutral element) | |
446 | * \param group underlying EC_GROUP object | |
447 | * \param point EC_POINT to set to infinity | |
448 | * \return 1 on success and 0 if an error occured | |
449 | */ | |
450 | int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point); | |
451 | ||
452 | /** Sets the jacobian projective coordinates of a EC_POINT over GFp | |
453 | * \param group underlying EC_GROUP object | |
454 | * \param p EC_POINT object | |
455 | * \param x BIGNUM with the x-coordinate | |
456 | * \param y BIGNUM with the y-coordinate | |
457 | * \param z BIGNUM with the z-coordinate | |
458 | * \param ctx BN_CTX object (optional) | |
459 | * \return 1 on success and 0 if an error occured | |
460 | */ | |
461 | int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, | |
462 | const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx); | |
463 | ||
464 | /** Gets the jacobian projective coordinates of a EC_POINT over GFp | |
465 | * \param group underlying EC_GROUP object | |
466 | * \param p EC_POINT object | |
467 | * \param x BIGNUM for the x-coordinate | |
468 | * \param y BIGNUM for the y-coordinate | |
469 | * \param z BIGNUM for the z-coordinate | |
470 | * \param ctx BN_CTX object (optional) | |
471 | * \return 1 on success and 0 if an error occured | |
472 | */ | |
473 | int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group, | |
474 | const EC_POINT *p, BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx); | |
475 | ||
476 | /** Sets the affine coordinates of a EC_POINT over GFp | |
477 | * \param group underlying EC_GROUP object | |
478 | * \param p EC_POINT object | |
479 | * \param x BIGNUM with the x-coordinate | |
480 | * \param y BIGNUM with the y-coordinate | |
481 | * \param ctx BN_CTX object (optional) | |
482 | * \return 1 on success and 0 if an error occured | |
483 | */ | |
484 | int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, | |
485 | const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx); | |
486 | ||
487 | /** Gets the affine coordinates of a EC_POINT over GFp | |
488 | * \param group underlying EC_GROUP object | |
489 | * \param p EC_POINT object | |
490 | * \param x BIGNUM for the x-coordinate | |
491 | * \param y BIGNUM for the y-coordinate | |
492 | * \param ctx BN_CTX object (optional) | |
493 | * \return 1 on success and 0 if an error occured | |
494 | */ | |
495 | int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, | |
496 | const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx); | |
497 | ||
498 | /** Sets the x9.62 compressed coordinates of a EC_POINT over GFp | |
499 | * \param group underlying EC_GROUP object | |
500 | * \param p EC_POINT object | |
501 | * \param x BIGNUM with x-coordinate | |
502 | * \param y_bit integer with the y-Bit (either 0 or 1) | |
503 | * \param ctx BN_CTX object (optional) | |
504 | * \return 1 on success and 0 if an error occured | |
505 | */ | |
506 | int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, | |
507 | const BIGNUM *x, int y_bit, BN_CTX *ctx); | |
b3310161 | 508 | #ifndef OPENSSL_NO_EC2M |
ba12070f NL |
509 | /** Sets the affine coordinates of a EC_POINT over GF2m |
510 | * \param group underlying EC_GROUP object | |
511 | * \param p EC_POINT object | |
512 | * \param x BIGNUM with the x-coordinate | |
513 | * \param y BIGNUM with the y-coordinate | |
514 | * \param ctx BN_CTX object (optional) | |
515 | * \return 1 on success and 0 if an error occured | |
516 | */ | |
517 | int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, | |
518 | const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx); | |
519 | ||
520 | /** Gets the affine coordinates of a EC_POINT over GF2m | |
521 | * \param group underlying EC_GROUP object | |
522 | * \param p EC_POINT object | |
523 | * \param x BIGNUM for the x-coordinate | |
524 | * \param y BIGNUM for the y-coordinate | |
525 | * \param ctx BN_CTX object (optional) | |
526 | * \return 1 on success and 0 if an error occured | |
527 | */ | |
528 | int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group, | |
529 | const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx); | |
530 | ||
531 | /** Sets the x9.62 compressed coordinates of a EC_POINT over GF2m | |
532 | * \param group underlying EC_GROUP object | |
533 | * \param p EC_POINT object | |
534 | * \param x BIGNUM with x-coordinate | |
535 | * \param y_bit integer with the y-Bit (either 0 or 1) | |
536 | * \param ctx BN_CTX object (optional) | |
537 | * \return 1 on success and 0 if an error occured | |
538 | */ | |
539 | int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, | |
540 | const BIGNUM *x, int y_bit, BN_CTX *ctx); | |
b3310161 | 541 | #endif |
ba12070f NL |
542 | /** Encodes a EC_POINT object to a octet string |
543 | * \param group underlying EC_GROUP object | |
544 | * \param p EC_POINT object | |
545 | * \param form point conversion form | |
546 | * \param buf memory buffer for the result. If NULL the function returns | |
547 | * required buffer size. | |
548 | * \param len length of the memory buffer | |
549 | * \param ctx BN_CTX object (optional) | |
550 | * \return the length of the encoded octet string or 0 if an error occurred | |
551 | */ | |
552 | size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p, | |
553 | point_conversion_form_t form, | |
554 | unsigned char *buf, size_t len, BN_CTX *ctx); | |
555 | ||
556 | /** Decodes a EC_POINT from a octet string | |
557 | * \param group underlying EC_GROUP object | |
558 | * \param p EC_POINT object | |
559 | * \param buf memory buffer with the encoded ec point | |
560 | * \param len length of the encoded ec point | |
561 | * \param ctx BN_CTX object (optional) | |
562 | * \return 1 on success and 0 if an error occured | |
563 | */ | |
564 | int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p, | |
565 | const unsigned char *buf, size_t len, BN_CTX *ctx); | |
7d7db13e | 566 | |
6cbe6382 BM |
567 | /* other interfaces to point2oct/oct2point: */ |
568 | BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *, | |
569 | point_conversion_form_t form, BIGNUM *, BN_CTX *); | |
570 | EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *, | |
571 | EC_POINT *, BN_CTX *); | |
572 | char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *, | |
573 | point_conversion_form_t form, BN_CTX *); | |
574 | EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *, | |
575 | EC_POINT *, BN_CTX *); | |
576 | ||
3a12ce01 | 577 | |
ba12070f NL |
578 | /********************************************************************/ |
579 | /* functions for doing EC_POINT arithmetic */ | |
580 | /********************************************************************/ | |
581 | ||
582 | /** Computes the sum of two EC_POINT | |
583 | * \param group underlying EC_GROUP object | |
584 | * \param r EC_POINT object for the result (r = a + b) | |
585 | * \param a EC_POINT object with the first summand | |
586 | * \param b EC_POINT object with the second summand | |
587 | * \param ctx BN_CTX object (optional) | |
588 | * \return 1 on success and 0 if an error occured | |
589 | */ | |
590 | int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx); | |
591 | ||
592 | /** Computes the double of a EC_POINT | |
593 | * \param group underlying EC_GROUP object | |
594 | * \param r EC_POINT object for the result (r = 2 * a) | |
595 | * \param a EC_POINT object | |
596 | * \param ctx BN_CTX object (optional) | |
597 | * \return 1 on success and 0 if an error occured | |
598 | */ | |
599 | int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx); | |
600 | ||
601 | /** Computes the inverse of a EC_POINT | |
602 | * \param group underlying EC_GROUP object | |
603 | * \param a EC_POINT object to be inverted (it's used for the result as well) | |
604 | * \param ctx BN_CTX object (optional) | |
605 | * \return 1 on success and 0 if an error occured | |
606 | */ | |
607 | int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx); | |
608 | ||
609 | /** Checks whether the point is the neutral element of the group | |
610 | * \param group the underlying EC_GROUP object | |
611 | * \param p EC_POINT object | |
612 | * \return 1 if the point is the neutral element and 0 otherwise | |
613 | */ | |
614 | int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p); | |
615 | ||
616 | /** Checks whether the point is on the curve | |
617 | * \param group underlying EC_GROUP object | |
618 | * \param point EC_POINT object to check | |
619 | * \param ctx BN_CTX object (optional) | |
620 | * \return 1 if point if on the curve and 0 otherwise | |
621 | */ | |
622 | int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx); | |
623 | ||
624 | /** Compares two EC_POINTs | |
625 | * \param group underlying EC_GROUP object | |
626 | * \param a first EC_POINT object | |
627 | * \param b second EC_POINT object | |
628 | * \param ctx BN_CTX object (optional) | |
629 | * \return 0 if both points are equal and a value != 0 otherwise | |
630 | */ | |
631 | int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx); | |
fb171e53 | 632 | |
9945b460 DSH |
633 | int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx); |
634 | int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[], BN_CTX *ctx); | |
fb171e53 | 635 | |
ba12070f NL |
636 | /** Computes r = generator * n sum_{i=0}^num p[i] * m[i] |
637 | * \param group underlying EC_GROUP object | |
638 | * \param r EC_POINT object for the result | |
639 | * \param n BIGNUM with the multiplier for the group generator (optional) | |
640 | * \param num number futher summands | |
641 | * \param p array of size num of EC_POINT objects | |
642 | * \param m array of size num of BIGNUM objects | |
643 | * \param ctx BN_CTX object (optional) | |
644 | * \return 1 on success and 0 if an error occured | |
645 | */ | |
646 | int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, size_t num, const EC_POINT *p[], const BIGNUM *m[], BN_CTX *ctx); | |
647 | ||
648 | /** Computes r = generator * n + q * m | |
649 | * \param group underlying EC_GROUP object | |
650 | * \param r EC_POINT object for the result | |
651 | * \param n BIGNUM with the multiplier for the group generator (optional) | |
652 | * \param q EC_POINT object with the first factor of the second summand | |
653 | * \param m BIGNUM with the second factor of the second summand | |
654 | * \param ctx BN_CTX object (optional) | |
655 | * \return 1 on success and 0 if an error occured | |
656 | */ | |
657 | int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx); | |
3a12ce01 | 658 | |
ba12070f NL |
659 | /** Stores multiples of generator for faster point multiplication |
660 | * \param group EC_GROUP object | |
661 | * \param ctx BN_CTX object (optional) | |
662 | * \return 1 on success and 0 if an error occured | |
663 | */ | |
664 | int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx); | |
6cc5e19d | 665 | |
ba12070f NL |
666 | /** Reports whether a precomputation has been done |
667 | * \param group EC_GROUP object | |
668 | * \return 1 if a pre-computation has been done and 0 otherwise | |
669 | */ | |
670 | int EC_GROUP_have_precompute_mult(const EC_GROUP *group); | |
6cc5e19d BM |
671 | |
672 | ||
ba12070f NL |
673 | /********************************************************************/ |
674 | /* ASN1 stuff */ | |
675 | /********************************************************************/ | |
8aefe253 BM |
676 | |
677 | /* EC_GROUP_get_basis_type() returns the NID of the basis type | |
34f1f2a8 BM |
678 | * used to represent the field elements */ |
679 | int EC_GROUP_get_basis_type(const EC_GROUP *); | |
c9a90645 | 680 | #ifndef OPENSSL_NO_EC2M |
34f1f2a8 BM |
681 | int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k); |
682 | int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1, | |
8aefe253 | 683 | unsigned int *k2, unsigned int *k3); |
c9a90645 | 684 | #endif |
8aefe253 | 685 | |
254ef80d | 686 | #define OPENSSL_EC_NAMED_CURVE 0x001 |
458c2917 | 687 | |
458c2917 BM |
688 | typedef struct ecpk_parameters_st ECPKPARAMETERS; |
689 | ||
6343829a | 690 | EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len); |
458c2917 BM |
691 | int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out); |
692 | ||
41a15c4f BL |
693 | #define d2i_ECPKParameters_bio(bp,x) ASN1_d2i_bio_of(EC_GROUP,NULL,d2i_ECPKParameters,bp,x) |
694 | #define i2d_ECPKParameters_bio(bp,x) ASN1_i2d_bio_of_const(EC_GROUP,i2d_ECPKParameters,bp,x) | |
5dbd3efc BM |
695 | #define d2i_ECPKParameters_fp(fp,x) (EC_GROUP *)ASN1_d2i_fp(NULL, \ |
696 | (char *(*)())d2i_ECPKParameters,(fp),(unsigned char **)(x)) | |
697 | #define i2d_ECPKParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECPKParameters,(fp), \ | |
698 | (unsigned char *)(x)) | |
458c2917 | 699 | |
5f3d6f70 BM |
700 | #ifndef OPENSSL_NO_BIO |
701 | int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off); | |
702 | #endif | |
703 | #ifndef OPENSSL_NO_FP_API | |
704 | int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off); | |
705 | #endif | |
706 | ||
ba12070f NL |
707 | |
708 | /********************************************************************/ | |
709 | /* EC_KEY functions */ | |
710 | /********************************************************************/ | |
711 | ||
14a7cfb3 BM |
712 | typedef struct ec_key_st EC_KEY; |
713 | ||
14a7cfb3 BM |
714 | /* some values for the encoding_flag */ |
715 | #define EC_PKEY_NO_PARAMETERS 0x001 | |
716 | #define EC_PKEY_NO_PUBKEY 0x002 | |
717 | ||
cac4fb58 DSH |
718 | /* some values for the flags field */ |
719 | #define EC_FLAG_NON_FIPS_ALLOW 0x1 | |
720 | #define EC_FLAG_FIPS_CHECKED 0x2 | |
721 | ||
ba12070f NL |
722 | /** Creates a new EC_KEY object. |
723 | * \return EC_KEY object or NULL if an error occurred. | |
724 | */ | |
14a7cfb3 | 725 | EC_KEY *EC_KEY_new(void); |
ba12070f | 726 | |
cac4fb58 DSH |
727 | int EC_KEY_get_flags(const EC_KEY *key); |
728 | ||
729 | void EC_KEY_set_flags(EC_KEY *key, int flags); | |
730 | ||
731 | void EC_KEY_clear_flags(EC_KEY *key, int flags); | |
732 | ||
ba12070f NL |
733 | /** Creates a new EC_KEY object using a named curve as underlying |
734 | * EC_GROUP object. | |
735 | * \param nid NID of the named curve. | |
736 | * \return EC_KEY object or NULL if an error occurred. | |
737 | */ | |
9dd84053 | 738 | EC_KEY *EC_KEY_new_by_curve_name(int nid); |
ba12070f NL |
739 | |
740 | /** Frees a EC_KEY object. | |
741 | * \param key EC_KEY object to be freed. | |
742 | */ | |
743 | void EC_KEY_free(EC_KEY *key); | |
744 | ||
745 | /** Copies a EC_KEY object. | |
746 | * \param dst destination EC_KEY object | |
747 | * \param src src EC_KEY object | |
748 | * \return dst or NULL if an error occurred. | |
749 | */ | |
750 | EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src); | |
751 | ||
752 | /** Creates a new EC_KEY object and copies the content from src to it. | |
753 | * \param src the source EC_KEY object | |
754 | * \return newly created EC_KEY object or NULL if an error occurred. | |
755 | */ | |
756 | EC_KEY *EC_KEY_dup(const EC_KEY *src); | |
757 | ||
758 | /** Increases the internal reference count of a EC_KEY object. | |
759 | * \param key EC_KEY object | |
760 | * \return 1 on success and 0 if an error occurred. | |
761 | */ | |
762 | int EC_KEY_up_ref(EC_KEY *key); | |
763 | ||
764 | /** Returns the EC_GROUP object of a EC_KEY object | |
765 | * \param key EC_KEY object | |
766 | * \return the EC_GROUP object (possibly NULL). | |
767 | */ | |
768 | const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key); | |
769 | ||
770 | /** Sets the EC_GROUP of a EC_KEY object. | |
771 | * \param key EC_KEY object | |
772 | * \param group EC_GROUP to use in the EC_KEY object (note: the EC_KEY | |
773 | * object will use an own copy of the EC_GROUP). | |
774 | * \return 1 on success and 0 if an error occurred. | |
775 | */ | |
776 | int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group); | |
777 | ||
778 | /** Returns the private key of a EC_KEY object. | |
779 | * \param key EC_KEY object | |
780 | * \return a BIGNUM with the private key (possibly NULL). | |
781 | */ | |
782 | const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key); | |
783 | ||
784 | /** Sets the private key of a EC_KEY object. | |
785 | * \param key EC_KEY object | |
786 | * \param prv BIGNUM with the private key (note: the EC_KEY object | |
787 | * will use an own copy of the BIGNUM). | |
788 | * \return 1 on success and 0 if an error occurred. | |
789 | */ | |
790 | int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv); | |
791 | ||
792 | /** Returns the public key of a EC_KEY object. | |
793 | * \param key the EC_KEY object | |
794 | * \return a EC_POINT object with the public key (possibly NULL) | |
795 | */ | |
796 | const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key); | |
797 | ||
798 | /** Sets the public key of a EC_KEY object. | |
799 | * \param key EC_KEY object | |
800 | * \param pub EC_POINT object with the public key (note: the EC_KEY object | |
801 | * will use an own copy of the EC_POINT object). | |
802 | * \return 1 on success and 0 if an error occurred. | |
803 | */ | |
804 | int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub); | |
805 | ||
806 | unsigned EC_KEY_get_enc_flags(const EC_KEY *key); | |
9945b460 DSH |
807 | void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags); |
808 | point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key); | |
809 | void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform); | |
9dd84053 | 810 | /* functions to set/get method specific data */ |
9945b460 | 811 | void *EC_KEY_get_key_method_data(EC_KEY *key, |
9dd84053 | 812 | void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *)); |
9945b460 | 813 | void EC_KEY_insert_key_method_data(EC_KEY *key, void *data, |
9dd84053 NL |
814 | void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *)); |
815 | /* wrapper functions for the underlying EC_GROUP object */ | |
9945b460 | 816 | void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag); |
ba12070f NL |
817 | |
818 | /** Creates a table of pre-computed multiples of the generator to | |
819 | * accelerate further EC_KEY operations. | |
820 | * \param key EC_KEY object | |
821 | * \param ctx BN_CTX object (optional) | |
822 | * \return 1 on success and 0 if an error occurred. | |
823 | */ | |
824 | int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx); | |
825 | ||
826 | /** Creates a new ec private (and optional a new public) key. | |
827 | * \param key EC_KEY object | |
828 | * \return 1 on success and 0 if an error occurred. | |
829 | */ | |
830 | int EC_KEY_generate_key(EC_KEY *key); | |
831 | ||
832 | /** Verifies that a private and/or public key is valid. | |
833 | * \param key the EC_KEY object | |
834 | * \return 1 on success and 0 otherwise. | |
835 | */ | |
836 | int EC_KEY_check_key(const EC_KEY *key); | |
837 | ||
fef1c40b DSH |
838 | /** Sets a public key from affine coordindates performing |
839 | * neccessary NIST PKV tests. | |
840 | * \param key the EC_KEY object | |
841 | * \param x public key x coordinate | |
842 | * \param y public key y coordinate | |
843 | * \return 1 on success and 0 otherwise. | |
844 | */ | |
845 | int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y); | |
846 | ||
ba12070f NL |
847 | |
848 | /********************************************************************/ | |
849 | /* de- and encoding functions for SEC1 ECPrivateKey */ | |
850 | /********************************************************************/ | |
851 | ||
852 | /** Decodes a private key from a memory buffer. | |
853 | * \param key a pointer to a EC_KEY object which should be used (or NULL) | |
854 | * \param in pointer to memory with the DER encoded private key | |
855 | * \param len length of the DER encoded private key | |
856 | * \return the decoded private key or NULL if an error occurred. | |
857 | */ | |
6343829a | 858 | EC_KEY *d2i_ECPrivateKey(EC_KEY **key, const unsigned char **in, long len); |
ba12070f NL |
859 | |
860 | /** Encodes a private key object and stores the result in a buffer. | |
861 | * \param key the EC_KEY object to encode | |
862 | * \param out the buffer for the result (if NULL the function returns number | |
863 | * of bytes needed). | |
864 | * \return 1 on success and 0 if an error occurred. | |
865 | */ | |
866 | int i2d_ECPrivateKey(EC_KEY *key, unsigned char **out); | |
867 | ||
868 | ||
869 | /********************************************************************/ | |
870 | /* de- and encoding functions for EC parameters */ | |
871 | /********************************************************************/ | |
872 | ||
873 | /** Decodes ec parameter from a memory buffer. | |
874 | * \param key a pointer to a EC_KEY object which should be used (or NULL) | |
875 | * \param in pointer to memory with the DER encoded ec parameters | |
876 | * \param len length of the DER encoded ec parameters | |
877 | * \return a EC_KEY object with the decoded parameters or NULL if an error | |
878 | * occurred. | |
879 | */ | |
880 | EC_KEY *d2i_ECParameters(EC_KEY **key, const unsigned char **in, long len); | |
881 | ||
882 | /** Encodes ec parameter and stores the result in a buffer. | |
883 | * \param key the EC_KEY object with ec paramters to encode | |
884 | * \param out the buffer for the result (if NULL the function returns number | |
885 | * of bytes needed). | |
886 | * \return 1 on success and 0 if an error occurred. | |
887 | */ | |
888 | int i2d_ECParameters(EC_KEY *key, unsigned char **out); | |
889 | ||
890 | ||
891 | /********************************************************************/ | |
892 | /* de- and encoding functions for EC public key */ | |
893 | /* (octet string, not DER -- hence 'o2i' and 'i2o') */ | |
894 | /********************************************************************/ | |
895 | ||
896 | /** Decodes a ec public key from a octet string. | |
897 | * \param key a pointer to a EC_KEY object which should be used | |
898 | * \param in memory buffer with the encoded public key | |
899 | * \param len length of the encoded public key | |
900 | * \return EC_KEY object with decoded public key or NULL if an error | |
901 | * occurred. | |
902 | */ | |
903 | EC_KEY *o2i_ECPublicKey(EC_KEY **key, const unsigned char **in, long len); | |
904 | ||
905 | /** Encodes a ec public key in an octet string. | |
906 | * \param key the EC_KEY object with the public key | |
907 | * \param out the buffer for the result (if NULL the function returns number | |
908 | * of bytes needed). | |
909 | * \return 1 on success and 0 if an error occurred | |
910 | */ | |
911 | int i2o_ECPublicKey(EC_KEY *key, unsigned char **out); | |
14a7cfb3 BM |
912 | |
913 | #ifndef OPENSSL_NO_BIO | |
ba12070f NL |
914 | /** Prints out the ec parameters on human readable form. |
915 | * \param bp BIO object to which the information is printed | |
916 | * \param key EC_KEY object | |
917 | * \return 1 on success and 0 if an error occurred | |
918 | */ | |
919 | int ECParameters_print(BIO *bp, const EC_KEY *key); | |
920 | ||
921 | /** Prints out the contents of a EC_KEY object | |
922 | * \param bp BIO object to which the information is printed | |
923 | * \param key EC_KEY object | |
924 | * \param off line offset | |
925 | * \return 1 on success and 0 if an error occurred | |
926 | */ | |
927 | int EC_KEY_print(BIO *bp, const EC_KEY *key, int off); | |
928 | ||
14a7cfb3 BM |
929 | #endif |
930 | #ifndef OPENSSL_NO_FP_API | |
ba12070f NL |
931 | /** Prints out the ec parameters on human readable form. |
932 | * \param fp file descriptor to which the information is printed | |
933 | * \param key EC_KEY object | |
934 | * \return 1 on success and 0 if an error occurred | |
935 | */ | |
936 | int ECParameters_print_fp(FILE *fp, const EC_KEY *key); | |
937 | ||
938 | /** Prints out the contents of a EC_KEY object | |
939 | * \param fp file descriptor to which the information is printed | |
940 | * \param key EC_KEY object | |
941 | * \param off line offset | |
942 | * \return 1 on success and 0 if an error occurred | |
943 | */ | |
944 | int EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off); | |
945 | ||
14a7cfb3 | 946 | #endif |
0bee0e62 | 947 | |
41a15c4f | 948 | #define ECParameters_dup(x) ASN1_dup_of(EC_KEY,i2d_ECParameters,d2i_ECParameters,x) |
458c2917 | 949 | |
ad0db060 DSH |
950 | #ifndef __cplusplus |
951 | #if defined(__SUNPRO_C) | |
952 | # if __SUNPRO_C >= 0x520 | |
953 | # pragma error_messages (default,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE) | |
954 | # endif | |
955 | # endif | |
956 | #endif | |
957 | ||
9ca7047d DSH |
958 | #define EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid) \ |
959 | EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, EVP_PKEY_OP_PARAMGEN, \ | |
960 | EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, nid, NULL) | |
961 | ||
962 | ||
963 | #define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID (EVP_PKEY_ALG_CTRL + 1) | |
964 | ||
65e81670 BM |
965 | /* BEGIN ERROR CODES */ |
966 | /* The following lines are auto generated by the script mkerr.pl. Any changes | |
967 | * made after this point may be overwritten when the script is next run. | |
968 | */ | |
de10f690 | 969 | void ERR_load_EC_strings(void); |
6cc5e19d | 970 | |
65e81670 | 971 | /* Error codes for the EC functions. */ |
6cc5e19d | 972 | |
65e81670 | 973 | /* Function codes. */ |
04daec86 | 974 | #define EC_F_BN_TO_FELEM 224 |
3ba1f111 | 975 | #define EC_F_COMPUTE_WNAF 143 |
7eb18f12 BM |
976 | #define EC_F_D2I_ECPARAMETERS 144 |
977 | #define EC_F_D2I_ECPKPARAMETERS 145 | |
978 | #define EC_F_D2I_ECPRIVATEKEY 146 | |
5c95c2ac | 979 | #define EC_F_DO_EC_KEY_PRINT 221 |
19f6c524 | 980 | #define EC_F_ECKEY_PARAM2TYPE 223 |
7e76e563 RL |
981 | #define EC_F_ECKEY_PARAM_DECODE 212 |
982 | #define EC_F_ECKEY_PRIV_DECODE 213 | |
983 | #define EC_F_ECKEY_PRIV_ENCODE 214 | |
984 | #define EC_F_ECKEY_PUB_DECODE 215 | |
985 | #define EC_F_ECKEY_PUB_ENCODE 216 | |
986 | #define EC_F_ECKEY_TYPE2PARAM 220 | |
7eb18f12 BM |
987 | #define EC_F_ECPARAMETERS_PRINT 147 |
988 | #define EC_F_ECPARAMETERS_PRINT_FP 148 | |
989 | #define EC_F_ECPKPARAMETERS_PRINT 149 | |
990 | #define EC_F_ECPKPARAMETERS_PRINT_FP 150 | |
5c6bf031 BM |
991 | #define EC_F_ECP_NIST_MOD_192 203 |
992 | #define EC_F_ECP_NIST_MOD_224 204 | |
993 | #define EC_F_ECP_NIST_MOD_256 205 | |
994 | #define EC_F_ECP_NIST_MOD_521 206 | |
7eb18f12 BM |
995 | #define EC_F_EC_ASN1_GROUP2CURVE 153 |
996 | #define EC_F_EC_ASN1_GROUP2FIELDID 154 | |
997 | #define EC_F_EC_ASN1_GROUP2PARAMETERS 155 | |
998 | #define EC_F_EC_ASN1_GROUP2PKPARAMETERS 156 | |
458c2917 | 999 | #define EC_F_EC_ASN1_PARAMETERS2GROUP 157 |
7eb18f12 | 1000 | #define EC_F_EC_ASN1_PKPARAMETERS2GROUP 158 |
739a543e | 1001 | #define EC_F_EC_EX_DATA_SET_DATA 211 |
aa4ce731 | 1002 | #define EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY 208 |
7eb18f12 | 1003 | #define EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT 159 |
34f1f2a8 | 1004 | #define EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE 195 |
7eb18f12 BM |
1005 | #define EC_F_EC_GF2M_SIMPLE_OCT2POINT 160 |
1006 | #define EC_F_EC_GF2M_SIMPLE_POINT2OCT 161 | |
1007 | #define EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES 162 | |
1008 | #define EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES 163 | |
1009 | #define EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES 164 | |
156e8557 BM |
1010 | #define EC_F_EC_GFP_MONT_FIELD_DECODE 133 |
1011 | #define EC_F_EC_GFP_MONT_FIELD_ENCODE 134 | |
1012 | #define EC_F_EC_GFP_MONT_FIELD_MUL 131 | |
aa4ce731 | 1013 | #define EC_F_EC_GFP_MONT_FIELD_SET_TO_ONE 209 |
156e8557 | 1014 | #define EC_F_EC_GFP_MONT_FIELD_SQR 132 |
aa4ce731 BM |
1015 | #define EC_F_EC_GFP_MONT_GROUP_SET_CURVE 189 |
1016 | #define EC_F_EC_GFP_MONT_GROUP_SET_CURVE_GFP 135 | |
04daec86 BM |
1017 | #define EC_F_EC_GFP_NISTP224_GROUP_SET_CURVE 225 |
1018 | #define EC_F_EC_GFP_NISTP224_POINTS_MUL 228 | |
1019 | #define EC_F_EC_GFP_NISTP224_POINT_GET_AFFINE_COORDINATES 226 | |
3e00b4c9 BM |
1020 | #define EC_F_EC_GFP_NISTP256_GROUP_SET_CURVE 230 |
1021 | #define EC_F_EC_GFP_NISTP256_POINTS_MUL 231 | |
1022 | #define EC_F_EC_GFP_NISTP256_POINT_GET_AFFINE_COORDINATES 232 | |
1023 | #define EC_F_EC_GFP_NISTP521_GROUP_SET_CURVE 233 | |
1024 | #define EC_F_EC_GFP_NISTP521_POINTS_MUL 234 | |
1025 | #define EC_F_EC_GFP_NISTP521_POINT_GET_AFFINE_COORDINATES 235 | |
5c6bf031 BM |
1026 | #define EC_F_EC_GFP_NIST_FIELD_MUL 200 |
1027 | #define EC_F_EC_GFP_NIST_FIELD_SQR 201 | |
aa4ce731 | 1028 | #define EC_F_EC_GFP_NIST_GROUP_SET_CURVE 202 |
7eb18f12 BM |
1029 | #define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT 165 |
1030 | #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE 166 | |
1031 | #define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP 100 | |
de10f690 BM |
1032 | #define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR 101 |
1033 | #define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE 102 | |
1034 | #define EC_F_EC_GFP_SIMPLE_OCT2POINT 103 | |
1035 | #define EC_F_EC_GFP_SIMPLE_POINT2OCT 104 | |
48fe4d62 | 1036 | #define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE 137 |
7eb18f12 BM |
1037 | #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES 167 |
1038 | #define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105 | |
1039 | #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES 168 | |
1040 | #define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128 | |
1041 | #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES 169 | |
1042 | #define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129 | |
1043 | #define EC_F_EC_GROUP_CHECK 170 | |
1044 | #define EC_F_EC_GROUP_CHECK_DISCRIMINANT 171 | |
de10f690 | 1045 | #define EC_F_EC_GROUP_COPY 106 |
48fe4d62 BM |
1046 | #define EC_F_EC_GROUP_GET0_GENERATOR 139 |
1047 | #define EC_F_EC_GROUP_GET_COFACTOR 140 | |
7eb18f12 | 1048 | #define EC_F_EC_GROUP_GET_CURVE_GF2M 172 |
bb62a8b0 | 1049 | #define EC_F_EC_GROUP_GET_CURVE_GFP 130 |
7eb18f12 | 1050 | #define EC_F_EC_GROUP_GET_DEGREE 173 |
48fe4d62 | 1051 | #define EC_F_EC_GROUP_GET_ORDER 141 |
34f1f2a8 BM |
1052 | #define EC_F_EC_GROUP_GET_PENTANOMIAL_BASIS 193 |
1053 | #define EC_F_EC_GROUP_GET_TRINOMIAL_BASIS 194 | |
de10f690 | 1054 | #define EC_F_EC_GROUP_NEW 108 |
8b15c740 | 1055 | #define EC_F_EC_GROUP_NEW_BY_CURVE_NAME 174 |
7eb18f12 | 1056 | #define EC_F_EC_GROUP_NEW_FROM_DATA 175 |
194dd046 | 1057 | #define EC_F_EC_GROUP_PRECOMPUTE_MULT 142 |
7793f30e | 1058 | #define EC_F_EC_GROUP_SET_CURVE_GF2M 176 |
de10f690 | 1059 | #define EC_F_EC_GROUP_SET_CURVE_GFP 109 |
739a543e | 1060 | #define EC_F_EC_GROUP_SET_EXTRA_DATA 110 |
de10f690 | 1061 | #define EC_F_EC_GROUP_SET_GENERATOR 111 |
7eb18f12 BM |
1062 | #define EC_F_EC_KEY_CHECK_KEY 177 |
1063 | #define EC_F_EC_KEY_COPY 178 | |
1064 | #define EC_F_EC_KEY_GENERATE_KEY 179 | |
aa4ce731 | 1065 | #define EC_F_EC_KEY_NEW 182 |
7eb18f12 BM |
1066 | #define EC_F_EC_KEY_PRINT 180 |
1067 | #define EC_F_EC_KEY_PRINT_FP 181 | |
fef1c40b | 1068 | #define EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES 229 |
48fe4d62 | 1069 | #define EC_F_EC_POINTS_MAKE_AFFINE 136 |
de10f690 BM |
1070 | #define EC_F_EC_POINT_ADD 112 |
1071 | #define EC_F_EC_POINT_CMP 113 | |
1072 | #define EC_F_EC_POINT_COPY 114 | |
1073 | #define EC_F_EC_POINT_DBL 115 | |
7eb18f12 | 1074 | #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M 183 |
de10f690 BM |
1075 | #define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP 116 |
1076 | #define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP 117 | |
aa4ce731 | 1077 | #define EC_F_EC_POINT_INVERT 210 |
de10f690 BM |
1078 | #define EC_F_EC_POINT_IS_AT_INFINITY 118 |
1079 | #define EC_F_EC_POINT_IS_ON_CURVE 119 | |
1080 | #define EC_F_EC_POINT_MAKE_AFFINE 120 | |
7eb18f12 | 1081 | #define EC_F_EC_POINT_MUL 184 |
de10f690 BM |
1082 | #define EC_F_EC_POINT_NEW 121 |
1083 | #define EC_F_EC_POINT_OCT2POINT 122 | |
1084 | #define EC_F_EC_POINT_POINT2OCT 123 | |
7eb18f12 | 1085 | #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M 185 |
de10f690 | 1086 | #define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP 124 |
7eb18f12 | 1087 | #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M 186 |
1d5bd6cf BM |
1088 | #define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP 125 |
1089 | #define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP 126 | |
de10f690 | 1090 | #define EC_F_EC_POINT_SET_TO_INFINITY 127 |
37c660ff | 1091 | #define EC_F_EC_PRE_COMP_DUP 207 |
19f6c524 | 1092 | #define EC_F_EC_PRE_COMP_NEW 196 |
7eb18f12 BM |
1093 | #define EC_F_EC_WNAF_MUL 187 |
1094 | #define EC_F_EC_WNAF_PRECOMPUTE_MULT 188 | |
7eb18f12 BM |
1095 | #define EC_F_I2D_ECPARAMETERS 190 |
1096 | #define EC_F_I2D_ECPKPARAMETERS 191 | |
1097 | #define EC_F_I2D_ECPRIVATEKEY 192 | |
62e3163b | 1098 | #define EC_F_I2O_ECPUBLICKEY 151 |
04daec86 | 1099 | #define EC_F_NISTP224_PRE_COMP_NEW 227 |
3e00b4c9 BM |
1100 | #define EC_F_NISTP256_PRE_COMP_NEW 236 |
1101 | #define EC_F_NISTP521_PRE_COMP_NEW 237 | |
62e3163b | 1102 | #define EC_F_O2I_ECPUBLICKEY 152 |
5c95c2ac | 1103 | #define EC_F_OLD_EC_PRIV_DECODE 222 |
9ca7047d DSH |
1104 | #define EC_F_PKEY_EC_CTRL 197 |
1105 | #define EC_F_PKEY_EC_CTRL_STR 198 | |
1106 | #define EC_F_PKEY_EC_DERIVE 217 | |
1107 | #define EC_F_PKEY_EC_KEYGEN 199 | |
1108 | #define EC_F_PKEY_EC_PARAMGEN 219 | |
1109 | #define EC_F_PKEY_EC_SIGN 218 | |
6cc5e19d | 1110 | |
65e81670 | 1111 | /* Reason codes. */ |
7eb18f12 BM |
1112 | #define EC_R_ASN1_ERROR 115 |
1113 | #define EC_R_ASN1_UNKNOWN_FIELD 116 | |
04daec86 | 1114 | #define EC_R_BIGNUM_OUT_OF_RANGE 144 |
226cc7de | 1115 | #define EC_R_BUFFER_TOO_SMALL 100 |
fef1c40b | 1116 | #define EC_R_COORDINATES_OUT_OF_RANGE 146 |
7eb18f12 | 1117 | #define EC_R_D2I_ECPKPARAMETERS_FAILURE 117 |
5e3225cc | 1118 | #define EC_R_DECODE_ERROR 142 |
af28dd6c | 1119 | #define EC_R_DISCRIMINANT_IS_ZERO 118 |
7eb18f12 | 1120 | #define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 119 |
3b2eead3 | 1121 | #define EC_R_FIELD_TOO_LARGE 143 |
b3310161 | 1122 | #define EC_R_GF2M_NOT_SUPPORTED 147 |
7eb18f12 BM |
1123 | #define EC_R_GROUP2PKPARAMETERS_FAILURE 120 |
1124 | #define EC_R_I2D_ECPKPARAMETERS_FAILURE 121 | |
226cc7de | 1125 | #define EC_R_INCOMPATIBLE_OBJECTS 101 |
48fe4d62 | 1126 | #define EC_R_INVALID_ARGUMENT 112 |
bb62a8b0 BM |
1127 | #define EC_R_INVALID_COMPRESSED_POINT 110 |
1128 | #define EC_R_INVALID_COMPRESSION_BIT 109 | |
5e3225cc | 1129 | #define EC_R_INVALID_CURVE 141 |
9ca7047d | 1130 | #define EC_R_INVALID_DIGEST_TYPE 138 |
226cc7de | 1131 | #define EC_R_INVALID_ENCODING 102 |
de10f690 BM |
1132 | #define EC_R_INVALID_FIELD 103 |
1133 | #define EC_R_INVALID_FORM 104 | |
7eb18f12 | 1134 | #define EC_R_INVALID_GROUP_ORDER 122 |
5e3225cc | 1135 | #define EC_R_INVALID_PENTANOMIAL_BASIS 132 |
7eb18f12 | 1136 | #define EC_R_INVALID_PRIVATE_KEY 123 |
5e3225cc | 1137 | #define EC_R_INVALID_TRINOMIAL_BASIS 137 |
9ca7047d | 1138 | #define EC_R_KEYS_NOT_SET 140 |
7eb18f12 BM |
1139 | #define EC_R_MISSING_PARAMETERS 124 |
1140 | #define EC_R_MISSING_PRIVATE_KEY 125 | |
37c660ff BM |
1141 | #define EC_R_NOT_A_NIST_PRIME 135 |
1142 | #define EC_R_NOT_A_SUPPORTED_NIST_PRIME 136 | |
7eb18f12 | 1143 | #define EC_R_NOT_IMPLEMENTED 126 |
156e8557 | 1144 | #define EC_R_NOT_INITIALIZED 111 |
5c6bf031 | 1145 | #define EC_R_NO_FIELD_MOD 133 |
9ca7047d | 1146 | #define EC_R_NO_PARAMETERS_SET 139 |
5c6bf031 | 1147 | #define EC_R_PASSED_NULL_PARAMETER 134 |
7eb18f12 | 1148 | #define EC_R_PKPARAMETERS2GROUP_FAILURE 127 |
de10f690 BM |
1149 | #define EC_R_POINT_AT_INFINITY 106 |
1150 | #define EC_R_POINT_IS_NOT_ON_CURVE 107 | |
1151 | #define EC_R_SLOT_FULL 108 | |
6f8f4431 | 1152 | #define EC_R_UNDEFINED_GENERATOR 113 |
7eb18f12 BM |
1153 | #define EC_R_UNDEFINED_ORDER 128 |
1154 | #define EC_R_UNKNOWN_GROUP 129 | |
38374911 | 1155 | #define EC_R_UNKNOWN_ORDER 114 |
34f1f2a8 | 1156 | #define EC_R_UNSUPPORTED_FIELD 131 |
04daec86 | 1157 | #define EC_R_WRONG_CURVE_PARAMETERS 145 |
7eb18f12 | 1158 | #define EC_R_WRONG_ORDER 130 |
6cc5e19d | 1159 | |
65e81670 BM |
1160 | #ifdef __cplusplus |
1161 | } | |
1162 | #endif | |
5acaa495 | 1163 | #endif |