* bithelp.h, des.c, random.c, rndlinux.c, sha1.c, blowfish.c, elgamal.c,
[gnupg.git] / mpi / mpiutil.c
1 /* mpiutil.ac  -  Utility functions for MPI
2  * Copyright (C) 1998, 1999 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "mpi.h"
28 #include "mpi-internal.h"
29 #include "memory.h"
30 #include "util.h"
31
32
33 #ifdef M_DEBUG
34 #undef mpi_alloc
35 #undef mpi_alloc_secure
36 #undef mpi_free
37 #endif
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 chnage this to bits (or bytes).
43  *
44  *        But mpi_alloc is used in a lot of places :-)
45  */
46 MPI
47 #ifdef M_DEBUG
48 mpi_debug_alloc( unsigned nlimbs, const char *info )
49 #else
50 mpi_alloc( unsigned nlimbs )
51 #endif
52 {
53     MPI a;
54
55     if( DBG_MEMORY )
56         log_debug("mpi_alloc(%u)\n", nlimbs*BITS_PER_MPI_LIMB );
57 #ifdef M_DEBUG
58     a = m_debug_alloc( sizeof *a, info );
59     a->d = nlimbs? mpi_debug_alloc_limb_space( nlimbs, 0, info ) : NULL;
60 #else
61     a = m_alloc( sizeof *a );
62     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 0 ) : NULL;
63 #endif
64     a->alloced = nlimbs;
65     a->nlimbs = 0;
66     a->sign = 0;
67     a->flags = 0;
68     a->nbits = 0;
69     return a;
70 }
71
72 void
73 mpi_m_check( MPI a )
74 {
75     m_check(a);
76     m_check(a->d);
77 }
78
79 MPI
80 #ifdef M_DEBUG
81 mpi_debug_alloc_secure( unsigned nlimbs, const char *info )
82 #else
83 mpi_alloc_secure( unsigned nlimbs )
84 #endif
85 {
86     MPI a;
87
88     if( DBG_MEMORY )
89         log_debug("mpi_alloc_secure(%u)\n", nlimbs*BITS_PER_MPI_LIMB );
90 #ifdef M_DEBUG
91     a = m_debug_alloc( sizeof *a, info );
92     a->d = nlimbs? mpi_debug_alloc_limb_space( nlimbs, 1, info ) : NULL;
93 #else
94     a = m_alloc( sizeof *a );
95     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 1 ) : NULL;
96 #endif
97     a->alloced = nlimbs;
98     a->flags = 1;
99     a->nlimbs = 0;
100     a->sign = 0;
101     a->nbits = 0;
102     return a;
103 }
104
105
106 #if 0
107 static void *unused_limbs_5;
108 static void *unused_limbs_32;
109 static void *unused_limbs_64;
110 #endif
111
112 mpi_ptr_t
113 #ifdef M_DEBUG
114 mpi_debug_alloc_limb_space( unsigned nlimbs, int secure, const char *info )
115 #else
116 mpi_alloc_limb_space( unsigned nlimbs, int secure )
117 #endif
118 {
119     size_t len = nlimbs * sizeof(mpi_limb_t);
120     mpi_ptr_t p;
121
122     if( DBG_MEMORY )
123         log_debug("mpi_alloc_limb_space(%u)\n", (unsigned)len*8 );
124 #if 0
125     if( !secure ) {
126         if( nlimbs == 5 && unused_limbs_5 ) {  /* DSA 160 bits */
127             p = unused_limbs_5;
128             unused_limbs_5 = *p;
129             return p;
130         }
131         else if( nlimbs == 32 && unused_limbs_32 ) {  /* DSA 1024 bits */
132             p = unused_limbs_32;
133             unused_limbs_32 = *p;
134             return p;
135         }
136         else if( nlimbs == 64 && unused_limbs_64 ) {  /* DSA 2*1024 bits */
137             p = unused_limbs_64;
138             unused_limbs_64 = *p;
139             return p;
140         }
141     }
142 #endif
143
144 #ifdef M_DEBUG
145     p = secure? m_debug_alloc_secure(len, info):m_debug_alloc( len, info );
146 #else
147     p = secure? m_alloc_secure( len ):m_alloc( len );
148 #endif
149
150     return p;
151 }
152
153 void
154 #ifdef M_DEBUG
155 mpi_debug_free_limb_space( mpi_ptr_t a, const char *info )
156 #else
157 mpi_free_limb_space( mpi_ptr_t a )
158 #endif
159 {
160     if( !a )
161         return;
162     if( DBG_MEMORY )
163         log_debug("mpi_free_limb_space of size %lu\n", (ulong)m_size(a)*8 );
164
165 #if 0
166     if( !m_is_secure(a) ) {
167         size_t nlimbs = m_size(a) / 4 ;
168         void *p = a;
169
170         if( nlimbs == 5 ) {  /* DSA 160 bits */
171             *a = unused_limbs_5;
172             unused_limbs_5 = a;
173             return;
174         }
175         else if( nlimbs == 32 ) {  /* DSA 1024 bits */
176             *a = unused_limbs_32;
177             unused_limbs_32 = a;
178             return;
179         }
180         else if( nlimbs == 64 ) {  /* DSA 2*1024 bits */
181             *a = unused_limbs_64;
182             unused_limbs_64 = a;
183             return;
184         }
185     }
186 #endif
187
188     m_free(a);
189 }
190
191
192 void
193 mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs )
194 {
195     mpi_free_limb_space(a->d);
196     a->d = ap;
197     a->alloced = nlimbs;
198 }
199
200
201
202 /****************
203  * Resize the array of A to NLIMBS. the additional space is cleared
204  * (set to 0) [done by m_realloc()]
205  */
206 void
207 #ifdef M_DEBUG
208 mpi_debug_resize( MPI a, unsigned nlimbs, const char *info )
209 #else
210 mpi_resize( MPI a, unsigned nlimbs )
211 #endif
212 {
213     if( nlimbs <= a->alloced )
214         return; /* no need to do it */
215     /* Note: a->secure is not used - instead the realloc functions
216      * take care of it. Maybe we should drop a->secure completely
217      * and rely on a mpi_is_secure function, which would be
218      * a wrapper around m_is_secure
219      */
220 #ifdef M_DEBUG
221     if( a->d )
222         a->d = m_debug_realloc(a->d, nlimbs * sizeof(mpi_limb_t), info );
223     else
224         a->d = m_debug_alloc_clear( nlimbs * sizeof(mpi_limb_t), info );
225 #else
226     if( a->d )
227         a->d = m_realloc(a->d, nlimbs * sizeof(mpi_limb_t) );
228     else
229         a->d = m_alloc_clear( nlimbs * sizeof(mpi_limb_t) );
230 #endif
231     a->alloced = nlimbs;
232 }
233
234 void
235 mpi_clear( MPI a )
236 {
237     a->nlimbs = 0;
238     a->nbits = 0;
239     a->flags = 0;
240 }
241
242
243 void
244 #ifdef M_DEBUG
245 mpi_debug_free( MPI a, const char *info )
246 #else
247 mpi_free( MPI a )
248 #endif
249 {
250     if( !a )
251         return;
252     if( DBG_MEMORY )
253         log_debug("mpi_free\n" );
254     if( a->flags & 4 )
255         m_free( a->d );
256     else {
257 #ifdef M_DEBUG
258         mpi_debug_free_limb_space(a->d, info);
259 #else
260         mpi_free_limb_space(a->d);
261 #endif
262     }
263     if( a->flags & ~7 )
264         log_bug("invalid flag value in mpi\n");
265     m_free(a);
266 }
267
268
269 void
270 mpi_set_secure( MPI a )
271 {
272     mpi_ptr_t ap, bp;
273
274     if( (a->flags & 1) )
275         return;
276     a->flags |= 1;
277     ap = a->d;
278     if( !a->nlimbs ) {
279         assert(!ap);
280         return;
281     }
282 #ifdef M_DEBUG
283     bp = mpi_debug_alloc_limb_space( a->nlimbs, 1, "set_secure" );
284 #else
285     bp = mpi_alloc_limb_space( a->nlimbs, 1 );
286 #endif
287     MPN_COPY( bp, ap, a->nlimbs );
288     a->d = bp;
289 #ifdef M_DEBUG
290     mpi_debug_free_limb_space(ap, "set_secure");
291 #else
292     mpi_free_limb_space(ap);
293 #endif
294 }
295
296
297 MPI
298 mpi_set_opaque( MPI a, void *p, int len )
299 {
300     if( !a ) {
301 #ifdef M_DEBUG
302         a = mpi_debug_alloc(0,"alloc_opaque");
303 #else
304         a = mpi_alloc(0);
305 #endif
306     }
307
308     if( a->flags & 4 )
309         m_free( a->d );
310     else {
311 #ifdef M_DEBUG
312         mpi_debug_free_limb_space(a->d, "alloc_opaque");
313 #else
314         mpi_free_limb_space(a->d);
315 #endif
316     }
317
318     a->d = p;
319     a->alloced = 0;
320     a->nlimbs = 0;
321     a->nbits = len;
322     a->flags = 4;
323     return a;
324 }
325
326
327 void *
328 mpi_get_opaque( MPI a, int *len )
329 {
330     if( !(a->flags & 4) )
331         log_bug("mpi_get_opaque on normal mpi\n");
332     if( len )
333         *len = a->nbits;
334     return a->d;
335 }
336
337
338 /****************
339  * Note: This copy function should not interpret the MPI
340  *       but copy it transparently.
341  */
342 MPI
343 #ifdef M_DEBUG
344 mpi_debug_copy( MPI a, const char *info )
345 #else
346 mpi_copy( MPI a )
347 #endif
348 {
349     int i;
350     MPI b;
351
352     if( a && (a->flags & 4) ) {
353         void *p = m_is_secure(a->d)? m_alloc_secure( a->nbits )
354                                    : m_alloc( a->nbits );
355         memcpy( p, a->d, a->nbits );
356         b = mpi_set_opaque( NULL, p, a->nbits );
357     }
358     else if( a ) {
359 #ifdef M_DEBUG
360         b = mpi_is_secure(a)? mpi_debug_alloc_secure( a->nlimbs, info )
361                             : mpi_debug_alloc( a->nlimbs, info );
362 #else
363         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
364                             : mpi_alloc( a->nlimbs );
365 #endif
366         b->nlimbs = a->nlimbs;
367         b->sign = a->sign;
368         b->flags  = a->flags;
369         b->nbits = a->nbits;
370         for(i=0; i < b->nlimbs; i++ )
371             b->d[i] = a->d[i];
372     }
373     else
374         b = NULL;
375     return b;
376 }
377
378
379 /****************
380  * This function allocates an MPI which is optimized to hold
381  * a value as large as the one given in the arhgument and allocates it
382  * with the same flags as A.
383  */
384 MPI
385 #ifdef M_DEBUG
386 mpi_debug_alloc_like( MPI a, const char *info )
387 #else
388 mpi_alloc_like( MPI a )
389 #endif
390 {
391     MPI b;
392
393     if( a && (a->flags & 4) ) {
394         void *p = m_is_secure(a->d)? m_alloc_secure( a->nbits )
395                                    : m_alloc( a->nbits );
396         memcpy( p, a->d, a->nbits );
397         b = mpi_set_opaque( NULL, p, a->nbits );
398     }
399     else if( a ) {
400 #ifdef M_DEBUG
401         b = mpi_is_secure(a)? mpi_debug_alloc_secure( a->nlimbs, info )
402                             : mpi_debug_alloc( a->nlimbs, info );
403 #else
404         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
405                             : mpi_alloc( a->nlimbs );
406 #endif
407         b->nlimbs = 0;
408         b->sign = 0;
409         b->flags = a->flags;
410         b->nbits = 0;
411     }
412     else
413         b = NULL;
414     return b;
415 }
416
417
418 void
419 mpi_set( MPI w, MPI u)
420 {
421     mpi_ptr_t wp, up;
422     mpi_size_t usize = u->nlimbs;
423     int usign = u->sign;
424
425     RESIZE_IF_NEEDED(w, usize);
426     wp = w->d;
427     up = u->d;
428     MPN_COPY( wp, up, usize );
429     w->nlimbs = usize;
430     w->nbits = u->nbits;
431     w->flags = u->flags;
432     w->sign = usign;
433 }
434
435
436 void
437 mpi_set_ui( MPI w, unsigned long u)
438 {
439     RESIZE_IF_NEEDED(w, 1);
440     w->d[0] = u;
441     w->nlimbs = u? 1:0;
442     w->sign = 0;
443     w->nbits = 0;
444     w->flags = 0;
445 }
446
447
448 MPI
449 mpi_alloc_set_ui( unsigned long u)
450 {
451 #ifdef M_DEBUG
452     MPI w = mpi_debug_alloc(1,"alloc_set_ui");
453 #else
454     MPI w = mpi_alloc(1);
455 #endif
456     w->d[0] = u;
457     w->nlimbs = u? 1:0;
458     w->sign = 0;
459     return w;
460 }
461
462
463 void
464 mpi_swap( MPI a, MPI b)
465 {
466     struct gcry_mpi tmp;
467
468     tmp = *a; *a = *b; *b = tmp;
469 }