9a370cd4bc7621458fc9740c2d4078918ba7537a
[openssl.git] / crypto / asn1 / asn1_par.c
1 /* crypto/asn1/asn1_par.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 "internal/cryptlib.h"
61 #include <openssl/buffer.h>
62 #include <openssl/objects.h>
63 #include <openssl/asn1.h>
64
65 static int asn1_print_info(BIO *bp, int tag, int xclass, int constructed,
66                            int indent);
67 static int asn1_parse2(BIO *bp, const unsigned char **pp, long length,
68                        int offset, int depth, int indent, int dump);
69 static int asn1_print_info(BIO *bp, int tag, int xclass, int constructed,
70                            int indent)
71 {
72     static const char fmt[] = "%-18s";
73     char str[128];
74     const char *p;
75
76     if (constructed & V_ASN1_CONSTRUCTED)
77         p = "cons: ";
78     else
79         p = "prim: ";
80     if (BIO_write(bp, p, 6) < 6)
81         goto err;
82     BIO_indent(bp, indent, 128);
83
84     p = str;
85     if ((xclass & V_ASN1_PRIVATE) == V_ASN1_PRIVATE)
86         BIO_snprintf(str, sizeof str, "priv [ %d ] ", tag);
87     else if ((xclass & V_ASN1_CONTEXT_SPECIFIC) == V_ASN1_CONTEXT_SPECIFIC)
88         BIO_snprintf(str, sizeof str, "cont [ %d ]", tag);
89     else if ((xclass & V_ASN1_APPLICATION) == V_ASN1_APPLICATION)
90         BIO_snprintf(str, sizeof str, "appl [ %d ]", tag);
91     else if (tag > 30)
92         BIO_snprintf(str, sizeof str, "<ASN1 %d>", tag);
93     else
94         p = ASN1_tag2str(tag);
95
96     if (BIO_printf(bp, fmt, p) <= 0)
97         goto err;
98     return (1);
99  err:
100     return (0);
101 }
102
103 int ASN1_parse(BIO *bp, const unsigned char *pp, long len, int indent)
104 {
105     return (asn1_parse2(bp, &pp, len, 0, 0, indent, 0));
106 }
107
108 int ASN1_parse_dump(BIO *bp, const unsigned char *pp, long len, int indent,
109                     int dump)
110 {
111     return (asn1_parse2(bp, &pp, len, 0, 0, indent, dump));
112 }
113
114 static int asn1_parse2(BIO *bp, const unsigned char **pp, long length,
115                        int offset, int depth, int indent, int dump)
116 {
117     const unsigned char *p, *ep, *tot, *op, *opp;
118     long len;
119     int tag, xclass, ret = 0;
120     int nl, hl, j, r;
121     ASN1_OBJECT *o = NULL;
122     ASN1_OCTET_STRING *os = NULL;
123     /* ASN1_BMPSTRING *bmp=NULL; */
124     int dump_indent;
125
126     dump_indent = 6;            /* Because we know BIO_dump_indent() */
127     p = *pp;
128     tot = p + length;
129     op = p - 1;
130     while ((p < tot) && (op < p)) {
131         op = p;
132         j = ASN1_get_object(&p, &len, &tag, &xclass, length);
133         if (j & 0x80) {
134             if (BIO_write(bp, "Error in encoding\n", 18) <= 0)
135                 goto end;
136             ret = 0;
137             goto end;
138         }
139         hl = (p - op);
140         length -= hl;
141         /*
142          * if j == 0x21 it is a constructed indefinite length object
143          */
144         if (BIO_printf(bp, "%5ld:", (long)offset + (long)(op - *pp))
145             <= 0)
146             goto end;
147
148         if (j != (V_ASN1_CONSTRUCTED | 1)) {
149             if (BIO_printf(bp, "d=%-2d hl=%ld l=%4ld ",
150                            depth, (long)hl, len) <= 0)
151                 goto end;
152         } else {
153             if (BIO_printf(bp, "d=%-2d hl=%ld l=inf  ", depth, (long)hl) <= 0)
154                 goto end;
155         }
156         if (!asn1_print_info(bp, tag, xclass, j, (indent) ? depth : 0))
157             goto end;
158         if (j & V_ASN1_CONSTRUCTED) {
159             ep = p + len;
160             if (BIO_write(bp, "\n", 1) <= 0)
161                 goto end;
162             if (len > length) {
163                 BIO_printf(bp, "length is greater than %ld\n", length);
164                 ret = 0;
165                 goto end;
166             }
167             if ((j == 0x21) && (len == 0)) {
168                 for (;;) {
169                     r = asn1_parse2(bp, &p, (long)(tot - p),
170                                     offset + (p - *pp), depth + 1,
171                                     indent, dump);
172                     if (r == 0) {
173                         ret = 0;
174                         goto end;
175                     }
176                     if ((r == 2) || (p >= tot))
177                         break;
178                 }
179             } else
180                 while (p < ep) {
181                     r = asn1_parse2(bp, &p, (long)len,
182                                     offset + (p - *pp), depth + 1,
183                                     indent, dump);
184                     if (r == 0) {
185                         ret = 0;
186                         goto end;
187                     }
188                 }
189         } else if (xclass != 0) {
190             p += len;
191             if (BIO_write(bp, "\n", 1) <= 0)
192                 goto end;
193         } else {
194             nl = 0;
195             if ((tag == V_ASN1_PRINTABLESTRING) ||
196                 (tag == V_ASN1_T61STRING) ||
197                 (tag == V_ASN1_IA5STRING) ||
198                 (tag == V_ASN1_VISIBLESTRING) ||
199                 (tag == V_ASN1_NUMERICSTRING) ||
200                 (tag == V_ASN1_UTF8STRING) ||
201                 (tag == V_ASN1_UTCTIME) || (tag == V_ASN1_GENERALIZEDTIME)) {
202                 if (BIO_write(bp, ":", 1) <= 0)
203                     goto end;
204                 if ((len > 0) && BIO_write(bp, (const char *)p, (int)len)
205                     != (int)len)
206                     goto end;
207             } else if (tag == V_ASN1_OBJECT) {
208                 opp = op;
209                 if (d2i_ASN1_OBJECT(&o, &opp, len + hl) != NULL) {
210                     if (BIO_write(bp, ":", 1) <= 0)
211                         goto end;
212                     i2a_ASN1_OBJECT(bp, o);
213                 } else {
214                     if (BIO_write(bp, ":BAD OBJECT", 11) <= 0)
215                         goto end;
216                 }
217             } else if (tag == V_ASN1_BOOLEAN) {
218                 if (len != 1) {
219                     if (BIO_write(bp, "Bad boolean\n", 12) <= 0)
220                         goto end;
221                 }
222                 BIO_printf(bp, ":%u", p[0]);
223             } else if (tag == V_ASN1_BMPSTRING) {
224                 /* do the BMP thang */
225             } else if (tag == V_ASN1_OCTET_STRING) {
226                 int i, printable = 1;
227
228                 opp = op;
229                 os = d2i_ASN1_OCTET_STRING(NULL, &opp, len + hl);
230                 if (os != NULL && os->length > 0) {
231                     opp = os->data;
232                     /*
233                      * testing whether the octet string is printable
234                      */
235                     for (i = 0; i < os->length; i++) {
236                         if (((opp[i] < ' ') &&
237                              (opp[i] != '\n') &&
238                              (opp[i] != '\r') &&
239                              (opp[i] != '\t')) || (opp[i] > '~')) {
240                             printable = 0;
241                             break;
242                         }
243                     }
244                     if (printable)
245                         /* printable string */
246                     {
247                         if (BIO_write(bp, ":", 1) <= 0)
248                             goto end;
249                         if (BIO_write(bp, (const char *)opp, os->length) <= 0)
250                             goto end;
251                     } else if (!dump)
252                         /*
253                          * not printable => print octet string as hex dump
254                          */
255                     {
256                         if (BIO_write(bp, "[HEX DUMP]:", 11) <= 0)
257                             goto end;
258                         for (i = 0; i < os->length; i++) {
259                             if (BIO_printf(bp, "%02X", opp[i]) <= 0)
260                                 goto end;
261                         }
262                     } else
263                         /* print the normal dump */
264                     {
265                         if (!nl) {
266                             if (BIO_write(bp, "\n", 1) <= 0)
267                                 goto end;
268                         }
269                         if (BIO_dump_indent(bp,
270                                             (const char *)opp,
271                                             ((dump == -1 || dump >
272                                               os->
273                                               length) ? os->length : dump),
274                                             dump_indent) <= 0)
275                             goto end;
276                         nl = 1;
277                     }
278                 }
279                 ASN1_OCTET_STRING_free(os);
280                 os = NULL;
281             } else if (tag == V_ASN1_INTEGER) {
282                 ASN1_INTEGER *bs;
283                 int i;
284
285                 opp = op;
286                 bs = d2i_ASN1_INTEGER(NULL, &opp, len + hl);
287                 if (bs != NULL) {
288                     if (BIO_write(bp, ":", 1) <= 0)
289                         goto end;
290                     if (bs->type == V_ASN1_NEG_INTEGER)
291                         if (BIO_write(bp, "-", 1) <= 0)
292                             goto end;
293                     for (i = 0; i < bs->length; i++) {
294                         if (BIO_printf(bp, "%02X", bs->data[i]) <= 0)
295                             goto end;
296                     }
297                     if (bs->length == 0) {
298                         if (BIO_write(bp, "00", 2) <= 0)
299                             goto end;
300                     }
301                 } else {
302                     if (BIO_write(bp, "BAD INTEGER", 11) <= 0)
303                         goto end;
304                 }
305                 ASN1_INTEGER_free(bs);
306             } else if (tag == V_ASN1_ENUMERATED) {
307                 ASN1_ENUMERATED *bs;
308                 int i;
309
310                 opp = op;
311                 bs = d2i_ASN1_ENUMERATED(NULL, &opp, len + hl);
312                 if (bs != NULL) {
313                     if (BIO_write(bp, ":", 1) <= 0)
314                         goto end;
315                     if (bs->type == V_ASN1_NEG_ENUMERATED)
316                         if (BIO_write(bp, "-", 1) <= 0)
317                             goto end;
318                     for (i = 0; i < bs->length; i++) {
319                         if (BIO_printf(bp, "%02X", bs->data[i]) <= 0)
320                             goto end;
321                     }
322                     if (bs->length == 0) {
323                         if (BIO_write(bp, "00", 2) <= 0)
324                             goto end;
325                     }
326                 } else {
327                     if (BIO_write(bp, "BAD ENUMERATED", 14) <= 0)
328                         goto end;
329                 }
330                 ASN1_ENUMERATED_free(bs);
331             } else if (len > 0 && dump) {
332                 if (!nl) {
333                     if (BIO_write(bp, "\n", 1) <= 0)
334                         goto end;
335                 }
336                 if (BIO_dump_indent(bp, (const char *)p,
337                                     ((dump == -1 || dump > len) ? len : dump),
338                                     dump_indent) <= 0)
339                     goto end;
340                 nl = 1;
341             }
342
343             if (!nl) {
344                 if (BIO_write(bp, "\n", 1) <= 0)
345                     goto end;
346             }
347             p += len;
348             if ((tag == V_ASN1_EOC) && (xclass == 0)) {
349                 ret = 2;        /* End of sequence */
350                 goto end;
351             }
352         }
353         length -= len;
354     }
355     ret = 1;
356  end:
357     ASN1_OBJECT_free(o);
358     ASN1_OCTET_STRING_free(os);
359     *pp = p;
360     return (ret);
361 }
362
363 const char *ASN1_tag2str(int tag)
364 {
365     static const char *const tag2str[] = {
366         /* 0-4 */
367         "EOC", "BOOLEAN", "INTEGER", "BIT STRING", "OCTET STRING",
368         /* 5-9 */
369         "NULL", "OBJECT", "OBJECT DESCRIPTOR", "EXTERNAL", "REAL",
370         /* 10-13 */
371         "ENUMERATED", "<ASN1 11>", "UTF8STRING", "<ASN1 13>",
372         /* 15-17 */
373         "<ASN1 14>", "<ASN1 15>", "SEQUENCE", "SET",
374         /* 18-20 */
375         "NUMERICSTRING", "PRINTABLESTRING", "T61STRING",
376         /* 21-24 */
377         "VIDEOTEXSTRING", "IA5STRING", "UTCTIME", "GENERALIZEDTIME",
378         /* 25-27 */
379         "GRAPHICSTRING", "VISIBLESTRING", "GENERALSTRING",
380         /* 28-30 */
381         "UNIVERSALSTRING", "<ASN1 29>", "BMPSTRING"
382     };
383
384     if ((tag == V_ASN1_NEG_INTEGER) || (tag == V_ASN1_NEG_ENUMERATED))
385         tag &= ~0x100;
386
387     if (tag < 0 || tag > 30)
388         return "(unknown)";
389     return tag2str[tag];
390 }