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