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