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

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