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

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