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