1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "ASN1PARSE 1"
135 .TH ASN1PARSE 1 "2010-02-27" "0.9.8m" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 asn1parse \- ASN.1 parsing tool
143 .IX Header "SYNOPSIS"
144 \&\fBopenssl\fR \fBasn1parse\fR
145 [\fB\-inform PEM|DER\fR]
146 [\fB\-in filename\fR]
147 [\fB\-out filename\fR]
149 [\fB\-offset number\fR]
150 [\fB\-length number\fR]
152 [\fB\-oid filename\fR]
153 [\fB\-strparse offset\fR]
154 [\fB\-genstr string\fR]
155 [\fB\-genconf file\fR]
157 .IX Header "DESCRIPTION"
158 The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN\s0.1
159 structures. It can also be used to extract data from \s-1ASN\s0.1 formatted data.
162 .IP "\fB\-inform\fR \fBDER|PEM\fR" 4
163 .IX Item "-inform DER|PEM"
164 the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
166 .IP "\fB\-in filename\fR" 4
167 .IX Item "-in filename"
168 the input file, default is standard input
169 .IP "\fB\-out filename\fR" 4
170 .IX Item "-out filename"
171 output file to place the \s-1DER\s0 encoded data into. If this
172 option is not present then no data will be output. This is most useful when
173 combined with the \fB\-strparse\fR option.
174 .IP "\fB\-noout\fR" 4
176 don't output the parsed version of the input file.
177 .IP "\fB\-offset number\fR" 4
178 .IX Item "-offset number"
179 starting offset to begin parsing, default is start of file.
180 .IP "\fB\-length number\fR" 4
181 .IX Item "-length number"
182 number of bytes to parse, default is until end of file.
185 indents the output according to the \*(L"depth\*(R" of the structures.
186 .IP "\fB\-oid filename\fR" 4
187 .IX Item "-oid filename"
188 a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
189 file is described in the \s-1NOTES\s0 section below.
190 .IP "\fB\-strparse offset\fR" 4
191 .IX Item "-strparse offset"
192 parse the contents octets of the \s-1ASN\s0.1 object starting at \fBoffset\fR. This
193 option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
194 .IP "\fB\-genstr string\fR, \fB\-genconf file\fR" 4
195 .IX Item "-genstr string, -genconf file"
196 generate encoded data based on \fBstring\fR, \fBfile\fR or both using
197 \&\fIASN1_generate_nconf()\fR format. If \fBfile\fR only is present then the string
198 is obtained from the default section using the name \fBasn1\fR. The encoded
199 data is passed through the \s-1ASN1\s0 parser and printed out as though it came
200 from a file, the contents can thus be examined and written to a file
201 using the \fBout\fR option.
203 .IX Subsection "OUTPUT"
204 The output will typically contain lines like this:
207 \& 0:d=0 hl=4 l= 681 cons: SEQUENCE
213 \& 229:d=3 hl=3 l= 141 prim: BIT STRING
214 \& 373:d=2 hl=3 l= 162 cons: cont [ 3 ]
215 \& 376:d=3 hl=3 l= 159 cons: SEQUENCE
216 \& 379:d=4 hl=2 l= 29 cons: SEQUENCE
217 \& 381:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Subject Key Identifier
218 \& 386:d=5 hl=2 l= 22 prim: OCTET STRING
219 \& 410:d=4 hl=2 l= 112 cons: SEQUENCE
220 \& 412:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Authority Key Identifier
221 \& 417:d=5 hl=2 l= 105 prim: OCTET STRING
222 \& 524:d=4 hl=2 l= 12 cons: SEQUENCE
227 This example is part of a self signed certificate. Each line starts with the
228 offset in decimal. \fBd=XX\fR specifies the current depth. The depth is increased
229 within the scope of any \s-1SET\s0 or \s-1SEQUENCE\s0. \fBhl=XX\fR gives the header length
230 (tag and length octets) of the current type. \fBl=XX\fR gives the length of
233 The \fB\-i\fR option can be used to make the output more readable.
235 Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output.
237 In this example the \s-1BIT\s0 \s-1STRING\s0 at offset 229 is the certificate public key.
238 The contents octets of this will contain the public key information. This can
239 be examined using the option \fB\-strparse 229\fR to yield:
242 \& 0:d=0 hl=3 l= 137 cons: SEQUENCE
243 \& 3:d=1 hl=3 l= 129 prim: INTEGER :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897
244 \& 135:d=1 hl=2 l= 3 prim: INTEGER :010001
248 If an \s-1OID\s0 is not part of OpenSSL's internal table it will be represented in
249 numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option
250 allows additional OIDs to be included. Each line consists of three columns,
251 the first column is the \s-1OID\s0 in numerical format and should be followed by white
252 space. The second column is the \*(L"short name\*(R" which is a single word followed
253 by white space. The final column is the rest of the line and is the
254 \&\*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
256 \&\f(CW\*(C`1.2.3.4 shortName A long name\*(C'\fR
258 .IX Header "EXAMPLES"
262 \& openssl asn1parse \-in file.pem
265 Parse a \s-1DER\s0 file:
268 \& openssl asn1parse \-inform DER \-in file.der
271 Generate a simple UTF8String:
274 \& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq
277 Generate and write out a UTF8String, don't print parsed output:
280 \& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq \-noout \-out utf8.der
283 Generate using a config file:
286 \& openssl asn1parse \-genconf asn1.cnf \-noout \-out asn1.der
292 \& asn1=SEQUENCE:seq_sect
297 \& field2=EXP:0, UTF8:some random string
301 There should be options to change the format of output lines. The output of some
302 \&\s-1ASN\s0.1 types is not well handled (if at all).