a82a8e73da6d99435c96bb96a3fb226dbe00ef63
[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, const 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   if (!d)
294     return NULL;
295   memcpy (d, p, n);
296   return gcry_mpi_set_opaque (a, d, nbits);
297 }
298
299
300 void *
301 gcry_mpi_get_opaque( gcry_mpi_t a, unsigned int *nbits )
302 {
303     if( !(a->flags & 4) )
304         log_bug("mpi_get_opaque on normal mpi\n");
305     if( nbits )
306         *nbits = a->sign;
307     return a->d;
308 }
309
310
311 void *
312 _gcry_mpi_get_opaque_copy (gcry_mpi_t a, unsigned int *nbits)
313 {
314   const void *s;
315   void *d;
316   unsigned int n;
317
318   s = gcry_mpi_get_opaque (a, nbits);
319   if (!s && nbits)
320     return NULL;
321   n = (*nbits+7)/8;
322   d = gcry_is_secure (s)? gcry_malloc_secure (n) : gcry_malloc (n);
323   if (d)
324     memcpy (d, s, n);
325   return d;
326 }
327
328 /****************
329  * Note: This copy function should not interpret the MPI
330  *       but copy it transparently.
331  */
332 gcry_mpi_t
333 gcry_mpi_copy( gcry_mpi_t a )
334 {
335     int i;
336     gcry_mpi_t b;
337
338     if( a && (a->flags & 4) ) {
339         void *p = gcry_is_secure(a->d)? gcry_xmalloc_secure( (a->sign+7)/8 )
340                                      : gcry_xmalloc( (a->sign+7)/8 );
341         memcpy( p, a->d, (a->sign+7)/8 );
342         b = gcry_mpi_set_opaque( NULL, p, a->sign );
343         b->flags &= ~(16|32); /* Reset the immutable and constant flags.  */
344     }
345     else if( a ) {
346         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
347                             : mpi_alloc( a->nlimbs );
348         b->nlimbs = a->nlimbs;
349         b->sign = a->sign;
350         b->flags  = a->flags;
351         b->flags &= ~(16|32); /* Reset the immutable and constant flags.  */
352         for(i=0; i < b->nlimbs; i++ )
353             b->d[i] = a->d[i];
354     }
355     else
356         b = NULL;
357     return b;
358 }
359
360
361 /* Return true if A is negative.  */
362 int
363 _gcry_mpi_is_neg (gcry_mpi_t a)
364 {
365   if (a->sign && _gcry_mpi_cmp_ui (a, 0))
366     return 1;
367   else
368     return 0;
369 }
370
371
372 /* W = - U */
373 void
374 _gcry_mpi_neg (gcry_mpi_t w, gcry_mpi_t u)
375 {
376   if (w != u)
377     mpi_set (w, u);
378   else if (mpi_is_immutable (w))
379     {
380       mpi_immutable_failed ();
381       return;
382     }
383
384   w->sign = !u->sign;
385 }
386
387
388 /* W = [W] */
389 void
390 _gcry_mpi_abs (gcry_mpi_t w)
391 {
392   if (mpi_is_immutable (w))
393     {
394       mpi_immutable_failed ();
395       return;
396     }
397
398   w->sign = 0;
399 }
400
401
402 /****************
403  * This function allocates an MPI which is optimized to hold
404  * a value as large as the one given in the argument and allocates it
405  * with the same flags as A.
406  */
407 gcry_mpi_t
408 _gcry_mpi_alloc_like( gcry_mpi_t a )
409 {
410     gcry_mpi_t b;
411
412     if( a && (a->flags & 4) ) {
413         int n = (a->sign+7)/8;
414         void *p = gcry_is_secure(a->d)? gcry_malloc_secure( n )
415                                      : gcry_malloc( n );
416         memcpy( p, a->d, n );
417         b = gcry_mpi_set_opaque( NULL, p, a->sign );
418     }
419     else if( a ) {
420         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
421                             : mpi_alloc( a->nlimbs );
422         b->nlimbs = 0;
423         b->sign = 0;
424         b->flags = a->flags;
425     }
426     else
427         b = NULL;
428     return b;
429 }
430
431
432 /* Set U into W and release U.  If W is NULL only U will be released. */
433 void
434 gcry_mpi_snatch (gcry_mpi_t w, gcry_mpi_t u)
435 {
436   if (w)
437     {
438       if (mpi_is_immutable (w))
439         {
440           mpi_immutable_failed ();
441           return;
442         }
443       _gcry_mpi_assign_limb_space (w, u->d, u->alloced);
444       w->nlimbs = u->nlimbs;
445       w->sign   = u->sign;
446       w->flags  = u->flags;
447       u->alloced = 0;
448       u->nlimbs = 0;
449       u->d = NULL;
450     }
451   _gcry_mpi_free (u);
452 }
453
454
455 gcry_mpi_t
456 gcry_mpi_set( gcry_mpi_t w, gcry_mpi_t u)
457 {
458   mpi_ptr_t wp, up;
459   mpi_size_t usize = u->nlimbs;
460   int usign = u->sign;
461
462   if (!w)
463     w = _gcry_mpi_alloc( mpi_get_nlimbs(u) );
464   if (mpi_is_immutable (w))
465     {
466       mpi_immutable_failed ();
467       return w;
468     }
469   RESIZE_IF_NEEDED(w, usize);
470   wp = w->d;
471   up = u->d;
472   MPN_COPY( wp, up, usize );
473   w->nlimbs = usize;
474   w->flags = u->flags;
475   w->flags &= ~(16|32); /* Reset the immutable and constant flags.  */
476   w->sign = usign;
477   return w;
478 }
479
480
481 gcry_mpi_t
482 gcry_mpi_set_ui( gcry_mpi_t w, unsigned long u)
483 {
484   if (!w)
485     w = _gcry_mpi_alloc (1);
486   /* FIXME: If U is 0 we have no need to resize and thus possible
487      allocating the the limbs. */
488   if (mpi_is_immutable (w))
489     {
490       mpi_immutable_failed ();
491       return w;
492     }
493   RESIZE_IF_NEEDED(w, 1);
494   w->d[0] = u;
495   w->nlimbs = u? 1:0;
496   w->sign = 0;
497   w->flags = 0;
498   return w;
499 }
500
501 gcry_err_code_t
502 _gcry_mpi_get_ui (gcry_mpi_t w, unsigned long *u)
503 {
504   gcry_err_code_t err = GPG_ERR_NO_ERROR;
505   unsigned long x = 0;
506
507   if (w->nlimbs > 1)
508     err = GPG_ERR_TOO_LARGE;
509   else if (w->nlimbs == 1)
510     x = w->d[0];
511   else
512     x = 0;
513
514   if (! err)
515     *u = x;
516
517   return err;
518 }
519
520 gcry_error_t
521 gcry_mpi_get_ui (gcry_mpi_t w, unsigned long *u)
522 {
523   gcry_err_code_t err = GPG_ERR_NO_ERROR;
524
525   err = _gcry_mpi_get_ui (w, u);
526
527   return gcry_error (err);
528 }
529
530 gcry_mpi_t
531 _gcry_mpi_alloc_set_ui( unsigned long u)
532 {
533     gcry_mpi_t w = mpi_alloc(1);
534     w->d[0] = u;
535     w->nlimbs = u? 1:0;
536     w->sign = 0;
537     return w;
538 }
539
540 void
541 gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b)
542 {
543     struct gcry_mpi tmp;
544
545     tmp = *a; *a = *b; *b = tmp;
546 }
547
548
549 gcry_mpi_t
550 gcry_mpi_new( unsigned int nbits )
551 {
552     return _gcry_mpi_alloc ( (nbits+BITS_PER_MPI_LIMB-1)
553                              / BITS_PER_MPI_LIMB );
554 }
555
556
557 gcry_mpi_t
558 gcry_mpi_snew( unsigned int nbits )
559 {
560   return _gcry_mpi_alloc_secure ( (nbits+BITS_PER_MPI_LIMB-1)
561                                   / BITS_PER_MPI_LIMB );
562 }
563
564 void
565 gcry_mpi_release( gcry_mpi_t a )
566 {
567     _gcry_mpi_free( a );
568 }
569
570 void
571 gcry_mpi_randomize( gcry_mpi_t w,
572                     unsigned int nbits, enum gcry_random_level level )
573 {
574   unsigned char *p;
575   size_t nbytes = (nbits+7)/8;
576
577   if (mpi_is_immutable (w))
578     {
579       mpi_immutable_failed ();
580       return;
581     }
582   if (level == GCRY_WEAK_RANDOM)
583     {
584       p = mpi_is_secure(w) ? gcry_xmalloc_secure (nbytes)
585                            : gcry_xmalloc (nbytes);
586       gcry_create_nonce (p, nbytes);
587     }
588   else
589     {
590       p = mpi_is_secure(w) ? gcry_random_bytes_secure (nbytes, level)
591                            : gcry_random_bytes (nbytes, level);
592     }
593   _gcry_mpi_set_buffer( w, p, nbytes, 0 );
594   gcry_free (p);
595 }
596
597
598 void
599 gcry_mpi_set_flag (gcry_mpi_t a, enum gcry_mpi_flag flag)
600 {
601   switch (flag)
602     {
603     case GCRYMPI_FLAG_SECURE:     mpi_set_secure(a); break;
604     case GCRYMPI_FLAG_CONST:      a->flags |= (16|32); break;
605     case GCRYMPI_FLAG_IMMUTABLE:  a->flags |= 16; break;
606     case GCRYMPI_FLAG_OPAQUE:
607     default: log_bug("invalid flag value\n");
608     }
609 }
610
611 void
612 gcry_mpi_clear_flag (gcry_mpi_t a, enum gcry_mpi_flag flag)
613 {
614   (void)a; /* Not yet used. */
615
616   switch (flag)
617     {
618     case GCRYMPI_FLAG_IMMUTABLE:
619       if (!(a->flags & 32))
620         a->flags &= ~16;
621       break;
622     case GCRYMPI_FLAG_CONST:
623     case GCRYMPI_FLAG_SECURE:
624     case GCRYMPI_FLAG_OPAQUE:
625     default: log_bug("invalid flag value\n");
626     }
627 }
628
629 int
630 gcry_mpi_get_flag (gcry_mpi_t a, enum gcry_mpi_flag flag)
631 {
632   switch (flag)
633     {
634     case GCRYMPI_FLAG_SECURE:    return !!(a->flags & 1);
635     case GCRYMPI_FLAG_OPAQUE:    return !!(a->flags & 4);
636     case GCRYMPI_FLAG_IMMUTABLE: return !!(a->flags & 16);
637     case GCRYMPI_FLAG_CONST:     return !!(a->flags & 32);
638     default: log_bug("invalid flag value\n");
639     }
640   /*NOTREACHED*/
641   return 0;
642 }
643
644
645 /* Return a constant MPI descripbed by NO which is one of the
646    MPI_C_xxx macros.  There is no need to copy this returned value; it
647    may be used directly.  */
648 gcry_mpi_t
649 _gcry_mpi_const (enum gcry_mpi_constants no)
650 {
651   if ((int)no < 0 || no > MPI_NUMBER_OF_CONSTANTS)
652     log_bug("invalid mpi_const selector %d\n", no);
653   if (!constants[no])
654     log_bug("MPI subsystem not initialized\n");
655   return constants[no];
656 }