Initial import from FreeBSD RELENG_4:
[dragonfly.git] / secure / usr.bin / openssl / man / asn1parse.1
1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:49:31 2003
3 .\"
4 .\" Standard preamble:
5 .\" ======================================================================
6 .de Sh \" Subsection heading
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp \" Vertical space (when we can't use .PP)
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip \" List item
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb \" Begin verbatim text
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve \" End verbatim text
30 .ft R
31
32 .fi
33 ..
34 .\" Set up some character translations and predefined strings.  \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote.  | will give a
37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
40 .tr \(*W-|\(bv\*(Tr
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
42 .ie n \{\
43 .    ds -- \(*W-
44 .    ds PI pi
45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
47 .    ds L" ""
48 .    ds R" ""
49 .    ds C` ""
50 .    ds C' ""
51 'br\}
52 .el\{\
53 .    ds -- \|\(em\|
54 .    ds PI \(*p
55 .    ds L" ``
56 .    ds R" ''
57 'br\}
58 .\"
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
63 .if \nF \{\
64 .    de IX
65 .    tm Index:\\$1\t\\n%\t"\\$2"
66 ..
67 .    nr % 0
68 .    rr F
69 .\}
70 .\"
71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
73 .hy 0
74 .if n .na
75 .\"
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
78 .bd B 3
79 .    \" fudge factors for nroff and troff
80 .if n \{\
81 .    ds #H 0
82 .    ds #V .8m
83 .    ds #F .3m
84 .    ds #[ \f1
85 .    ds #] \fP
86 .\}
87 .if t \{\
88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 .    ds #V .6m
90 .    ds #F 0
91 .    ds #[ \&
92 .    ds #] \&
93 .\}
94 .    \" simple accents for nroff and troff
95 .if n \{\
96 .    ds ' \&
97 .    ds ` \&
98 .    ds ^ \&
99 .    ds , \&
100 .    ds ~ ~
101 .    ds /
102 .\}
103 .if t \{\
104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
110 .\}
111 .    \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 .    \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 .    \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
126 \{\
127 .    ds : e
128 .    ds 8 ss
129 .    ds o a
130 .    ds d- d\h'-1'\(ga
131 .    ds D- D\h'-1'\(hy
132 .    ds th \o'bp'
133 .    ds Th \o'LP'
134 .    ds ae ae
135 .    ds Ae AE
136 .\}
137 .rm #[ #] #H #V #F C
138 .\" ======================================================================
139 .\"
140 .IX Title "ASN1PARSE 1"
141 .TH ASN1PARSE 1 "0.9.7a" "2003-02-19" "OpenSSL"
142 .UC
143 .SH "NAME"
144 asn1parse \- \s-1ASN\s0.1 parsing tool
145 .SH "SYNOPSIS"
146 .IX Header "SYNOPSIS"
147 \&\fBopenssl\fR \fBasn1parse\fR
148 [\fB\-inform PEM|DER\fR]
149 [\fB\-in filename\fR]
150 [\fB\-out filename\fR]
151 [\fB\-noout\fR]
152 [\fB\-offset number\fR]
153 [\fB\-length number\fR]
154 [\fB\-i\fR]
155 [\fB\-oid filename\fR]
156 [\fB\-strparse offset\fR]
157 .SH "DESCRIPTION"
158 .IX Header "DESCRIPTION"
159 The \fBasn1parse\fR command is a diagnostic utility that can parse \s-1ASN\s0.1
160 structures. It can also be used to extract data from \s-1ASN\s0.1 formatted data.
161 .SH "OPTIONS"
162 .IX Header "OPTIONS"
163 .Ip "\fB\-inform\fR \fBDER|PEM\fR" 4
164 .IX Item "-inform DER|PEM"
165 the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
166 encoded.
167 .Ip "\fB\-in filename\fR" 4
168 .IX Item "-in filename"
169 the input file, default is standard input
170 .Ip "\fB\-out filename\fR" 4
171 .IX Item "-out filename"
172 output file to place the \s-1DER\s0 encoded data into. If this
173 option is not present then no data will be output. This is most useful when
174 combined with the \fB\-strparse\fR option.
175 .Ip "\fB\-noout\fR" 4
176 .IX Item "-noout"
177 don't output the parsed version of the input file.
178 .Ip "\fB\-offset number\fR" 4
179 .IX Item "-offset number"
180 starting offset to begin parsing, default is start of file.
181 .Ip "\fB\-length number\fR" 4
182 .IX Item "-length number"
183 number of bytes to parse, default is until end of file.
184 .Ip "\fB\-i\fR" 4
185 .IX Item "-i"
186 indents the output according to the \*(L"depth\*(R" of the structures.
187 .Ip "\fB\-oid filename\fR" 4
188 .IX Item "-oid filename"
189 a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
190 file is described in the \s-1NOTES\s0 section below.
191 .Ip "\fB\-strparse offset\fR" 4
192 .IX Item "-strparse offset"
193 parse the contents octets of the \s-1ASN\s0.1 object starting at \fBoffset\fR. This
194 option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
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 \&.....
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      
214 \&  524:d=4  hl=2 l=  12 cons: SEQUENCE
215 .Ve
216 \&.....
217 .PP
218 This example is part of a self signed certificate. Each line starts with the
219 offset in decimal. \fBd=XX\fR specifies the current depth. The depth is increased
220 within the scope of any \s-1SET\s0 or \s-1SEQUENCE\s0. \fBhl=XX\fR gives the header length
221 (tag and length octets) of the current type. \fBl=XX\fR gives the length of
222 the contents octets.
223 .PP
224 The \fB\-i\fR option can be used to make the output more readable.
225 .PP
226 Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output. 
227 .PP
228 In this example the \s-1BIT\s0 \s-1STRING\s0 at offset 229 is the certificate public key.
229 The contents octets of this will contain the public key information. This can
230 be examined using the option \fB\-strparse 229\fR to yield:
231 .PP
232 .Vb 3
233 \&    0:d=0  hl=3 l= 137 cons: SEQUENCE          
234 \&    3:d=1  hl=3 l= 129 prim: INTEGER           :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897
235 \&  135:d=1  hl=2 l=   3 prim: INTEGER           :010001
236 .Ve
237 .SH "NOTES"
238 .IX Header "NOTES"
239 If an \s-1OID\s0 is not part of OpenSSL's internal table it will be represented in
240 numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option 
241 allows additional OIDs to be included. Each line consists of three columns,
242 the first column is the \s-1OID\s0 in numerical format and should be followed by white
243 space. The second column is the \*(L"short name\*(R" which is a single word followed
244 by white space. The final column is the rest of the line and is the
245 \&\*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
246 .PP
247 \&\f(CW\*(C`1.2.3.4     shortName       A long name\*(C'\fR
248 .SH "BUGS"
249 .IX Header "BUGS"
250 There should be options to change the format of input lines. The output of some
251 \&\s-1ASN\s0.1 types is not well handled (if at all).