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