Merge from vendor branch TNFTP:
[dragonfly.git] / secure / usr.bin / openssl / man / asn1parse.1
CommitLineData
c6e28a8e 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
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<>.
984263bc 32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb
JR
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
984263bc 66.if n .na
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "ASN1PARSE 1"
c6e28a8e 132.TH ASN1PARSE 1 "2006-09-06" "0.9.8c" "OpenSSL"
984263bc 133.SH "NAME"
e3cdf75b 134asn1parse \- ASN.1 parsing tool
984263bc 135.SH "SYNOPSIS"
8b0cefbb
JR
136.IX Header "SYNOPSIS"
137\&\fBopenssl\fR \fBasn1parse\fR
984263bc
MD
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]
a561f9ff
SS
147[\fB\-genstr string\fR]
148[\fB\-genconf file\fR]
984263bc 149.SH "DESCRIPTION"
8b0cefbb
JR
150.IX Header "DESCRIPTION"
151The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN\s0.1
152structures. It can also be used to extract data from \s-1ASN\s0.1 formatted data.
984263bc 153.SH "OPTIONS"
8b0cefbb
JR
154.IX Header "OPTIONS"
155.IP "\fB\-inform\fR \fBDER|PEM\fR" 4
156.IX Item "-inform DER|PEM"
984263bc
MD
157the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
158encoded.
8b0cefbb
JR
159.IP "\fB\-in filename\fR" 4
160.IX Item "-in filename"
984263bc 161the input file, default is standard input
8b0cefbb
JR
162.IP "\fB\-out filename\fR" 4
163.IX Item "-out filename"
984263bc
MD
164output file to place the \s-1DER\s0 encoded data into. If this
165option is not present then no data will be output. This is most useful when
166combined with the \fB\-strparse\fR option.
8b0cefbb
JR
167.IP "\fB\-noout\fR" 4
168.IX Item "-noout"
984263bc 169don't output the parsed version of the input file.
8b0cefbb
JR
170.IP "\fB\-offset number\fR" 4
171.IX Item "-offset number"
984263bc 172starting offset to begin parsing, default is start of file.
8b0cefbb
JR
173.IP "\fB\-length number\fR" 4
174.IX Item "-length number"
984263bc 175number of bytes to parse, default is until end of file.
8b0cefbb
JR
176.IP "\fB\-i\fR" 4
177.IX Item "-i"
984263bc 178indents the output according to the \*(L"depth\*(R" of the structures.
8b0cefbb
JR
179.IP "\fB\-oid filename\fR" 4
180.IX Item "-oid filename"
984263bc
MD
181a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
182file is described in the \s-1NOTES\s0 section below.
8b0cefbb
JR
183.IP "\fB\-strparse offset\fR" 4
184.IX Item "-strparse offset"
984263bc
MD
185parse the contents octets of the \s-1ASN\s0.1 object starting at \fBoffset\fR. This
186option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
a561f9ff
SS
187.IP "\fB\-genstr string\fR, \fB\-genconf file\fR" 4
188.IX Item "-genstr string, -genconf file"
189generate 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
191is obtained from the default section using the name \fBasn1\fR. The encoded
192data is passed through the \s-1ASN1\s0 parser and printed out as though it came
193from a file, the contents can thus be examined and written to a file
194using the \fBout\fR option.
984263bc 195.Sh "\s-1OUTPUT\s0"
8b0cefbb 196.IX Subsection "OUTPUT"
984263bc
MD
197The output will typically contain lines like this:
198.PP
199.Vb 1
8b0cefbb 200\& 0:d=0 hl=4 l= 681 cons: SEQUENCE
984263bc 201.Ve
8b0cefbb 202.PP
984263bc
MD
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
8b0cefbb 215\& 524:d=4 hl=2 l= 12 cons: SEQUENCE
984263bc 216.Ve
8b0cefbb 217.PP
984263bc
MD
218\&.....
219.PP
220This example is part of a self signed certificate. Each line starts with the
8b0cefbb
JR
221offset in decimal. \fBd=XX\fR specifies the current depth. The depth is increased
222within 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
984263bc
MD
224the contents octets.
225.PP
226The \fB\-i\fR option can be used to make the output more readable.
227.PP
228Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output.
229.PP
230In this example the \s-1BIT\s0 \s-1STRING\s0 at offset 229 is the certificate public key.
231The contents octets of this will contain the public key information. This can
232be 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"
8b0cefbb
JR
240.IX Header "NOTES"
241If an \s-1OID\s0 is not part of OpenSSL's internal table it will be represented in
984263bc
MD
242numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option
243allows additional OIDs to be included. Each line consists of three columns,
8b0cefbb 244the first column is the \s-1OID\s0 in numerical format and should be followed by white
984263bc
MD
245space. The second column is the \*(L"short name\*(R" which is a single word followed
246by white space. The final column is the rest of the line and is the
8b0cefbb 247\&\*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
984263bc 248.PP
8b0cefbb 249\&\f(CW\*(C`1.2.3.4 shortName A long name\*(C'\fR
a561f9ff
SS
250.SH "EXAMPLES"
251.IX Header "EXAMPLES"
252Parse a file:
253.PP
254.Vb 1
255\& openssl asn1parse -in file.pem
256.Ve
257.PP
258Parse a \s-1DER\s0 file:
259.PP
260.Vb 1
261\& openssl asn1parse -inform DER -in file.der
262.Ve
263.PP
264Generate a simple UTF8String:
265.PP
266.Vb 1
267\& openssl asn1parse -genstr 'UTF8:Hello World'
268.Ve
269.PP
270Generate 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
276Generate using a config file:
277.PP
278.Vb 1
279\& openssl asn1parse -genconf asn1.cnf -noout -out asn1.der
280.Ve
281.PP
282Example 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
984263bc 296.SH "BUGS"
e3cdf75b 297.IX Header "BUGS"
a561f9ff 298There should be options to change the format of output lines. The output of some
8b0cefbb 299\&\s-1ASN\s0.1 types is not well handled (if at all).