bug fixes
[gnupg.git] / mpi / mpicoder.c
1 /* mpicoder.c  -  Coder for the external representation of MPIs
2  *      Copyright (C) 1998 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 <string.h>
24 #include <stdlib.h>
25 #include <assert.h>
26
27 #include "mpi.h"
28 #include "mpi-internal.h"
29 #include "iobuf.h"
30 #include "memory.h"
31 #include "util.h"
32
33 #ifdef M_DEBUG
34   #undef mpi_read
35 #endif
36
37 #define MAX_EXTERN_MPI_BITS 16384
38
39 /****************
40  * write an mpi to out.
41  */
42 int
43 mpi_write( IOBUF out, MPI a )
44 {
45     int rc;
46     unsigned nbits = mpi_get_nbits(a);
47     byte *p, *buf;
48     unsigned n;
49
50     if( nbits > MAX_EXTERN_MPI_BITS )
51         log_bug("mpi_encode: mpi too large (%u bits)\n", nbits);
52
53     iobuf_put(out, (nbits >>8) );
54     iobuf_put(out, (nbits) );
55
56     p = buf = mpi_get_buffer( a, &n, NULL );
57     rc = iobuf_write( out, p, n );
58     m_free(buf);
59     return rc;
60 }
61
62
63 /****************
64  * Read an external representation of an mpi and return the MPI
65  * The external format is a 16 bit unsigned value stored in network byte order,
66  * giving the number of bits for the following integer. The integer is stored
67  * with MSB first (left padded with zeroes to align on a byte boundary).
68  */
69 MPI
70 #ifdef M_DEBUG
71 mpi_debug_read(IOBUF inp, unsigned *ret_nread, int secure, const char *info)
72 #else
73 mpi_read(IOBUF inp, unsigned *ret_nread, int secure)
74 #endif
75 {
76     int c, i, j;
77     unsigned nbits, nbytes, nlimbs, nread=0;
78     mpi_limb_t a;
79     MPI val = MPI_NULL;
80
81     if( (c = iobuf_get(inp)) == -1 )
82         goto leave;
83     nbits = c << 8;
84     if( (c = iobuf_get(inp)) == -1 )
85         goto leave;
86     nbits |= c;
87     if( nbits > MAX_EXTERN_MPI_BITS ) {
88         log_error("mpi too large (%u bits)\n", nbits);
89         goto leave;
90     }
91     nread = 2;
92
93     nbytes = (nbits+7) / 8;
94     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
95   #ifdef M_DEBUG
96     val = secure? mpi_debug_alloc_secure( nlimbs, info )
97                 : mpi_debug_alloc( nlimbs, info );
98   #else
99     val = secure? mpi_alloc_secure( nlimbs )
100                 : mpi_alloc( nlimbs );
101   #endif
102     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
103     i %= BYTES_PER_MPI_LIMB;
104     val->nbits = nbits;
105     j= val->nlimbs = nlimbs;
106     val->sign = 0;
107     for( ; j > 0; j-- ) {
108         a = 0;
109         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
110             a <<= 8;
111             a |= iobuf_get(inp) & 0xff; nread++;
112         }
113         i = 0;
114         val->d[j-1] = a;
115     }
116
117   leave:
118     if( nread > *ret_nread )
119         log_bug("mpi crosses packet border");
120     else
121         *ret_nread = nread;
122     return val;
123 }
124
125
126
127 /****************
128  * Make an mpi from a character string.
129  */
130 int
131 mpi_fromstr(MPI val, const char *str)
132 {
133     int hexmode=0, sign=0, prepend_zero=0, i, j, c, c1, c2;
134     unsigned nbits, nbytes, nlimbs;
135     mpi_limb_t a;
136
137     if( *str == '-' ) {
138         sign = 1;
139         str++;
140     }
141     if( *str == '0' && str[1] == 'x' )
142         hexmode = 1;
143     else
144         return 1; /* other bases are not yet supported */
145     str += 2;
146
147     nbits = strlen(str)*4;
148     if( nbits % 8 )
149         prepend_zero = 1;
150     nbytes = (nbits+7) / 8;
151     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
152     if( val->alloced < nlimbs )
153         mpi_resize(val, nlimbs );
154     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
155     i %= BYTES_PER_MPI_LIMB;
156     j= val->nlimbs = nlimbs;
157     val->sign = sign;
158     for( ; j > 0; j-- ) {
159         a = 0;
160         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
161             if( prepend_zero ) {
162                 c1 = '0';
163                 prepend_zero = 0;
164             }
165             else
166                 c1 = *str++;
167             assert(c1);
168             c2 = *str++;
169             assert(c2);
170             if( c1 >= '0' && c1 <= '9' )
171                 c = c1 - '0';
172             else if( c1 >= 'a' && c1 <= 'f' )
173                 c = c1 - 'a' + 10;
174             else if( c1 >= 'A' && c1 <= 'F' )
175                 c = c1 - 'A' + 10;
176             else {
177                 mpi_clear(val);
178                 return 1;
179             }
180             c <<= 4;
181             if( c2 >= '0' && c2 <= '9' )
182                 c |= c2 - '0';
183             else if( c2 >= 'a' && c2 <= 'f' )
184                 c |= c2 - 'a' + 10;
185             else if( c2 >= 'A' && c2 <= 'F' )
186                 c |= c2 - 'A' + 10;
187             else {
188                 mpi_clear(val);
189                 return 1;
190             }
191             a <<= 8;
192             a |= c;
193         }
194         i = 0;
195         val->d[j-1] = a;
196     }
197
198     return 0;
199 }
200
201
202 /****************
203  * print an MPI to the given stream and return the number of characters
204  * printed.
205  */
206 int
207 mpi_print( FILE *fp, MPI a, int mode )
208 {
209     int i, n=0;
210
211     if( a == MPI_NULL )
212         return fprintf(fp, "[MPI_NULL]");
213     if( !mode ) {
214         unsigned n1, n2;
215         n1 = mpi_get_nbits(a);
216         n2 = mpi_get_nbit_info(a);
217         if( n2 && n2 != n1 )
218             n += fprintf(fp, "[%u bits (%u)]", n1, n2 );
219         else
220             n += fprintf(fp, "[%u bits]", n1);
221     }
222     else {
223         if( a->sign )
224             putc('-', fp);
225        #if BYTES_PER_MPI_LIMB == 2
226           #define X "4"
227        #elif BYTES_PER_MPI_LIMB == 4
228           #define X "8"
229        #elif BYTES_PER_MPI_LIMB == 8
230           #define X "16"
231        #else
232           #error please define the format here
233        #endif
234         for(i=a->nlimbs; i > 0 ; i-- ) {
235             n += fprintf(fp, i!=a->nlimbs? "%0" X "lX":"%lX", (ulong)a->d[i-1]);
236        #undef X
237         }
238         if( !a->nlimbs )
239             putc('0', fp );
240     }
241     return n;
242 }
243
244
245 /****************
246  * Special function to get the low 8 bytes from an mpi.
247  * This can be used as a keyid; KEYID is an 2 element array.
248  * Return the low 4 bytes.
249  */
250 u32
251 mpi_get_keyid( MPI a, u32 *keyid )
252 {
253 #if BYTES_PER_MPI_LIMB == 4
254     if( keyid ) {
255         keyid[0] = a->nlimbs >= 2? a->d[1] : 0;
256         keyid[1] = a->nlimbs >= 1? a->d[0] : 0;
257     }
258     return a->nlimbs >= 1? a->d[0] : 0;
259 #elif BYTES_PER_MPI_LIMB == 8
260     if( keyid ) {
261         keyid[0] = a->nlimbs? (u32)(a->d[0] >> 32) : 0;
262         keyid[1] = a->nlimbs? (u32)(a->d[0] & 0xffffffff) : 0;
263     }
264     return a->nlimbs? (u32)(a->d[0] & 0xffffffff) : 0;
265 #else
266   #error Make this function work with other LIMB sizes
267 #endif
268 }
269
270
271 /****************
272  * Return an m_alloced buffer with the MPI (msb first).
273  * NBYTES receives the length of this buffer. Caller must free the
274  * return string (This function does return a 0 byte buffer with NBYTES
275  * set to zero if the value of A is zero. If sign is not NULL, it will
276  * be set to the sign of the A.
277  */
278 static byte *
279 do_get_buffer( MPI a, unsigned *nbytes, int *sign, int force_secure )
280 {
281     byte *p, *buffer;
282     mpi_limb_t alimb;
283     int i;
284
285     if( sign )
286         *sign = a->sign;
287     *nbytes = a->nlimbs * BYTES_PER_MPI_LIMB;
288     p = buffer = force_secure || mpi_is_secure(a) ? m_alloc_secure( *nbytes)
289                                                   : m_alloc( *nbytes );
290
291     for(i=a->nlimbs-1; i >= 0; i-- ) {
292         alimb = a->d[i];
293       #if BYTES_PER_MPI_LIMB == 4
294         *p++ = alimb >> 24;
295         *p++ = alimb >> 16;
296         *p++ = alimb >>  8;
297         *p++ = alimb      ;
298       #elif BYTES_PER_MPI_LIMB == 8
299         *p++ = alimb >> 56;
300         *p++ = alimb >> 48;
301         *p++ = alimb >> 40;
302         *p++ = alimb >> 32;
303         *p++ = alimb >> 24;
304         *p++ = alimb >> 16;
305         *p++ = alimb >>  8;
306         *p++ = alimb      ;
307       #else
308         #error please implement for this limb size.
309       #endif
310     }
311
312     /* this is sub-optimal but we need to do the shift oepration because
313      * the caller has to free the returned buffer */
314     for(p=buffer; !*p && *nbytes; p++, --*nbytes )
315         ;
316     if( p != buffer )
317         memmove(buffer,p, *nbytes);
318     return buffer;
319 }
320
321
322 byte *
323 mpi_get_buffer( MPI a, unsigned *nbytes, int *sign )
324 {
325     return do_get_buffer( a, nbytes, sign, 0 );
326 }
327
328 byte *
329 mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign )
330 {
331     return do_get_buffer( a, nbytes, sign, 1 );
332 }
333
334 /****************
335  * Use BUFFER to update MPI.
336  */
337 void
338 mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign )
339 {
340     const byte *p;
341     mpi_limb_t alimb;
342     int nlimbs;
343     int i;
344
345     nlimbs = (nbytes + BYTES_PER_MPI_LIMB - 1) / BYTES_PER_MPI_LIMB;
346     RESIZE_IF_NEEDED(a, nlimbs);
347     a->sign = sign;
348
349     for(i=0, p = buffer+nbytes-1; p >= buffer+BYTES_PER_MPI_LIMB; ) {
350       #if BYTES_PER_MPI_LIMB == 4
351         alimb  = *p--       ;
352         alimb |= *p-- <<  8 ;
353         alimb |= *p-- << 16 ;
354         alimb |= *p-- << 24 ;
355       #elif BYTES_PER_MPI_LIMB == 8
356         /* cast due to egc's "left shift count >= width of type" warning*/
357         alimb  = (mpi_limb_t)*p--       ;
358         alimb |= (mpi_limb_t)*p-- <<  8 ;
359         alimb |= (mpi_limb_t)*p-- << 16 ;
360         alimb |= (mpi_limb_t)*p-- << 24 ;
361         alimb |= (mpi_limb_t)*p-- << 32 ;
362         alimb |= (mpi_limb_t)*p-- << 40 ;
363         alimb |= (mpi_limb_t)*p-- << 48 ;
364         alimb |= (mpi_limb_t)*p-- << 56 ;
365       #else
366         #error please implement for this limb size.
367       #endif
368         a->d[i++] = alimb;
369     }
370     if( p >= buffer ) {
371       #if BYTES_PER_MPI_LIMB == 4
372         alimb  = *p--       ;
373         if( p >= buffer ) alimb |= *p-- <<  8 ;
374         if( p >= buffer ) alimb |= *p-- << 16 ;
375         if( p >= buffer ) alimb |= *p-- << 24 ;
376       #elif BYTES_PER_MPI_LIMB == 8
377         alimb  = (mpi_limb_t)*p-- ;
378         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- <<  8 ;
379         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 16 ;
380         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 24 ;
381         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 32 ;
382         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 40 ;
383         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 48 ;
384         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 56 ;
385       #else
386         #error please implement for this limb size.
387       #endif
388         a->d[i++] = alimb;
389     }
390     a->nlimbs = i;
391     assert( i == nlimbs );
392 }
393