Add ASN1_buf_print to print a buffer in ASN1_bn_print format.
[openssl.git] / crypto / asn1 / asn1_par.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include "internal/cryptlib.h"
60 #include <openssl/buffer.h>
61 #include <openssl/objects.h>
62 #include <openssl/asn1.h>
63
64 #ifndef ASN1_PARSE_MAXDEPTH
65 #define ASN1_PARSE_MAXDEPTH 128
66 #endif
67
68 static int asn1_print_info(BIO *bp, int tag, int xclass, int constructed,
69                            int indent);
70 static int asn1_parse2(BIO *bp, const unsigned char **pp, long length,
71                        int offset, int depth, int indent, int dump);
72 static int asn1_print_info(BIO *bp, int tag, int xclass, int constructed,
73                            int indent)
74 {
75     static const char fmt[] = "%-18s";
76     char str[128];
77     const char *p;
78
79     if (constructed & V_ASN1_CONSTRUCTED)
80         p = "cons: ";
81     else
82         p = "prim: ";
83     if (BIO_write(bp, p, 6) < 6)
84         goto err;
85     BIO_indent(bp, indent, 128);
86
87     p = str;
88     if ((xclass & V_ASN1_PRIVATE) == V_ASN1_PRIVATE)
89         BIO_snprintf(str, sizeof str, "priv [ %d ] ", tag);
90     else if ((xclass & V_ASN1_CONTEXT_SPECIFIC) == V_ASN1_CONTEXT_SPECIFIC)
91         BIO_snprintf(str, sizeof str, "cont [ %d ]", tag);
92     else if ((xclass & V_ASN1_APPLICATION) == V_ASN1_APPLICATION)
93         BIO_snprintf(str, sizeof str, "appl [ %d ]", tag);
94     else if (tag > 30)
95         BIO_snprintf(str, sizeof str, "<ASN1 %d>", tag);
96     else
97         p = ASN1_tag2str(tag);
98
99     if (BIO_printf(bp, fmt, p) <= 0)
100         goto err;
101     return (1);
102  err:
103     return (0);
104 }
105
106 int ASN1_parse(BIO *bp, const unsigned char *pp, long len, int indent)
107 {
108     return (asn1_parse2(bp, &pp, len, 0, 0, indent, 0));
109 }
110
111 int ASN1_parse_dump(BIO *bp, const unsigned char *pp, long len, int indent,
112                     int dump)
113 {
114     return (asn1_parse2(bp, &pp, len, 0, 0, indent, dump));
115 }
116
117 static int asn1_parse2(BIO *bp, const unsigned char **pp, long length,
118                        int offset, int depth, int indent, int dump)
119 {
120     const unsigned char *p, *ep, *tot, *op, *opp;
121     long len;
122     int tag, xclass, ret = 0;
123     int nl, hl, j, r;
124     ASN1_OBJECT *o = NULL;
125     ASN1_OCTET_STRING *os = NULL;
126     /* ASN1_BMPSTRING *bmp=NULL; */
127     int dump_indent;
128
129     if (depth > ASN1_PARSE_MAXDEPTH) {
130             BIO_puts(bp, "BAD RECURSION DEPTH\n");
131             return 0;
132     }
133
134     dump_indent = 6;            /* Because we know BIO_dump_indent() */
135     p = *pp;
136     tot = p + length;
137     op = p - 1;
138     while ((p < tot) && (op < p)) {
139         op = p;
140         j = ASN1_get_object(&p, &len, &tag, &xclass, length);
141         if (j & 0x80) {
142             if (BIO_write(bp, "Error in encoding\n", 18) <= 0)
143                 goto end;
144             ret = 0;
145             goto end;
146         }
147         hl = (p - op);
148         length -= hl;
149         /*
150          * if j == 0x21 it is a constructed indefinite length object
151          */
152         if (BIO_printf(bp, "%5ld:", (long)offset + (long)(op - *pp))
153             <= 0)
154             goto end;
155
156         if (j != (V_ASN1_CONSTRUCTED | 1)) {
157             if (BIO_printf(bp, "d=%-2d hl=%ld l=%4ld ",
158                            depth, (long)hl, len) <= 0)
159                 goto end;
160         } else {
161             if (BIO_printf(bp, "d=%-2d hl=%ld l=inf  ", depth, (long)hl) <= 0)
162                 goto end;
163         }
164         if (!asn1_print_info(bp, tag, xclass, j, (indent) ? depth : 0))
165             goto end;
166         if (j & V_ASN1_CONSTRUCTED) {
167             ep = p + len;
168             if (BIO_write(bp, "\n", 1) <= 0)
169                 goto end;
170             if (len > length) {
171                 BIO_printf(bp, "length is greater than %ld\n", length);
172                 ret = 0;
173                 goto end;
174             }
175             if ((j == 0x21) && (len == 0)) {
176                 for (;;) {
177                     r = asn1_parse2(bp, &p, (long)(tot - p),
178                                     offset + (p - *pp), depth + 1,
179                                     indent, dump);
180                     if (r == 0) {
181                         ret = 0;
182                         goto end;
183                     }
184                     if ((r == 2) || (p >= tot))
185                         break;
186                 }
187             } else
188                 while (p < ep) {
189                     r = asn1_parse2(bp, &p, (long)len,
190                                     offset + (p - *pp), depth + 1,
191                                     indent, dump);
192                     if (r == 0) {
193                         ret = 0;
194                         goto end;
195                     }
196                 }
197         } else if (xclass != 0) {
198             p += len;
199             if (BIO_write(bp, "\n", 1) <= 0)
200                 goto end;
201         } else {
202             nl = 0;
203             if ((tag == V_ASN1_PRINTABLESTRING) ||
204                 (tag == V_ASN1_T61STRING) ||
205                 (tag == V_ASN1_IA5STRING) ||
206                 (tag == V_ASN1_VISIBLESTRING) ||
207                 (tag == V_ASN1_NUMERICSTRING) ||
208                 (tag == V_ASN1_UTF8STRING) ||
209                 (tag == V_ASN1_UTCTIME) || (tag == V_ASN1_GENERALIZEDTIME)) {
210                 if (BIO_write(bp, ":", 1) <= 0)
211                     goto end;
212                 if ((len > 0) && BIO_write(bp, (const char *)p, (int)len)
213                     != (int)len)
214                     goto end;
215             } else if (tag == V_ASN1_OBJECT) {
216                 opp = op;
217                 if (d2i_ASN1_OBJECT(&o, &opp, len + hl) != NULL) {
218                     if (BIO_write(bp, ":", 1) <= 0)
219                         goto end;
220                     i2a_ASN1_OBJECT(bp, o);
221                 } else {
222                     if (BIO_write(bp, ":BAD OBJECT", 11) <= 0)
223                         goto end;
224                 }
225             } else if (tag == V_ASN1_BOOLEAN) {
226                 if (len != 1) {
227                     if (BIO_write(bp, "Bad boolean\n", 12) <= 0)
228                         goto end;
229                 }
230                 BIO_printf(bp, ":%u", p[0]);
231             } else if (tag == V_ASN1_BMPSTRING) {
232                 /* do the BMP thang */
233             } else if (tag == V_ASN1_OCTET_STRING) {
234                 int i, printable = 1;
235
236                 opp = op;
237                 os = d2i_ASN1_OCTET_STRING(NULL, &opp, len + hl);
238                 if (os != NULL && os->length > 0) {
239                     opp = os->data;
240                     /*
241                      * testing whether the octet string is printable
242                      */
243                     for (i = 0; i < os->length; i++) {
244                         if (((opp[i] < ' ') &&
245                              (opp[i] != '\n') &&
246                              (opp[i] != '\r') &&
247                              (opp[i] != '\t')) || (opp[i] > '~')) {
248                             printable = 0;
249                             break;
250                         }
251                     }
252                     if (printable)
253                         /* printable string */
254                     {
255                         if (BIO_write(bp, ":", 1) <= 0)
256                             goto end;
257                         if (BIO_write(bp, (const char *)opp, os->length) <= 0)
258                             goto end;
259                     } else if (!dump)
260                         /*
261                          * not printable => print octet string as hex dump
262                          */
263                     {
264                         if (BIO_write(bp, "[HEX DUMP]:", 11) <= 0)
265                             goto end;
266                         for (i = 0; i < os->length; i++) {
267                             if (BIO_printf(bp, "%02X", opp[i]) <= 0)
268                                 goto end;
269                         }
270                     } else
271                         /* print the normal dump */
272                     {
273                         if (!nl) {
274                             if (BIO_write(bp, "\n", 1) <= 0)
275                                 goto end;
276                         }
277                         if (BIO_dump_indent(bp,
278                                             (const char *)opp,
279                                             ((dump == -1 || dump >
280                                               os->
281                                               length) ? os->length : dump),
282                                             dump_indent) <= 0)
283                             goto end;
284                         nl = 1;
285                     }
286                 }
287                 ASN1_OCTET_STRING_free(os);
288                 os = NULL;
289             } else if (tag == V_ASN1_INTEGER) {
290                 ASN1_INTEGER *bs;
291                 int i;
292
293                 opp = op;
294                 bs = d2i_ASN1_INTEGER(NULL, &opp, len + hl);
295                 if (bs != NULL) {
296                     if (BIO_write(bp, ":", 1) <= 0)
297                         goto end;
298                     if (bs->type == V_ASN1_NEG_INTEGER)
299                         if (BIO_write(bp, "-", 1) <= 0)
300                             goto end;
301                     for (i = 0; i < bs->length; i++) {
302                         if (BIO_printf(bp, "%02X", bs->data[i]) <= 0)
303                             goto end;
304                     }
305                     if (bs->length == 0) {
306                         if (BIO_write(bp, "00", 2) <= 0)
307                             goto end;
308                     }
309                 } else {
310                     if (BIO_write(bp, "BAD INTEGER", 11) <= 0)
311                         goto end;
312                 }
313                 ASN1_INTEGER_free(bs);
314             } else if (tag == V_ASN1_ENUMERATED) {
315                 ASN1_ENUMERATED *bs;
316                 int i;
317
318                 opp = op;
319                 bs = d2i_ASN1_ENUMERATED(NULL, &opp, len + hl);
320                 if (bs != NULL) {
321                     if (BIO_write(bp, ":", 1) <= 0)
322                         goto end;
323                     if (bs->type == V_ASN1_NEG_ENUMERATED)
324                         if (BIO_write(bp, "-", 1) <= 0)
325                             goto end;
326                     for (i = 0; i < bs->length; i++) {
327                         if (BIO_printf(bp, "%02X", bs->data[i]) <= 0)
328                             goto end;
329                     }
330                     if (bs->length == 0) {
331                         if (BIO_write(bp, "00", 2) <= 0)
332                             goto end;
333                     }
334                 } else {
335                     if (BIO_write(bp, "BAD ENUMERATED", 14) <= 0)
336                         goto end;
337                 }
338                 ASN1_ENUMERATED_free(bs);
339             } else if (len > 0 && dump) {
340                 if (!nl) {
341                     if (BIO_write(bp, "\n", 1) <= 0)
342                         goto end;
343                 }
344                 if (BIO_dump_indent(bp, (const char *)p,
345                                     ((dump == -1 || dump > len) ? len : dump),
346                                     dump_indent) <= 0)
347                     goto end;
348                 nl = 1;
349             }
350
351             if (!nl) {
352                 if (BIO_write(bp, "\n", 1) <= 0)
353                     goto end;
354             }
355             p += len;
356             if ((tag == V_ASN1_EOC) && (xclass == 0)) {
357                 ret = 2;        /* End of sequence */
358                 goto end;
359             }
360         }
361         length -= len;
362     }
363     ret = 1;
364  end:
365     ASN1_OBJECT_free(o);
366     ASN1_OCTET_STRING_free(os);
367     *pp = p;
368     return (ret);
369 }
370
371 const char *ASN1_tag2str(int tag)
372 {
373     static const char *const tag2str[] = {
374         /* 0-4 */
375         "EOC", "BOOLEAN", "INTEGER", "BIT STRING", "OCTET STRING",
376         /* 5-9 */
377         "NULL", "OBJECT", "OBJECT DESCRIPTOR", "EXTERNAL", "REAL",
378         /* 10-13 */
379         "ENUMERATED", "<ASN1 11>", "UTF8STRING", "<ASN1 13>",
380         /* 15-17 */
381         "<ASN1 14>", "<ASN1 15>", "SEQUENCE", "SET",
382         /* 18-20 */
383         "NUMERICSTRING", "PRINTABLESTRING", "T61STRING",
384         /* 21-24 */
385         "VIDEOTEXSTRING", "IA5STRING", "UTCTIME", "GENERALIZEDTIME",
386         /* 25-27 */
387         "GRAPHICSTRING", "VISIBLESTRING", "GENERALSTRING",
388         /* 28-30 */
389         "UNIVERSALSTRING", "<ASN1 29>", "BMPSTRING"
390     };
391
392     if ((tag == V_ASN1_NEG_INTEGER) || (tag == V_ASN1_NEG_ENUMERATED))
393         tag &= ~0x100;
394
395     if (tag < 0 || tag > 30)
396         return "(unknown)";
397     return tag2str[tag];
398 }