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