Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / usr.bin / openssl / man / asn1parse.1
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
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-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
984263bc 41'br\}
8b0cefbb 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
8b0cefbb 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
8b0cefbb
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 54..
8b0cefbb
JR
55. nr % 0
56. rr F
984263bc 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
8b0cefbb
JR
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
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
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'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 107. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
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
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "ASN1PARSE 1"
e3261593 127.TH ASN1PARSE 1 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
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
984263bc 132.SH "NAME"
e3cdf75b 133asn1parse \- ASN.1 parsing tool
984263bc 134.SH "SYNOPSIS"
8b0cefbb
JR
135.IX Header "SYNOPSIS"
136\&\fBopenssl\fR \fBasn1parse\fR
984263bc
MD
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\-strparse offset\fR]
a561f9ff
SS
146[\fB\-genstr string\fR]
147[\fB\-genconf file\fR]
984263bc 148.SH "DESCRIPTION"
8b0cefbb
JR
149.IX Header "DESCRIPTION"
150The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN\s0.1
151structures. It can also be used to extract data from \s-1ASN\s0.1 formatted data.
984263bc 152.SH "OPTIONS"
8b0cefbb
JR
153.IX Header "OPTIONS"
154.IP "\fB\-inform\fR \fBDER|PEM\fR" 4
155.IX Item "-inform DER|PEM"
984263bc
MD
156the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
157encoded.
8b0cefbb
JR
158.IP "\fB\-in filename\fR" 4
159.IX Item "-in filename"
984263bc 160the input file, default is standard input
8b0cefbb
JR
161.IP "\fB\-out filename\fR" 4
162.IX Item "-out filename"
984263bc
MD
163output file to place the \s-1DER\s0 encoded data into. If this
164option is not present then no data will be output. This is most useful when
165combined with the \fB\-strparse\fR option.
8b0cefbb
JR
166.IP "\fB\-noout\fR" 4
167.IX Item "-noout"
984263bc 168don't output the parsed version of the input file.
8b0cefbb
JR
169.IP "\fB\-offset number\fR" 4
170.IX Item "-offset number"
984263bc 171starting offset to begin parsing, default is start of file.
8b0cefbb
JR
172.IP "\fB\-length number\fR" 4
173.IX Item "-length number"
984263bc 174number of bytes to parse, default is until end of file.
8b0cefbb
JR
175.IP "\fB\-i\fR" 4
176.IX Item "-i"
984263bc 177indents the output according to the \*(L"depth\*(R" of the structures.
8b0cefbb
JR
178.IP "\fB\-oid filename\fR" 4
179.IX Item "-oid filename"
984263bc
MD
180a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
181file is described in the \s-1NOTES\s0 section below.
8b0cefbb
JR
182.IP "\fB\-strparse offset\fR" 4
183.IX Item "-strparse offset"
984263bc
MD
184parse the contents octets of the \s-1ASN\s0.1 object starting at \fBoffset\fR. This
185option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
a561f9ff
SS
186.IP "\fB\-genstr string\fR, \fB\-genconf file\fR" 4
187.IX Item "-genstr string, -genconf file"
188generate encoded data based on \fBstring\fR, \fBfile\fR or both using
01185282
PA
189\&\fIASN1_generate_nconf\fR\|(3) format. If \fBfile\fR only is
190present then the string is obtained from the default section using the name
191\&\fBasn1\fR. The encoded data is passed through the \s-1ASN1\s0 parser and printed out as
192though it came from a file, the contents can thus be examined and written to a
193file using the \fBout\fR option.
194.SS "\s-1OUTPUT\s0"
8b0cefbb 195.IX Subsection "OUTPUT"
984263bc
MD
196The output will typically contain lines like this:
197.PP
198.Vb 1
8b0cefbb 199\& 0:d=0 hl=4 l= 681 cons: SEQUENCE
984263bc 200.Ve
8b0cefbb 201.PP
984263bc
MD
202\&.....
203.PP
204.Vb 10
205\& 229:d=3 hl=3 l= 141 prim: BIT STRING
206\& 373:d=2 hl=3 l= 162 cons: cont [ 3 ]
207\& 376:d=3 hl=3 l= 159 cons: SEQUENCE
208\& 379:d=4 hl=2 l= 29 cons: SEQUENCE
209\& 381:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Subject Key Identifier
210\& 386:d=5 hl=2 l= 22 prim: OCTET STRING
211\& 410:d=4 hl=2 l= 112 cons: SEQUENCE
212\& 412:d=5 hl=2 l= 3 prim: OBJECT :X509v3 Authority Key Identifier
213\& 417:d=5 hl=2 l= 105 prim: OCTET STRING
8b0cefbb 214\& 524:d=4 hl=2 l= 12 cons: SEQUENCE
984263bc 215.Ve
8b0cefbb 216.PP
984263bc
MD
217\&.....
218.PP
219This example is part of a self signed certificate. Each line starts with the
8b0cefbb
JR
220offset in decimal. \fBd=XX\fR specifies the current depth. The depth is increased
221within the scope of any \s-1SET\s0 or \s-1SEQUENCE\s0. \fBhl=XX\fR gives the header length
222(tag and length octets) of the current type. \fBl=XX\fR gives the length of
984263bc
MD
223the contents octets.
224.PP
225The \fB\-i\fR option can be used to make the output more readable.
226.PP
e257b235 227Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output.
984263bc
MD
228.PP
229In this example the \s-1BIT\s0 \s-1STRING\s0 at offset 229 is the certificate public key.
230The contents octets of this will contain the public key information. This can
231be examined using the option \fB\-strparse 229\fR to yield:
232.PP
233.Vb 3
234\& 0:d=0 hl=3 l= 137 cons: SEQUENCE
235\& 3:d=1 hl=3 l= 129 prim: INTEGER :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897
236\& 135:d=1 hl=2 l= 3 prim: INTEGER :010001
237.Ve
238.SH "NOTES"
8b0cefbb
JR
239.IX Header "NOTES"
240If an \s-1OID\s0 is not part of OpenSSL's internal table it will be represented in
984263bc
MD
241numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option
242allows additional OIDs to be included. Each line consists of three columns,
8b0cefbb 243the first column is the \s-1OID\s0 in numerical format and should be followed by white
984263bc
MD
244space. The second column is the \*(L"short name\*(R" which is a single word followed
245by white space. The final column is the rest of the line and is the
8b0cefbb 246\&\*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
984263bc 247.PP
8b0cefbb 248\&\f(CW\*(C`1.2.3.4 shortName A long name\*(C'\fR
a561f9ff
SS
249.SH "EXAMPLES"
250.IX Header "EXAMPLES"
251Parse a file:
252.PP
253.Vb 1
e257b235 254\& openssl asn1parse \-in file.pem
a561f9ff
SS
255.Ve
256.PP
257Parse a \s-1DER\s0 file:
258.PP
259.Vb 1
e257b235 260\& openssl asn1parse \-inform DER \-in file.der
a561f9ff
SS
261.Ve
262.PP
263Generate a simple UTF8String:
264.PP
265.Vb 1
e257b235 266\& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq
a561f9ff
SS
267.Ve
268.PP
269Generate and write out a UTF8String, don't print parsed output:
270.PP
271.Vb 1
e257b235 272\& openssl asn1parse \-genstr \*(AqUTF8:Hello World\*(Aq \-noout \-out utf8.der
a561f9ff
SS
273.Ve
274.PP
275Generate using a config file:
276.PP
277.Vb 1
e257b235 278\& openssl asn1parse \-genconf asn1.cnf \-noout \-out asn1.der
a561f9ff
SS
279.Ve
280.PP
281Example config file:
282.PP
283.Vb 1
284\& asn1=SEQUENCE:seq_sect
e257b235 285\&
a561f9ff 286\& [seq_sect]
e257b235 287\&
a561f9ff
SS
288\& field1=BOOL:TRUE
289\& field2=EXP:0, UTF8:some random string
290.Ve
984263bc 291.SH "BUGS"
e3cdf75b 292.IX Header "BUGS"
a561f9ff 293There should be options to change the format of output lines. The output of some
8b0cefbb 294\&\s-1ASN\s0.1 types is not well handled (if at all).
01185282
PA
295.SH "SEE ALSO"
296.IX Header "SEE ALSO"
297\&\fIASN1_generate_nconf\fR\|(3)