Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / usr.bin / openssl / man / asn1parse.1
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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
e257b235
PA
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<>.
32.tr \(*W-
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 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
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.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
8b0cefbb
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
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
984263bc 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
8b0cefbb
JR
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'
984263bc 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 115. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
121. ds : e
122. ds 8 ss
123. ds o a
124. ds d- d\h'-1'\(ga
125. ds D- D\h'-1'\(hy
126. ds th \o'bp'
127. ds Th \o'LP'
128. ds ae ae
129. ds Ae AE
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "ASN1PARSE 1"
e257b235
PA
135.TH ASN1PARSE 1 "2009-01-11" "0.9.8j" "OpenSSL"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
984263bc 140.SH "NAME"
e3cdf75b 141asn1parse \- ASN.1 parsing tool
984263bc 142.SH "SYNOPSIS"
8b0cefbb
JR
143.IX Header "SYNOPSIS"
144\&\fBopenssl\fR \fBasn1parse\fR
984263bc
MD
145[\fB\-inform PEM|DER\fR]
146[\fB\-in filename\fR]
147[\fB\-out filename\fR]
148[\fB\-noout\fR]
149[\fB\-offset number\fR]
150[\fB\-length number\fR]
151[\fB\-i\fR]
152[\fB\-oid filename\fR]
153[\fB\-strparse offset\fR]
a561f9ff
SS
154[\fB\-genstr string\fR]
155[\fB\-genconf file\fR]
984263bc 156.SH "DESCRIPTION"
8b0cefbb
JR
157.IX Header "DESCRIPTION"
158The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN\s0.1
159structures. It can also be used to extract data from \s-1ASN\s0.1 formatted data.
984263bc 160.SH "OPTIONS"
8b0cefbb
JR
161.IX Header "OPTIONS"
162.IP "\fB\-inform\fR \fBDER|PEM\fR" 4
163.IX Item "-inform DER|PEM"
984263bc
MD
164the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
165encoded.
8b0cefbb
JR
166.IP "\fB\-in filename\fR" 4
167.IX Item "-in filename"
984263bc 168the input file, default is standard input
8b0cefbb
JR
169.IP "\fB\-out filename\fR" 4
170.IX Item "-out filename"
984263bc
MD
171output file to place the \s-1DER\s0 encoded data into. If this
172option is not present then no data will be output. This is most useful when
173combined with the \fB\-strparse\fR option.
8b0cefbb
JR
174.IP "\fB\-noout\fR" 4
175.IX Item "-noout"
984263bc 176don't output the parsed version of the input file.
8b0cefbb
JR
177.IP "\fB\-offset number\fR" 4
178.IX Item "-offset number"
984263bc 179starting offset to begin parsing, default is start of file.
8b0cefbb
JR
180.IP "\fB\-length number\fR" 4
181.IX Item "-length number"
984263bc 182number of bytes to parse, default is until end of file.
8b0cefbb
JR
183.IP "\fB\-i\fR" 4
184.IX Item "-i"
984263bc 185indents the output according to the \*(L"depth\*(R" of the structures.
8b0cefbb
JR
186.IP "\fB\-oid filename\fR" 4
187.IX Item "-oid filename"
984263bc
MD
188a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
189file is described in the \s-1NOTES\s0 section below.
8b0cefbb
JR
190.IP "\fB\-strparse offset\fR" 4
191.IX Item "-strparse offset"
984263bc
MD
192parse the contents octets of the \s-1ASN\s0.1 object starting at \fBoffset\fR. This
193option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
a561f9ff
SS
194.IP "\fB\-genstr string\fR, \fB\-genconf file\fR" 4
195.IX Item "-genstr string, -genconf file"
196generate 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
198is obtained from the default section using the name \fBasn1\fR. The encoded
199data is passed through the \s-1ASN1\s0 parser and printed out as though it came
200from a file, the contents can thus be examined and written to a file
e257b235 201using the \fBout\fR option.
984263bc 202.Sh "\s-1OUTPUT\s0"
8b0cefbb 203.IX Subsection "OUTPUT"
984263bc
MD
204The output will typically contain lines like this:
205.PP
206.Vb 1
8b0cefbb 207\& 0:d=0 hl=4 l= 681 cons: SEQUENCE
984263bc 208.Ve
8b0cefbb 209.PP
984263bc
MD
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
8b0cefbb 222\& 524:d=4 hl=2 l= 12 cons: SEQUENCE
984263bc 223.Ve
8b0cefbb 224.PP
984263bc
MD
225\&.....
226.PP
227This example is part of a self signed certificate. Each line starts with the
8b0cefbb
JR
228offset in decimal. \fBd=XX\fR specifies the current depth. The depth is increased
229within 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
984263bc
MD
231the contents octets.
232.PP
233The \fB\-i\fR option can be used to make the output more readable.
234.PP
e257b235 235Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output.
984263bc
MD
236.PP
237In this example the \s-1BIT\s0 \s-1STRING\s0 at offset 229 is the certificate public key.
238The contents octets of this will contain the public key information. This can
239be 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"
8b0cefbb
JR
247.IX Header "NOTES"
248If an \s-1OID\s0 is not part of OpenSSL's internal table it will be represented in
984263bc
MD
249numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option
250allows additional OIDs to be included. Each line consists of three columns,
8b0cefbb 251the first column is the \s-1OID\s0 in numerical format and should be followed by white
984263bc
MD
252space. The second column is the \*(L"short name\*(R" which is a single word followed
253by white space. The final column is the rest of the line and is the
8b0cefbb 254\&\*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
984263bc 255.PP
8b0cefbb 256\&\f(CW\*(C`1.2.3.4 shortName A long name\*(C'\fR
a561f9ff
SS
257.SH "EXAMPLES"
258.IX Header "EXAMPLES"
259Parse a file:
260.PP
261.Vb 1
e257b235 262\& openssl asn1parse \-in file.pem
a561f9ff
SS
263.Ve
264.PP
265Parse a \s-1DER\s0 file:
266.PP
267.Vb 1
e257b235 268\& openssl asn1parse \-inform DER \-in file.der
a561f9ff
SS
269.Ve
270.PP
271Generate a simple UTF8String:
272.PP
273.Vb 1
e257b235 274\& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq
a561f9ff
SS
275.Ve
276.PP
277Generate and write out a UTF8String, don't print parsed output:
278.PP
279.Vb 1
e257b235 280\& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq \-noout \-out utf8.der
a561f9ff
SS
281.Ve
282.PP
283Generate using a config file:
284.PP
285.Vb 1
e257b235 286\& openssl asn1parse \-genconf asn1.cnf \-noout \-out asn1.der
a561f9ff
SS
287.Ve
288.PP
289Example config file:
290.PP
291.Vb 1
292\& asn1=SEQUENCE:seq_sect
e257b235 293\&
a561f9ff 294\& [seq_sect]
e257b235 295\&
a561f9ff
SS
296\& field1=BOOL:TRUE
297\& field2=EXP:0, UTF8:some random string
298.Ve
984263bc 299.SH "BUGS"
e3cdf75b 300.IX Header "BUGS"
a561f9ff 301There should be options to change the format of output lines. The output of some
8b0cefbb 302\&\s-1ASN\s0.1 types is not well handled (if at all).