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

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:49:37 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 "SESS_ID 1"
 141 .TH SESS_ID 1 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 sess_id \- \s-1SSL/TLS\s0 session handling utility
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 \&\fBopenssl\fR \fBsess_id\fR
 148 [\fB\-inform PEM|DER\fR]
 149 [\fB\-outform PEM|DER\fR]
 150 [\fB\-in filename\fR]
 151 [\fB\-out filename\fR]
 152 [\fB\-text\fR]
 153 [\fB\-noout\fR]
 154 [\fB\-context \s-1ID\s0\fR]
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 The \fBsess_id\fR process the encoded version of the \s-1SSL\s0 session structure
 158 and optionally prints out \s-1SSL\s0 session details (for example the \s-1SSL\s0 session
 159 master key) in human readable format. Since this is a diagnostic tool that
 160 needs some knowledge of the \s-1SSL\s0 protocol to use properly, most users will
 161 not need to use it.
 162 .Ip "\fB\-inform DER|PEM\fR" 4
 163 .IX Item "-inform DER|PEM"
 164 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
 165 format containing session details. The precise format can vary from one version
 166 to the next.  The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR
 167 format base64 encoded with additional header and footer lines.
 168 .Ip "\fB\-outform DER|PEM\fR" 4
 169 .IX Item "-outform DER|PEM"
 170 This specifies the output format, the options have the same meaning as the
 171 \&\fB\-inform\fR option.
 172 .Ip "\fB\-in filename\fR" 4
 173 .IX Item "-in filename"
 174 This specifies the input filename to read session information from or standard
 175 input by default.
 176 .Ip "\fB\-out filename\fR" 4
 177 .IX Item "-out filename"
 178 This specifies the output filename to write session information to or standard
 179 output if this option is not specified.
 180 .Ip "\fB\-text\fR" 4
 181 .IX Item "-text"
 182 prints out the various public or private key components in
 183 plain text in addition to the encoded version.
 184 .Ip "\fB\-cert\fR" 4
 185 .IX Item "-cert"
 186 if a certificate is present in the session it will be output using this option,
 187 if the \fB\-text\fR option is also present then it will be printed out in text form.
 188 .Ip "\fB\-noout\fR" 4
 189 .IX Item "-noout"
 190 this option prevents output of the encoded version of the session.
 191 .Ip "\fB\-context \s-1ID\s0\fR" 4
 192 .IX Item "-context ID"
 193 this option can set the session id so the output session information uses the
 194 supplied \s-1ID\s0. The \s-1ID\s0 can be any string of characters. This option wont normally
 195 be used.
 196 .SH "OUTPUT"
 197 .IX Header "OUTPUT"
 198 Typical output:
 199 .PP
 200 .Vb 10
 201 \& SSL-Session:
 202 \&     Protocol  : TLSv1
 203 \&     Cipher    : 0016
 204 \&     Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
 205 \&     Session-ID-ctx: 01000000
 206 \&     Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
 207 \&     Key-Arg   : None
 208 \&     Start Time: 948459261
 209 \&     Timeout   : 300 (sec)
 210 \&     Verify return code 0 (ok)
 211 .Ve
 212 Theses are described below in more detail.
 213 .Ip "\fBProtocol\fR" 4
 214 .IX Item "Protocol"
 215 this is the protocol in use TLSv1, SSLv3 or SSLv2.
 216 .Ip "\fBCipher\fR" 4
 217 .IX Item "Cipher"
 218 the cipher used this is the actual raw \s-1SSL\s0 or \s-1TLS\s0 cipher code, see the \s-1SSL\s0
 219 or \s-1TLS\s0 specifications for more information.
 220 .Ip "\fBSession-ID\fR" 4
 221 .IX Item "Session-ID"
 222 the \s-1SSL\s0 session \s-1ID\s0 in hex format.
 223 .Ip "\fBSession-ID-ctx\fR" 4
 224 .IX Item "Session-ID-ctx"
 225 the session \s-1ID\s0 context in hex format.
 226 .Ip "\fBMaster-Key\fR" 4
 227 .IX Item "Master-Key"
 228 this is the \s-1SSL\s0 session master key.
 229 .Ip "\fBKey-Arg\fR" 4
 230 .IX Item "Key-Arg"
 231 the key argument, this is only used in \s-1SSL\s0 v2.
 232 .Ip "\fBStart Time\fR" 4
 233 .IX Item "Start Time"
 234 this is the session start time represented as an integer in standard Unix format.
 235 .Ip "\fBTimeout\fR" 4
 236 .IX Item "Timeout"
 237 the timeout in seconds.
 238 .Ip "\fBVerify return code\fR" 4
 239 .IX Item "Verify return code"
 240 this is the return code when an \s-1SSL\s0 client certificate is verified.
 241 .SH "NOTES"
 242 .IX Header "NOTES"
 243 The \s-1PEM\s0 encoded session format uses the header and footer lines:
 244 .PP
 245 .Vb 2
 246 \& -----BEGIN SSL SESSION PARAMETERS-----
 247 \& -----END SSL SESSION PARAMETERS-----
 248 .Ve
 249 Since the \s-1SSL\s0 session output contains the master key it is possible to read the contents
 250 of an encrypted session using this information. Therefore appropriate security precautions
 251 should be taken if the information is being output by a \*(L"real\*(R" application. This is
 252 however strongly discouraged and should only be used for debugging purposes.
 253 .SH "BUGS"
 254 .IX Header "BUGS"
 255 The cipher and start time should be printed out in human readable form.
 256 .SH "SEE ALSO"
 257 .IX Header "SEE ALSO"
 258 ciphers(1), s_server(1)