Add group_order_bits to EC_METHOD.
[openssl.git] / crypto / ec / ecp_mont.c
1 /*
2  * Originally written by Bodo Moeller for the OpenSSL project.
3  */
4 /* ====================================================================
5  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  *
19  * 3. All advertising materials mentioning features or use of this
20  *    software must display the following acknowledgment:
21  *    "This product includes software developed by the OpenSSL Project
22  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23  *
24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25  *    endorse or promote products derived from this software without
26  *    prior written permission. For written permission, please contact
27  *    openssl-core@openssl.org.
28  *
29  * 5. Products derived from this software may not be called "OpenSSL"
30  *    nor may "OpenSSL" appear in their names without prior written
31  *    permission of the OpenSSL Project.
32  *
33  * 6. Redistributions of any form whatsoever must retain the following
34  *    acknowledgment:
35  *    "This product includes software developed by the OpenSSL Project
36  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49  * OF THE POSSIBILITY OF SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This product includes cryptographic software written by Eric Young
53  * (eay@cryptsoft.com).  This product includes software written by Tim
54  * Hudson (tjh@cryptsoft.com).
55  *
56  */
57 /* ====================================================================
58  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
59  * Portions of this software developed by SUN MICROSYSTEMS, INC.,
60  * and contributed to the OpenSSL project.
61  */
62
63 #include <openssl/err.h>
64
65 #include "ec_lcl.h"
66
67 const EC_METHOD *EC_GFp_mont_method(void)
68 {
69     static const EC_METHOD ret = {
70         EC_FLAGS_DEFAULT_OCT,
71         NID_X9_62_prime_field,
72         ec_GFp_mont_group_init,
73         ec_GFp_mont_group_finish,
74         ec_GFp_mont_group_clear_finish,
75         ec_GFp_mont_group_copy,
76         ec_GFp_mont_group_set_curve,
77         ec_GFp_simple_group_get_curve,
78         ec_GFp_simple_group_get_degree,
79         0, /* group_order_bits */
80         ec_GFp_simple_group_check_discriminant,
81         ec_GFp_simple_point_init,
82         ec_GFp_simple_point_finish,
83         ec_GFp_simple_point_clear_finish,
84         ec_GFp_simple_point_copy,
85         ec_GFp_simple_point_set_to_infinity,
86         ec_GFp_simple_set_Jprojective_coordinates_GFp,
87         ec_GFp_simple_get_Jprojective_coordinates_GFp,
88         ec_GFp_simple_point_set_affine_coordinates,
89         ec_GFp_simple_point_get_affine_coordinates,
90         0, 0, 0,
91         ec_GFp_simple_add,
92         ec_GFp_simple_dbl,
93         ec_GFp_simple_invert,
94         ec_GFp_simple_is_at_infinity,
95         ec_GFp_simple_is_on_curve,
96         ec_GFp_simple_cmp,
97         ec_GFp_simple_make_affine,
98         ec_GFp_simple_points_make_affine,
99         0 /* mul */ ,
100         0 /* precompute_mult */ ,
101         0 /* have_precompute_mult */ ,
102         ec_GFp_mont_field_mul,
103         ec_GFp_mont_field_sqr,
104         0 /* field_div */ ,
105         ec_GFp_mont_field_encode,
106         ec_GFp_mont_field_decode,
107         ec_GFp_mont_field_set_to_one
108     };
109
110     return &ret;
111 }
112
113 int ec_GFp_mont_group_init(EC_GROUP *group)
114 {
115     int ok;
116
117     ok = ec_GFp_simple_group_init(group);
118     group->field_data1 = NULL;
119     group->field_data2 = NULL;
120     return ok;
121 }
122
123 void ec_GFp_mont_group_finish(EC_GROUP *group)
124 {
125     BN_MONT_CTX_free(group->field_data1);
126     group->field_data1 = NULL;
127     BN_free(group->field_data2);
128     group->field_data2 = NULL;
129     ec_GFp_simple_group_finish(group);
130 }
131
132 void ec_GFp_mont_group_clear_finish(EC_GROUP *group)
133 {
134     BN_MONT_CTX_free(group->field_data1);
135     group->field_data1 = NULL;
136     BN_clear_free(group->field_data2);
137     group->field_data2 = NULL;
138     ec_GFp_simple_group_clear_finish(group);
139 }
140
141 int ec_GFp_mont_group_copy(EC_GROUP *dest, const EC_GROUP *src)
142 {
143     BN_MONT_CTX_free(dest->field_data1);
144     dest->field_data1 = NULL;
145     BN_clear_free(dest->field_data2);
146     dest->field_data2 = NULL;
147
148     if (!ec_GFp_simple_group_copy(dest, src))
149         return 0;
150
151     if (src->field_data1 != NULL) {
152         dest->field_data1 = BN_MONT_CTX_new();
153         if (dest->field_data1 == NULL)
154             return 0;
155         if (!BN_MONT_CTX_copy(dest->field_data1, src->field_data1))
156             goto err;
157     }
158     if (src->field_data2 != NULL) {
159         dest->field_data2 = BN_dup(src->field_data2);
160         if (dest->field_data2 == NULL)
161             goto err;
162     }
163
164     return 1;
165
166  err:
167     BN_MONT_CTX_free(dest->field_data1);
168     dest->field_data1 = NULL;
169     return 0;
170 }
171
172 int ec_GFp_mont_group_set_curve(EC_GROUP *group, const BIGNUM *p,
173                                 const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
174 {
175     BN_CTX *new_ctx = NULL;
176     BN_MONT_CTX *mont = NULL;
177     BIGNUM *one = NULL;
178     int ret = 0;
179
180     BN_MONT_CTX_free(group->field_data1);
181     group->field_data1 = NULL;
182     BN_free(group->field_data2);
183     group->field_data2 = NULL;
184
185     if (ctx == NULL) {
186         ctx = new_ctx = BN_CTX_new();
187         if (ctx == NULL)
188             return 0;
189     }
190
191     mont = BN_MONT_CTX_new();
192     if (mont == NULL)
193         goto err;
194     if (!BN_MONT_CTX_set(mont, p, ctx)) {
195         ECerr(EC_F_EC_GFP_MONT_GROUP_SET_CURVE, ERR_R_BN_LIB);
196         goto err;
197     }
198     one = BN_new();
199     if (one == NULL)
200         goto err;
201     if (!BN_to_montgomery(one, BN_value_one(), mont, ctx))
202         goto err;
203
204     group->field_data1 = mont;
205     mont = NULL;
206     group->field_data2 = one;
207     one = NULL;
208
209     ret = ec_GFp_simple_group_set_curve(group, p, a, b, ctx);
210
211     if (!ret) {
212         BN_MONT_CTX_free(group->field_data1);
213         group->field_data1 = NULL;
214         BN_free(group->field_data2);
215         group->field_data2 = NULL;
216     }
217
218  err:
219     BN_CTX_free(new_ctx);
220     BN_MONT_CTX_free(mont);
221     return ret;
222 }
223
224 int ec_GFp_mont_field_mul(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a,
225                           const BIGNUM *b, BN_CTX *ctx)
226 {
227     if (group->field_data1 == NULL) {
228         ECerr(EC_F_EC_GFP_MONT_FIELD_MUL, EC_R_NOT_INITIALIZED);
229         return 0;
230     }
231
232     return BN_mod_mul_montgomery(r, a, b, group->field_data1, ctx);
233 }
234
235 int ec_GFp_mont_field_sqr(const EC_GROUP *group, BIGNUM *r, const BIGNUM *a,
236                           BN_CTX *ctx)
237 {
238     if (group->field_data1 == NULL) {
239         ECerr(EC_F_EC_GFP_MONT_FIELD_SQR, EC_R_NOT_INITIALIZED);
240         return 0;
241     }
242
243     return BN_mod_mul_montgomery(r, a, a, group->field_data1, ctx);
244 }
245
246 int ec_GFp_mont_field_encode(const EC_GROUP *group, BIGNUM *r,
247                              const BIGNUM *a, BN_CTX *ctx)
248 {
249     if (group->field_data1 == NULL) {
250         ECerr(EC_F_EC_GFP_MONT_FIELD_ENCODE, EC_R_NOT_INITIALIZED);
251         return 0;
252     }
253
254     return BN_to_montgomery(r, a, (BN_MONT_CTX *)group->field_data1, ctx);
255 }
256
257 int ec_GFp_mont_field_decode(const EC_GROUP *group, BIGNUM *r,
258                              const BIGNUM *a, BN_CTX *ctx)
259 {
260     if (group->field_data1 == NULL) {
261         ECerr(EC_F_EC_GFP_MONT_FIELD_DECODE, EC_R_NOT_INITIALIZED);
262         return 0;
263     }
264
265     return BN_from_montgomery(r, a, group->field_data1, ctx);
266 }
267
268 int ec_GFp_mont_field_set_to_one(const EC_GROUP *group, BIGNUM *r,
269                                  BN_CTX *ctx)
270 {
271     if (group->field_data2 == NULL) {
272         ECerr(EC_F_EC_GFP_MONT_FIELD_SET_TO_ONE, EC_R_NOT_INITIALIZED);
273         return 0;
274     }
275
276     if (!BN_copy(r, group->field_data2))
277         return 0;
278     return 1;
279 }