d410d90b6c7d2ed8bffc0e0cc1d7033e8a8211e0
[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
32 const char *
33 _gcry_mpi_get_hw_config (void)
34 {
35   return mod_source_info + 1;
36 }
37
38
39 /****************
40  * Note:  It was a bad idea to use the number of limbs to allocate
41  *        because on a alpha the limbs are large but we normally need
42  *        integers of n bits - So we should change this to bits (or bytes).
43  *
44  *        But mpi_alloc is used in a lot of places :-(.  New code
45  *        should use mpi_new.
46  */
47 gcry_mpi_t
48 _gcry_mpi_alloc( unsigned nlimbs )
49 {
50     gcry_mpi_t a;
51
52     a = gcry_xmalloc( sizeof *a );
53     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 0 ) : NULL;
54     a->alloced = nlimbs;
55     a->nlimbs = 0;
56     a->sign = 0;
57     a->flags = 0;
58     return a;
59 }
60
61 void
62 _gcry_mpi_m_check( gcry_mpi_t a )
63 {
64     _gcry_check_heap(a);
65     _gcry_check_heap(a->d);
66 }
67
68 gcry_mpi_t
69 _gcry_mpi_alloc_secure( unsigned nlimbs )
70 {
71     gcry_mpi_t a;
72
73     a = gcry_xmalloc( sizeof *a );
74     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 1 ) : NULL;
75     a->alloced = nlimbs;
76     a->flags = 1;
77     a->nlimbs = 0;
78     a->sign = 0;
79     return a;
80 }
81
82
83
84 mpi_ptr_t
85 _gcry_mpi_alloc_limb_space( unsigned int nlimbs, int secure )
86 {
87     mpi_ptr_t p;
88     size_t len;
89
90     len = (nlimbs ? nlimbs : 1) * sizeof (mpi_limb_t);
91     p = secure ? gcry_xmalloc_secure (len) : gcry_xmalloc (len);
92     if (! nlimbs)
93       *p = 0;
94
95     return p;
96 }
97
98 void
99 _gcry_mpi_free_limb_space( mpi_ptr_t a, unsigned int nlimbs)
100 {
101   if (a)
102     {
103       size_t len = nlimbs * sizeof(mpi_limb_t);
104
105       /* If we have information on the number of allocated limbs, we
106          better wipe that space out.  This is a failsafe feature if
107          secure memory has been disabled or was not properly
108          implemented in user provided allocation functions. */
109       if (len)
110         wipememory (a, len);
111       gcry_free(a);
112     }
113 }
114
115
116 void
117 _gcry_mpi_assign_limb_space( gcry_mpi_t a, mpi_ptr_t ap, unsigned int nlimbs )
118 {
119   _gcry_mpi_free_limb_space (a->d, a->alloced);
120   a->d = ap;
121   a->alloced = nlimbs;
122 }
123
124
125
126 /****************
127  * Resize the array of A to NLIMBS. The additional space is cleared
128  * (set to 0).
129  */
130 void
131 _gcry_mpi_resize (gcry_mpi_t a, unsigned nlimbs)
132 {
133   size_t i;
134
135   if (nlimbs <= a->alloced)
136     {
137       /* We only need to clear the new space (this is a nop if the
138          limb space is already of the correct size. */
139       for (i=a->nlimbs; i < a->alloced; i++)
140         a->d[i] = 0;
141       return;
142     }
143
144   /* Actually resize the limb space.  */
145   if (a->d)
146     {
147       a->d = gcry_xrealloc (a->d, nlimbs * sizeof (mpi_limb_t));
148       for (i=a->alloced; i < nlimbs; i++)
149         a->d[i] = 0;
150     }
151   else
152     {
153       if (a->flags & 1)
154         /* Secure memory is wanted.  */
155         a->d = gcry_xcalloc_secure (nlimbs , sizeof (mpi_limb_t));
156       else
157         /* Standard memory.  */
158         a->d = gcry_xcalloc (nlimbs , sizeof (mpi_limb_t));
159     }
160   a->alloced = nlimbs;
161 }
162
163 void
164 _gcry_mpi_clear( gcry_mpi_t a )
165 {
166     a->nlimbs = 0;
167     a->flags = 0;
168 }
169
170
171 void
172 _gcry_mpi_free( gcry_mpi_t a )
173 {
174   if (!a )
175     return;
176   if ((a->flags & 4))
177     gcry_free( a->d );
178   else
179     {
180       _gcry_mpi_free_limb_space(a->d, a->alloced);
181     }
182   if ((a->flags & ~7))
183     log_bug("invalid flag value in mpi\n");
184   gcry_free(a);
185 }
186
187 static void
188 mpi_set_secure( gcry_mpi_t a )
189 {
190   mpi_ptr_t ap, bp;
191
192   if ( (a->flags & 1) )
193     return;
194   a->flags |= 1;
195   ap = a->d;
196   if (!a->nlimbs)
197     {
198       gcry_assert (!ap);
199       return;
200     }
201   bp = mpi_alloc_limb_space (a->nlimbs, 1);
202   MPN_COPY( bp, ap, a->nlimbs );
203   a->d = bp;
204   _gcry_mpi_free_limb_space (ap, a->alloced);
205 }
206
207
208 gcry_mpi_t
209 gcry_mpi_set_opaque( gcry_mpi_t a, void *p, unsigned int nbits )
210 {
211   if (!a)
212     a = mpi_alloc(0);
213
214   if( a->flags & 4 )
215     gcry_free( a->d );
216   else
217     _gcry_mpi_free_limb_space (a->d, a->alloced);
218
219   a->d = p;
220   a->alloced = 0;
221   a->nlimbs = 0;
222   a->sign  = nbits;
223   a->flags = 4;
224   return a;
225 }
226
227
228 void *
229 gcry_mpi_get_opaque( gcry_mpi_t a, unsigned int *nbits )
230 {
231     if( !(a->flags & 4) )
232         log_bug("mpi_get_opaque on normal mpi\n");
233     if( nbits )
234         *nbits = a->sign;
235     return a->d;
236 }
237
238
239 /****************
240  * Note: This copy function should not interpret the MPI
241  *       but copy it transparently.
242  */
243 gcry_mpi_t
244 gcry_mpi_copy( gcry_mpi_t a )
245 {
246     int i;
247     gcry_mpi_t b;
248
249     if( a && (a->flags & 4) ) {
250         void *p = gcry_is_secure(a->d)? gcry_xmalloc_secure( (a->sign+7)/8 )
251                                      : gcry_xmalloc( (a->sign+7)/8 );
252         memcpy( p, a->d, (a->sign+7)/8 );
253         b = gcry_mpi_set_opaque( NULL, p, a->sign );
254     }
255     else if( a ) {
256         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
257                             : mpi_alloc( a->nlimbs );
258         b->nlimbs = a->nlimbs;
259         b->sign = a->sign;
260         b->flags  = a->flags;
261         for(i=0; i < b->nlimbs; i++ )
262             b->d[i] = a->d[i];
263     }
264     else
265         b = NULL;
266     return b;
267 }
268
269
270 /****************
271  * This function allocates an MPI which is optimized to hold
272  * a value as large as the one given in the argument and allocates it
273  * with the same flags as A.
274  */
275 gcry_mpi_t
276 _gcry_mpi_alloc_like( gcry_mpi_t a )
277 {
278     gcry_mpi_t b;
279
280     if( a && (a->flags & 4) ) {
281         int n = (a->sign+7)/8;
282         void *p = gcry_is_secure(a->d)? gcry_malloc_secure( n )
283                                      : gcry_malloc( n );
284         memcpy( p, a->d, n );
285         b = gcry_mpi_set_opaque( NULL, p, a->sign );
286     }
287     else if( a ) {
288         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
289                             : mpi_alloc( a->nlimbs );
290         b->nlimbs = 0;
291         b->sign = 0;
292         b->flags = a->flags;
293     }
294     else
295         b = NULL;
296     return b;
297 }
298
299
300 /* Set U into W and release U.  If W is NULL only U will be released. */
301 void
302 gcry_mpi_snatch (gcry_mpi_t w, gcry_mpi_t u)
303 {
304   if (w)
305     {
306       _gcry_mpi_assign_limb_space (w, u->d, u->alloced);
307       w->nlimbs = u->nlimbs;
308       w->sign   = u->sign;
309       w->flags  = u->flags;
310       u->alloced = 0;
311       u->nlimbs = 0;
312       u->d = NULL;
313     }
314   _gcry_mpi_free (u);
315 }
316
317
318 gcry_mpi_t
319 gcry_mpi_set( gcry_mpi_t w, gcry_mpi_t u)
320 {
321   mpi_ptr_t wp, up;
322   mpi_size_t usize = u->nlimbs;
323   int usign = u->sign;
324
325   if (!w)
326     w = _gcry_mpi_alloc( mpi_get_nlimbs(u) );
327   RESIZE_IF_NEEDED(w, usize);
328   wp = w->d;
329   up = u->d;
330   MPN_COPY( wp, up, usize );
331   w->nlimbs = usize;
332   w->flags = u->flags;
333   w->sign = usign;
334   return w;
335 }
336
337
338 gcry_mpi_t
339 gcry_mpi_set_ui( gcry_mpi_t w, unsigned long u)
340 {
341   if (!w)
342     w = _gcry_mpi_alloc (1);
343   /* FIXME: If U is 0 we have no need to resize and thus possible
344      allocating the the limbs. */
345   RESIZE_IF_NEEDED(w, 1);
346   w->d[0] = u;
347   w->nlimbs = u? 1:0;
348   w->sign = 0;
349   w->flags = 0;
350   return w;
351 }
352
353 gcry_err_code_t
354 _gcry_mpi_get_ui (gcry_mpi_t w, unsigned long *u)
355 {
356   gcry_err_code_t err = GPG_ERR_NO_ERROR;
357   unsigned long x = 0;
358
359   if (w->nlimbs > 1)
360     err = GPG_ERR_TOO_LARGE;
361   else if (w->nlimbs == 1)
362     x = w->d[0];
363   else
364     x = 0;
365
366   if (! err)
367     *u = x;
368
369   return err;
370 }
371
372 gcry_error_t
373 gcry_mpi_get_ui (gcry_mpi_t w, unsigned long *u)
374 {
375   gcry_err_code_t err = GPG_ERR_NO_ERROR;
376
377   err = _gcry_mpi_get_ui (w, u);
378
379   return gcry_error (err);
380 }
381
382 gcry_mpi_t
383 _gcry_mpi_alloc_set_ui( unsigned long u)
384 {
385     gcry_mpi_t w = mpi_alloc(1);
386     w->d[0] = u;
387     w->nlimbs = u? 1:0;
388     w->sign = 0;
389     return w;
390 }
391
392 void
393 gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b)
394 {
395     struct gcry_mpi tmp;
396
397     tmp = *a; *a = *b; *b = tmp;
398 }
399
400
401 gcry_mpi_t
402 gcry_mpi_new( unsigned int nbits )
403 {
404     return _gcry_mpi_alloc ( (nbits+BITS_PER_MPI_LIMB-1)
405                              / BITS_PER_MPI_LIMB );
406 }
407
408
409 gcry_mpi_t
410 gcry_mpi_snew( unsigned int nbits )
411 {
412   return _gcry_mpi_alloc_secure ( (nbits+BITS_PER_MPI_LIMB-1)
413                                   / BITS_PER_MPI_LIMB );
414 }
415
416 void
417 gcry_mpi_release( gcry_mpi_t a )
418 {
419     _gcry_mpi_free( a );
420 }
421
422 void
423 gcry_mpi_randomize( gcry_mpi_t w,
424                     unsigned int nbits, enum gcry_random_level level )
425 {
426   unsigned char *p;
427   size_t nbytes = (nbits+7)/8;
428
429   if (level == GCRY_WEAK_RANDOM)
430     {
431       p = mpi_is_secure(w) ? gcry_xmalloc_secure (nbytes)
432                            : gcry_xmalloc (nbytes);
433       gcry_create_nonce (p, nbytes);
434     }
435   else
436     {
437       p = mpi_is_secure(w) ? gcry_random_bytes_secure (nbytes, level)
438                            : gcry_random_bytes (nbytes, level);
439     }
440   _gcry_mpi_set_buffer( w, p, nbytes, 0 );
441   gcry_free (p);
442 }
443
444
445 void
446 gcry_mpi_set_flag( gcry_mpi_t a, enum gcry_mpi_flag flag )
447 {
448     switch( flag ) {
449       case GCRYMPI_FLAG_SECURE:  mpi_set_secure(a); break;
450       case GCRYMPI_FLAG_OPAQUE:
451       default: log_bug("invalid flag value\n");
452     }
453 }
454
455 void
456 gcry_mpi_clear_flag( gcry_mpi_t a, enum gcry_mpi_flag flag )
457 {
458   (void)a; /* Not yet used. */
459
460   switch (flag)
461     {
462     case GCRYMPI_FLAG_SECURE:
463     case GCRYMPI_FLAG_OPAQUE:
464     default: log_bug("invalid flag value\n");
465     }
466 }
467
468 int
469 gcry_mpi_get_flag( gcry_mpi_t a, enum gcry_mpi_flag flag )
470 {
471   switch (flag)
472     {
473     case GCRYMPI_FLAG_SECURE: return (a->flags & 1);
474     case GCRYMPI_FLAG_OPAQUE: return (a->flags & 4);
475     default: log_bug("invalid flag value\n");
476     }
477   /*NOTREACHED*/
478   return 0;
479 }