New function OBJ_obj2txt()
[openssl.git] / crypto / asn1 / a_int.c
1 /* crypto/asn1/a_int.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 "cryptlib.h"
61 #include <openssl/asn1.h>
62
63 /* 
64  * This converts an ASN1 INTEGER into its DER encoding.
65  * The internal representation is an ASN1_STRING whose data is a big endian
66  * representation of the value, ignoring the sign. The sign is determined by
67  * the type: V_ASN1_INTEGER for positive and V_ASN1_NEG_INTEGER for negative. 
68  *
69  * Positive integers are no problem: they are almost the same as the DER
70  * encoding, except if the first byte is >= 0x80 we need to add a zero pad.
71  *
72  * Negative integers are a bit trickier...
73  * The DER representation of negative integers is in 2s complement form.
74  * The internal form is converted by complementing each octet and finally 
75  * adding one to the result. This can be done less messily with a little trick.
76  * If the internal form has trailing zeroes then they will become FF by the
77  * complement and 0 by the add one (due to carry) so just copy as many trailing 
78  * zeros to the destination as there are in the source. The carry will add one
79  * to the last none zero octet: so complement this octet and add one and finally
80  * complement any left over until you get to the start of the string.
81  *
82  * Padding is a little trickier too. If the first bytes is > 0x80 then we pad
83  * with 0xff. However if the first byte is 0x80 and one of the following bytes
84  * is non-zero we pad with 0xff. The reason for this distinction is that 0x80
85  * followed by optional zeros isn't padded.
86  */
87
88 int i2d_ASN1_INTEGER(ASN1_INTEGER *a, unsigned char **pp)
89         {
90         int pad=0,ret,r,i,t;
91         unsigned char *p,*n,pb=0;
92
93         if ((a == NULL) || (a->data == NULL)) return(0);
94         t=a->type;
95         if (a->length == 0)
96                 ret=1;
97         else
98                 {
99                 ret=a->length;
100                 i=a->data[0];
101                 if ((t == V_ASN1_INTEGER) && (i > 127)) {
102                         pad=1;
103                         pb=0;
104                 } else if(t == V_ASN1_NEG_INTEGER) {
105                         if(i>128) {
106                                 pad=1;
107                                 pb=0xFF;
108                         } else if(i == 128) {
109                         /*
110                          * Special case: if any other bytes non zero we pad:
111                          * otherwise we don't.
112                          */
113                                 for(i = 1; i < a->length; i++) if(a->data[i]) {
114                                                 pad=1;
115                                                 pb=0xFF;
116                                                 break;
117                                 }
118                         }
119                 }
120                 ret+=pad;
121                 }
122         r=ASN1_object_size(0,ret,V_ASN1_INTEGER);
123         if (pp == NULL) return(r);
124         p= *pp;
125
126         ASN1_put_object(&p,0,ret,V_ASN1_INTEGER,V_ASN1_UNIVERSAL);
127         if (pad) *(p++)=pb;
128         if (a->length == 0) *(p++)=0;
129         else if (t == V_ASN1_INTEGER) memcpy(p,a->data,(unsigned int)a->length);
130         else {
131                 /* Begin at the end of the encoding */
132                 n=a->data + a->length - 1;
133                 p += a->length - 1;
134                 i = a->length;
135                 /* Copy zeros to destination as long as source is zero */
136                 while(!*n) {
137                         *(p--) = 0;
138                         n--;
139                         i--;
140                 }
141                 /* Complement and increment next octet */
142                 *(p--) = ((*(n--)) ^ 0xff) + 1;
143                 i--;
144                 /* Complement any octets left */
145                 for(;i > 0; i--) *(p--) = *(n--) ^ 0xff;
146         }
147
148         *pp+=r;
149         return(r);
150         }
151
152 ASN1_INTEGER *d2i_ASN1_INTEGER(ASN1_INTEGER **a, unsigned char **pp,
153              long length)
154         {
155         ASN1_INTEGER *ret=NULL;
156         unsigned char *p,*to,*s, *pend;
157         long len;
158         int inf,tag,xclass;
159         int i;
160
161         if ((a == NULL) || ((*a) == NULL))
162                 {
163                 if ((ret=ASN1_INTEGER_new()) == NULL) return(NULL);
164                 ret->type=V_ASN1_INTEGER;
165                 }
166         else
167                 ret=(*a);
168
169         p= *pp;
170         inf=ASN1_get_object(&p,&len,&tag,&xclass,length);
171         pend = p + len;
172         if (inf & 0x80)
173                 {
174                 i=ASN1_R_BAD_OBJECT_HEADER;
175                 goto err;
176                 }
177
178         if (tag != V_ASN1_INTEGER)
179                 {
180                 i=ASN1_R_EXPECTING_AN_INTEGER;
181                 goto err;
182                 }
183
184         /* We must Malloc stuff, even for 0 bytes otherwise it
185          * signifies a missing NULL parameter. */
186         s=(unsigned char *)Malloc((int)len+1);
187         if (s == NULL)
188                 {
189                 i=ERR_R_MALLOC_FAILURE;
190                 goto err;
191                 }
192         to=s;
193         if (*p & 0x80) /* a negative number */
194                 {
195                 ret->type=V_ASN1_NEG_INTEGER;
196                 if ((*p == 0xff) && (len != 1)) {
197                         p++;
198                         len--;
199                 }
200                 i = len;
201                 p += i - 1;
202                 to += i - 1;
203                 while((!*p) && i) {
204                         *(to--) = 0;
205                         i--;
206                         p--;
207                 }
208                 /* Special case: if all zeros then the number will be of
209                  * the form FF followed by n zero bytes: this corresponds to
210                  * 1 followed by n zero bytes. We've already written n zeros
211                  * so we just append an extra one and set the first byte to
212                  * a 1. This is treated separately because it is the only case
213                  * where the number of bytes is larger than len.
214                  */
215                 if(!i) {
216                         *s = 1;
217                         s[len] = 0;
218                         len++;
219                 } else {
220                         *(to--) = (*(p--) ^ 0xff) + 1;
221                         i--;
222                         for(;i > 0; i--) *(to--) = *(p--) ^ 0xff;
223                 }
224         } else {
225                 ret->type=V_ASN1_INTEGER;
226                 if ((*p == 0) && (len != 1))
227                         {
228                         p++;
229                         len--;
230                         }
231                 memcpy(s,p,(int)len);
232         }
233
234         if (ret->data != NULL) Free((char *)ret->data);
235         ret->data=s;
236         ret->length=(int)len;
237         if (a != NULL) (*a)=ret;
238         *pp=pend;
239         return(ret);
240 err:
241         ASN1err(ASN1_F_D2I_ASN1_INTEGER,i);
242         if ((ret != NULL) && ((a == NULL) || (*a != ret)))
243                 ASN1_INTEGER_free(ret);
244         return(NULL);
245         }
246
247 /* This is a version of d2i_ASN1_INTEGER that ignores the sign bit of
248  * ASN1 integers: some broken software can encode a positive INTEGER
249  * with its MSB set as negative (it doesn't add a padding zero).
250  */
251
252 ASN1_INTEGER *d2i_ASN1_UINTEGER(ASN1_INTEGER **a, unsigned char **pp,
253              long length)
254         {
255         ASN1_INTEGER *ret=NULL;
256         unsigned char *p,*to,*s;
257         long len;
258         int inf,tag,xclass;
259         int i;
260
261         if ((a == NULL) || ((*a) == NULL))
262                 {
263                 if ((ret=ASN1_INTEGER_new()) == NULL) return(NULL);
264                 ret->type=V_ASN1_INTEGER;
265                 }
266         else
267                 ret=(*a);
268
269         p= *pp;
270         inf=ASN1_get_object(&p,&len,&tag,&xclass,length);
271         if (inf & 0x80)
272                 {
273                 i=ASN1_R_BAD_OBJECT_HEADER;
274                 goto err;
275                 }
276
277         if (tag != V_ASN1_INTEGER)
278                 {
279                 i=ASN1_R_EXPECTING_AN_INTEGER;
280                 goto err;
281                 }
282
283         /* We must Malloc stuff, even for 0 bytes otherwise it
284          * signifies a missing NULL parameter. */
285         s=(unsigned char *)Malloc((int)len+1);
286         if (s == NULL)
287                 {
288                 i=ERR_R_MALLOC_FAILURE;
289                 goto err;
290                 }
291         to=s;
292                 ret->type=V_ASN1_INTEGER;
293                 if ((*p == 0) && (len != 1))
294                         {
295                         p++;
296                         len--;
297                         }
298                 memcpy(s,p,(int)len);
299                 p+=len;
300
301         if (ret->data != NULL) Free((char *)ret->data);
302         ret->data=s;
303         ret->length=(int)len;
304         if (a != NULL) (*a)=ret;
305         *pp=p;
306         return(ret);
307 err:
308         ASN1err(ASN1_F_D2I_ASN1_UINTEGER,i);
309         if ((ret != NULL) && ((a == NULL) || (*a != ret)))
310                 ASN1_INTEGER_free(ret);
311         return(NULL);
312         }
313
314 int ASN1_INTEGER_set(ASN1_INTEGER *a, long v)
315         {
316         int i,j,k;
317         unsigned char buf[sizeof(long)+1];
318         long d;
319
320         a->type=V_ASN1_INTEGER;
321         if (a->length < (sizeof(long)+1))
322                 {
323                 if (a->data != NULL)
324                         Free((char *)a->data);
325                 if ((a->data=(unsigned char *)Malloc(sizeof(long)+1)) != NULL)
326                         memset((char *)a->data,0,sizeof(long)+1);
327                 }
328         if (a->data == NULL)
329                 {
330                 ASN1err(ASN1_F_ASN1_INTEGER_SET,ERR_R_MALLOC_FAILURE);
331                 return(0);
332                 }
333         d=v;
334         if (d < 0)
335                 {
336                 d= -d;
337                 a->type=V_ASN1_NEG_INTEGER;
338                 }
339
340         for (i=0; i<sizeof(long); i++)
341                 {
342                 if (d == 0) break;
343                 buf[i]=(int)d&0xff;
344                 d>>=8;
345                 }
346         j=0;
347         for (k=i-1; k >=0; k--)
348                 a->data[j++]=buf[k];
349         a->length=j;
350         return(1);
351         }
352
353 long ASN1_INTEGER_get(ASN1_INTEGER *a)
354         {
355         int neg=0,i;
356         long r=0;
357
358         if (a == NULL) return(0L);
359         i=a->type;
360         if (i == V_ASN1_NEG_INTEGER)
361                 neg=1;
362         else if (i != V_ASN1_INTEGER)
363                 return(0);
364         
365         if (a->length > sizeof(long))
366                 {
367                 /* hmm... a bit ugly */
368                 return(0xffffffffL);
369                 }
370         if (a->data == NULL)
371                 return(0);
372
373         for (i=0; i<a->length; i++)
374                 {
375                 r<<=8;
376                 r|=(unsigned char)a->data[i];
377                 }
378         if (neg) r= -r;
379         return(r);
380         }
381
382 ASN1_INTEGER *BN_to_ASN1_INTEGER(BIGNUM *bn, ASN1_INTEGER *ai)
383         {
384         ASN1_INTEGER *ret;
385         int len,j;
386
387         if (ai == NULL)
388                 ret=ASN1_INTEGER_new();
389         else
390                 ret=ai;
391         if (ret == NULL)
392                 {
393                 ASN1err(ASN1_F_BN_TO_ASN1_INTEGER,ERR_R_NESTED_ASN1_ERROR);
394                 goto err;
395                 }
396         if(bn->neg) ret->type = V_ASN1_NEG_INTEGER;
397         else ret->type=V_ASN1_INTEGER;
398         j=BN_num_bits(bn);
399         len=((j == 0)?0:((j/8)+1));
400         ret->data=(unsigned char *)Malloc(len+4);
401         ret->length=BN_bn2bin(bn,ret->data);
402         return(ret);
403 err:
404         if (ret != ai) ASN1_INTEGER_free(ret);
405         return(NULL);
406         }
407
408 BIGNUM *ASN1_INTEGER_to_BN(ASN1_INTEGER *ai, BIGNUM *bn)
409         {
410         BIGNUM *ret;
411
412         if ((ret=BN_bin2bn(ai->data,ai->length,bn)) == NULL)
413                 ASN1err(ASN1_F_ASN1_INTEGER_TO_BN,ASN1_R_BN_LIB);
414         if(ai->type == V_ASN1_NEG_INTEGER) bn->neg = 1;
415         return(ret);
416         }