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