| blob | c427f2478892c77943f95f9b7320466a21c39bf3 |
1 .\" $NetBSD: openssl_asn1parse.1,v 1.14 2015/06/12 17:01:14 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "ASN1PARSE 1"
138 .TH ASN1PARSE 1 "2014-08-10" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 asn1parse \- ASN.1 parsing tool
145 .SH "LIBRARY"
146 libcrypto, -lcrypto
147 .SH "SYNOPSIS"
148 .IX Header "SYNOPSIS"
149 \&\fBopenssl\fR \fBasn1parse\fR
150 [\fB\-inform PEM|DER\fR]
151 [\fB\-in filename\fR]
152 [\fB\-out filename\fR]
153 [\fB\-noout\fR]
154 [\fB\-offset number\fR]
155 [\fB\-length number\fR]
156 [\fB\-i\fR]
157 [\fB\-oid filename\fR]
158 [\fB\-dump\fR]
159 [\fB\-dlimit num\fR]
160 [\fB\-strparse offset\fR]
161 [\fB\-genstr string\fR]
162 [\fB\-genconf file\fR]
163 .SH "DESCRIPTION"
164 .IX Header "DESCRIPTION"
165 The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN.1\s0
166 structures. It can also be used to extract data from \s-1ASN.1\s0 formatted data.
167 .SH "OPTIONS"
168 .IX Header "OPTIONS"
169 .IP "\fB\-inform\fR \fBDER|PEM\fR" 4
170 .IX Item "-inform DER|PEM"
171 the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
172 encoded.
173 .IP "\fB\-in filename\fR" 4
174 .IX Item "-in filename"
175 the input file, default is standard input
176 .IP "\fB\-out filename\fR" 4
177 .IX Item "-out filename"
178 output file to place the \s-1DER\s0 encoded data into. If this
179 option is not present then no data will be output. This is most useful when
180 combined with the \fB\-strparse\fR option.
181 .IP "\fB\-noout\fR" 4
182 .IX Item "-noout"
183 don't output the parsed version of the input file.
184 .IP "\fB\-offset number\fR" 4
185 .IX Item "-offset number"
186 starting offset to begin parsing, default is start of file.
187 .IP "\fB\-length number\fR" 4
188 .IX Item "-length number"
189 number of bytes to parse, default is until end of file.
190 .IP "\fB\-i\fR" 4
191 .IX Item "-i"
192 indents the output according to the \*(L"depth\*(R" of the structures.
193 .IP "\fB\-oid filename\fR" 4
194 .IX Item "-oid filename"
195 a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
196 file is described in the \s-1NOTES\s0 section below.
197 .IP "\fB\-dump\fR" 4
198 .IX Item "-dump"
199 dump unknown data in hex format.
200 .IP "\fB\-dlimit num\fR" 4
201 .IX Item "-dlimit num"
202 like \fB\-dump\fR, but only the first \fBnum\fR bytes are output.
203 .IP "\fB\-strparse offset\fR" 4
204 .IX Item "-strparse offset"
205 parse the contents octets of the \s-1ASN.1\s0 object starting at \fBoffset\fR. This
206 option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
207 .IP "\fB\-genstr string\fR, \fB\-genconf file\fR" 4
208 .IX Item "-genstr string, -genconf file"
209 generate encoded data based on \fBstring\fR, \fBfile\fR or both using
210 \&\fIASN1_generate_nconf\fR\|(3) format. If \fBfile\fR only is
211 present then the string is obtained from the default section using the name
212 \&\fBasn1\fR. The encoded data is passed through the \s-1ASN1\s0 parser and printed out as
213 though it came from a file, the contents can thus be examined and written to a
214 file using the \fBout\fR option.
215 .SS "\s-1OUTPUT\s0"
216 .IX Subsection "OUTPUT"
217 The output will typically contain lines like this:
218 .PP
219 .Vb 1
220 \& 0:d=0 hl=4 l= 681 cons: SEQUENCE
221 .Ve
222 .PP
223 \&.....
224 .PP
225 .Vb 10
226 \& 229:d=3 hl=3 l= 141 prim: BIT STRING
227 \& 373:d=2 hl=3 l= 162 cons: cont [ 3 ]
228 \& 376:d=3 hl=3 l= 159 cons: SEQUENCE
229 \& 379:d=4 hl=2 l= 29 cons: SEQUENCE
230 \& 381:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Subject Key Identifier
231 \& 386:d=5 hl=2 l= 22 prim: OCTET STRING
232 \& 410:d=4 hl=2 l= 112 cons: SEQUENCE
233 \& 412:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Authority Key Identifier
234 \& 417:d=5 hl=2 l= 105 prim: OCTET STRING
235 \& 524:d=4 hl=2 l= 12 cons: SEQUENCE
236 .Ve
237 .PP
238 \&.....
239 .PP
240 This example is part of a self signed certificate. Each line starts with the
241 offset in decimal. \fBd=XX\fR specifies the current depth. The depth is increased
242 within the scope of any \s-1SET\s0 or \s-1SEQUENCE. \s0\fBhl=XX\fR gives the header length
243 (tag and length octets) of the current type. \fBl=XX\fR gives the length of
244 the contents octets.
245 .PP
246 The \fB\-i\fR option can be used to make the output more readable.
247 .PP
248 Some knowledge of the \s-1ASN.1\s0 structure is needed to interpret the output.
249 .PP
250 In this example the \s-1BIT STRING\s0 at offset 229 is the certificate public key.
251 The contents octets of this will contain the public key information. This can
252 be examined using the option \fB\-strparse 229\fR to yield:
253 .PP
254 .Vb 3
255 \& 0:d=0 hl=3 l= 137 cons: SEQUENCE
256 \& 3:d=1 hl=3 l= 129 prim: INTEGER :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897
257 \& 135:d=1 hl=2 l= 3 prim: INTEGER :010001
258 .Ve
259 .SH "NOTES"
260 .IX Header "NOTES"
261 If an \s-1OID\s0 is not part of OpenSSL's internal table it will be represented in
262 numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option
263 allows additional OIDs to be included. Each line consists of three columns,
264 the first column is the \s-1OID\s0 in numerical format and should be followed by white
265 space. The second column is the \*(L"short name\*(R" which is a single word followed
266 by white space. The final column is the rest of the line and is the
267 \&\*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
268 .PP
269 \&\f(CW\*(C`1.2.3.4 shortName A long name\*(C'\fR
270 .SH "EXAMPLES"
271 .IX Header "EXAMPLES"
272 Parse a file:
273 .PP
274 .Vb 1
275 \& openssl asn1parse \-in file.pem
276 .Ve
277 .PP
278 Parse a \s-1DER\s0 file:
279 .PP
280 .Vb 1
281 \& openssl asn1parse \-inform DER \-in file.der
282 .Ve
283 .PP
284 Generate a simple UTF8String:
285 .PP
286 .Vb 1
287 \& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq
288 .Ve
289 .PP
290 Generate and write out a UTF8String, don't print parsed output:
291 .PP
292 .Vb 1
293 \& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq \-noout \-out utf8.der
294 .Ve
295 .PP
296 Generate using a config file:
297 .PP
298 .Vb 1
299 \& openssl asn1parse \-genconf asn1.cnf \-noout \-out asn1.der
300 .Ve
301 .PP
302 Example config file:
303 .PP
304 .Vb 1
305 \& asn1=SEQUENCE:seq_sect
306 \&
307 \& [seq_sect]
308 \&
309 \& field1=BOOL:TRUE
310 \& field2=EXP:0, UTF8:some random string
311 .Ve
312 .SH "BUGS"
313 .IX Header "BUGS"
314 There should be options to change the format of output lines. The output of some
315 \&\s-1ASN.1\s0 types is not well handled (if at all).
316 .SH "SEE ALSO"
317 .IX Header "SEE ALSO"
318 \&\fIASN1_generate_nconf\fR\|(3)