]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/ec/ec.h
Update the configuration of CygWin32 to use the new capabilities of
[thirdparty/openssl.git] / crypto / ec / ec.h
CommitLineData
65e81670
BM
1/* crypto/ec/ec.h */
2/* ====================================================================
3 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
6cc5e19d 4 *
65e81670
BM
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
6cc5e19d 8 *
65e81670
BM
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
6cc5e19d 11 *
65e81670
BM
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
6cc5e19d 16 *
65e81670
BM
17 * 3. All advertising materials mentioning features or use of this
18 * software must display the following acknowledgment:
19 * "This product includes software developed by the OpenSSL Project
20 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 *
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 * endorse or promote products derived from this software without
24 * prior written permission. For written permission, please contact
25 * openssl-core@openssl.org.
26 *
27 * 5. Products derived from this software may not be called "OpenSSL"
28 * nor may "OpenSSL" appear in their names without prior written
29 * permission of the OpenSSL Project.
30 *
31 * 6. Redistributions of any form whatsoever must retain the following
32 * acknowledgment:
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 *
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
49 *
50 * This product includes cryptographic software written by Eric Young
51 * (eay@cryptsoft.com). This product includes software written by Tim
52 * Hudson (tjh@cryptsoft.com).
6cc5e19d
BM
53 *
54 */
55
6cc5e19d
BM
56#ifndef HEADER_EC_H
57#define HEADER_EC_H
58
bb62a8b0 59#ifdef OPENSSL_NO_EC
37da54b1 60#error EC is disabled.
bb62a8b0
BM
61#endif
62
5acaa495 63#include <openssl/bn.h>
0e995464 64#include <openssl/symhacks.h>
6cc5e19d 65
65e81670
BM
66#ifdef __cplusplus
67extern "C" {
68#endif
6cc5e19d 69
6cc5e19d 70
3a12ce01 71typedef enum {
226cc7de 72 /* values as defined in X9.62 (ECDSA) and elsewhere */
3a12ce01
BM
73 POINT_CONVERSION_COMPRESSED = 2,
74 POINT_CONVERSION_UNCOMPRESSED = 4,
75 POINT_CONVERSION_HYBRID = 6
76} point_conversion_form_t;
77
78
79typedef struct ec_method_st EC_METHOD;
80
81typedef struct ec_group_st
82 /*
83 EC_METHOD *meth;
84 -- field definition
85 -- curve coefficients
86 -- optional generator with associated information (order, cofactor)
e3a4f8b8 87 -- optional extra data (TODO: precomputed table for fast computation of multiples of generator)
3a12ce01
BM
88 */
89 EC_GROUP;
90
91typedef struct ec_point_st EC_POINT;
92
93
94/* EC_METHODs for curves over GF(p).
95 * EC_GFp_simple_method provides the basis for the optimized methods.
96 */
3a12ce01
BM
97const EC_METHOD *EC_GFp_simple_method(void);
98const EC_METHOD *EC_GFp_mont_method(void);
8a2908a2 99#if 0
48fe4d62
BM
100const EC_METHOD *EC_GFp_recp_method(void); /* TODO */
101const EC_METHOD *EC_GFp_nist_method(void); /* TODO */
8a2908a2 102#endif
3a12ce01
BM
103
104
105EC_GROUP *EC_GROUP_new(const EC_METHOD *);
48fe4d62
BM
106void EC_GROUP_free(EC_GROUP *);
107void EC_GROUP_clear_free(EC_GROUP *);
108int EC_GROUP_copy(EC_GROUP *, const EC_GROUP *);
109
110const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *);
111
112
3a12ce01 113/* We don't have types for field specifications and field elements in general.
48fe4d62 114 * Otherwise we could declare
7d7db13e 115 * int EC_GROUP_set_curve(EC_GROUP *, .....);
3a12ce01 116 */
bb62a8b0 117int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
48fe4d62 118int EC_GROUP_get_curve_GFp(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
3a12ce01 119
24b8dc9a
BM
120/* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
121 * after choosing an appropriate EC_METHOD */
7d7db13e
BM
122EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
123
124int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
48fe4d62
BM
125EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *);
126int EC_GROUP_get_order(const EC_GROUP *, BIGNUM *order, BN_CTX *);
127int EC_GROUP_get_cofactor(const EC_GROUP *, BIGNUM *cofactor, BN_CTX *);
24b8dc9a 128
3a12ce01
BM
129EC_POINT *EC_POINT_new(const EC_GROUP *);
130void EC_POINT_free(EC_POINT *);
0657bf9c 131void EC_POINT_clear_free(EC_POINT *);
7d7db13e 132int EC_POINT_copy(EC_POINT *, const EC_POINT *);
3a12ce01 133
48fe4d62
BM
134const EC_METHOD *EC_POINT_method_of(const EC_POINT *);
135
226cc7de 136int EC_POINT_set_to_infinity(const EC_GROUP *, EC_POINT *);
1d5bd6cf
BM
137int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
138 const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
139int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
140 BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
226cc7de
BM
141int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
142 const BIGNUM *x, const BIGNUM *y, BN_CTX *);
143int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
144 BIGNUM *x, BIGNUM *y, BN_CTX *);
1d5bd6cf
BM
145int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *, EC_POINT *,
146 const BIGNUM *x, int y_bit, BN_CTX *);
7d7db13e 147
5b438e9b 148size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
7d7db13e
BM
149 unsigned char *buf, size_t len, BN_CTX *);
150int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
151 const unsigned char *buf, size_t len, BN_CTX *);
152
153int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
154int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
1d5bd6cf 155int EC_POINT_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
3a12ce01 156
5b438e9b
BM
157int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
158int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
1d5bd6cf 159int EC_POINT_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
fb171e53 160
e869d4bd 161int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
48fe4d62 162int EC_POINTs_make_affine(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
fb171e53 163
3a12ce01 164
38374911
BM
165int EC_POINTs_mul(const EC_GROUP *, EC_POINT *r, const BIGNUM *, size_t num, const EC_POINT *[], const BIGNUM *[], BN_CTX *);
166int EC_POINT_mul(const EC_GROUP *, EC_POINT *r, const BIGNUM *, const EC_POINT *, const BIGNUM *, BN_CTX *);
194dd046 167int EC_GROUP_precompute_mult(EC_GROUP *, BN_CTX *);
6cc5e19d 168
6cc5e19d
BM
169
170
65e81670
BM
171/* BEGIN ERROR CODES */
172/* The following lines are auto generated by the script mkerr.pl. Any changes
173 * made after this point may be overwritten when the script is next run.
174 */
de10f690 175void ERR_load_EC_strings(void);
6cc5e19d 176
65e81670 177/* Error codes for the EC functions. */
6cc5e19d 178
65e81670 179/* Function codes. */
3ba1f111 180#define EC_F_COMPUTE_WNAF 143
156e8557
BM
181#define EC_F_EC_GFP_MONT_FIELD_DECODE 133
182#define EC_F_EC_GFP_MONT_FIELD_ENCODE 134
183#define EC_F_EC_GFP_MONT_FIELD_MUL 131
184#define EC_F_EC_GFP_MONT_FIELD_SQR 132
de10f690
BM
185#define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP 100
186#define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR 101
187#define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE 102
188#define EC_F_EC_GFP_SIMPLE_OCT2POINT 103
189#define EC_F_EC_GFP_SIMPLE_POINT2OCT 104
48fe4d62 190#define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE 137
de10f690 191#define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105
bb62a8b0
BM
192#define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128
193#define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129
de10f690 194#define EC_F_EC_GROUP_COPY 106
48fe4d62
BM
195#define EC_F_EC_GROUP_GET0_GENERATOR 139
196#define EC_F_EC_GROUP_GET_COFACTOR 140
bb62a8b0 197#define EC_F_EC_GROUP_GET_CURVE_GFP 130
de10f690 198#define EC_F_EC_GROUP_GET_EXTRA_DATA 107
48fe4d62 199#define EC_F_EC_GROUP_GET_ORDER 141
de10f690 200#define EC_F_EC_GROUP_NEW 108
194dd046 201#define EC_F_EC_GROUP_PRECOMPUTE_MULT 142
de10f690
BM
202#define EC_F_EC_GROUP_SET_CURVE_GFP 109
203#define EC_F_EC_GROUP_SET_EXTRA_DATA 110
204#define EC_F_EC_GROUP_SET_GENERATOR 111
48fe4d62
BM
205#define EC_F_EC_POINTS_MAKE_AFFINE 136
206#define EC_F_EC_POINTS_MUL 138
de10f690
BM
207#define EC_F_EC_POINT_ADD 112
208#define EC_F_EC_POINT_CMP 113
209#define EC_F_EC_POINT_COPY 114
210#define EC_F_EC_POINT_DBL 115
211#define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP 116
212#define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP 117
213#define EC_F_EC_POINT_IS_AT_INFINITY 118
214#define EC_F_EC_POINT_IS_ON_CURVE 119
215#define EC_F_EC_POINT_MAKE_AFFINE 120
216#define EC_F_EC_POINT_NEW 121
217#define EC_F_EC_POINT_OCT2POINT 122
218#define EC_F_EC_POINT_POINT2OCT 123
219#define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP 124
1d5bd6cf
BM
220#define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP 125
221#define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP 126
de10f690 222#define EC_F_EC_POINT_SET_TO_INFINITY 127
156e8557 223#define EC_F_GFP_MONT_GROUP_SET_CURVE_GFP 135
6cc5e19d 224
65e81670 225/* Reason codes. */
226cc7de
BM
226#define EC_R_BUFFER_TOO_SMALL 100
227#define EC_R_INCOMPATIBLE_OBJECTS 101
48fe4d62 228#define EC_R_INVALID_ARGUMENT 112
bb62a8b0
BM
229#define EC_R_INVALID_COMPRESSED_POINT 110
230#define EC_R_INVALID_COMPRESSION_BIT 109
226cc7de 231#define EC_R_INVALID_ENCODING 102
de10f690
BM
232#define EC_R_INVALID_FIELD 103
233#define EC_R_INVALID_FORM 104
156e8557 234#define EC_R_NOT_INITIALIZED 111
de10f690
BM
235#define EC_R_NO_SUCH_EXTRA_DATA 105
236#define EC_R_POINT_AT_INFINITY 106
237#define EC_R_POINT_IS_NOT_ON_CURVE 107
238#define EC_R_SLOT_FULL 108
6f8f4431 239#define EC_R_UNDEFINED_GENERATOR 113
38374911 240#define EC_R_UNKNOWN_ORDER 114
6cc5e19d 241
65e81670
BM
242#ifdef __cplusplus
243}
244#endif
5acaa495 245#endif