Further comment changes for reformat
[openssl.git] / crypto / bn / bn_print.c
1 /* crypto/bn/bn_print.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include <ctype.h>
61 #include "cryptlib.h"
62 #include <openssl/buffer.h>
63 #include "bn_lcl.h"
64
65 static const char Hex[]="0123456789ABCDEF";
66
67 /* Must 'OPENSSL_free' the returned data */
68 char *BN_bn2hex(const BIGNUM *a)
69         {
70         int i,j,v,z=0;
71         char *buf;
72         char *p;
73
74         buf=(char *)OPENSSL_malloc(a->top*BN_BYTES*2+2);
75         if (buf == NULL)
76                 {
77                 BNerr(BN_F_BN_BN2HEX,ERR_R_MALLOC_FAILURE);
78                 goto err;
79                 }
80         p=buf;
81         if (a->neg) *(p++)='-';
82         if (BN_is_zero(a)) *(p++)='0';
83         for (i=a->top-1; i >=0; i--)
84                 {
85                 for (j=BN_BITS2-8; j >= 0; j-=8)
86                         {
87                         /* strip leading zeros */
88                         v=((int)(a->d[i]>>(long)j))&0xff;
89                         if (z || (v != 0))
90                                 {
91                                 *(p++)=Hex[v>>4];
92                                 *(p++)=Hex[v&0x0f];
93                                 z=1;
94                                 }
95                         }
96                 }
97         *p='\0';
98 err:
99         return(buf);
100         }
101
102 /* Must 'OPENSSL_free' the returned data */
103 char *BN_bn2dec(const BIGNUM *a)
104         {
105         int i=0,num, ok = 0;
106         char *buf=NULL;
107         char *p;
108         BIGNUM *t=NULL;
109         BN_ULONG *bn_data=NULL,*lp;
110
111         /*-
112          * get an upper bound for the length of the decimal integer
113          * num <= (BN_num_bits(a) + 1) * log(2)
114          *     <= 3 * BN_num_bits(a) * 0.1001 + log(2) + 1     (rounding error)
115          *     <= BN_num_bits(a)/10 + BN_num_bits/1000 + 1 + 1 
116          */
117         i=BN_num_bits(a)*3;
118         num=(i/10+i/1000+1)+1;
119         bn_data=(BN_ULONG *)OPENSSL_malloc((num/BN_DEC_NUM+1)*sizeof(BN_ULONG));
120         buf=(char *)OPENSSL_malloc(num+3);
121         if ((buf == NULL) || (bn_data == NULL))
122                 {
123                 BNerr(BN_F_BN_BN2DEC,ERR_R_MALLOC_FAILURE);
124                 goto err;
125                 }
126         if ((t=BN_dup(a)) == NULL) goto err;
127
128 #define BUF_REMAIN (num+3 - (size_t)(p - buf))
129         p=buf;
130         lp=bn_data;
131         if (BN_is_zero(t))
132                 {
133                 *(p++)='0';
134                 *(p++)='\0';
135                 }
136         else
137                 {
138                 if (BN_is_negative(t))
139                         *p++ = '-';
140
141                 i=0;
142                 while (!BN_is_zero(t))
143                         {
144                         *lp=BN_div_word(t,BN_DEC_CONV);
145                         lp++;
146                         }
147                 lp--;
148                 /* We now have a series of blocks, BN_DEC_NUM chars
149                  * in length, where the last one needs truncation.
150                  * The blocks need to be reversed in order. */
151                 BIO_snprintf(p,BUF_REMAIN,BN_DEC_FMT1,*lp);
152                 while (*p) p++;
153                 while (lp != bn_data)
154                         {
155                         lp--;
156                         BIO_snprintf(p,BUF_REMAIN,BN_DEC_FMT2,*lp);
157                         while (*p) p++;
158                         }
159                 }
160         ok = 1;
161 err:
162         if (bn_data != NULL) OPENSSL_free(bn_data);
163         if (t != NULL) BN_free(t);
164         if (!ok && buf)
165                 {
166                 OPENSSL_free(buf);
167                 buf = NULL;
168                 }
169
170         return(buf);
171         }
172
173 int BN_hex2bn(BIGNUM **bn, const char *a)
174         {
175         BIGNUM *ret=NULL;
176         BN_ULONG l=0;
177         int neg=0,h,m,i,j,k,c;
178         int num;
179
180         if ((a == NULL) || (*a == '\0')) return(0);
181
182         if (*a == '-') { neg=1; a++; }
183
184         for (i=0; isxdigit((unsigned char) a[i]); i++)
185                 ;
186
187         num=i+neg;
188         if (bn == NULL) return(num);
189
190         /* a is the start of the hex digits, and it is 'i' long */
191         if (*bn == NULL)
192                 {
193                 if ((ret=BN_new()) == NULL) return(0);
194                 }
195         else
196                 {
197                 ret= *bn;
198                 BN_zero(ret);
199                 }
200
201         /* i is the number of hex digests; */
202         if (bn_expand(ret,i*4) == NULL) goto err;
203
204         j=i; /* least significant 'hex' */
205         m=0;
206         h=0;
207         while (j > 0)
208                 {
209                 m=((BN_BYTES*2) <= j)?(BN_BYTES*2):j;
210                 l=0;
211                 for (;;)
212                         {
213                         c=a[j-m];
214                         if ((c >= '0') && (c <= '9')) k=c-'0';
215                         else if ((c >= 'a') && (c <= 'f')) k=c-'a'+10;
216                         else if ((c >= 'A') && (c <= 'F')) k=c-'A'+10;
217                         else k=0; /* paranoia */
218                         l=(l<<4)|k;
219
220                         if (--m <= 0)
221                                 {
222                                 ret->d[h++]=l;
223                                 break;
224                                 }
225                         }
226                 j-=(BN_BYTES*2);
227                 }
228         ret->top=h;
229         bn_correct_top(ret);
230         ret->neg=neg;
231
232         *bn=ret;
233         bn_check_top(ret);
234         return(num);
235 err:
236         if (*bn == NULL) BN_free(ret);
237         return(0);
238         }
239
240 int BN_dec2bn(BIGNUM **bn, const char *a)
241         {
242         BIGNUM *ret=NULL;
243         BN_ULONG l=0;
244         int neg=0,i,j;
245         int num;
246
247         if ((a == NULL) || (*a == '\0')) return(0);
248         if (*a == '-') { neg=1; a++; }
249
250         for (i=0; isdigit((unsigned char) a[i]); i++)
251                 ;
252
253         num=i+neg;
254         if (bn == NULL) return(num);
255
256         /* a is the start of the digits, and it is 'i' long.
257          * We chop it into BN_DEC_NUM digits at a time */
258         if (*bn == NULL)
259                 {
260                 if ((ret=BN_new()) == NULL) return(0);
261                 }
262         else
263                 {
264                 ret= *bn;
265                 BN_zero(ret);
266                 }
267
268         /* i is the number of digests, a bit of an over expand; */
269         if (bn_expand(ret,i*4) == NULL) goto err;
270
271         j=BN_DEC_NUM-(i%BN_DEC_NUM);
272         if (j == BN_DEC_NUM) j=0;
273         l=0;
274         while (*a)
275                 {
276                 l*=10;
277                 l+= *a-'0';
278                 a++;
279                 if (++j == BN_DEC_NUM)
280                         {
281                         BN_mul_word(ret,BN_DEC_CONV);
282                         BN_add_word(ret,l);
283                         l=0;
284                         j=0;
285                         }
286                 }
287         ret->neg=neg;
288
289         bn_correct_top(ret);
290         *bn=ret;
291         bn_check_top(ret);
292         return(num);
293 err:
294         if (*bn == NULL) BN_free(ret);
295         return(0);
296         }
297
298 int BN_asc2bn(BIGNUM **bn, const char *a)
299         {
300         const char *p = a;
301         if (*p == '-')
302                 p++;
303
304         if (p[0] == '0' && (p[1] == 'X' || p[1] == 'x'))
305                 {               
306                 if (!BN_hex2bn(bn, p + 2))
307                         return 0;
308                 }
309         else
310                 {
311                 if (!BN_dec2bn(bn, p))
312                         return 0;
313                 }
314         if (*a == '-')
315                 (*bn)->neg = 1;
316         return 1;
317         }
318
319 #ifndef OPENSSL_NO_BIO
320 #ifndef OPENSSL_NO_FP_API
321 int BN_print_fp(FILE *fp, const BIGNUM *a)
322         {
323         BIO *b;
324         int ret;
325
326         if ((b=BIO_new(BIO_s_file())) == NULL)
327                 return(0);
328         BIO_set_fp(b,fp,BIO_NOCLOSE);
329         ret=BN_print(b,a);
330         BIO_free(b);
331         return(ret);
332         }
333 #endif
334
335 int BN_print(BIO *bp, const BIGNUM *a)
336         {
337         int i,j,v,z=0;
338         int ret=0;
339
340         if ((a->neg) && (BIO_write(bp,"-",1) != 1)) goto end;
341         if (BN_is_zero(a) && (BIO_write(bp,"0",1) != 1)) goto end;
342         for (i=a->top-1; i >=0; i--)
343                 {
344                 for (j=BN_BITS2-4; j >= 0; j-=4)
345                         {
346                         /* strip leading zeros */
347                         v=((int)(a->d[i]>>(long)j))&0x0f;
348                         if (z || (v != 0))
349                                 {
350                                 if (BIO_write(bp,&(Hex[v]),1) != 1)
351                                         goto end;
352                                 z=1;
353                                 }
354                         }
355                 }
356         ret=1;
357 end:
358         return(ret);
359         }
360 #endif
361
362 char *BN_options(void)
363         {
364         static int init=0;
365         static char data[16];
366
367         if (!init)
368                 {
369                 init++;
370 #ifdef BN_LLONG
371                 BIO_snprintf(data,sizeof data,"bn(%d,%d)",
372                              (int)sizeof(BN_ULLONG)*8,(int)sizeof(BN_ULONG)*8);
373 #else
374                 BIO_snprintf(data,sizeof data,"bn(%d,%d)",
375                              (int)sizeof(BN_ULONG)*8,(int)sizeof(BN_ULONG)*8);
376 #endif
377                 }
378         return(data);
379         }