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