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