Further comment amendments to preserve formatting prior to source reformat
[openssl.git] / crypto / ec / ec2_mult.c
1 /* crypto/ec/ec2_mult.c */
2 /* ====================================================================
3  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
4  *
5  * The Elliptic Curve Public-Key Crypto Library (ECC Code) included
6  * herein is developed by SUN MICROSYSTEMS, INC., and is contributed
7  * to the OpenSSL project.
8  *
9  * The ECC Code is licensed pursuant to the OpenSSL open source
10  * license provided below.
11  *
12  * The software is originally written by Sheueling Chang Shantz and
13  * Douglas Stebila of Sun Microsystems Laboratories.
14  *
15  */
16 /* ====================================================================
17  * Copyright (c) 1998-2003 The OpenSSL Project.  All rights reserved.
18  *
19  * Redistribution and use in source and binary forms, with or without
20  * modification, are permitted provided that the following conditions
21  * are met:
22  *
23  * 1. Redistributions of source code must retain the above copyright
24  *    notice, this list of conditions and the following disclaimer. 
25  *
26  * 2. Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in
28  *    the documentation and/or other materials provided with the
29  *    distribution.
30  *
31  * 3. All advertising materials mentioning features or use of this
32  *    software must display the following acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
35  *
36  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
37  *    endorse or promote products derived from this software without
38  *    prior written permission. For written permission, please contact
39  *    openssl-core@openssl.org.
40  *
41  * 5. Products derived from this software may not be called "OpenSSL"
42  *    nor may "OpenSSL" appear in their names without prior written
43  *    permission of the OpenSSL Project.
44  *
45  * 6. Redistributions of any form whatsoever must retain the following
46  *    acknowledgment:
47  *    "This product includes software developed by the OpenSSL Project
48  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
51  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
54  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
56  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
57  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
59  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
60  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
61  * OF THE POSSIBILITY OF SUCH DAMAGE.
62  * ====================================================================
63  *
64  * This product includes cryptographic software written by Eric Young
65  * (eay@cryptsoft.com).  This product includes software written by Tim
66  * Hudson (tjh@cryptsoft.com).
67  *
68  */
69
70
71
72 #include <openssl/err.h>
73
74 #include "internal/bn_int.h"
75 #include "ec_lcl.h"
76
77 #ifndef OPENSSL_NO_EC2M
78
79
80 /*-
81  * Compute the x-coordinate x/z for the point 2*(x/z) in Montgomery projective 
82  * coordinates.
83  * Uses algorithm Mdouble in appendix of 
84  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
85  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
86  * modified to not require precomputation of c=b^{2^{m-1}}.
87  */
88 static int gf2m_Mdouble(const EC_GROUP *group, BIGNUM *x, BIGNUM *z, BN_CTX *ctx)
89         {
90         BIGNUM *t1;
91         int ret = 0;
92         
93         /* Since Mdouble is static we can guarantee that ctx != NULL. */
94         BN_CTX_start(ctx);
95         t1 = BN_CTX_get(ctx);
96         if (t1 == NULL) goto err;
97
98         if (!group->meth->field_sqr(group, x, x, ctx)) goto err;
99         if (!group->meth->field_sqr(group, t1, z, ctx)) goto err;
100         if (!group->meth->field_mul(group, z, x, t1, ctx)) goto err;
101         if (!group->meth->field_sqr(group, x, x, ctx)) goto err;
102         if (!group->meth->field_sqr(group, t1, t1, ctx)) goto err;
103         if (!group->meth->field_mul(group, t1, group->b, t1, ctx)) goto err;
104         if (!BN_GF2m_add(x, x, t1)) goto err;
105
106         ret = 1;
107
108  err:
109         BN_CTX_end(ctx);
110         return ret;
111         }
112
113 /*-
114  * Compute the x-coordinate x1/z1 for the point (x1/z1)+(x2/x2) in Montgomery 
115  * projective coordinates.
116  * Uses algorithm Madd in appendix of 
117  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
118  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
119  */
120 static int gf2m_Madd(const EC_GROUP *group, const BIGNUM *x, BIGNUM *x1, BIGNUM *z1, 
121         const BIGNUM *x2, const BIGNUM *z2, BN_CTX *ctx)
122         {
123         BIGNUM *t1, *t2;
124         int ret = 0;
125         
126         /* Since Madd is static we can guarantee that ctx != NULL. */
127         BN_CTX_start(ctx);
128         t1 = BN_CTX_get(ctx);
129         t2 = BN_CTX_get(ctx);
130         if (t2 == NULL) goto err;
131
132         if (!BN_copy(t1, x)) goto err;
133         if (!group->meth->field_mul(group, x1, x1, z2, ctx)) goto err;
134         if (!group->meth->field_mul(group, z1, z1, x2, ctx)) goto err;
135         if (!group->meth->field_mul(group, t2, x1, z1, ctx)) goto err;
136         if (!BN_GF2m_add(z1, z1, x1)) goto err;
137         if (!group->meth->field_sqr(group, z1, z1, ctx)) goto err;
138         if (!group->meth->field_mul(group, x1, z1, t1, ctx)) goto err;
139         if (!BN_GF2m_add(x1, x1, t2)) goto err;
140
141         ret = 1;
142
143  err:
144         BN_CTX_end(ctx);
145         return ret;
146         }
147
148 /*-
149  * Compute the x, y affine coordinates from the point (x1, z1) (x2, z2) 
150  * using Montgomery point multiplication algorithm Mxy() in appendix of 
151  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
152  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
153  * Returns:
154  *     0 on error
155  *     1 if return value should be the point at infinity
156  *     2 otherwise
157  */
158 static int gf2m_Mxy(const EC_GROUP *group, const BIGNUM *x, const BIGNUM *y, BIGNUM *x1, 
159         BIGNUM *z1, BIGNUM *x2, BIGNUM *z2, BN_CTX *ctx)
160         {
161         BIGNUM *t3, *t4, *t5;
162         int ret = 0;
163         
164         if (BN_is_zero(z1))
165                 {
166                 BN_zero(x2);
167                 BN_zero(z2);
168                 return 1;
169                 }
170         
171         if (BN_is_zero(z2))
172                 {
173                 if (!BN_copy(x2, x)) return 0;
174                 if (!BN_GF2m_add(z2, x, y)) return 0;
175                 return 2;
176                 }
177                 
178         /* Since Mxy is static we can guarantee that ctx != NULL. */
179         BN_CTX_start(ctx);
180         t3 = BN_CTX_get(ctx);
181         t4 = BN_CTX_get(ctx);
182         t5 = BN_CTX_get(ctx);
183         if (t5 == NULL) goto err;
184
185         if (!BN_one(t5)) goto err;
186
187         if (!group->meth->field_mul(group, t3, z1, z2, ctx)) goto err;
188
189         if (!group->meth->field_mul(group, z1, z1, x, ctx)) goto err;
190         if (!BN_GF2m_add(z1, z1, x1)) goto err;
191         if (!group->meth->field_mul(group, z2, z2, x, ctx)) goto err;
192         if (!group->meth->field_mul(group, x1, z2, x1, ctx)) goto err;
193         if (!BN_GF2m_add(z2, z2, x2)) goto err;
194
195         if (!group->meth->field_mul(group, z2, z2, z1, ctx)) goto err;
196         if (!group->meth->field_sqr(group, t4, x, ctx)) goto err;
197         if (!BN_GF2m_add(t4, t4, y)) goto err;
198         if (!group->meth->field_mul(group, t4, t4, t3, ctx)) goto err;
199         if (!BN_GF2m_add(t4, t4, z2)) goto err;
200
201         if (!group->meth->field_mul(group, t3, t3, x, ctx)) goto err;
202         if (!group->meth->field_div(group, t3, t5, t3, ctx)) goto err;
203         if (!group->meth->field_mul(group, t4, t3, t4, ctx)) goto err;
204         if (!group->meth->field_mul(group, x2, x1, t3, ctx)) goto err;
205         if (!BN_GF2m_add(z2, x2, x)) goto err;
206
207         if (!group->meth->field_mul(group, z2, z2, t4, ctx)) goto err;
208         if (!BN_GF2m_add(z2, z2, y)) goto err;
209
210         ret = 2;
211
212  err:
213         BN_CTX_end(ctx);
214         return ret;
215         }
216
217
218 /*-
219  * Computes scalar*point and stores the result in r.
220  * point can not equal r.
221  * Uses a modified algorithm 2P of
222  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
223  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
224  *
225  * To protect against side-channel attack the function uses constant time swap,
226  * avoiding conditional branches.
227  */
228 static int ec_GF2m_montgomery_point_multiply(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
229         const EC_POINT *point, BN_CTX *ctx)
230         {
231         BIGNUM *x1, *x2, *z1, *z2;
232         int ret = 0, i;
233         BN_ULONG mask,word;
234
235         if (r == point)
236                 {
237                 ECerr(EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY, EC_R_INVALID_ARGUMENT);
238                 return 0;
239                 }
240         
241         /* if result should be point at infinity */
242         if ((scalar == NULL) || BN_is_zero(scalar) || (point == NULL) || 
243                 EC_POINT_is_at_infinity(group, point))
244                 {
245                 return EC_POINT_set_to_infinity(group, r);
246                 }
247
248         /* only support affine coordinates */
249         if (!point->Z_is_one) return 0;
250
251         /* Since point_multiply is static we can guarantee that ctx != NULL. */
252         BN_CTX_start(ctx);
253         x1 = BN_CTX_get(ctx);
254         z1 = BN_CTX_get(ctx);
255         if (z1 == NULL) goto err;
256
257         x2 = r->X;
258         z2 = r->Y;
259
260         bn_wexpand(x1, bn_get_top(group->field));
261         bn_wexpand(z1, bn_get_top(group->field));
262         bn_wexpand(x2, bn_get_top(group->field));
263         bn_wexpand(z2, bn_get_top(group->field));
264
265         if (!BN_GF2m_mod_arr(x1, point->X, group->poly)) goto err; /* x1 = x */
266         if (!BN_one(z1)) goto err; /* z1 = 1 */
267         if (!group->meth->field_sqr(group, z2, x1, ctx)) goto err; /* z2 = x1^2 = x^2 */
268         if (!group->meth->field_sqr(group, x2, z2, ctx)) goto err;
269         if (!BN_GF2m_add(x2, x2, group->b)) goto err; /* x2 = x^4 + b */
270
271         /* find top most bit and go one past it */
272         i = bn_get_top(scalar) - 1;
273         mask = BN_TBIT;
274         word = bn_get_words(scalar)[i];
275         while (!(word & mask)) mask >>= 1;
276         mask >>= 1;
277         /* if top most bit was at word break, go to next word */
278         if (!mask) 
279                 {
280                 i--;
281                 mask = BN_TBIT;
282                 }
283
284         for (; i >= 0; i--)
285                 {
286                 word = bn_get_words(scalar)[i];
287                 while (mask)
288                         {
289                         BN_consttime_swap(word & mask, x1, x2, bn_get_top(group->field));
290                         BN_consttime_swap(word & mask, z1, z2, bn_get_top(group->field));
291                         if (!gf2m_Madd(group, point->X, x2, z2, x1, z1, ctx)) goto err;
292                         if (!gf2m_Mdouble(group, x1, z1, ctx)) goto err;
293                         BN_consttime_swap(word & mask, x1, x2, bn_get_top(group->field));
294                         BN_consttime_swap(word & mask, z1, z2, bn_get_top(group->field));
295                         mask >>= 1;
296                         }
297                 mask = BN_TBIT;
298                 }
299
300         /* convert out of "projective" coordinates */
301         i = gf2m_Mxy(group, point->X, point->Y, x1, z1, x2, z2, ctx);
302         if (i == 0) goto err;
303         else if (i == 1) 
304                 {
305                 if (!EC_POINT_set_to_infinity(group, r)) goto err;
306                 }
307         else
308                 {
309                 if (!BN_one(r->Z)) goto err;
310                 r->Z_is_one = 1;
311                 }
312
313         /* GF(2^m) field elements should always have BIGNUM::neg = 0 */
314         BN_set_negative(r->X, 0);
315         BN_set_negative(r->Y, 0);
316
317         ret = 1;
318
319  err:
320         BN_CTX_end(ctx);
321         return ret;
322         }
323
324
325 /*-
326  * Computes the sum
327  *     scalar*group->generator + scalars[0]*points[0] + ... + scalars[num-1]*points[num-1]
328  * gracefully ignoring NULL scalar values.
329  */
330 int ec_GF2m_simple_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
331         size_t num, const EC_POINT *points[], const BIGNUM *scalars[], BN_CTX *ctx)
332         {
333         BN_CTX *new_ctx = NULL;
334         int ret = 0;
335         size_t i;
336         EC_POINT *p=NULL;
337         EC_POINT *acc = NULL;
338
339         if (ctx == NULL)
340                 {
341                 ctx = new_ctx = BN_CTX_new();
342                 if (ctx == NULL)
343                         return 0;
344                 }
345
346         /* This implementation is more efficient than the wNAF implementation for 2
347          * or fewer points.  Use the ec_wNAF_mul implementation for 3 or more points,
348          * or if we can perform a fast multiplication based on precomputation.
349          */
350         if ((scalar && (num > 1)) || (num > 2) || (num == 0 && EC_GROUP_have_precompute_mult(group)))
351                 {
352                 ret = ec_wNAF_mul(group, r, scalar, num, points, scalars, ctx);
353                 goto err;
354                 }
355
356         if ((p = EC_POINT_new(group)) == NULL) goto err;
357         if ((acc = EC_POINT_new(group)) == NULL) goto err;
358
359         if (!EC_POINT_set_to_infinity(group, acc)) goto err;
360
361         if (scalar)
362                 {
363                 if (!ec_GF2m_montgomery_point_multiply(group, p, scalar, group->generator, ctx)) goto err;
364                 if (BN_is_negative(scalar))
365                         if (!group->meth->invert(group, p, ctx)) goto err;
366                 if (!group->meth->add(group, acc, acc, p, ctx)) goto err;
367                 }
368
369         for (i = 0; i < num; i++)
370                 {
371                 if (!ec_GF2m_montgomery_point_multiply(group, p, scalars[i], points[i], ctx)) goto err;
372                 if (BN_is_negative(scalars[i]))
373                         if (!group->meth->invert(group, p, ctx)) goto err;
374                 if (!group->meth->add(group, acc, acc, p, ctx)) goto err;
375                 }
376
377         if (!EC_POINT_copy(r, acc)) goto err;
378
379         ret = 1;
380
381   err:
382         if (p) EC_POINT_free(p);
383         if (acc) EC_POINT_free(acc);
384         if (new_ctx != NULL)
385                 BN_CTX_free(new_ctx);
386         return ret;
387         }
388
389
390 /* Precomputation for point multiplication: fall back to wNAF methods
391  * because ec_GF2m_simple_mul() uses ec_wNAF_mul() if appropriate */
392
393 int ec_GF2m_precompute_mult(EC_GROUP *group, BN_CTX *ctx)
394         {
395         return ec_wNAF_precompute_mult(group, ctx);
396         }
397
398 int ec_GF2m_have_precompute_mult(const EC_GROUP *group)
399         {
400         return ec_wNAF_have_precompute_mult(group);
401         }
402
403 #endif