doc/apps/asn1parse.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 asn1parse - ASN.1 parsing tool
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<asn1parse>
  10 [B<-inform PEM|DER>]
  11 [B<-in filename>]
  12 [B<-out filename>]
  13 [B<-noout>]
  14 [B<-offset number>]
  15 [B<-length number>]
  16 [B<-i>]
  17 [B<-oid filename>]
  18 [B<-strparse offset>]
  19 [B<-genstr string>]
  20 [B<-genconf file>]
  21 [B<-strictpem>]
  22
  23 =head1 DESCRIPTION
  24
  25 The B<asn1parse> command is a diagnostic utility that can parse ASN.1
  26 structures. It can also be used to extract data from ASN.1 formatted data.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-inform> B<DER|PEM>
  33
  34 the input format. B<DER> is binary format and B<PEM> (the default) is base64
  35 encoded.
  36
  37 =item B<-in filename>
  38
  39 the input file, default is standard input
  40
  41 =item B<-out filename>
  42
  43 output file to place the DER encoded data into. If this
  44 option is not present then no data will be output. This is most useful when
  45 combined with the B<-strparse> option.
  46
  47 =item B<-noout>
  48
  49 don't output the parsed version of the input file.
  50
  51 =item B<-offset number>
  52
  53 starting offset to begin parsing, default is start of file.
  54
  55 =item B<-length number>
  56
  57 number of bytes to parse, default is until end of file.
  58
  59 =item B<-i>
  60
  61 indents the output according to the "depth" of the structures.
  62
  63 =item B<-oid filename>
  64
  65 a file containing additional OBJECT IDENTIFIERs (OIDs). The format of this
  66 file is described in the NOTES section below.
  67
  68 =item B<-strparse offset>
  69
  70 parse the contents octets of the ASN.1 object starting at B<offset>. This
  71 option can be used multiple times to "drill down" into a nested structure.
  72
  73 =item B<-genstr string>, B<-genconf file>
  74
  75 generate encoded data based on B<string>, B<file> or both using
  76 L<ASN1_generate_nconf(3)|ASN1_generate_nconf(3)> format. If B<file> only is
  77 present then the string is obtained from the default section using the name
  78 B<asn1>. The encoded data is passed through the ASN1 parser and printed out as
  79 though it came from a file, the contents can thus be examined and written to a
  80 file using the B<out> option.
  81
  82 =item B<-strictpem>
  83
  84 If this option is used then B<-inform> will be ignored. Without this option any
  85 data in a PEM format input file will be treated as base64 encoded and processed
  86 whether it has the normal PEM BEGIN and END markers or not. This option will
  87 ignore any data prior to the start of the BEGIN marker in a PEM file.
  88
  89 =back
  90
  91 =head2 OUTPUT
  92
  93 The output will typically contain lines like this:
  94
  95   0:d=0  hl=4 l= 681 cons: SEQUENCE
  96
  97 .....
  98
  99   229:d=3  hl=3 l= 141 prim: BIT STRING
 100   373:d=2  hl=3 l= 162 cons: cont [ 3 ]
 101   376:d=3  hl=3 l= 159 cons: SEQUENCE
 102   379:d=4  hl=2 l=  29 cons: SEQUENCE
 103   381:d=5  hl=2 l=   3 prim: OBJECT            :X509v3 Subject Key Identifier
 104   386:d=5  hl=2 l=  22 prim: OCTET STRING
 105   410:d=4  hl=2 l= 112 cons: SEQUENCE
 106   412:d=5  hl=2 l=   3 prim: OBJECT            :X509v3 Authority Key Identifier
 107   417:d=5  hl=2 l= 105 prim: OCTET STRING
 108   524:d=4  hl=2 l=  12 cons: SEQUENCE
 109
 110 .....
 111
 112 This example is part of a self signed certificate. Each line starts with the
 113 offset in decimal. B<d=XX> specifies the current depth. The depth is increased
 114 within the scope of any SET or SEQUENCE. B<hl=XX> gives the header length
 115 (tag and length octets) of the current type. B<l=XX> gives the length of
 116 the contents octets.
 117
 118 The B<-i> option can be used to make the output more readable.
 119
 120 Some knowledge of the ASN.1 structure is needed to interpret the output.
 121
 122 In this example the BIT STRING at offset 229 is the certificate public key.
 123 The contents octets of this will contain the public key information. This can
 124 be examined using the option B<-strparse 229> to yield:
 125
 126     0:d=0  hl=3 l= 137 cons: SEQUENCE
 127     3:d=1  hl=3 l= 129 prim: INTEGER           :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897
 128   135:d=1  hl=2 l=   3 prim: INTEGER           :010001
 129
 130 =head1 NOTES
 131
 132 If an OID is not part of OpenSSL's internal table it will be represented in
 133 numerical form (for example 1.2.3.4). The file passed to the B<-oid> option
 134 allows additional OIDs to be included. Each line consists of three columns,
 135 the first column is the OID in numerical format and should be followed by white
 136 space. The second column is the "short name" which is a single word followed
 137 by white space. The final column is the rest of the line and is the
 138 "long name". B<asn1parse> displays the long name. Example:
 139
 140 C<1.2.3.4       shortName       A long name>
 141
 142 =head1 EXAMPLES
 143
 144 Parse a file:
 145
 146  openssl asn1parse -in file.pem
 147
 148 Parse a DER file:
 149
 150  openssl asn1parse -inform DER -in file.der
 151
 152 Generate a simple UTF8String:
 153
 154  openssl asn1parse -genstr 'UTF8:Hello World'
 155
 156 Generate and write out a UTF8String, don't print parsed output:
 157
 158  openssl asn1parse -genstr 'UTF8:Hello World' -noout -out utf8.der
 159
 160 Generate using a config file:
 161
 162  openssl asn1parse -genconf asn1.cnf -noout -out asn1.der
 163
 164 Example config file:
 165
 166  asn1=SEQUENCE:seq_sect
 167
 168  [seq_sect]
 169
 170  field1=BOOL:TRUE
 171  field2=EXP:0, UTF8:some random string
 172
 173
 174 =head1 BUGS
 175
 176 There should be options to change the format of output lines. The output of some
 177 ASN.1 types is not well handled (if at all).
 178
 179 =head1 SEE ALSO
 180
 181 L<ASN1_generate_nconf(3)|ASN1_generate_nconf(3)>
 182
 183 =cut