Prepare support for non-Weierstrass EC equations.
[libgcrypt.git] / mpi / ec.c
1 /* ec.c -  Elliptic Curve functions
2  * Copyright (C) 2007 Free Software Foundation, Inc.
3  * Copyright (C) 2013 g10 Code GmbH
4  *
5  * This file is part of Libgcrypt.
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <errno.h>
25
26 #include "mpi-internal.h"
27 #include "longlong.h"
28 #include "g10lib.h"
29 #include "context.h"
30 #include "ec-context.h"
31
32
33 #define point_init(a)  _gcry_mpi_point_init ((a))
34 #define point_free(a)  _gcry_mpi_point_free_parts ((a))
35
36
37 /* Create a new point option.  NBITS gives the size in bits of one
38    coordinate; it is only used to pre-allocate some resources and
39    might also be passed as 0 to use a default value.  */
40 mpi_point_t
41 gcry_mpi_point_new (unsigned int nbits)
42 {
43   mpi_point_t p;
44
45   (void)nbits;  /* Currently not used.  */
46
47   p = gcry_xmalloc (sizeof *p);
48   _gcry_mpi_point_init (p);
49   return p;
50 }
51
52
53 /* Release the point object P.  P may be NULL. */
54 void
55 gcry_mpi_point_release (mpi_point_t p)
56 {
57   if (p)
58     {
59       _gcry_mpi_point_free_parts (p);
60       gcry_free (p);
61     }
62 }
63
64
65 /* Initialize the fields of a point object.  gcry_mpi_point_free_parts
66    may be used to release the fields.  */
67 void
68 _gcry_mpi_point_init (mpi_point_t p)
69 {
70   p->x = mpi_new (0);
71   p->y = mpi_new (0);
72   p->z = mpi_new (0);
73 }
74
75
76 /* Release the parts of a point object. */
77 void
78 _gcry_mpi_point_free_parts (mpi_point_t p)
79 {
80   mpi_free (p->x); p->x = NULL;
81   mpi_free (p->y); p->y = NULL;
82   mpi_free (p->z); p->z = NULL;
83 }
84
85
86 /* Set the value from S into D.  */
87 static void
88 point_set (mpi_point_t d, mpi_point_t s)
89 {
90   mpi_set (d->x, s->x);
91   mpi_set (d->y, s->y);
92   mpi_set (d->z, s->z);
93 }
94
95
96 /* Return a copy of POINT.  */
97 static gcry_mpi_point_t
98 point_copy (gcry_mpi_point_t point)
99 {
100   gcry_mpi_point_t newpoint;
101
102   if (point)
103     {
104       newpoint = gcry_mpi_point_new (0);
105       point_set (newpoint, point);
106     }
107   else
108     newpoint = NULL;
109   return newpoint;
110 }
111
112
113 /* Set the projective coordinates from POINT into X, Y, and Z.  If a
114    coordinate is not required, X, Y, or Z may be passed as NULL.  */
115 void
116 gcry_mpi_point_get (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
117                     mpi_point_t point)
118 {
119   if (x)
120     mpi_set (x, point->x);
121   if (y)
122     mpi_set (y, point->y);
123   if (z)
124     mpi_set (z, point->z);
125 }
126
127
128 /* Set the projective coordinates from POINT into X, Y, and Z and
129    release POINT.  If a coordinate is not required, X, Y, or Z may be
130    passed as NULL.  */
131 void
132 gcry_mpi_point_snatch_get (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
133                            mpi_point_t point)
134 {
135   mpi_snatch (x, point->x);
136   mpi_snatch (y, point->y);
137   mpi_snatch (z, point->z);
138   gcry_free (point);
139 }
140
141
142 /* Set the projective coordinates from X, Y, and Z into POINT.  If a
143    coordinate is given as NULL, the value 0 is stored into point.  If
144    POINT is given as NULL a new point object is allocated.  Returns
145    POINT or the newly allocated point object. */
146 mpi_point_t
147 gcry_mpi_point_set (mpi_point_t point,
148                     gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z)
149 {
150   if (!point)
151     point = gcry_mpi_point_new (0);
152
153   if (x)
154     mpi_set (point->x, x);
155   else
156     mpi_clear (point->x);
157   if (y)
158     mpi_set (point->y, y);
159   else
160     mpi_clear (point->y);
161   if (z)
162     mpi_set (point->z, z);
163   else
164     mpi_clear (point->z);
165
166   return point;
167 }
168
169
170 /* Set the projective coordinates from X, Y, and Z into POINT.  If a
171    coordinate is given as NULL, the value 0 is stored into point.  If
172    POINT is given as NULL a new point object is allocated.  The
173    coordinates X, Y, and Z are released.  Returns POINT or the newly
174    allocated point object. */
175 mpi_point_t
176 gcry_mpi_point_snatch_set (mpi_point_t point,
177                            gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z)
178 {
179   if (!point)
180     point = gcry_mpi_point_new (0);
181
182   if (x)
183     mpi_snatch (point->x, x);
184   else
185     mpi_clear (point->x);
186   if (y)
187     mpi_snatch (point->y, y);
188   else
189     mpi_clear (point->y);
190   if (z)
191     mpi_snatch (point->z, z);
192   else
193     mpi_clear (point->z);
194
195   return point;
196 }
197
198
199 static void
200 ec_addm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, mpi_ec_t ctx)
201 {
202   mpi_addm (w, u, v, ctx->p);
203 }
204
205 static void
206 ec_subm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, mpi_ec_t ctx)
207 {
208   mpi_subm (w, u, v, ctx->p);
209 }
210
211 static void
212 ec_mulm (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v, mpi_ec_t ctx)
213 {
214 #if 0
215   /* NOTE: This code works only for limb sizes of 32 bit.  */
216   mpi_limb_t *wp, *sp;
217
218   if (ctx->nist_nbits == 192)
219     {
220       mpi_mul (w, u, v);
221       mpi_resize (w, 12);
222       wp = w->d;
223
224       sp = ctx->s[0]->d;
225       sp[0*2+0] = wp[0*2+0];
226       sp[0*2+1] = wp[0*2+1];
227       sp[1*2+0] = wp[1*2+0];
228       sp[1*2+1] = wp[1*2+1];
229       sp[2*2+0] = wp[2*2+0];
230       sp[2*2+1] = wp[2*2+1];
231
232       sp = ctx->s[1]->d;
233       sp[0*2+0] = wp[3*2+0];
234       sp[0*2+1] = wp[3*2+1];
235       sp[1*2+0] = wp[3*2+0];
236       sp[1*2+1] = wp[3*2+1];
237       sp[2*2+0] = 0;
238       sp[2*2+1] = 0;
239
240       sp = ctx->s[2]->d;
241       sp[0*2+0] = 0;
242       sp[0*2+1] = 0;
243       sp[1*2+0] = wp[4*2+0];
244       sp[1*2+1] = wp[4*2+1];
245       sp[2*2+0] = wp[4*2+0];
246       sp[2*2+1] = wp[4*2+1];
247
248       sp = ctx->s[3]->d;
249       sp[0*2+0] = wp[5*2+0];
250       sp[0*2+1] = wp[5*2+1];
251       sp[1*2+0] = wp[5*2+0];
252       sp[1*2+1] = wp[5*2+1];
253       sp[2*2+0] = wp[5*2+0];
254       sp[2*2+1] = wp[5*2+1];
255
256       ctx->s[0]->nlimbs = 6;
257       ctx->s[1]->nlimbs = 6;
258       ctx->s[2]->nlimbs = 6;
259       ctx->s[3]->nlimbs = 6;
260
261       mpi_add (ctx->c, ctx->s[0], ctx->s[1]);
262       mpi_add (ctx->c, ctx->c, ctx->s[2]);
263       mpi_add (ctx->c, ctx->c, ctx->s[3]);
264
265       while ( mpi_cmp (ctx->c, ctx->p ) >= 0 )
266         mpi_sub ( ctx->c, ctx->c, ctx->p );
267       mpi_set (w, ctx->c);
268     }
269   else if (ctx->nist_nbits == 384)
270     {
271       int i;
272       mpi_mul (w, u, v);
273       mpi_resize (w, 24);
274       wp = w->d;
275
276 #define NEXT(a) do { ctx->s[(a)]->nlimbs = 12; \
277                      sp = ctx->s[(a)]->d; \
278                      i = 0; } while (0)
279 #define X(a) do { sp[i++] = wp[(a)];} while (0)
280 #define X0(a) do { sp[i++] = 0; } while (0)
281       NEXT(0);
282       X(0);X(1);X(2);X(3);X(4);X(5);X(6);X(7);X(8);X(9);X(10);X(11);
283       NEXT(1);
284       X0();X0();X0();X0();X(21);X(22);X(23);X0();X0();X0();X0();X0();
285       NEXT(2);
286       X(12);X(13);X(14);X(15);X(16);X(17);X(18);X(19);X(20);X(21);X(22);X(23);
287       NEXT(3);
288       X(21);X(22);X(23);X(12);X(13);X(14);X(15);X(16);X(17);X(18);X(19);X(20);
289       NEXT(4);
290       X0();X(23);X0();X(20);X(12);X(13);X(14);X(15);X(16);X(17);X(18);X(19);
291       NEXT(5);
292       X0();X0();X0();X0();X(20);X(21);X(22);X(23);X0();X0();X0();X0();
293       NEXT(6);
294       X(20);X0();X0();X(21);X(22);X(23);X0();X0();X0();X0();X0();X0();
295       NEXT(7);
296       X(23);X(12);X(13);X(14);X(15);X(16);X(17);X(18);X(19);X(20);X(21);X(22);
297       NEXT(8);
298       X0();X(20);X(21);X(22);X(23);X0();X0();X0();X0();X0();X0();X0();
299       NEXT(9);
300       X0();X0();X0();X(23);X(23);X0();X0();X0();X0();X0();X0();X0();
301 #undef X0
302 #undef X
303 #undef NEXT
304       mpi_add (ctx->c, ctx->s[0], ctx->s[1]);
305       mpi_add (ctx->c, ctx->c, ctx->s[1]);
306       mpi_add (ctx->c, ctx->c, ctx->s[2]);
307       mpi_add (ctx->c, ctx->c, ctx->s[3]);
308       mpi_add (ctx->c, ctx->c, ctx->s[4]);
309       mpi_add (ctx->c, ctx->c, ctx->s[5]);
310       mpi_add (ctx->c, ctx->c, ctx->s[6]);
311       mpi_sub (ctx->c, ctx->c, ctx->s[7]);
312       mpi_sub (ctx->c, ctx->c, ctx->s[8]);
313       mpi_sub (ctx->c, ctx->c, ctx->s[9]);
314
315       while ( mpi_cmp (ctx->c, ctx->p ) >= 0 )
316         mpi_sub ( ctx->c, ctx->c, ctx->p );
317       while ( ctx->c->sign )
318         mpi_add ( ctx->c, ctx->c, ctx->p );
319       mpi_set (w, ctx->c);
320     }
321   else
322 #endif /*0*/
323     mpi_mulm (w, u, v, ctx->p);
324 }
325
326 static void
327 ec_powm (gcry_mpi_t w, const gcry_mpi_t b, const gcry_mpi_t e,
328          mpi_ec_t ctx)
329 {
330   mpi_powm (w, b, e, ctx->p);
331 }
332
333 static void
334 ec_invm (gcry_mpi_t x, gcry_mpi_t a, mpi_ec_t ctx)
335 {
336   mpi_invm (x, a, ctx->p);
337 }
338
339
340 /* Force recomputation of all helper variables.  */
341 static void
342 ec_get_reset (mpi_ec_t ec)
343 {
344   ec->t.valid.a_is_pminus3 = 0;
345   ec->t.valid.two_inv_p = 0;
346 }
347
348
349 /* Accessor for helper variable.  */
350 static int
351 ec_get_a_is_pminus3 (mpi_ec_t ec)
352 {
353   gcry_mpi_t tmp;
354
355   if (!ec->t.valid.a_is_pminus3)
356     {
357       ec->t.valid.a_is_pminus3 = 1;
358       tmp = mpi_alloc_like (ec->p);
359       mpi_sub_ui (tmp, ec->p, 3);
360       ec->t.a_is_pminus3 = !mpi_cmp (ec->a, tmp);
361       mpi_free (tmp);
362     }
363
364   return ec->t.a_is_pminus3;
365 }
366
367
368 /* Accessor for helper variable.  */
369 static gcry_mpi_t
370 ec_get_two_inv_p (mpi_ec_t ec)
371 {
372   if (!ec->t.valid.two_inv_p)
373     {
374       ec->t.valid.two_inv_p = 1;
375       if (!ec->t.two_inv_p)
376         ec->t.two_inv_p = mpi_alloc (0);
377       ec_invm (ec->t.two_inv_p, mpi_const (MPI_C_TWO), ec);
378     }
379   return ec->t.two_inv_p;
380 }
381
382
383
384 /* This function initialized a context for elliptic curve based on the
385    field GF(p).  P is the prime specifying this field, A is the first
386    coefficient.  CTX is expected to be zeroized.  */
387 static void
388 ec_p_init (mpi_ec_t ctx, gcry_mpi_t p, gcry_mpi_t a)
389 {
390   int i;
391
392   /* Fixme: Do we want to check some constraints? e.g.  a < p  */
393
394   ctx->p = mpi_copy (p);
395   ctx->a = mpi_copy (a);
396
397   ec_get_reset (ctx);
398
399   /* Allocate scratch variables.  */
400   for (i=0; i< DIM(ctx->t.scratch); i++)
401     ctx->t.scratch[i] = mpi_alloc_like (ctx->p);
402
403   /* Prepare for fast reduction.  */
404   /* FIXME: need a test for NIST values.  However it does not gain us
405      any real advantage, for 384 bits it is actually slower than using
406      mpi_mulm.  */
407 /*   ctx->nist_nbits = mpi_get_nbits (ctx->p); */
408 /*   if (ctx->nist_nbits == 192) */
409 /*     { */
410 /*       for (i=0; i < 4; i++) */
411 /*         ctx->s[i] = mpi_new (192); */
412 /*       ctx->c    = mpi_new (192*2); */
413 /*     } */
414 /*   else if (ctx->nist_nbits == 384) */
415 /*     { */
416 /*       for (i=0; i < 10; i++) */
417 /*         ctx->s[i] = mpi_new (384); */
418 /*       ctx->c    = mpi_new (384*2); */
419 /*     } */
420 }
421
422
423 static void
424 ec_deinit (void *opaque)
425 {
426   mpi_ec_t ctx = opaque;
427   int i;
428
429   /* Domain parameter.  */
430   mpi_free (ctx->p);
431   mpi_free (ctx->a);
432   mpi_free (ctx->b);
433   gcry_mpi_point_release (ctx->G);
434   mpi_free (ctx->n);
435
436   /* The key.  */
437   gcry_mpi_point_release (ctx->Q);
438   mpi_free (ctx->d);
439
440   /* Private data of ec.c.  */
441   mpi_free (ctx->t.two_inv_p);
442
443   for (i=0; i< DIM(ctx->t.scratch); i++)
444     mpi_free (ctx->t.scratch[i]);
445
446 /*   if (ctx->nist_nbits == 192) */
447 /*     { */
448 /*       for (i=0; i < 4; i++) */
449 /*         mpi_free (ctx->s[i]); */
450 /*       mpi_free (ctx->c); */
451 /*     } */
452 /*   else if (ctx->nist_nbits == 384) */
453 /*     { */
454 /*       for (i=0; i < 10; i++) */
455 /*         mpi_free (ctx->s[i]); */
456 /*       mpi_free (ctx->c); */
457 /*     } */
458 }
459
460
461 /* This function returns a new context for elliptic curve based on the
462    field GF(p).  P is the prime specifying this field, A is the first
463    coefficient.  This function is only used within Libgcrypt and not
464    part of the public API.
465
466    This context needs to be released using _gcry_mpi_ec_free.  */
467 mpi_ec_t
468 _gcry_mpi_ec_p_internal_new (gcry_mpi_t p, gcry_mpi_t a)
469 {
470   mpi_ec_t ctx;
471
472   ctx = gcry_xcalloc (1, sizeof *ctx);
473   ec_p_init (ctx, p, a);
474
475   return ctx;
476 }
477
478
479 void
480 _gcry_mpi_ec_free (mpi_ec_t ctx)
481 {
482   if (ctx)
483     {
484       ec_deinit (ctx);
485       gcry_free (ctx);
486     }
487 }
488
489
490 /* This function returns a new context for elliptic curve operations
491    based on the field GF(p).  P is the prime specifying this field, A
492    is the first coefficient.  On success the new context is stored at
493    R_CTX and 0 is returned; on error NULL is stored at R_CTX and an
494    error code is returned.  The context needs to be released using
495    gcry_ctx_release.  This is an internal fucntions.  */
496 gpg_err_code_t
497 _gcry_mpi_ec_p_new (gcry_ctx_t *r_ctx, gcry_mpi_t p, gcry_mpi_t a)
498 {
499   gcry_ctx_t ctx;
500   mpi_ec_t ec;
501
502   *r_ctx = NULL;
503   if (!p || !a || !mpi_cmp_ui (a, 0))
504     return GPG_ERR_EINVAL;
505
506   ctx = _gcry_ctx_alloc (CONTEXT_TYPE_EC, sizeof *ec, ec_deinit);
507   if (!ctx)
508     return gpg_err_code_from_syserror ();
509   ec = _gcry_ctx_get_pointer (ctx, CONTEXT_TYPE_EC);
510   ec_p_init (ec, p, a);
511
512   *r_ctx = ctx;
513   return 0;
514 }
515
516 gcry_mpi_t
517 _gcry_mpi_ec_get_mpi (const char *name, gcry_ctx_t ctx, int copy)
518 {
519   mpi_ec_t ec = _gcry_ctx_get_pointer (ctx, CONTEXT_TYPE_EC);
520
521   if (!strcmp (name, "p") && ec->p)
522     return mpi_is_const (ec->p) && !copy? ec->p : mpi_copy (ec->p);
523   if (!strcmp (name, "a") && ec->a)
524     return mpi_is_const (ec->a) && !copy? ec->a : mpi_copy (ec->a);
525   if (!strcmp (name, "b") && ec->b)
526     return mpi_is_const (ec->b) && !copy? ec->b : mpi_copy (ec->b);
527   if (!strcmp (name, "n") && ec->n)
528     return mpi_is_const (ec->n) && !copy? ec->n : mpi_copy (ec->n);
529   if (!strcmp (name, "d") && ec->d)
530     return mpi_is_const (ec->d) && !copy? ec->d : mpi_copy (ec->d);
531
532   /* Return a requested point coordinate.  */
533   if (!strcmp (name, "g.x") && ec->G && ec->G->x)
534     return mpi_is_const (ec->G->x) && !copy? ec->G->x : mpi_copy (ec->G->x);
535   if (!strcmp (name, "g.y") && ec->G && ec->G->y)
536     return mpi_is_const (ec->G->y) && !copy? ec->G->y : mpi_copy (ec->G->y);
537   if (!strcmp (name, "q.x") && ec->Q && ec->Q->x)
538     return mpi_is_const (ec->Q->x) && !copy? ec->Q->x : mpi_copy (ec->Q->x);
539   if (!strcmp (name, "q.y") && ec->Q && ec->Q->y)
540     return mpi_is_const (ec->G->y) && !copy? ec->Q->y : mpi_copy (ec->Q->y);
541
542   /* If a point has been requested, return it in standard encoding.  */
543   if (!strcmp (name, "g") && ec->G)
544     return _gcry_mpi_ec_ec2os (ec->G, ec);
545   if (!strcmp (name, "q"))
546     {
547       /* If only the private key is given, compute the public key.  */
548       if (!ec->Q && ec->d && ec->G && ec->p && ec->a)
549         {
550           ec->Q = gcry_mpi_point_new (0);
551           _gcry_mpi_ec_mul_point (ec->Q, ec->d, ec->G, ec);
552         }
553
554       if (ec->Q)
555         return _gcry_mpi_ec_ec2os (ec->Q, ec);
556     }
557
558   return NULL;
559 }
560
561
562 gcry_mpi_point_t
563 _gcry_mpi_ec_get_point (const char *name, gcry_ctx_t ctx, int copy)
564 {
565   mpi_ec_t ec = _gcry_ctx_get_pointer (ctx, CONTEXT_TYPE_EC);
566
567   (void)copy;  /* Not used.  */
568
569   if (!strcmp (name, "g") && ec->G)
570     return point_copy (ec->G);
571   if (!strcmp (name, "q"))
572     {
573       /* If only the private key is given, compute the public key.  */
574       if (!ec->Q && ec->d && ec->G && ec->p && ec->a)
575         {
576           ec->Q = gcry_mpi_point_new (0);
577           _gcry_mpi_ec_mul_point (ec->Q, ec->d, ec->G, ec);
578         }
579
580       if (ec->Q)
581         return point_copy (ec->Q);
582     }
583
584   return NULL;
585 }
586
587
588 gpg_err_code_t
589 _gcry_mpi_ec_set_mpi (const char *name, gcry_mpi_t newvalue,
590                       gcry_ctx_t ctx)
591 {
592   mpi_ec_t ec = _gcry_ctx_get_pointer (ctx, CONTEXT_TYPE_EC);
593
594   if (!strcmp (name, "p"))
595     {
596       mpi_free (ec->p);
597       ec->p = mpi_copy (newvalue);
598       ec_get_reset (ec);
599     }
600   else if (!strcmp (name, "a"))
601     {
602       mpi_free (ec->a);
603       ec->a = mpi_copy (newvalue);
604       ec_get_reset (ec);
605     }
606   else if (!strcmp (name, "b"))
607     {
608       mpi_free (ec->b);
609       ec->b = mpi_copy (newvalue);
610     }
611   else if (!strcmp (name, "n"))
612     {
613       mpi_free (ec->n);
614       ec->n = mpi_copy (newvalue);
615     }
616   else if (!strcmp (name, "d"))
617     {
618       mpi_free (ec->d);
619       ec->d = mpi_copy (newvalue);
620     }
621   else
622     return GPG_ERR_UNKNOWN_NAME;
623
624   return 0;
625 }
626
627
628 gpg_err_code_t
629 _gcry_mpi_ec_set_point (const char *name, gcry_mpi_point_t newvalue,
630                         gcry_ctx_t ctx)
631 {
632   mpi_ec_t ec = _gcry_ctx_get_pointer (ctx, CONTEXT_TYPE_EC);
633
634   if (!strcmp (name, "g"))
635     {
636       gcry_mpi_point_release (ec->G);
637       ec->G = point_copy (newvalue);
638     }
639   else if (!strcmp (name, "q"))
640     {
641       gcry_mpi_point_release (ec->Q);
642       ec->Q = point_copy (newvalue);
643     }
644   else
645     return GPG_ERR_UNKNOWN_NAME;
646
647   return 0;
648 }
649
650
651 /* Compute the affine coordinates from the projective coordinates in
652    POINT.  Set them into X and Y.  If one coordinate is not required,
653    X or Y may be passed as NULL.  CTX is the usual context. Returns: 0
654    on success or !0 if POINT is at infinity.  */
655 int
656 _gcry_mpi_ec_get_affine (gcry_mpi_t x, gcry_mpi_t y, mpi_point_t point,
657                          mpi_ec_t ctx)
658 {
659   gcry_mpi_t z1, z2, z3;
660
661   if (!mpi_cmp_ui (point->z, 0))
662     return -1;
663
664   z1 = mpi_new (0);
665   z2 = mpi_new (0);
666   ec_invm (z1, point->z, ctx);  /* z1 = z^(-1) mod p  */
667   ec_mulm (z2, z1, z1, ctx);    /* z2 = z^(-2) mod p  */
668
669   if (x)
670     ec_mulm (x, point->x, z2, ctx);
671
672   if (y)
673     {
674       z3 = mpi_new (0);
675       ec_mulm (z3, z2, z1, ctx);      /* z3 = z^(-3) mod p  */
676       ec_mulm (y, point->y, z3, ctx);
677       mpi_free (z3);
678     }
679
680   mpi_free (z2);
681   mpi_free (z1);
682   return 0;
683 }
684
685
686 \f
687 /*  RESULT = 2 * POINT  (Weierstrass version). */
688 static void
689 dup_point_weierstrass (mpi_point_t result, mpi_point_t point, mpi_ec_t ctx)
690 {
691 #define x3 (result->x)
692 #define y3 (result->y)
693 #define z3 (result->z)
694 #define t1 (ctx->t.scratch[0])
695 #define t2 (ctx->t.scratch[1])
696 #define t3 (ctx->t.scratch[2])
697 #define l1 (ctx->t.scratch[3])
698 #define l2 (ctx->t.scratch[4])
699 #define l3 (ctx->t.scratch[5])
700
701   if (!mpi_cmp_ui (point->y, 0) || !mpi_cmp_ui (point->z, 0))
702     {
703       /* P_y == 0 || P_z == 0 => [1:1:0] */
704       mpi_set_ui (x3, 1);
705       mpi_set_ui (y3, 1);
706       mpi_set_ui (z3, 0);
707     }
708   else
709     {
710       if (ec_get_a_is_pminus3 (ctx))  /* Use the faster case.  */
711         {
712           /* L1 = 3(X - Z^2)(X + Z^2) */
713           /*                          T1: used for Z^2. */
714           /*                          T2: used for the right term.  */
715           ec_powm (t1, point->z, mpi_const (MPI_C_TWO), ctx);
716           ec_subm (l1, point->x, t1, ctx);
717           ec_mulm (l1, l1, mpi_const (MPI_C_THREE), ctx);
718           ec_addm (t2, point->x, t1, ctx);
719           ec_mulm (l1, l1, t2, ctx);
720         }
721       else /* Standard case. */
722         {
723           /* L1 = 3X^2 + aZ^4 */
724           /*                          T1: used for aZ^4. */
725           ec_powm (l1, point->x, mpi_const (MPI_C_TWO), ctx);
726           ec_mulm (l1, l1, mpi_const (MPI_C_THREE), ctx);
727           ec_powm (t1, point->z, mpi_const (MPI_C_FOUR), ctx);
728           ec_mulm (t1, t1, ctx->a, ctx);
729           ec_addm (l1, l1, t1, ctx);
730         }
731       /* Z3 = 2YZ */
732       ec_mulm (z3, point->y, point->z, ctx);
733       ec_mulm (z3, z3, mpi_const (MPI_C_TWO), ctx);
734
735       /* L2 = 4XY^2 */
736       /*                              T2: used for Y2; required later. */
737       ec_powm (t2, point->y, mpi_const (MPI_C_TWO), ctx);
738       ec_mulm (l2, t2, point->x, ctx);
739       ec_mulm (l2, l2, mpi_const (MPI_C_FOUR), ctx);
740
741       /* X3 = L1^2 - 2L2 */
742       /*                              T1: used for L2^2. */
743       ec_powm (x3, l1, mpi_const (MPI_C_TWO), ctx);
744       ec_mulm (t1, l2, mpi_const (MPI_C_TWO), ctx);
745       ec_subm (x3, x3, t1, ctx);
746
747       /* L3 = 8Y^4 */
748       /*                              T2: taken from above. */
749       ec_powm (t2, t2, mpi_const (MPI_C_TWO), ctx);
750       ec_mulm (l3, t2, mpi_const (MPI_C_EIGHT), ctx);
751
752       /* Y3 = L1(L2 - X3) - L3 */
753       ec_subm (y3, l2, x3, ctx);
754       ec_mulm (y3, y3, l1, ctx);
755       ec_subm (y3, y3, l3, ctx);
756     }
757
758 #undef x3
759 #undef y3
760 #undef z3
761 #undef t1
762 #undef t2
763 #undef t3
764 #undef l1
765 #undef l2
766 #undef l3
767 }
768
769
770 /*  RESULT = 2 * POINT  (Montgomery version). */
771 static void
772 dup_point_montgomery (mpi_point_t result, mpi_point_t point, mpi_ec_t ctx)
773 {
774   log_fatal ("%s: %s not yet supported\n",
775              "_gcry_mpi_ec_dup_point", "Montgomery");
776 }
777
778
779 /*  RESULT = 2 * POINT  (Twisted Edwards version). */
780 static void
781 dup_point_twistededwards (mpi_point_t result, mpi_point_t point, mpi_ec_t ctx)
782 {
783   log_fatal ("%s: %s not yet supported\n",
784              "_gcry_mpi_ec_dup_point", "Twisted Edwards");
785 }
786
787
788 /*  RESULT = 2 * POINT  */
789 void
790 _gcry_mpi_ec_dup_point (mpi_point_t result, mpi_point_t point, mpi_ec_t ctx)
791 {
792   switch (ctx->model)
793     {
794     case MPI_EC_WEIERSTRASS:
795       dup_point_weierstrass (result, point, ctx);
796       break;
797     case MPI_EC_MONTGOMERY:
798       dup_point_montgomery (result, point, ctx);
799       break;
800     case MPI_EC_TWISTEDEDWARDS:
801       dup_point_twistededwards (result, point, ctx);
802       break;
803     }
804 }
805
806
807 /* RESULT = P1 + P2  (Weierstrass version).*/
808 static void
809 add_points_weierstrass (mpi_point_t result,
810                         mpi_point_t p1, mpi_point_t p2,
811                         mpi_ec_t ctx)
812 {
813 #define x1 (p1->x    )
814 #define y1 (p1->y    )
815 #define z1 (p1->z    )
816 #define x2 (p2->x    )
817 #define y2 (p2->y    )
818 #define z2 (p2->z    )
819 #define x3 (result->x)
820 #define y3 (result->y)
821 #define z3 (result->z)
822 #define l1 (ctx->t.scratch[0])
823 #define l2 (ctx->t.scratch[1])
824 #define l3 (ctx->t.scratch[2])
825 #define l4 (ctx->t.scratch[3])
826 #define l5 (ctx->t.scratch[4])
827 #define l6 (ctx->t.scratch[5])
828 #define l7 (ctx->t.scratch[6])
829 #define l8 (ctx->t.scratch[7])
830 #define l9 (ctx->t.scratch[8])
831 #define t1 (ctx->t.scratch[9])
832 #define t2 (ctx->t.scratch[10])
833
834   if ( (!mpi_cmp (x1, x2)) && (!mpi_cmp (y1, y2)) && (!mpi_cmp (z1, z2)) )
835     {
836       /* Same point; need to call the duplicate function.  */
837       _gcry_mpi_ec_dup_point (result, p1, ctx);
838     }
839   else if (!mpi_cmp_ui (z1, 0))
840     {
841       /* P1 is at infinity.  */
842       mpi_set (x3, p2->x);
843       mpi_set (y3, p2->y);
844       mpi_set (z3, p2->z);
845     }
846   else if (!mpi_cmp_ui (z2, 0))
847     {
848       /* P2 is at infinity.  */
849       mpi_set (x3, p1->x);
850       mpi_set (y3, p1->y);
851       mpi_set (z3, p1->z);
852     }
853   else
854     {
855       int z1_is_one = !mpi_cmp_ui (z1, 1);
856       int z2_is_one = !mpi_cmp_ui (z2, 1);
857
858       /* l1 = x1 z2^2  */
859       /* l2 = x2 z1^2  */
860       if (z2_is_one)
861         mpi_set (l1, x1);
862       else
863         {
864           ec_powm (l1, z2, mpi_const (MPI_C_TWO), ctx);
865           ec_mulm (l1, l1, x1, ctx);
866         }
867       if (z1_is_one)
868         mpi_set (l2, x2);
869       else
870         {
871           ec_powm (l2, z1, mpi_const (MPI_C_TWO), ctx);
872           ec_mulm (l2, l2, x2, ctx);
873         }
874       /* l3 = l1 - l2 */
875       ec_subm (l3, l1, l2, ctx);
876       /* l4 = y1 z2^3  */
877       ec_powm (l4, z2, mpi_const (MPI_C_THREE), ctx);
878       ec_mulm (l4, l4, y1, ctx);
879       /* l5 = y2 z1^3  */
880       ec_powm (l5, z1, mpi_const (MPI_C_THREE), ctx);
881       ec_mulm (l5, l5, y2, ctx);
882       /* l6 = l4 - l5  */
883       ec_subm (l6, l4, l5, ctx);
884
885       if (!mpi_cmp_ui (l3, 0))
886         {
887           if (!mpi_cmp_ui (l6, 0))
888             {
889               /* P1 and P2 are the same - use duplicate function.  */
890               _gcry_mpi_ec_dup_point (result, p1, ctx);
891             }
892           else
893             {
894               /* P1 is the inverse of P2.  */
895               mpi_set_ui (x3, 1);
896               mpi_set_ui (y3, 1);
897               mpi_set_ui (z3, 0);
898             }
899         }
900       else
901         {
902           /* l7 = l1 + l2  */
903           ec_addm (l7, l1, l2, ctx);
904           /* l8 = l4 + l5  */
905           ec_addm (l8, l4, l5, ctx);
906           /* z3 = z1 z2 l3  */
907           ec_mulm (z3, z1, z2, ctx);
908           ec_mulm (z3, z3, l3, ctx);
909           /* x3 = l6^2 - l7 l3^2  */
910           ec_powm (t1, l6, mpi_const (MPI_C_TWO), ctx);
911           ec_powm (t2, l3, mpi_const (MPI_C_TWO), ctx);
912           ec_mulm (t2, t2, l7, ctx);
913           ec_subm (x3, t1, t2, ctx);
914           /* l9 = l7 l3^2 - 2 x3  */
915           ec_mulm (t1, x3, mpi_const (MPI_C_TWO), ctx);
916           ec_subm (l9, t2, t1, ctx);
917           /* y3 = (l9 l6 - l8 l3^3)/2  */
918           ec_mulm (l9, l9, l6, ctx);
919           ec_powm (t1, l3, mpi_const (MPI_C_THREE), ctx); /* fixme: Use saved value*/
920           ec_mulm (t1, t1, l8, ctx);
921           ec_subm (y3, l9, t1, ctx);
922           ec_mulm (y3, y3, ec_get_two_inv_p (ctx), ctx);
923         }
924     }
925
926 #undef x1
927 #undef y1
928 #undef z1
929 #undef x2
930 #undef y2
931 #undef z2
932 #undef x3
933 #undef y3
934 #undef z3
935 #undef l1
936 #undef l2
937 #undef l3
938 #undef l4
939 #undef l5
940 #undef l6
941 #undef l7
942 #undef l8
943 #undef l9
944 #undef t1
945 #undef t2
946 }
947
948
949 /* RESULT = P1 + P2  (Montgomery version).*/
950 static void
951 add_points_montgomery (mpi_point_t result,
952                        mpi_point_t p1, mpi_point_t p2,
953                        mpi_ec_t ctx)
954 {
955   log_fatal ("%s: %s not yet supported\n",
956              "_gcry_mpi_ec_add_points", "Montgomery");
957 }
958
959
960 /* RESULT = P1 + P2  (Twisted Edwards version).*/
961 static void
962 add_points_twistededwards (mpi_point_t result,
963                            mpi_point_t p1, mpi_point_t p2,
964                            mpi_ec_t ctx)
965 {
966   log_fatal ("%s: %s not yet supported\n",
967              "_gcry_mpi_ec_add_points", "Twisted Edwards");
968 }
969
970
971 /* RESULT = P1 + P2 */
972 void
973 _gcry_mpi_ec_add_points (mpi_point_t result,
974                          mpi_point_t p1, mpi_point_t p2,
975                          mpi_ec_t ctx)
976 {
977   switch (ctx->model)
978     {
979     case MPI_EC_WEIERSTRASS:
980       add_points_weierstrass (result, p1, p2, ctx);
981       break;
982     case MPI_EC_MONTGOMERY:
983       add_points_montgomery (result, p1, p2, ctx);
984       break;
985     case MPI_EC_TWISTEDEDWARDS:
986       add_points_twistededwards (result, p1, p2, ctx);
987       break;
988     }
989 }
990
991
992 /* Scalar point multiplication - the main function for ECC.  If takes
993    an integer SCALAR and a POINT as well as the usual context CTX.
994    RESULT will be set to the resulting point. */
995 void
996 _gcry_mpi_ec_mul_point (mpi_point_t result,
997                         gcry_mpi_t scalar, mpi_point_t point,
998                         mpi_ec_t ctx)
999 {
1000 #if 0
1001   /* Simple left to right binary method.  GECC Algorithm 3.27 */
1002   unsigned int nbits;
1003   int i;
1004
1005   nbits = mpi_get_nbits (scalar);
1006   mpi_set_ui (result->x, 1);
1007   mpi_set_ui (result->y, 1);
1008   mpi_set_ui (result->z, 0);
1009
1010   for (i=nbits-1; i >= 0; i--)
1011     {
1012       _gcry_mpi_ec_dup_point (result, result, ctx);
1013       if (mpi_test_bit (scalar, i) == 1)
1014         _gcry_mpi_ec_add_points (result, result, point, ctx);
1015     }
1016
1017 #else
1018   gcry_mpi_t x1, y1, z1, k, h, yy;
1019   unsigned int i, loops;
1020   mpi_point_struct p1, p2, p1inv;
1021
1022   x1 = mpi_alloc_like (ctx->p);
1023   y1 = mpi_alloc_like (ctx->p);
1024   h  = mpi_alloc_like (ctx->p);
1025   k  = mpi_copy (scalar);
1026   yy = mpi_copy (point->y);
1027
1028   if ( mpi_is_neg (k) )
1029     {
1030       k->sign = 0;
1031       ec_invm (yy, yy, ctx);
1032     }
1033
1034   if (!mpi_cmp_ui (point->z, 1))
1035     {
1036       mpi_set (x1, point->x);
1037       mpi_set (y1, yy);
1038     }
1039   else
1040     {
1041       gcry_mpi_t z2, z3;
1042
1043       z2 = mpi_alloc_like (ctx->p);
1044       z3 = mpi_alloc_like (ctx->p);
1045       ec_mulm (z2, point->z, point->z, ctx);
1046       ec_mulm (z3, point->z, z2, ctx);
1047       ec_invm (z2, z2, ctx);
1048       ec_mulm (x1, point->x, z2, ctx);
1049       ec_invm (z3, z3, ctx);
1050       ec_mulm (y1, yy, z3, ctx);
1051       mpi_free (z2);
1052       mpi_free (z3);
1053     }
1054   z1 = mpi_copy (mpi_const (MPI_C_ONE));
1055
1056   mpi_mul (h, k, mpi_const (MPI_C_THREE)); /* h = 3k */
1057   loops = mpi_get_nbits (h);
1058   if (loops < 2)
1059     {
1060       /* If SCALAR is zero, the above mpi_mul sets H to zero and thus
1061          LOOPs will be zero.  To avoid an underflow of I in the main
1062          loop we set LOOP to 2 and the result to (0,0,0).  */
1063       loops = 2;
1064       mpi_clear (result->x);
1065       mpi_clear (result->y);
1066       mpi_clear (result->z);
1067     }
1068   else
1069     {
1070       mpi_set (result->x, point->x);
1071       mpi_set (result->y, yy);
1072       mpi_set (result->z, point->z);
1073     }
1074   mpi_free (yy); yy = NULL;
1075
1076   p1.x = x1; x1 = NULL;
1077   p1.y = y1; y1 = NULL;
1078   p1.z = z1; z1 = NULL;
1079   point_init (&p2);
1080   point_init (&p1inv);
1081
1082   for (i=loops-2; i > 0; i--)
1083     {
1084       _gcry_mpi_ec_dup_point (result, result, ctx);
1085       if (mpi_test_bit (h, i) == 1 && mpi_test_bit (k, i) == 0)
1086         {
1087           point_set (&p2, result);
1088           _gcry_mpi_ec_add_points (result, &p2, &p1, ctx);
1089         }
1090       if (mpi_test_bit (h, i) == 0 && mpi_test_bit (k, i) == 1)
1091         {
1092           point_set (&p2, result);
1093           /* Invert point: y = p - y mod p  */
1094           point_set (&p1inv, &p1);
1095           ec_subm (p1inv.y, ctx->p, p1inv.y, ctx);
1096           _gcry_mpi_ec_add_points (result, &p2, &p1inv, ctx);
1097         }
1098     }
1099
1100   point_free (&p1);
1101   point_free (&p2);
1102   point_free (&p1inv);
1103   mpi_free (h);
1104   mpi_free (k);
1105 #endif
1106 }