secure/usr.bin/openssl/man/asn1parse.1

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH ASN1PARSE 1 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 asn1parse \- ASN.1 parsing tool
 192 .SH "SYNOPSIS"
 193 \fBopenssl\fR \fBasn1parse\fR
 194 [\fB\-inform PEM|DER\fR]
 195 [\fB\-in filename\fR]
 196 [\fB\-out filename\fR]
 197 [\fB\-noout\fR]
 198 [\fB\-offset number\fR]
 199 [\fB\-length number\fR]
 200 [\fB\-i\fR]
 201 [\fB\-oid filename\fR]
 202 [\fB\-strparse offset\fR]
 203 .SH "DESCRIPTION"
 204 The \fBasn1parse\fR command is a diagnostic utility that can parse ASN.1
 205 structures. It can also be used to extract data from ASN.1 formatted data.
 206 .SH "OPTIONS"
 207 .Ip "\fB\-inform\fR \fB\s-1DER\s0|\s-1PEM\s0\fR" 4
 208 the input format. \fB\s-1DER\s0\fR is binary format and \fB\s-1PEM\s0\fR (the default) is base64
 209 encoded.
 210 .Ip "\fB\-in filename\fR" 4
 211 the input file, default is standard input
 212 .Ip "\fB\-out filename\fR" 4
 213 output file to place the \s-1DER\s0 encoded data into. If this
 214 option is not present then no data will be output. This is most useful when
 215 combined with the \fB\-strparse\fR option.
 216 .Ip "\fB\-noout\fR" 4
 217 don't output the parsed version of the input file.
 218 .Ip "\fB\-offset number\fR" 4
 219 starting offset to begin parsing, default is start of file.
 220 .Ip "\fB\-length number\fR" 4
 221 number of bytes to parse, default is until end of file.
 222 .Ip "\fB\-i\fR" 4
 223 indents the output according to the \*(L"depth\*(R" of the structures.
 224 .Ip "\fB\-oid filename\fR" 4
 225 a file containing additional \s-1OBJECT\s0 IDENTIFIERs (OIDs). The format of this
 226 file is described in the \s-1NOTES\s0 section below.
 227 .Ip "\fB\-strparse offset\fR" 4
 228 parse the contents octets of the \s-1ASN\s0.1 object starting at \fBoffset\fR. This
 229 option can be used multiple times to \*(L"drill down\*(R" into a nested structure.
 230 .Sh "\s-1OUTPUT\s0"
 231 The output will typically contain lines like this:
 232 .PP
 233 .Vb 1
 234 \&  0:d=0  hl=4 l= 681 cons: SEQUENCE
 235 .Ve
 236 \&.....
 237 .PP
 238 .Vb 10
 239 \&  229:d=3  hl=3 l= 141 prim: BIT STRING
 240 \&  373:d=2  hl=3 l= 162 cons: cont [ 3 ]
 241 \&  376:d=3  hl=3 l= 159 cons: SEQUENCE
 242 \&  379:d=4  hl=2 l=  29 cons: SEQUENCE
 243 \&  381:d=5  hl=2 l=   3 prim: OBJECT            :X509v3 Subject Key Identifier
 244 \&  386:d=5  hl=2 l=  22 prim: OCTET STRING
 245 \&  410:d=4  hl=2 l= 112 cons: SEQUENCE
 246 \&  412:d=5  hl=2 l=   3 prim: OBJECT            :X509v3 Authority Key Identifier
 247 \&  417:d=5  hl=2 l= 105 prim: OCTET STRING
 248 \&  524:d=4  hl=2 l=  12 cons: SEQUENCE
 249 .Ve
 250 \&.....
 251 .PP
 252 This example is part of a self signed certificate. Each line starts with the
 253 offset in decimal. \fBd=\s-1XX\s0\fR specifies the current depth. The depth is increased
 254 within the scope of any \s-1SET\s0 or \s-1SEQUENCE\s0. \fBhl=\s-1XX\s0\fR gives the header length
 255 (tag and length octets) of the current type. \fBl=\s-1XX\s0\fR gives the length of
 256 the contents octets.
 257 .PP
 258 The \fB\-i\fR option can be used to make the output more readable.
 259 .PP
 260 Some knowledge of the \s-1ASN\s0.1 structure is needed to interpret the output.
 261 .PP
 262 In this example the \s-1BIT\s0 \s-1STRING\s0 at offset 229 is the certificate public key.
 263 The contents octets of this will contain the public key information. This can
 264 be examined using the option \fB\-strparse 229\fR to yield:
 265 .PP
 266 .Vb 3
 267 \&    0:d=0  hl=3 l= 137 cons: SEQUENCE
 268 \&    3:d=1  hl=3 l= 129 prim: INTEGER           :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897
 269 \&  135:d=1  hl=2 l=   3 prim: INTEGER           :010001
 270 .Ve
 271 .SH "NOTES"
 272 If an OID is not part of OpenSSL's internal table it will be represented in
 273 numerical form (for example 1.2.3.4). The file passed to the \fB\-oid\fR option
 274 allows additional OIDs to be included. Each line consists of three columns,
 275 the first column is the OID in numerical format and should be followed by white
 276 space. The second column is the \*(L"short name\*(R" which is a single word followed
 277 by white space. The final column is the rest of the line and is the
 278 \*(L"long name\*(R". \fBasn1parse\fR displays the long name. Example:
 279 .PP
 280 \f(CW1.2.3.4    shortName       A long name\fR
 281 .SH "BUGS"
 282 There should be options to change the format of input lines. The output of some
 283 ASN.1 types is not well handled (if at all).
 284
 285 .rn }` ''
 286 .IX Title "ASN1PARSE 1"
 287 .IX Name "asn1parse - ASN.1 parsing tool"
 288
 289 .IX Header "NAME"
 290
 291 .IX Header "SYNOPSIS"
 292
 293 .IX Header "DESCRIPTION"
 294
 295 .IX Header "OPTIONS"
 296
 297 .IX Item "\fB\-inform\fR \fB\s-1DER\s0|\s-1PEM\s0\fR"
 298
 299 .IX Item "\fB\-in filename\fR"
 300
 301 .IX Item "\fB\-out filename\fR"
 302
 303 .IX Item "\fB\-noout\fR"
 304
 305 .IX Item "\fB\-offset number\fR"
 306
 307 .IX Item "\fB\-length number\fR"
 308
 309 .IX Item "\fB\-i\fR"
 310
 311 .IX Item "\fB\-oid filename\fR"
 312
 313 .IX Item "\fB\-strparse offset\fR"
 314
 315 .IX Subsection "\s-1OUTPUT\s0"
 316
 317 .IX Header "NOTES"
 318
 319 .IX Header "BUGS"
 320