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