See ChangeLog: Wed Dec 23 13:34:22 CET 1998 Werner Koch
[libgcrypt.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 MPI
127 mpi_read_from_buffer(byte *buffer, unsigned *ret_nread, int secure)
128 {
129     int i, j;
130     unsigned nbits, nbytes, nlimbs, nread=0;
131     mpi_limb_t a;
132     MPI val = MPI_NULL;
133
134     if( *ret_nread < 2 )
135         goto leave;
136     nbits = buffer[0] << 8 | buffer[1];
137     if( nbits > MAX_EXTERN_MPI_BITS ) {
138         log_error("mpi too large (%u bits)\n", nbits);
139         goto leave;
140     }
141     buffer += 2;
142     nread = 2;
143
144     nbytes = (nbits+7) / 8;
145     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
146     val = secure? mpi_alloc_secure( nlimbs )
147                 : mpi_alloc( nlimbs );
148     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
149     i %= BYTES_PER_MPI_LIMB;
150     val->nbits = nbits;
151     j= val->nlimbs = nlimbs;
152     val->sign = 0;
153     for( ; j > 0; j-- ) {
154         a = 0;
155         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
156             if( ++nread > *ret_nread )
157                 log_bug("mpi larger than buffer");
158             a <<= 8;
159             a |= *buffer++;
160         }
161         i = 0;
162         val->d[j-1] = a;
163     }
164
165   leave:
166     *ret_nread = nread;
167     return val;
168 }
169
170
171 /****************
172  * Make an mpi from a character string.
173  */
174 int
175 mpi_fromstr(MPI val, const char *str)
176 {
177     int hexmode=0, sign=0, prepend_zero=0, i, j, c, c1, c2;
178     unsigned nbits, nbytes, nlimbs;
179     mpi_limb_t a;
180
181     if( *str == '-' ) {
182         sign = 1;
183         str++;
184     }
185     if( *str == '0' && str[1] == 'x' )
186         hexmode = 1;
187     else
188         return 1; /* other bases are not yet supported */
189     str += 2;
190
191     nbits = strlen(str)*4;
192     if( nbits % 8 )
193         prepend_zero = 1;
194     nbytes = (nbits+7) / 8;
195     nlimbs = (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
196     if( val->alloced < nlimbs )
197         mpi_resize(val, nlimbs );
198     i = BYTES_PER_MPI_LIMB - nbytes % BYTES_PER_MPI_LIMB;
199     i %= BYTES_PER_MPI_LIMB;
200     j= val->nlimbs = nlimbs;
201     val->sign = sign;
202     for( ; j > 0; j-- ) {
203         a = 0;
204         for(; i < BYTES_PER_MPI_LIMB; i++ ) {
205             if( prepend_zero ) {
206                 c1 = '0';
207                 prepend_zero = 0;
208             }
209             else
210                 c1 = *str++;
211             assert(c1);
212             c2 = *str++;
213             assert(c2);
214             if( c1 >= '0' && c1 <= '9' )
215                 c = c1 - '0';
216             else if( c1 >= 'a' && c1 <= 'f' )
217                 c = c1 - 'a' + 10;
218             else if( c1 >= 'A' && c1 <= 'F' )
219                 c = c1 - 'A' + 10;
220             else {
221                 mpi_clear(val);
222                 return 1;
223             }
224             c <<= 4;
225             if( c2 >= '0' && c2 <= '9' )
226                 c |= c2 - '0';
227             else if( c2 >= 'a' && c2 <= 'f' )
228                 c |= c2 - 'a' + 10;
229             else if( c2 >= 'A' && c2 <= 'F' )
230                 c |= c2 - 'A' + 10;
231             else {
232                 mpi_clear(val);
233                 return 1;
234             }
235             a <<= 8;
236             a |= c;
237         }
238         i = 0;
239         val->d[j-1] = a;
240     }
241
242     return 0;
243 }
244
245
246 /****************
247  * print an MPI to the given stream and return the number of characters
248  * printed.
249  */
250 int
251 mpi_print( FILE *fp, MPI a, int mode )
252 {
253     int i, n=0;
254
255     if( a == MPI_NULL )
256         return fprintf(fp, "[MPI_NULL]");
257     if( !mode ) {
258         unsigned n1, n2;
259         n1 = mpi_get_nbits(a);
260         n2 = mpi_get_nbit_info(a);
261         if( n2 && n2 != n1 )
262             n += fprintf(fp, "[%u bits (%u)]", n1, n2 );
263         else
264             n += fprintf(fp, "[%u bits]", n1);
265     }
266     else {
267         if( a->sign )
268             putc('-', fp);
269        #if BYTES_PER_MPI_LIMB == 2
270           #define X "4"
271        #elif BYTES_PER_MPI_LIMB == 4
272           #define X "8"
273        #elif BYTES_PER_MPI_LIMB == 8
274           #define X "16"
275        #else
276           #error please define the format here
277        #endif
278         for(i=a->nlimbs; i > 0 ; i-- ) {
279             n += fprintf(fp, i!=a->nlimbs? "%0" X "lX":"%lX", (ulong)a->d[i-1]);
280        #undef X
281         }
282         if( !a->nlimbs )
283             putc('0', fp );
284     }
285     return n;
286 }
287
288
289 /****************
290  * Special function to get the low 8 bytes from an mpi.
291  * This can be used as a keyid; KEYID is an 2 element array.
292  * Return the low 4 bytes.
293  */
294 u32
295 mpi_get_keyid( MPI a, u32 *keyid )
296 {
297 #if BYTES_PER_MPI_LIMB == 4
298     if( keyid ) {
299         keyid[0] = a->nlimbs >= 2? a->d[1] : 0;
300         keyid[1] = a->nlimbs >= 1? a->d[0] : 0;
301     }
302     return a->nlimbs >= 1? a->d[0] : 0;
303 #elif BYTES_PER_MPI_LIMB == 8
304     if( keyid ) {
305         keyid[0] = a->nlimbs? (u32)(a->d[0] >> 32) : 0;
306         keyid[1] = a->nlimbs? (u32)(a->d[0] & 0xffffffff) : 0;
307     }
308     return a->nlimbs? (u32)(a->d[0] & 0xffffffff) : 0;
309 #else
310   #error Make this function work with other LIMB sizes
311 #endif
312 }
313
314
315 /****************
316  * Return an m_alloced buffer with the MPI (msb first).
317  * NBYTES receives the length of this buffer. Caller must free the
318  * return string (This function does return a 0 byte buffer with NBYTES
319  * set to zero if the value of A is zero. If sign is not NULL, it will
320  * be set to the sign of the A.
321  */
322 static byte *
323 do_get_buffer( MPI a, unsigned *nbytes, int *sign, int force_secure )
324 {
325     byte *p, *buffer;
326     mpi_limb_t alimb;
327     int i;
328
329     if( sign )
330         *sign = a->sign;
331     *nbytes = a->nlimbs * BYTES_PER_MPI_LIMB;
332     p = buffer = force_secure || mpi_is_secure(a) ? m_alloc_secure( *nbytes)
333                                                   : m_alloc( *nbytes );
334
335     for(i=a->nlimbs-1; i >= 0; i-- ) {
336         alimb = a->d[i];
337       #if BYTES_PER_MPI_LIMB == 4
338         *p++ = alimb >> 24;
339         *p++ = alimb >> 16;
340         *p++ = alimb >>  8;
341         *p++ = alimb      ;
342       #elif BYTES_PER_MPI_LIMB == 8
343         *p++ = alimb >> 56;
344         *p++ = alimb >> 48;
345         *p++ = alimb >> 40;
346         *p++ = alimb >> 32;
347         *p++ = alimb >> 24;
348         *p++ = alimb >> 16;
349         *p++ = alimb >>  8;
350         *p++ = alimb      ;
351       #else
352         #error please implement for this limb size.
353       #endif
354     }
355
356     /* this is sub-optimal but we need to do the shift oepration because
357      * the caller has to free the returned buffer */
358     for(p=buffer; !*p && *nbytes; p++, --*nbytes )
359         ;
360     if( p != buffer )
361         memmove(buffer,p, *nbytes);
362     return buffer;
363 }
364
365
366 byte *
367 mpi_get_buffer( MPI a, unsigned *nbytes, int *sign )
368 {
369     return do_get_buffer( a, nbytes, sign, 0 );
370 }
371
372 byte *
373 mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign )
374 {
375     return do_get_buffer( a, nbytes, sign, 1 );
376 }
377
378 /****************
379  * Use BUFFER to update MPI.
380  */
381 void
382 mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign )
383 {
384     const byte *p;
385     mpi_limb_t alimb;
386     int nlimbs;
387     int i;
388
389     nlimbs = (nbytes + BYTES_PER_MPI_LIMB - 1) / BYTES_PER_MPI_LIMB;
390     RESIZE_IF_NEEDED(a, nlimbs);
391     a->sign = sign;
392
393     for(i=0, p = buffer+nbytes-1; p >= buffer+BYTES_PER_MPI_LIMB; ) {
394       #if BYTES_PER_MPI_LIMB == 4
395         alimb  = *p--       ;
396         alimb |= *p-- <<  8 ;
397         alimb |= *p-- << 16 ;
398         alimb |= *p-- << 24 ;
399       #elif BYTES_PER_MPI_LIMB == 8
400         alimb  = (mpi_limb_t)*p--       ;
401         alimb |= (mpi_limb_t)*p-- <<  8 ;
402         alimb |= (mpi_limb_t)*p-- << 16 ;
403         alimb |= (mpi_limb_t)*p-- << 24 ;
404         alimb |= (mpi_limb_t)*p-- << 32 ;
405         alimb |= (mpi_limb_t)*p-- << 40 ;
406         alimb |= (mpi_limb_t)*p-- << 48 ;
407         alimb |= (mpi_limb_t)*p-- << 56 ;
408       #else
409         #error please implement for this limb size.
410       #endif
411         a->d[i++] = alimb;
412     }
413     if( p >= buffer ) {
414       #if BYTES_PER_MPI_LIMB == 4
415         alimb  = *p--       ;
416         if( p >= buffer ) alimb |= *p-- <<  8 ;
417         if( p >= buffer ) alimb |= *p-- << 16 ;
418         if( p >= buffer ) alimb |= *p-- << 24 ;
419       #elif BYTES_PER_MPI_LIMB == 8
420         alimb  = (mpi_limb_t)*p-- ;
421         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- <<  8 ;
422         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 16 ;
423         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 24 ;
424         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 32 ;
425         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 40 ;
426         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 48 ;
427         if( p >= buffer ) alimb |= (mpi_limb_t)*p-- << 56 ;
428       #else
429         #error please implement for this limb size.
430       #endif
431         a->d[i++] = alimb;
432     }
433     a->nlimbs = i;
434     assert( i == nlimbs );
435 }
436