Converted all m_free to xfree etc.
[gnupg.git] / mpi / mpicoder.c
1 /* mpicoder.c  -  Coder for the external representation of MPIs
2  * Copyright (C) 1998, 1999, 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <string.h>
25 #include <stdlib.h>
26 #include <assert.h>
27
28 #include "mpi.h"
29 #include "mpi-internal.h"
30 #include "iobuf.h"
31 #include "memory.h"
32 #include "util.h"
33
34 #ifdef M_DEBUG
35 #undef mpi_read
36 #endif
37
38 #define MAX_EXTERN_MPI_BITS 16384
39
40 /****************
41  * write an mpi to out.
42  */
43 int
44 mpi_write( IOBUF out, MPI a )
45 {
46     int rc;
47     unsigned nbits = mpi_get_nbits(a);
48     byte *p, *buf;
49     unsigned n;
50
51     if( nbits > MAX_EXTERN_MPI_BITS )
52         log_bug("mpi_encode: mpi too large (%u bits)\n", nbits);
53
54     iobuf_put(out, (nbits >>8) );
55     iobuf_put(out, (nbits) );
56
57     p = buf = mpi_get_buffer( a, &n, NULL );
58     rc = iobuf_write( out, p, n );
59     xfree(buf);
60     return rc;
61 }
62
63
64 /****************
65  * Read an external representation of an mpi and return the MPI
66  * The external format is a 16 bit unsigned value stored in network byte order,
67  * giving the number of bits for the following integer. The integer is stored
68  * with MSB first (left padded with zeroes to align on a byte boundary).
69  */
70 MPI
71 #ifdef M_DEBUG
72 mpi_debug_read(IOBUF inp, unsigned *ret_nread, int secure, const char *info)
73 #else
74 mpi_read(IOBUF inp, unsigned *ret_nread, int secure)
75 #endif
76 {
77     int c, i, j;
78     unsigned int nmax = *ret_nread;
79     unsigned nbits, nbytes, nlimbs, nread=0;
80     mpi_limb_t a;
81     MPI val = MPI_NULL;
82
83     if( (c = iobuf_get(inp)) == -1 )
84         goto leave;
85     if (++nread >= nmax)
86         goto overflow;
87     nbits = c << 8;
88     if( (c = iobuf_get(inp)) == -1 )
89         goto leave;
90     if (++nread >= nmax)
91         goto overflow;
92     nbits |= c;
93     if( nbits > MAX_EXTERN_MPI_BITS ) {
94         log_error("mpi too large for this implementation (%u bits)\n", nbits);
95         goto leave;
96     }
97
98     nbytes = (nbits+7) / 8;
99     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
100 #ifdef M_DEBUG
101     val = secure? mpi_debug_alloc_secure( nlimbs, info )
102                 : mpi_debug_alloc( nlimbs, info );
103 #else
104     val = secure? mpi_alloc_secure( nlimbs )
105                 : mpi_alloc( nlimbs );
106 #endif
107     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
108     i %= BYTES_PER_MPI_LIMB;
109     val->nbits = nbits;
110     j= val->nlimbs = nlimbs;
111     val->sign = 0;
112     for( ; j > 0; j-- ) {
113         a = 0;
114         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
115             if (nread >= nmax) {
116 #ifdef M_DEBUG
117                 mpi_debug_free (val);
118 #else
119                 mpi_free (val);
120 #endif
121                 val = NULL;
122                 goto overflow;
123             }
124             a <<= 8;
125             a |= iobuf_get(inp) & 0xff; nread++;
126         }
127         i = 0;
128         val->d[j-1] = a;
129     }
130
131   leave:
132     *ret_nread = nread;
133     return val;
134   overflow:
135     log_error ("mpi larger than indicated length (%u bytes)\n", nmax);
136     *ret_nread = nread;
137     return val;
138 }
139
140
141 MPI
142 mpi_read_from_buffer(byte *buffer, unsigned int *ret_nread, int secure)
143 {
144     int i, j;
145     unsigned nbits, nbytes, nlimbs, nread=0;
146     mpi_limb_t a;
147     MPI val = MPI_NULL;
148
149     if( *ret_nread < 2 )
150         goto leave;
151     nbits = buffer[0] << 8 | buffer[1];
152     if( nbits > MAX_EXTERN_MPI_BITS ) {
153         log_info ("mpi too large (%u bits)\n", nbits);
154         goto leave;
155     }
156     buffer += 2;
157     nread = 2;
158
159     nbytes = (nbits+7) / 8;
160     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
161     val = secure? mpi_alloc_secure( nlimbs )
162                 : mpi_alloc( nlimbs );
163     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
164     i %= BYTES_PER_MPI_LIMB;
165     val->nbits = nbits;
166     j= val->nlimbs = nlimbs;
167     val->sign = 0;
168     for( ; j > 0; j-- ) {
169         a = 0;
170         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
171           if( ++nread > *ret_nread ) {
172               /* This (as well as the above error condition) may
173                  happen if we use this function to parse a decrypted
174                  MPI which didn't turn out to be a real MPI - possible
175                  because the supplied key was wrong but the OpenPGP
176                  checksum didn't caught it. */
177                 log_info ("mpi larger than buffer\n");
178                 mpi_free (val);
179                 val = MPI_NULL;
180                 goto leave;
181           }
182           a <<= 8;
183           a |= *buffer++;
184         }
185         i = 0;
186         val->d[j-1] = a;
187     }
188
189   leave:
190     *ret_nread = nread;
191     return val;
192 }
193
194
195 /****************
196  * Make an mpi from a character string.
197  */
198 int
199 mpi_fromstr(MPI val, const char *str)
200 {
201     int hexmode=0, sign=0, prepend_zero=0, i, j, c, c1, c2;
202     unsigned nbits, nbytes, nlimbs;
203     mpi_limb_t a;
204
205     if( *str == '-' ) {
206         sign = 1;
207         str++;
208     }
209     if( *str == '0' && str[1] == 'x' )
210         hexmode = 1;
211     else
212         return 1; /* other bases are not yet supported */
213     str += 2;
214
215     nbits = strlen(str)*4;
216     if( nbits % 8 )
217         prepend_zero = 1;
218     nbytes = (nbits+7) / 8;
219     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
220     if( val->alloced < nlimbs )
221         mpi_resize(val, nlimbs );
222     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
223     i %= BYTES_PER_MPI_LIMB;
224     j= val->nlimbs = nlimbs;
225     val->sign = sign;
226     for( ; j > 0; j-- ) {
227         a = 0;
228         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
229             if( prepend_zero ) {
230                 c1 = '0';
231                 prepend_zero = 0;
232             }
233             else
234                 c1 = *str++;
235             assert(c1);
236             c2 = *str++;
237             assert(c2);
238             if( c1 >= '0' && c1 <= '9' )
239                 c = c1 - '0';
240             else if( c1 >= 'a' && c1 <= 'f' )
241                 c = c1 - 'a' + 10;
242             else if( c1 >= 'A' && c1 <= 'F' )
243                 c = c1 - 'A' + 10;
244             else {
245                 mpi_clear(val);
246                 return 1;
247             }
248             c <<= 4;
249             if( c2 >= '0' && c2 <= '9' )
250                 c |= c2 - '0';
251             else if( c2 >= 'a' && c2 <= 'f' )
252                 c |= c2 - 'a' + 10;
253             else if( c2 >= 'A' && c2 <= 'F' )
254                 c |= c2 - 'A' + 10;
255             else {
256                 mpi_clear(val);
257                 return 1;
258             }
259             a <<= 8;
260             a |= c;
261         }
262         i = 0;
263         val->d[j-1] = a;
264     }
265
266     return 0;
267 }
268
269
270 /****************
271  * print an MPI to the given stream and return the number of characters
272  * printed.
273  */
274 int
275 mpi_print( FILE *fp, MPI a, int mode )
276 {
277     int i, n=0;
278
279     if( a == MPI_NULL )
280         return fprintf(fp, "[MPI_NULL]");
281     if( !mode ) {
282         unsigned int n1;
283
284         n1 = mpi_get_nbits(a);
285         n += fprintf(fp, "[%u bits]", n1);
286     }
287     else {
288         if( a->sign )
289             putc('-', fp);
290 #if BYTES_PER_MPI_LIMB == 2
291 #define X "4"
292 #elif BYTES_PER_MPI_LIMB == 4
293 #define X "8"
294 #elif BYTES_PER_MPI_LIMB == 8
295 #define X "16"
296 #else
297 #error please define the format here
298 #endif
299         for(i=a->nlimbs; i > 0 ; i-- ) {
300             n += fprintf(fp, i!=a->nlimbs? "%0" X "lX":"%lX", (ulong)a->d[i-1]);
301 #undef X
302         }
303         if( !a->nlimbs )
304             putc('0', fp );
305     }
306     return n;
307 }
308
309
310 void
311 g10_log_mpidump( const char *text, MPI a )
312 {
313     FILE *fp = log_stream();
314
315     g10_log_print_prefix(text);
316     mpi_print(fp, a, 1 );
317     fputc('\n', fp);
318 }
319
320 /****************
321  * Special function to get the low 8 bytes from an mpi.
322  * This can be used as a keyid; KEYID is an 2 element array.
323  * Return the low 4 bytes.
324  */
325 u32
326 mpi_get_keyid( MPI a, u32 *keyid )
327 {
328 #if BYTES_PER_MPI_LIMB == 4
329     if( keyid ) {
330         keyid[0] = a->nlimbs >= 2? a->d[1] : 0;
331         keyid[1] = a->nlimbs >= 1? a->d[0] : 0;
332     }
333     return a->nlimbs >= 1? a->d[0] : 0;
334 #elif BYTES_PER_MPI_LIMB == 8
335     if( keyid ) {
336         keyid[0] = a->nlimbs? (u32)(a->d[0] >> 32) : 0;
337         keyid[1] = a->nlimbs? (u32)(a->d[0] & 0xffffffff) : 0;
338     }
339     return a->nlimbs? (u32)(a->d[0] & 0xffffffff) : 0;
340 #else
341 #error Make this function work with other LIMB sizes
342 #endif
343 }
344
345
346 /****************
347  * Return an xmalloced buffer with the MPI (msb first).
348  * NBYTES receives the length of this buffer. Caller must free the
349  * return string (This function does return a 0 byte buffer with NBYTES
350  * set to zero if the value of A is zero. If sign is not NULL, it will
351  * be set to the sign of the A.
352  */
353 static byte *
354 do_get_buffer( MPI a, unsigned *nbytes, int *sign, int force_secure )
355 {
356     byte *p, *buffer;
357     mpi_limb_t alimb;
358     int i;
359     unsigned int n;
360
361     if( sign )
362         *sign = a->sign;
363     *nbytes = n = a->nlimbs * BYTES_PER_MPI_LIMB;
364     if (!n)
365       n++; /* avoid zero length allocation */
366     p = buffer = force_secure || mpi_is_secure(a) ? xmalloc_secure(n)
367                                                   : xmalloc(n);
368
369     for(i=a->nlimbs-1; i >= 0; i-- ) {
370         alimb = a->d[i];
371 #if BYTES_PER_MPI_LIMB == 4
372         *p++ = alimb >> 24;
373         *p++ = alimb >> 16;
374         *p++ = alimb >>  8;
375         *p++ = alimb      ;
376 #elif BYTES_PER_MPI_LIMB == 8
377         *p++ = alimb >> 56;
378         *p++ = alimb >> 48;
379         *p++ = alimb >> 40;
380         *p++ = alimb >> 32;
381         *p++ = alimb >> 24;
382         *p++ = alimb >> 16;
383         *p++ = alimb >>  8;
384         *p++ = alimb      ;
385 #else
386 #error please implement for this limb size.
387 #endif
388     }
389
390     /* this is sub-optimal but we need to do the shift operation
391      * because the caller has to free the returned buffer */
392     for(p=buffer; !*p && *nbytes; p++, --*nbytes )
393       ;
394     if( p != buffer )
395       memmove(buffer,p, *nbytes);
396
397     return buffer;
398 }
399
400
401 byte *
402 mpi_get_buffer( MPI a, unsigned *nbytes, int *sign )
403 {
404     return do_get_buffer( a, nbytes, sign, 0 );
405 }
406
407 byte *
408 mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign )
409 {
410     return do_get_buffer( a, nbytes, sign, 1 );
411 }
412
413 /****************
414  * Use BUFFER to update MPI.
415  */
416 void
417 mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign )
418 {
419     const byte *p;
420     mpi_limb_t alimb;
421     int nlimbs;
422     int i;
423
424     nlimbs = (nbytes + BYTES_PER_MPI_LIMB - 1) / BYTES_PER_MPI_LIMB;
425     RESIZE_IF_NEEDED(a, nlimbs);
426     a->sign = sign;
427
428     for(i=0, p = buffer+nbytes-1; p >= buffer+BYTES_PER_MPI_LIMB; ) {
429 #if BYTES_PER_MPI_LIMB == 4
430         alimb  = (mpi_limb_t)*p-- ;
431         alimb |= (mpi_limb_t)*p-- <<  8 ;
432         alimb |= (mpi_limb_t)*p-- << 16 ;
433         alimb |= (mpi_limb_t)*p-- << 24 ;
434 #elif BYTES_PER_MPI_LIMB == 8
435         alimb  = (mpi_limb_t)*p--       ;
436         alimb |= (mpi_limb_t)*p-- <<  8 ;
437         alimb |= (mpi_limb_t)*p-- << 16 ;
438         alimb |= (mpi_limb_t)*p-- << 24 ;
439         alimb |= (mpi_limb_t)*p-- << 32 ;
440         alimb |= (mpi_limb_t)*p-- << 40 ;
441         alimb |= (mpi_limb_t)*p-- << 48 ;
442         alimb |= (mpi_limb_t)*p-- << 56 ;
443 #else
444 #error please implement for this limb size.
445 #endif
446         a->d[i++] = alimb;
447     }
448     if( p >= buffer ) {
449 #if BYTES_PER_MPI_LIMB == 4
450         alimb  = *p--       ;
451         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- <<  8 ;
452         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 16 ;
453         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 24 ;
454 #elif BYTES_PER_MPI_LIMB == 8
455         alimb  = (mpi_limb_t)*p-- ;
456         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- <<  8 ;
457         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 16 ;
458         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 24 ;
459         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 32 ;
460         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 40 ;
461         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 48 ;
462         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 56 ;
463 #else
464 #error please implement for this limb size.
465 #endif
466         a->d[i++] = alimb;
467     }
468     a->nlimbs = i;
469     assert( i == nlimbs );
470 }