4bfcc916fd2c822948da99f9a366d037d328bfd9
[openssl.git] / crypto / ec / ec_lcl.h
1 /* crypto/ec/ec_lcl.h */
2 /* ====================================================================
3  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer. 
11  *
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.
16  *
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).
53  *
54  */
55
56
57 #include <stdlib.h>
58
59 #include <openssl/ec.h>
60
61
62 /* Structure details are not part of the exported interface,
63  * so all this may change in future versions. */
64
65 struct ec_method_st {
66         /* used by EC_GROUP_new, EC_GROUP_set_curve_GFp, EC_GROUP_free, EC_GROUP_copy: */
67         int (*group_init)(EC_GROUP *);
68         /* int (*group_set)(EC_GROUP *, .....); */
69         int (*group_set_curve_GFp)(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
70         void (*group_finish)(EC_GROUP *);
71         void (*group_clear_finish)(EC_GROUP *);
72         int (*group_copy)(EC_GROUP *, const EC_GROUP *);
73
74         /* used by EC_GROUP_set_generator: */
75         int (*group_set_generator)(EC_GROUP *, const EC_POINT *generator,
76                 const BIGNUM *order, const BIGNUM *cofactor);
77         
78         /* TODO: 'set' and 'get' functions for EC_GROUPs */
79
80
81         /* used by EC_POINT_new, EC_POINT_free, EC_POINT_copy: */
82         int (*point_init)(EC_POINT *);
83         void (*point_finish)(EC_POINT *);
84         void (*point_clear_finish)(EC_POINT *);
85         int (*point_copy)(EC_POINT *, const EC_POINT *);
86
87         /* TODO: 'set' and 'get' functions for EC_POINTs */
88
89         /* used by EC_POINT_point2oct, EC_POINT_oct2point: */
90         size_t (*point2oct)(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
91                 unsigned char *buf, size_t len, BN_CTX *);
92         int (*oct2point)(const EC_GROUP *, EC_POINT *,
93                 const unsigned char *buf, size_t len, BN_CTX *);
94
95         /* used by EC_POINT_add, EC_POINT_dbl: */
96         int (*add)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
97         int (*dbl)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
98
99         /* used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_make_affine */
100         int (*is_at_infinity)(const EC_GROUP *, const EC_POINT *);
101         int (*is_on_curve)(const EC_GROUP *, const EC_POINT *, BN_CTX *);
102         int (*make_affine)(const EC_GROUP *, EC_POINT *, BN_CTX *);
103
104
105         /* internal functions */
106
107         /* 'field_mul' and 'field_sqr' can be used by 'add' and 'dbl' so that
108          * the same implementations of point operations can be used with different
109          * optimized implementations of expensive field operations: */
110         int (*field_mul)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
111         int (*field_sqr)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
112
113         int (*field_encode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. to Montgomery */
114         int (*field_decode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. from Montgomery */
115 } /* EC_METHOD */;
116
117
118 struct ec_group_st {
119         const EC_METHOD *meth;
120
121         void *extra_data;
122         void *(*extra_data_dup_func)(void *);
123         void (*extra_data_free_func)(void *);
124         void (*extra_data_clear_free_func)(void *);
125
126         /* All members except 'meth' and 'extra_data...' are handled by
127          * the method functions, even if they appear generic */
128         
129         BIGNUM field; /* Field specification.
130                        * For curves over GF(p), this is the modulus. */
131
132         BIGNUM a, b; /* Curve coefficients.
133                       * (Here the assumption is that BIGNUMs can be used
134                       * or abused for all kinds of fields, not just GF(p).)
135                       * For characteristic  > 3,  the curve is defined
136                       * by a Weierstrass equation of the form
137                       *     y^2 = x^3 + a*x + b.
138                       */
139         int a_is_minus3; /* enable optimized point arithmetics for special case */
140
141         EC_POINT *generator; /* optional */
142         BIGNUM order, cofactor;
143
144         void *field_data; /* method-specific (e.g., Montgomery structure) */
145 } /* EC_GROUP */;
146
147
148 /* Basically a 'mixin' for extra data, but available for EC_GROUPs only
149  * (with visibility limited to 'package' level for now).
150  * We use the function pointers as index for retrieval; this obviates
151  * global ex_data-style index tables.
152  * (Currently, we have one slot only, but is is possible to extend this
153  * if necessary.) */
154 int EC_GROUP_set_extra_data(EC_GROUP *, void *extra_data, void *(*extra_data_dup_func)(void *),
155         void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *));
156 void *EC_GROUP_get_extra_data(EC_GROUP *, void *(*extra_data_dup_func)(void *),
157         void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *));
158 void EC_GROUP_free_extra_data(EC_GROUP *);
159 void EC_GROUP_clear_free_extra_data(EC_GROUP *);
160
161
162
163 struct ec_point_st {
164         const EC_METHOD *meth;
165
166         /* All members except 'meth' are handled by the method functions,
167          * even if they appear generic */
168
169         BIGNUM X;
170         BIGNUM Y;
171         BIGNUM Z; /* Jacobian projective coordinates:
172                    * (X, Y, Z)  represents  (X/Z^2, Y/Z^3)  if  Z != 0 */
173         int Z_is_one; /* enable optimized point arithmetics for special case */
174 } /* EC_POINT */;
175
176
177
178 /* method functions in ecp_smpl.c */
179 int ec_GFp_simple_group_init(EC_GROUP *);
180 int ec_GFp_simple_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
181 void ec_GFp_simple_group_finish(EC_GROUP *);
182 void ec_GFp_simple_group_clear_finish(EC_GROUP *);
183 int ec_GFp_simple_group_copy(EC_GROUP *, const EC_GROUP *);
184 int ec_GFp_simple_group_set_generator(EC_GROUP *, const EC_POINT *generator,
185         const BIGNUM *order, const BIGNUM *cofactor);
186 /* TODO: 'set' and 'get' functions for EC_GROUPs */
187 int ec_GFp_simple_point_init(EC_POINT *);
188 void ec_GFp_simple_point_finish(EC_POINT *);
189 void ec_GFp_simple_point_clear_finish(EC_POINT *);
190 int ec_GFp_simple_point_copy(EC_POINT *, const EC_POINT *);
191 /* TODO: 'set' and 'get' functions for EC_POINTs */
192 size_t ec_GFp_simple_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
193         unsigned char *buf, size_t len, BN_CTX *);
194 int ec_GFp_simple_oct2point(const EC_GROUP *, EC_POINT *,
195         const unsigned char *buf, size_t len, BN_CTX *);
196 int ec_GFp_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
197 int ec_GFp_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
198 int ec_GFp_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
199 int ec_GFp_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
200 int ec_GFp_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
201 int ec_GFp_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
202 int ec_GFp_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
203
204
205 /* method functions in ecp_mont.c */
206 int ec_GFp_mont_group_init(EC_GROUP *);
207 int ec_GFp_mont_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
208 void ec_GFp_mont_group_finish(EC_GROUP *);
209 void ec_GFp_mont_group_clear_finish(EC_GROUP *);
210 int ec_GFp_mont_group_copy(EC_GROUP *, const EC_GROUP *);
211 int ec_GFp_mont_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
212 int ec_GFp_mont_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
213 int ec_GFp_mont_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
214 int ec_GFp_mont_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
215
216
217 /* method functions in ecp_recp.c */
218 int ec_GFp_recp_group_init(EC_GROUP *);
219 int ec_GFp_recp_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
220 void ec_GFp_recp_group_finish(EC_GROUP *);
221 void ec_GFp_recp_group_clear_finish(EC_GROUP *);
222 int ec_GFp_recp_group_copy(EC_GROUP *, const EC_GROUP *);
223 int ec_GFp_recp_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
224 int ec_GFp_recp_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
225 int ec_GFp_recp_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
226 int ec_GFp_recp_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
227
228
229 /* method functions in ecp_nist.c */
230 int ec_GFp_nist_group_init(EC_GROUP *);
231 int ec_GFp_nist_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
232 void ec_GFp_nist_group_finish(EC_GROUP *);
233 void ec_GFp_nist_group_clear_finish(EC_GROUP *);
234 int ec_GFp_nist_group_copy(EC_GROUP *, const EC_GROUP *);
235 int ec_GFp_nist_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
236 int ec_GFp_nist_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
237 int ec_GFp_nist_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
238 int ec_GFp_nist_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);