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