ecc: Add Ed25519 key generation and prepare for optimizations.
[libgcrypt.git] / mpi / mpiutil.c
1 /* mpiutil.ac  -  Utility functions for MPI
2  * Copyright (C) 1998, 2000, 2001, 2002, 2003,
3  *               2007  Free Software Foundation, Inc.
4  * Copyright (C) 2013  g10 Code GmbH
5  *
6  * This file is part of Libgcrypt.
7  *
8  * Libgcrypt is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as
10  * published by the Free Software Foundation; either version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * Libgcrypt is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "g10lib.h"
28 #include "mpi-internal.h"
29 #include "mod-source-info.h"
30
31 /* Constatns allocated right away at strtartup.  */
32 static gcry_mpi_t constants[MPI_NUMBER_OF_CONSTANTS];
33
34
35
36 const char *
37 _gcry_mpi_get_hw_config (void)
38 {
39   return mod_source_info + 1;
40 }
41
42
43 /* Initialize the MPI subsystem.  This is called early and allows to
44    do some initialization without taking care of threading issues.  */
45 gcry_err_code_t
46 _gcry_mpi_init (void)
47 {
48   int idx;
49   unsigned long value;
50
51   for (idx=0; idx < MPI_NUMBER_OF_CONSTANTS; idx++)
52     {
53       switch (idx)
54         {
55         case MPI_C_ZERO:  value = 0; break;
56         case MPI_C_ONE:   value = 1; break;
57         case MPI_C_TWO:   value = 2; break;
58         case MPI_C_THREE: value = 3; break;
59         case MPI_C_FOUR:  value = 4; break;
60         case MPI_C_EIGHT: value = 8; break;
61         default: log_bug ("invalid mpi_const selector %d\n", idx);
62         }
63       constants[idx] = mpi_alloc_set_ui (value);
64       constants[idx]->flags = (16|32);
65     }
66
67   return 0;
68 }
69
70
71 /****************
72  * Note:  It was a bad idea to use the number of limbs to allocate
73  *        because on a alpha the limbs are large but we normally need
74  *        integers of n bits - So we should change this to bits (or bytes).
75  *
76  *        But mpi_alloc is used in a lot of places :-(.  New code
77  *        should use mpi_new.
78  */
79 gcry_mpi_t
80 _gcry_mpi_alloc( unsigned nlimbs )
81 {
82     gcry_mpi_t a;
83
84     a = gcry_xmalloc( sizeof *a );
85     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 0 ) : NULL;
86     a->alloced = nlimbs;
87     a->nlimbs = 0;
88     a->sign = 0;
89     a->flags = 0;
90     return a;
91 }
92
93 void
94 _gcry_mpi_m_check( gcry_mpi_t a )
95 {
96     _gcry_check_heap(a);
97     _gcry_check_heap(a->d);
98 }
99
100 gcry_mpi_t
101 _gcry_mpi_alloc_secure( unsigned nlimbs )
102 {
103     gcry_mpi_t a;
104
105     a = gcry_xmalloc( sizeof *a );
106     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 1 ) : NULL;
107     a->alloced = nlimbs;
108     a->flags = 1;
109     a->nlimbs = 0;
110     a->sign = 0;
111     return a;
112 }
113
114
115
116 mpi_ptr_t
117 _gcry_mpi_alloc_limb_space( unsigned int nlimbs, int secure )
118 {
119     mpi_ptr_t p;
120     size_t len;
121
122     len = (nlimbs ? nlimbs : 1) * sizeof (mpi_limb_t);
123     p = secure ? gcry_xmalloc_secure (len) : gcry_xmalloc (len);
124     if (! nlimbs)
125       *p = 0;
126
127     return p;
128 }
129
130 void
131 _gcry_mpi_free_limb_space( mpi_ptr_t a, unsigned int nlimbs)
132 {
133   if (a)
134     {
135       size_t len = nlimbs * sizeof(mpi_limb_t);
136
137       /* If we have information on the number of allocated limbs, we
138          better wipe that space out.  This is a failsafe feature if
139          secure memory has been disabled or was not properly
140          implemented in user provided allocation functions. */
141       if (len)
142         wipememory (a, len);
143       gcry_free(a);
144     }
145 }
146
147
148 void
149 _gcry_mpi_assign_limb_space( gcry_mpi_t a, mpi_ptr_t ap, unsigned int nlimbs )
150 {
151   _gcry_mpi_free_limb_space (a->d, a->alloced);
152   a->d = ap;
153   a->alloced = nlimbs;
154 }
155
156
157
158 /****************
159  * Resize the array of A to NLIMBS. The additional space is cleared
160  * (set to 0).
161  */
162 void
163 _gcry_mpi_resize (gcry_mpi_t a, unsigned nlimbs)
164 {
165   size_t i;
166
167   if (nlimbs <= a->alloced)
168     {
169       /* We only need to clear the new space (this is a nop if the
170          limb space is already of the correct size. */
171       for (i=a->nlimbs; i < a->alloced; i++)
172         a->d[i] = 0;
173       return;
174     }
175
176   /* Actually resize the limb space.  */
177   if (a->d)
178     {
179       a->d = gcry_xrealloc (a->d, nlimbs * sizeof (mpi_limb_t));
180       for (i=a->alloced; i < nlimbs; i++)
181         a->d[i] = 0;
182     }
183   else
184     {
185       if (a->flags & 1)
186         /* Secure memory is wanted.  */
187         a->d = gcry_xcalloc_secure (nlimbs , sizeof (mpi_limb_t));
188       else
189         /* Standard memory.  */
190         a->d = gcry_xcalloc (nlimbs , sizeof (mpi_limb_t));
191     }
192   a->alloced = nlimbs;
193 }
194
195 void
196 _gcry_mpi_clear( gcry_mpi_t a )
197 {
198   if (mpi_is_immutable (a))
199     {
200       mpi_immutable_failed ();
201       return;
202     }
203   a->nlimbs = 0;
204   a->flags = 0;
205 }
206
207
208 void
209 _gcry_mpi_free( gcry_mpi_t a )
210 {
211   if (!a )
212     return;
213   if ((a->flags & 32))
214     return; /* Never release a constant. */
215   if ((a->flags & 4))
216     gcry_free( a->d );
217   else
218     {
219       _gcry_mpi_free_limb_space(a->d, a->alloced);
220     }
221   /* Check that the flags makes sense.  We better allow for bit 1
222      (value 2) for backward ABI compatibility.  */
223   if ((a->flags & ~(1|2|4|16)))
224     log_bug("invalid flag value in mpi_free\n");
225   gcry_free(a);
226 }
227
228
229 void
230 _gcry_mpi_immutable_failed (void)
231 {
232   log_info ("Warning: trying to change an immutable MPI\n");
233 }
234
235
236 static void
237 mpi_set_secure( gcry_mpi_t a )
238 {
239   mpi_ptr_t ap, bp;
240
241   if ( (a->flags & 1) )
242     return;
243   a->flags |= 1;
244   ap = a->d;
245   if (!a->nlimbs)
246     {
247       gcry_assert (!ap);
248       return;
249     }
250   bp = mpi_alloc_limb_space (a->nlimbs, 1);
251   MPN_COPY( bp, ap, a->nlimbs );
252   a->d = bp;
253   _gcry_mpi_free_limb_space (ap, a->alloced);
254 }
255
256
257 gcry_mpi_t
258 gcry_mpi_set_opaque( gcry_mpi_t a, void *p, unsigned int nbits )
259 {
260   if (!a)
261     a = mpi_alloc(0);
262
263   if (mpi_is_immutable (a))
264     {
265       mpi_immutable_failed ();
266       return a;
267     }
268
269   if( a->flags & 4 )
270     gcry_free( a->d );
271   else
272     _gcry_mpi_free_limb_space (a->d, a->alloced);
273
274   a->d = p;
275   a->alloced = 0;
276   a->nlimbs = 0;
277   a->sign  = nbits;
278   a->flags = 4;
279   if (gcry_is_secure (a->d))
280     a->flags |= 1;
281   return a;
282 }
283
284
285 gcry_mpi_t
286 _gcry_mpi_set_opaque_copy (gcry_mpi_t a, void *p, unsigned int nbits)
287 {
288   void *d;
289   unsigned int n;
290
291   n = (nbits+7)/8;
292   d = gcry_is_secure (p)? gcry_malloc_secure (n) : gcry_malloc (n);
293   memcpy (d, p, n);
294   return gcry_mpi_set_opaque (a, d, nbits);
295 }
296
297
298 void *
299 gcry_mpi_get_opaque( gcry_mpi_t a, unsigned int *nbits )
300 {
301     if( !(a->flags & 4) )
302         log_bug("mpi_get_opaque on normal mpi\n");
303     if( nbits )
304         *nbits = a->sign;
305     return a->d;
306 }
307
308
309 void *
310 _gcry_mpi_get_opaque_copy (gcry_mpi_t a, unsigned int *nbits)
311 {
312   const void *s;
313   void *d;
314   unsigned int n;
315
316   s = gcry_mpi_get_opaque (a, nbits);
317   if (!s && nbits)
318     return NULL;
319   n = (*nbits+7)/8;
320   d = gcry_is_secure (s)? gcry_malloc_secure (n) : gcry_malloc (n);
321   memcpy (d, s, n);
322   return d;
323 }
324
325 /****************
326  * Note: This copy function should not interpret the MPI
327  *       but copy it transparently.
328  */
329 gcry_mpi_t
330 gcry_mpi_copy( gcry_mpi_t a )
331 {
332     int i;
333     gcry_mpi_t b;
334
335     if( a && (a->flags & 4) ) {
336         void *p = gcry_is_secure(a->d)? gcry_xmalloc_secure( (a->sign+7)/8 )
337                                      : gcry_xmalloc( (a->sign+7)/8 );
338         memcpy( p, a->d, (a->sign+7)/8 );
339         b = gcry_mpi_set_opaque( NULL, p, a->sign );
340         b->flags &= ~(16|32); /* Reset the immutable and constant flags.  */
341     }
342     else if( a ) {
343         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
344                             : mpi_alloc( a->nlimbs );
345         b->nlimbs = a->nlimbs;
346         b->sign = a->sign;
347         b->flags  = a->flags;
348         b->flags &= ~(16|32); /* Reset the immutable and constant flags.  */
349         for(i=0; i < b->nlimbs; i++ )
350             b->d[i] = a->d[i];
351     }
352     else
353         b = NULL;
354     return b;
355 }
356
357
358 /* Return true if A is negative.  */
359 int
360 _gcry_mpi_is_neg (gcry_mpi_t a)
361 {
362   if (a->sign && _gcry_mpi_cmp_ui (a, 0))
363     return 1;
364   else
365     return 0;
366 }
367
368
369 /* W = - U */
370 void
371 _gcry_mpi_neg (gcry_mpi_t w, gcry_mpi_t u)
372 {
373   if (mpi_is_immutable (w))
374     {
375       mpi_immutable_failed ();
376       return;
377     }
378
379   w->sign = !u->sign;
380 }
381
382
383 /* W = [W] */
384 void
385 _gcry_mpi_abs (gcry_mpi_t w)
386 {
387   if (mpi_is_immutable (w))
388     {
389       mpi_immutable_failed ();
390       return;
391     }
392
393   w->sign = 0;
394 }
395
396
397 /****************
398  * This function allocates an MPI which is optimized to hold
399  * a value as large as the one given in the argument and allocates it
400  * with the same flags as A.
401  */
402 gcry_mpi_t
403 _gcry_mpi_alloc_like( gcry_mpi_t a )
404 {
405     gcry_mpi_t b;
406
407     if( a && (a->flags & 4) ) {
408         int n = (a->sign+7)/8;
409         void *p = gcry_is_secure(a->d)? gcry_malloc_secure( n )
410                                      : gcry_malloc( n );
411         memcpy( p, a->d, n );
412         b = gcry_mpi_set_opaque( NULL, p, a->sign );
413     }
414     else if( a ) {
415         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
416                             : mpi_alloc( a->nlimbs );
417         b->nlimbs = 0;
418         b->sign = 0;
419         b->flags = a->flags;
420     }
421     else
422         b = NULL;
423     return b;
424 }
425
426
427 /* Set U into W and release U.  If W is NULL only U will be released. */
428 void
429 gcry_mpi_snatch (gcry_mpi_t w, gcry_mpi_t u)
430 {
431   if (w)
432     {
433       if (mpi_is_immutable (w))
434         {
435           mpi_immutable_failed ();
436           return;
437         }
438       _gcry_mpi_assign_limb_space (w, u->d, u->alloced);
439       w->nlimbs = u->nlimbs;
440       w->sign   = u->sign;
441       w->flags  = u->flags;
442       u->alloced = 0;
443       u->nlimbs = 0;
444       u->d = NULL;
445     }
446   _gcry_mpi_free (u);
447 }
448
449
450 gcry_mpi_t
451 gcry_mpi_set( gcry_mpi_t w, gcry_mpi_t u)
452 {
453   mpi_ptr_t wp, up;
454   mpi_size_t usize = u->nlimbs;
455   int usign = u->sign;
456
457   if (!w)
458     w = _gcry_mpi_alloc( mpi_get_nlimbs(u) );
459   if (mpi_is_immutable (w))
460     {
461       mpi_immutable_failed ();
462       return w;
463     }
464   RESIZE_IF_NEEDED(w, usize);
465   wp = w->d;
466   up = u->d;
467   MPN_COPY( wp, up, usize );
468   w->nlimbs = usize;
469   w->flags = u->flags;
470   w->flags &= ~(16|32); /* Reset the immutable and constant flags.  */
471   w->sign = usign;
472   return w;
473 }
474
475
476 gcry_mpi_t
477 gcry_mpi_set_ui( gcry_mpi_t w, unsigned long u)
478 {
479   if (!w)
480     w = _gcry_mpi_alloc (1);
481   /* FIXME: If U is 0 we have no need to resize and thus possible
482      allocating the the limbs. */
483   if (mpi_is_immutable (w))
484     {
485       mpi_immutable_failed ();
486       return w;
487     }
488   RESIZE_IF_NEEDED(w, 1);
489   w->d[0] = u;
490   w->nlimbs = u? 1:0;
491   w->sign = 0;
492   w->flags = 0;
493   return w;
494 }
495
496 gcry_err_code_t
497 _gcry_mpi_get_ui (gcry_mpi_t w, unsigned long *u)
498 {
499   gcry_err_code_t err = GPG_ERR_NO_ERROR;
500   unsigned long x = 0;
501
502   if (w->nlimbs > 1)
503     err = GPG_ERR_TOO_LARGE;
504   else if (w->nlimbs == 1)
505     x = w->d[0];
506   else
507     x = 0;
508
509   if (! err)
510     *u = x;
511
512   return err;
513 }
514
515 gcry_error_t
516 gcry_mpi_get_ui (gcry_mpi_t w, unsigned long *u)
517 {
518   gcry_err_code_t err = GPG_ERR_NO_ERROR;
519
520   err = _gcry_mpi_get_ui (w, u);
521
522   return gcry_error (err);
523 }
524
525 gcry_mpi_t
526 _gcry_mpi_alloc_set_ui( unsigned long u)
527 {
528     gcry_mpi_t w = mpi_alloc(1);
529     w->d[0] = u;
530     w->nlimbs = u? 1:0;
531     w->sign = 0;
532     return w;
533 }
534
535 void
536 gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b)
537 {
538     struct gcry_mpi tmp;
539
540     tmp = *a; *a = *b; *b = tmp;
541 }
542
543
544 gcry_mpi_t
545 gcry_mpi_new( unsigned int nbits )
546 {
547     return _gcry_mpi_alloc ( (nbits+BITS_PER_MPI_LIMB-1)
548                              / BITS_PER_MPI_LIMB );
549 }
550
551
552 gcry_mpi_t
553 gcry_mpi_snew( unsigned int nbits )
554 {
555   return _gcry_mpi_alloc_secure ( (nbits+BITS_PER_MPI_LIMB-1)
556                                   / BITS_PER_MPI_LIMB );
557 }
558
559 void
560 gcry_mpi_release( gcry_mpi_t a )
561 {
562     _gcry_mpi_free( a );
563 }
564
565 void
566 gcry_mpi_randomize( gcry_mpi_t w,
567                     unsigned int nbits, enum gcry_random_level level )
568 {
569   unsigned char *p;
570   size_t nbytes = (nbits+7)/8;
571
572   if (mpi_is_immutable (w))
573     {
574       mpi_immutable_failed ();
575       return;
576     }
577   if (level == GCRY_WEAK_RANDOM)
578     {
579       p = mpi_is_secure(w) ? gcry_xmalloc_secure (nbytes)
580                            : gcry_xmalloc (nbytes);
581       gcry_create_nonce (p, nbytes);
582     }
583   else
584     {
585       p = mpi_is_secure(w) ? gcry_random_bytes_secure (nbytes, level)
586                            : gcry_random_bytes (nbytes, level);
587     }
588   _gcry_mpi_set_buffer( w, p, nbytes, 0 );
589   gcry_free (p);
590 }
591
592
593 void
594 gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag)
595 {
596   switch (flag)
597     {
598     case GCRYMPI_FLAG_SECURE:     mpi_set_secure(a); break;
599     case GCRYMPI_FLAG_CONST:      a->flags |= (16|32); break;
600     case GCRYMPI_FLAG_IMMUTABLE:  a->flags |= 16; break;
601     case GCRYMPI_FLAG_OPAQUE:
602     default: log_bug("invalid flag value\n");
603     }
604 }
605
606 void
607 gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag)
608 {
609   (void)a; /* Not yet used. */
610
611   switch (flag)
612     {
613     case GCRYMPI_FLAG_IMMUTABLE:
614       if (!(a->flags & 32))
615         a->flags &= ~16;
616       break;
617     case GCRYMPI_FLAG_CONST:
618     case GCRYMPI_FLAG_SECURE:
619     case GCRYMPI_FLAG_OPAQUE:
620     default: log_bug("invalid flag value\n");
621     }
622 }
623
624 int
625 gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag)
626 {
627   switch (flag)
628     {
629     case GCRYMPI_FLAG_SECURE:    return !!(a->flags & 1);
630     case GCRYMPI_FLAG_OPAQUE:    return !!(a->flags & 4);
631     case GCRYMPI_FLAG_IMMUTABLE: return !!(a->flags & 16);
632     case GCRYMPI_FLAG_CONST:     return !!(a->flags & 32);
633     default: log_bug("invalid flag value\n");
634     }
635   /*NOTREACHED*/
636   return 0;
637 }
638
639
640 /* Return a constant MPI descripbed by NO which is one of the
641    MPI_C_xxx macros.  There is no need to copy this returned value; it
642    may be used directly.  */
643 gcry_mpi_t
644 _gcry_mpi_const (enum gcry_mpi_constants no)
645 {
646   if ((int)no < 0 || no > MPI_NUMBER_OF_CONSTANTS)
647     log_bug("invalid mpi_const selector %d\n", no);
648   if (!constants[no])
649     log_bug("MPI subsystem not initialized\n");
650   return constants[no];
651 }