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