openssl: Adjust manual pages for 1.0.1l.
[dragonfly.git] / secure / usr.bin / openssl / man / asn1parse.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "ASN1PARSE 1"
127 .TH ASN1PARSE 1 "2015-01-15" "1.0.1l" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 asn1parse \- ASN.1 parsing tool
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBasn1parse\fR
137 [\fB\-inform PEM|DER\fR]
138 [\fB\-in filename\fR]
139 [\fB\-out filename\fR]
140 [\fB\-noout\fR]
141 [\fB\-offset number\fR]
142 [\fB\-length number\fR]
143 [\fB\-i\fR]
144 [\fB\-oid filename\fR]
145 [\fB\-dump\fR]
146 [\fB\-dlimit num\fR]
147 [\fB\-strparse offset\fR]
148 [\fB\-genstr string\fR]
149 [\fB\-genconf file\fR]
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN\s0.1
153 structures. It can also be used to extract data from \s-1ASN\s0.1 formatted data.
154 .SH "OPTIONS"
155 .IX Header "OPTIONS"
156 .IP "\fB\-inform\fR \fBDER|PEM\fR" 4
157 .IX Item "-inform DER|PEM"
158 the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
159 encoded.
160 .IP "\fB\-in filename\fR" 4
161 .IX Item "-in filename"
162 the input file, default is standard input
163 .IP "\fB\-out filename\fR" 4
164 .IX Item "-out filename"
165 output file to place the \s-1DER\s0 encoded data into. If this
166 option is not present then no data will be output. This is most useful when
167 combined with the \fB\-strparse\fR option.
168 .IP "\fB\-noout\fR" 4
169 .IX Item "-noout"
170 don't output the parsed version of the input file.
171 .IP "\fB\-offset number\fR" 4
172 .IX Item "-offset number"
173 starting offset to begin parsing, default is start of file.
174 .IP "\fB\-length number\fR" 4
175 .IX Item "-length number"
176 number of bytes to parse, default is until end of file.
177 .IP "\fB\-i\fR" 4
178 .IX Item "-i"
179 indents the output according to the \*(L"depth\*(R" of the structures.
180 .IP "\fB\-oid filename\fR" 4
181 .IX Item "-oid filename"
182 a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
183 file is described in the \s-1NOTES\s0 section below.
184 .IP "\fB\-dump\fR" 4
185 .IX Item "-dump"
186 dump unknown data in hex format.
187 .IP "\fB\-dlimit num\fR" 4
188 .IX Item "-dlimit num"
189 like \fB\-dump\fR, but only the first \fBnum\fR bytes are output.
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\|(3) format. If \fBfile\fR only is
198 present then the string is obtained from the default section using the name
199 \&\fBasn1\fR. The encoded data is passed through the \s-1ASN1\s0 parser and printed out as
200 though it came from a file, the contents can thus be examined and written to a
201 file using the \fBout\fR option.
202 .SS "\s-1OUTPUT\s0"
203 .IX Subsection "OUTPUT"
204 The output will typically contain lines like this:
205 .PP
206 .Vb 1
207 \&  0:d=0  hl=4 l= 681 cons: SEQUENCE
208 .Ve
209 .PP
210 \&.....
211 .PP
212 .Vb 10
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
223 .Ve
224 .PP
225 \&.....
226 .PP
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
231 the contents octets.
232 .PP
233 The \fB\-i\fR option can be used to make the output more readable.
234 .PP
235 Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output.
236 .PP
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:
240 .PP
241 .Vb 3
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
245 .Ve
246 .SH "NOTES"
247 .IX Header "NOTES"
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:
255 .PP
256 \&\f(CW\*(C`1.2.3.4     shortName       A long name\*(C'\fR
257 .SH "EXAMPLES"
258 .IX Header "EXAMPLES"
259 Parse a file:
260 .PP
261 .Vb 1
262 \& openssl asn1parse \-in file.pem
263 .Ve
264 .PP
265 Parse a \s-1DER\s0 file:
266 .PP
267 .Vb 1
268 \& openssl asn1parse \-inform DER \-in file.der
269 .Ve
270 .PP
271 Generate a simple UTF8String:
272 .PP
273 .Vb 1
274 \& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq
275 .Ve
276 .PP
277 Generate and write out a UTF8String, don't print parsed output:
278 .PP
279 .Vb 1
280 \& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq \-noout \-out utf8.der
281 .Ve
282 .PP
283 Generate using a config file:
284 .PP
285 .Vb 1
286 \& openssl asn1parse \-genconf asn1.cnf \-noout \-out asn1.der
287 .Ve
288 .PP
289 Example config file:
290 .PP
291 .Vb 1
292 \& asn1=SEQUENCE:seq_sect
293 \&
294 \& [seq_sect]
295 \&
296 \& field1=BOOL:TRUE
297 \& field2=EXP:0, UTF8:some random string
298 .Ve
299 .SH "BUGS"
300 .IX Header "BUGS"
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).
303 .SH "SEE ALSO"
304 .IX Header "SEE ALSO"
305 \&\fIASN1_generate_nconf\fR\|(3)