mark all block comments that need format preserving so that
[openssl.git] / apps / asn1pars.c
1 /* apps/asn1pars.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 /* A nice addition from Dr Stephen Henson <steve@openssl.org> to 
60  * add the -strparse option which parses nested binary structures
61  */
62
63 #include <stdio.h>
64 #include <stdlib.h>
65 #include <string.h>
66 #include "apps.h"
67 #include <openssl/err.h>
68 #include <openssl/evp.h>
69 #include <openssl/x509.h>
70 #include <openssl/pem.h>
71
72 /*-
73  * -inform arg  - input format - default PEM (DER or PEM)
74  * -in arg      - input file - default stdin
75  * -i           - indent the details by depth
76  * -offset      - where in the file to start
77  * -length      - how many bytes to use
78  * -oid file    - extra oid description file
79  */
80
81 #undef PROG
82 #define PROG    asn1parse_main
83
84 int MAIN(int, char **);
85
86 static int do_generate(BIO *bio, char *genstr, char *genconf, BUF_MEM *buf);
87
88 int MAIN(int argc, char **argv)
89         {
90         int i,badops=0,offset=0,ret=1,j;
91         unsigned int length=0;
92         long num,tmplen;
93         BIO *in=NULL,*out=NULL,*b64=NULL, *derout = NULL;
94         int informat,indent=0, noout = 0, dump = 0;
95         char *infile=NULL,*str=NULL,*prog,*oidfile=NULL, *derfile=NULL;
96         char *genstr=NULL, *genconf=NULL;
97         unsigned char *tmpbuf;
98         const unsigned char *ctmpbuf;
99         BUF_MEM *buf=NULL;
100         STACK_OF(OPENSSL_STRING) *osk=NULL;
101         ASN1_TYPE *at=NULL;
102
103         informat=FORMAT_PEM;
104
105         apps_startup();
106
107         if (bio_err == NULL)
108                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
109                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
110
111         if (!load_config(bio_err, NULL))
112                 goto end;
113
114         prog=argv[0];
115         argc--;
116         argv++;
117         if ((osk=sk_OPENSSL_STRING_new_null()) == NULL)
118                 {
119                 BIO_printf(bio_err,"Memory allocation failure\n");
120                 goto end;
121                 }
122         while (argc >= 1)
123                 {
124                 if      (strcmp(*argv,"-inform") == 0)
125                         {
126                         if (--argc < 1) goto bad;
127                         informat=str2fmt(*(++argv));
128                         }
129                 else if (strcmp(*argv,"-in") == 0)
130                         {
131                         if (--argc < 1) goto bad;
132                         infile= *(++argv);
133                         }
134                 else if (strcmp(*argv,"-out") == 0)
135                         {
136                         if (--argc < 1) goto bad;
137                         derfile= *(++argv);
138                         }
139                 else if (strcmp(*argv,"-i") == 0)
140                         {
141                         indent=1;
142                         }
143                 else if (strcmp(*argv,"-noout") == 0) noout = 1;
144                 else if (strcmp(*argv,"-oid") == 0)
145                         {
146                         if (--argc < 1) goto bad;
147                         oidfile= *(++argv);
148                         }
149                 else if (strcmp(*argv,"-offset") == 0)
150                         {
151                         if (--argc < 1) goto bad;
152                         offset= atoi(*(++argv));
153                         }
154                 else if (strcmp(*argv,"-length") == 0)
155                         {
156                         if (--argc < 1) goto bad;
157                         length= atoi(*(++argv));
158                         if (length == 0) goto bad;
159                         }
160                 else if (strcmp(*argv,"-dump") == 0)
161                         {
162                         dump= -1;
163                         }
164                 else if (strcmp(*argv,"-dlimit") == 0)
165                         {
166                         if (--argc < 1) goto bad;
167                         dump= atoi(*(++argv));
168                         if (dump <= 0) goto bad;
169                         }
170                 else if (strcmp(*argv,"-strparse") == 0)
171                         {
172                         if (--argc < 1) goto bad;
173                         sk_OPENSSL_STRING_push(osk,*(++argv));
174                         }
175                 else if (strcmp(*argv,"-genstr") == 0)
176                         {
177                         if (--argc < 1) goto bad;
178                         genstr= *(++argv);
179                         }
180                 else if (strcmp(*argv,"-genconf") == 0)
181                         {
182                         if (--argc < 1) goto bad;
183                         genconf= *(++argv);
184                         }
185                 else
186                         {
187                         BIO_printf(bio_err,"unknown option %s\n",*argv);
188                         badops=1;
189                         break;
190                         }
191                 argc--;
192                 argv++;
193                 }
194
195         if (badops)
196                 {
197 bad:
198                 BIO_printf(bio_err,"%s [options] <infile\n",prog);
199                 BIO_printf(bio_err,"where options are\n");
200                 BIO_printf(bio_err," -inform arg   input format - one of DER PEM\n");
201                 BIO_printf(bio_err," -in arg       input file\n");
202                 BIO_printf(bio_err," -out arg      output file (output format is always DER\n");
203                 BIO_printf(bio_err," -noout arg    don't produce any output\n");
204                 BIO_printf(bio_err," -offset arg   offset into file\n");
205                 BIO_printf(bio_err," -length arg   length of section in file\n");
206                 BIO_printf(bio_err," -i            indent entries\n");
207                 BIO_printf(bio_err," -dump         dump unknown data in hex form\n");
208                 BIO_printf(bio_err," -dlimit arg   dump the first arg bytes of unknown data in hex form\n");
209                 BIO_printf(bio_err," -oid file     file of extra oid definitions\n");
210                 BIO_printf(bio_err," -strparse offset\n");
211                 BIO_printf(bio_err,"               a series of these can be used to 'dig' into multiple\n");
212                 BIO_printf(bio_err,"               ASN1 blob wrappings\n");
213                 BIO_printf(bio_err," -genstr str   string to generate ASN1 structure from\n");
214                 BIO_printf(bio_err," -genconf file file to generate ASN1 structure from\n");
215                 goto end;
216                 }
217
218         ERR_load_crypto_strings();
219
220         in=BIO_new(BIO_s_file());
221         out=BIO_new(BIO_s_file());
222         if ((in == NULL) || (out == NULL))
223                 {
224                 ERR_print_errors(bio_err);
225                 goto end;
226                 }
227         BIO_set_fp(out,stdout,BIO_NOCLOSE|BIO_FP_TEXT);
228 #ifdef OPENSSL_SYS_VMS
229         {
230         BIO *tmpbio = BIO_new(BIO_f_linebuffer());
231         out = BIO_push(tmpbio, out);
232         }
233 #endif
234
235         if (oidfile != NULL)
236                 {
237                 if (BIO_read_filename(in,oidfile) <= 0)
238                         {
239                         BIO_printf(bio_err,"problems opening %s\n",oidfile);
240                         ERR_print_errors(bio_err);
241                         goto end;
242                         }
243                 OBJ_create_objects(in);
244                 }
245
246         if (infile == NULL)
247                 BIO_set_fp(in,stdin,BIO_NOCLOSE);
248         else
249                 {
250                 if (BIO_read_filename(in,infile) <= 0)
251                         {
252                         perror(infile);
253                         goto end;
254                         }
255                 }
256
257         if (derfile) {
258                 if(!(derout = BIO_new_file(derfile, "wb"))) {
259                         BIO_printf(bio_err,"problems opening %s\n",derfile);
260                         ERR_print_errors(bio_err);
261                         goto end;
262                 }
263         }
264
265         if ((buf=BUF_MEM_new()) == NULL) goto end;
266         if (!BUF_MEM_grow(buf,BUFSIZ*8)) goto end; /* Pre-allocate :-) */
267
268         if (genstr || genconf)
269                 {
270                 num = do_generate(bio_err, genstr, genconf, buf);
271                 if (num < 0)
272                         {
273                         ERR_print_errors(bio_err);
274                         goto end;
275                         }
276                 }
277
278         else
279                 {
280
281                 if (informat == FORMAT_PEM)
282                         {
283                         BIO *tmp;
284
285                         if ((b64=BIO_new(BIO_f_base64())) == NULL)
286                                 goto end;
287                         BIO_push(b64,in);
288                         tmp=in;
289                         in=b64;
290                         b64=tmp;
291                         }
292
293                 num=0;
294                 for (;;)
295                         {
296                         if (!BUF_MEM_grow(buf,(int)num+BUFSIZ)) goto end;
297                         i=BIO_read(in,&(buf->data[num]),BUFSIZ);
298                         if (i <= 0) break;
299                         num+=i;
300                         }
301                 }
302         str=buf->data;
303
304         /* If any structs to parse go through in sequence */
305
306         if (sk_OPENSSL_STRING_num(osk))
307                 {
308                 tmpbuf=(unsigned char *)str;
309                 tmplen=num;
310                 for (i=0; i<sk_OPENSSL_STRING_num(osk); i++)
311                         {
312                         ASN1_TYPE *atmp;
313                         int typ;
314                         j=atoi(sk_OPENSSL_STRING_value(osk,i));
315                         if (j == 0)
316                                 {
317                                 BIO_printf(bio_err,"'%s' is an invalid number\n",sk_OPENSSL_STRING_value(osk,i));
318                                 continue;
319                                 }
320                         tmpbuf+=j;
321                         tmplen-=j;
322                         atmp = at;
323                         ctmpbuf = tmpbuf;
324                         at = d2i_ASN1_TYPE(NULL,&ctmpbuf,tmplen);
325                         ASN1_TYPE_free(atmp);
326                         if(!at)
327                                 {
328                                 BIO_printf(bio_err,"Error parsing structure\n");
329                                 ERR_print_errors(bio_err);
330                                 goto end;
331                                 }
332                         typ = ASN1_TYPE_get(at);
333                         if ((typ == V_ASN1_OBJECT)
334                                 || (typ == V_ASN1_NULL))
335                                 {
336                                 BIO_printf(bio_err, "Can't parse %s type\n",
337                                         typ == V_ASN1_NULL ? "NULL" : "OBJECT");
338                                 ERR_print_errors(bio_err);
339                                 goto end;
340                                 }
341                         /* hmm... this is a little evil but it works */
342                         tmpbuf=at->value.asn1_string->data;
343                         tmplen=at->value.asn1_string->length;
344                         }
345                 str=(char *)tmpbuf;
346                 num=tmplen;
347                 }
348
349         if (offset >= num)
350                 {
351                 BIO_printf(bio_err, "Error: offset too large\n");
352                 goto end;
353                 }
354
355         num -= offset;
356
357         if ((length == 0) || ((long)length > num)) length=(unsigned int)num;
358         if(derout) {
359                 if(BIO_write(derout, str + offset, length) != (int)length) {
360                         BIO_printf(bio_err, "Error writing output\n");
361                         ERR_print_errors(bio_err);
362                         goto end;
363                 }
364         }
365         if (!noout &&
366             !ASN1_parse_dump(out,(unsigned char *)&(str[offset]),length,
367                     indent,dump))
368                 {
369                 ERR_print_errors(bio_err);
370                 goto end;
371                 }
372         ret=0;
373 end:
374         BIO_free(derout);
375         if (in != NULL) BIO_free(in);
376         if (out != NULL) BIO_free_all(out);
377         if (b64 != NULL) BIO_free(b64);
378         if (ret != 0)
379                 ERR_print_errors(bio_err);
380         if (buf != NULL) BUF_MEM_free(buf);
381         if (at != NULL) ASN1_TYPE_free(at);
382         if (osk != NULL) sk_OPENSSL_STRING_free(osk);
383         OBJ_cleanup();
384         apps_shutdown();
385         OPENSSL_EXIT(ret);
386         }
387
388 static int do_generate(BIO *bio, char *genstr, char *genconf, BUF_MEM *buf)
389         {
390         CONF *cnf = NULL;
391         int len;
392         long errline;
393         unsigned char *p;
394         ASN1_TYPE *atyp = NULL;
395
396         if (genconf)
397                 {
398                 cnf = NCONF_new(NULL);
399                 if (!NCONF_load(cnf, genconf, &errline))
400                         goto conferr;
401                 if (!genstr)
402                         genstr = NCONF_get_string(cnf, "default", "asn1");
403                 if (!genstr)
404                         {
405                         BIO_printf(bio, "Can't find 'asn1' in '%s'\n", genconf);
406                         goto err;
407                         }
408                 }
409
410         atyp = ASN1_generate_nconf(genstr, cnf);
411         NCONF_free(cnf);
412         cnf = NULL;
413
414         if (!atyp)
415                 return -1;
416
417         len = i2d_ASN1_TYPE(atyp, NULL);
418
419         if (len <= 0)
420                 goto err;
421
422         if (!BUF_MEM_grow(buf,len))
423                 goto err;
424
425         p=(unsigned char *)buf->data;
426
427         i2d_ASN1_TYPE(atyp, &p);
428
429         ASN1_TYPE_free(atyp);
430         return len;
431
432         conferr:
433
434         if (errline > 0)
435                 BIO_printf(bio, "Error on line %ld of config file '%s'\n",
436                                                         errline, genconf);
437         else
438                 BIO_printf(bio, "Error loading config file '%s'\n", genconf);
439
440         err:
441         NCONF_free(cnf);
442         ASN1_TYPE_free(atyp);
443
444         return -1;
445
446         }