Use 0 for tbslen to perform strlen.
[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 #define OPENSSL_FIPSAPI
71
72 #include <openssl/err.h>
73
74 #include "ec_lcl.h"
75
76 #ifndef OPENSSL_NO_EC2M
77
78
79 /* Compute the x-coordinate x/z for the point 2*(x/z) in Montgomery projective 
80  * coordinates.
81  * Uses algorithm Mdouble in appendix of 
82  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
83  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
84  * modified to not require precomputation of c=b^{2^{m-1}}.
85  */
86 static int gf2m_Mdouble(const EC_GROUP *group, BIGNUM *x, BIGNUM *z, BN_CTX *ctx)
87         {
88         BIGNUM *t1;
89         int ret = 0;
90         
91         /* Since Mdouble is static we can guarantee that ctx != NULL. */
92         BN_CTX_start(ctx);
93         t1 = BN_CTX_get(ctx);
94         if (t1 == NULL) goto err;
95
96         if (!group->meth->field_sqr(group, x, x, ctx)) goto err;
97         if (!group->meth->field_sqr(group, t1, z, ctx)) goto err;
98         if (!group->meth->field_mul(group, z, x, t1, ctx)) goto err;
99         if (!group->meth->field_sqr(group, x, x, ctx)) goto err;
100         if (!group->meth->field_sqr(group, t1, t1, ctx)) goto err;
101         if (!group->meth->field_mul(group, t1, &group->b, t1, ctx)) goto err;
102         if (!BN_GF2m_add(x, x, t1)) goto err;
103
104         ret = 1;
105
106  err:
107         BN_CTX_end(ctx);
108         return ret;
109         }
110
111 /* Compute the x-coordinate x1/z1 for the point (x1/z1)+(x2/x2) in Montgomery 
112  * projective coordinates.
113  * Uses algorithm Madd in appendix of 
114  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
115  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
116  */
117 static int gf2m_Madd(const EC_GROUP *group, const BIGNUM *x, BIGNUM *x1, BIGNUM *z1, 
118         const BIGNUM *x2, const BIGNUM *z2, BN_CTX *ctx)
119         {
120         BIGNUM *t1, *t2;
121         int ret = 0;
122         
123         /* Since Madd is static we can guarantee that ctx != NULL. */
124         BN_CTX_start(ctx);
125         t1 = BN_CTX_get(ctx);
126         t2 = BN_CTX_get(ctx);
127         if (t2 == NULL) goto err;
128
129         if (!BN_copy(t1, x)) goto err;
130         if (!group->meth->field_mul(group, x1, x1, z2, ctx)) goto err;
131         if (!group->meth->field_mul(group, z1, z1, x2, ctx)) goto err;
132         if (!group->meth->field_mul(group, t2, x1, z1, ctx)) goto err;
133         if (!BN_GF2m_add(z1, z1, x1)) goto err;
134         if (!group->meth->field_sqr(group, z1, z1, ctx)) goto err;
135         if (!group->meth->field_mul(group, x1, z1, t1, ctx)) goto err;
136         if (!BN_GF2m_add(x1, x1, t2)) goto err;
137
138         ret = 1;
139
140  err:
141         BN_CTX_end(ctx);
142         return ret;
143         }
144
145 /* Compute the x, y affine coordinates from the point (x1, z1) (x2, z2) 
146  * using Montgomery point multiplication algorithm Mxy() in appendix of 
147  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
148  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
149  * Returns:
150  *     0 on error
151  *     1 if return value should be the point at infinity
152  *     2 otherwise
153  */
154 static int gf2m_Mxy(const EC_GROUP *group, const BIGNUM *x, const BIGNUM *y, BIGNUM *x1, 
155         BIGNUM *z1, BIGNUM *x2, BIGNUM *z2, BN_CTX *ctx)
156         {
157         BIGNUM *t3, *t4, *t5;
158         int ret = 0;
159         
160         if (BN_is_zero(z1))
161                 {
162                 BN_zero(x2);
163                 BN_zero(z2);
164                 return 1;
165                 }
166         
167         if (BN_is_zero(z2))
168                 {
169                 if (!BN_copy(x2, x)) return 0;
170                 if (!BN_GF2m_add(z2, x, y)) return 0;
171                 return 2;
172                 }
173                 
174         /* Since Mxy is static we can guarantee that ctx != NULL. */
175         BN_CTX_start(ctx);
176         t3 = BN_CTX_get(ctx);
177         t4 = BN_CTX_get(ctx);
178         t5 = BN_CTX_get(ctx);
179         if (t5 == NULL) goto err;
180
181         if (!BN_one(t5)) goto err;
182
183         if (!group->meth->field_mul(group, t3, z1, z2, ctx)) goto err;
184
185         if (!group->meth->field_mul(group, z1, z1, x, ctx)) goto err;
186         if (!BN_GF2m_add(z1, z1, x1)) goto err;
187         if (!group->meth->field_mul(group, z2, z2, x, ctx)) goto err;
188         if (!group->meth->field_mul(group, x1, z2, x1, ctx)) goto err;
189         if (!BN_GF2m_add(z2, z2, x2)) goto err;
190
191         if (!group->meth->field_mul(group, z2, z2, z1, ctx)) goto err;
192         if (!group->meth->field_sqr(group, t4, x, ctx)) goto err;
193         if (!BN_GF2m_add(t4, t4, y)) goto err;
194         if (!group->meth->field_mul(group, t4, t4, t3, ctx)) goto err;
195         if (!BN_GF2m_add(t4, t4, z2)) goto err;
196
197         if (!group->meth->field_mul(group, t3, t3, x, ctx)) goto err;
198         if (!group->meth->field_div(group, t3, t5, t3, ctx)) goto err;
199         if (!group->meth->field_mul(group, t4, t3, t4, ctx)) goto err;
200         if (!group->meth->field_mul(group, x2, x1, t3, ctx)) goto err;
201         if (!BN_GF2m_add(z2, x2, x)) goto err;
202
203         if (!group->meth->field_mul(group, z2, z2, t4, ctx)) goto err;
204         if (!BN_GF2m_add(z2, z2, y)) goto err;
205
206         ret = 2;
207
208  err:
209         BN_CTX_end(ctx);
210         return ret;
211         }
212
213 /* Computes scalar*point and stores the result in r.
214  * point can not equal r.
215  * Uses algorithm 2P of
216  *     Lopez, J. and Dahab, R.  "Fast multiplication on elliptic curves over 
217  *     GF(2^m) without precomputation" (CHES '99, LNCS 1717).
218  */
219 static int ec_GF2m_montgomery_point_multiply(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
220         const EC_POINT *point, BN_CTX *ctx)
221         {
222         BIGNUM *x1, *x2, *z1, *z2;
223         int ret = 0, i;
224         BN_ULONG mask,word;
225
226         if (r == point)
227                 {
228                 ECerr(EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY, EC_R_INVALID_ARGUMENT);
229                 return 0;
230                 }
231         
232         /* if result should be point at infinity */
233         if ((scalar == NULL) || BN_is_zero(scalar) || (point == NULL) || 
234                 EC_POINT_is_at_infinity(group, point))
235                 {
236                 return EC_POINT_set_to_infinity(group, r);
237                 }
238
239         /* only support affine coordinates */
240         if (!point->Z_is_one) return 0;
241
242         /* Since point_multiply is static we can guarantee that ctx != NULL. */
243         BN_CTX_start(ctx);
244         x1 = BN_CTX_get(ctx);
245         z1 = BN_CTX_get(ctx);
246         if (z1 == NULL) goto err;
247
248         x2 = &r->X;
249         z2 = &r->Y;
250
251         if (!BN_GF2m_mod_arr(x1, &point->X, group->poly)) goto err; /* x1 = x */
252         if (!BN_one(z1)) goto err; /* z1 = 1 */
253         if (!group->meth->field_sqr(group, z2, x1, ctx)) goto err; /* z2 = x1^2 = x^2 */
254         if (!group->meth->field_sqr(group, x2, z2, ctx)) goto err;
255         if (!BN_GF2m_add(x2, x2, &group->b)) goto err; /* x2 = x^4 + b */
256
257         /* find top most bit and go one past it */
258         i = scalar->top - 1;
259         mask = BN_TBIT;
260         word = scalar->d[i];
261         while (!(word & mask)) mask >>= 1;
262         mask >>= 1;
263         /* if top most bit was at word break, go to next word */
264         if (!mask) 
265                 {
266                 i--;
267                 mask = BN_TBIT;
268                 }
269
270         for (; i >= 0; i--)
271                 {
272                 word = scalar->d[i];
273                 while (mask)
274                         {
275                         if (word & mask)
276                                 {
277                                 if (!gf2m_Madd(group, &point->X, x1, z1, x2, z2, ctx)) goto err;
278                                 if (!gf2m_Mdouble(group, x2, z2, ctx)) goto err;
279                                 }
280                         else
281                                 {
282                                 if (!gf2m_Madd(group, &point->X, x2, z2, x1, z1, ctx)) goto err;
283                                 if (!gf2m_Mdouble(group, x1, z1, ctx)) goto err;
284                                 }
285                         mask >>= 1;
286                         }
287                 mask = BN_TBIT;
288                 }
289
290         /* convert out of "projective" coordinates */
291         i = gf2m_Mxy(group, &point->X, &point->Y, x1, z1, x2, z2, ctx);
292         if (i == 0) goto err;
293         else if (i == 1) 
294                 {
295                 if (!EC_POINT_set_to_infinity(group, r)) goto err;
296                 }
297         else
298                 {
299                 if (!BN_one(&r->Z)) goto err;
300                 r->Z_is_one = 1;
301                 }
302
303         /* GF(2^m) field elements should always have BIGNUM::neg = 0 */
304         BN_set_negative(&r->X, 0);
305         BN_set_negative(&r->Y, 0);
306
307         ret = 1;
308
309  err:
310         BN_CTX_end(ctx);
311         return ret;
312         }
313
314
315 /* Computes the sum
316  *     scalar*group->generator + scalars[0]*points[0] + ... + scalars[num-1]*points[num-1]
317  * gracefully ignoring NULL scalar values.
318  */
319 int ec_GF2m_simple_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
320         size_t num, const EC_POINT *points[], const BIGNUM *scalars[], BN_CTX *ctx)
321         {
322         BN_CTX *new_ctx = NULL;
323         int ret = 0;
324         size_t i;
325         EC_POINT *p=NULL;
326         EC_POINT *acc = NULL;
327
328         if (ctx == NULL)
329                 {
330                 ctx = new_ctx = BN_CTX_new();
331                 if (ctx == NULL)
332                         return 0;
333                 }
334
335         /* This implementation is more efficient than the wNAF implementation for 2
336          * or fewer points.  Use the ec_wNAF_mul implementation for 3 or more points,
337          * or if we can perform a fast multiplication based on precomputation.
338          */
339         if ((scalar && (num > 1)) || (num > 2) || (num == 0 && EC_GROUP_have_precompute_mult(group)))
340                 {
341                 ret = ec_wNAF_mul(group, r, scalar, num, points, scalars, ctx);
342                 goto err;
343                 }
344
345         if ((p = EC_POINT_new(group)) == NULL) goto err;
346         if ((acc = EC_POINT_new(group)) == NULL) goto err;
347
348         if (!EC_POINT_set_to_infinity(group, acc)) goto err;
349
350         if (scalar)
351                 {
352                 if (!ec_GF2m_montgomery_point_multiply(group, p, scalar, group->generator, ctx)) goto err;
353                 if (BN_is_negative(scalar))
354                         if (!group->meth->invert(group, p, ctx)) goto err;
355                 if (!group->meth->add(group, acc, acc, p, ctx)) goto err;
356                 }
357
358         for (i = 0; i < num; i++)
359                 {
360                 if (!ec_GF2m_montgomery_point_multiply(group, p, scalars[i], points[i], ctx)) goto err;
361                 if (BN_is_negative(scalars[i]))
362                         if (!group->meth->invert(group, p, ctx)) goto err;
363                 if (!group->meth->add(group, acc, acc, p, ctx)) goto err;
364                 }
365
366         if (!EC_POINT_copy(r, acc)) goto err;
367
368         ret = 1;
369
370   err:
371         if (p) EC_POINT_free(p);
372         if (acc) EC_POINT_free(acc);
373         if (new_ctx != NULL)
374                 BN_CTX_free(new_ctx);
375         return ret;
376         }
377
378
379 /* Precomputation for point multiplication: fall back to wNAF methods
380  * because ec_GF2m_simple_mul() uses ec_wNAF_mul() if appropriate */
381
382 int ec_GF2m_precompute_mult(EC_GROUP *group, BN_CTX *ctx)
383         {
384         return ec_wNAF_precompute_mult(group, ctx);
385         }
386
387 int ec_GF2m_have_precompute_mult(const EC_GROUP *group)
388         {
389         return ec_wNAF_have_precompute_mult(group);
390         }
391
392 #endif