crypto/external/bsd/openssl/lib/libcrypto/man/openssl_asn1parse.1

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