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

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SESS_ID 1"
 132 .TH SESS_ID 1 "2018-11-20" "1.0.2q" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-sess_id,
 139 sess_id \- SSL/TLS session handling utility
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl\fR \fBsess_id\fR
 143 [\fB\-inform PEM|DER\fR]
 144 [\fB\-outform PEM|DER\fR]
 145 [\fB\-in filename\fR]
 146 [\fB\-out filename\fR]
 147 [\fB\-text\fR]
 148 [\fB\-noout\fR]
 149 [\fB\-context \s-1ID\s0\fR]
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 The \fBsess_id\fR process the encoded version of the \s-1SSL\s0 session structure
 153 and optionally prints out \s-1SSL\s0 session details (for example the \s-1SSL\s0 session
 154 master key) in human readable format. Since this is a diagnostic tool that
 155 needs some knowledge of the \s-1SSL\s0 protocol to use properly, most users will
 156 not need to use it.
 157 .IP "\fB\-inform DER|PEM\fR" 4
 158 .IX Item "-inform DER|PEM"
 159 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 160 format containing session details. The precise format can vary from one version
 161 to the next.  The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR
 162 format base64 encoded with additional header and footer lines.
 163 .IP "\fB\-outform DER|PEM\fR" 4
 164 .IX Item "-outform DER|PEM"
 165 This specifies the output format, the options have the same meaning as the
 166 \&\fB\-inform\fR option.
 167 .IP "\fB\-in filename\fR" 4
 168 .IX Item "-in filename"
 169 This specifies the input filename to read session information from or standard
 170 input by default.
 171 .IP "\fB\-out filename\fR" 4
 172 .IX Item "-out filename"
 173 This specifies the output filename to write session information to or standard
 174 output if this option is not specified.
 175 .IP "\fB\-text\fR" 4
 176 .IX Item "-text"
 177 prints out the various public or private key components in
 178 plain text in addition to the encoded version.
 179 .IP "\fB\-cert\fR" 4
 180 .IX Item "-cert"
 181 if a certificate is present in the session it will be output using this option,
 182 if the \fB\-text\fR option is also present then it will be printed out in text form.
 183 .IP "\fB\-noout\fR" 4
 184 .IX Item "-noout"
 185 this option prevents output of the encoded version of the session.
 186 .IP "\fB\-context \s-1ID\s0\fR" 4
 187 .IX Item "-context ID"
 188 this option can set the session id so the output session information uses the
 189 supplied \s-1ID.\s0 The \s-1ID\s0 can be any string of characters. This option wont normally
 190 be used.
 191 .SH "OUTPUT"
 192 .IX Header "OUTPUT"
 193 Typical output:
 194 .PP
 195 .Vb 10
 196 \& SSL\-Session:
 197 \&     Protocol  : TLSv1
 198 \&     Cipher    : 0016
 199 \&     Session\-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
 200 \&     Session\-ID\-ctx: 01000000
 201 \&     Master\-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
 202 \&     Key\-Arg   : None
 203 \&     Start Time: 948459261
 204 \&     Timeout   : 300 (sec)
 205 \&     Verify return code 0 (ok)
 206 .Ve
 207 .PP
 208 Theses are described below in more detail.
 209 .IP "\fBProtocol\fR" 4
 210 .IX Item "Protocol"
 211 this is the protocol in use TLSv1, SSLv3 or SSLv2.
 212 .IP "\fBCipher\fR" 4
 213 .IX Item "Cipher"
 214 the cipher used this is the actual raw \s-1SSL\s0 or \s-1TLS\s0 cipher code, see the \s-1SSL\s0
 215 or \s-1TLS\s0 specifications for more information.
 216 .IP "\fBSession-ID\fR" 4
 217 .IX Item "Session-ID"
 218 the \s-1SSL\s0 session \s-1ID\s0 in hex format.
 219 .IP "\fBSession-ID-ctx\fR" 4
 220 .IX Item "Session-ID-ctx"
 221 the session \s-1ID\s0 context in hex format.
 222 .IP "\fBMaster-Key\fR" 4
 223 .IX Item "Master-Key"
 224 this is the \s-1SSL\s0 session master key.
 225 .IP "\fBKey-Arg\fR" 4
 226 .IX Item "Key-Arg"
 227 the key argument, this is only used in \s-1SSL\s0 v2.
 228 .IP "\fBStart Time\fR" 4
 229 .IX Item "Start Time"
 230 this is the session start time represented as an integer in standard Unix format.
 231 .IP "\fBTimeout\fR" 4
 232 .IX Item "Timeout"
 233 the timeout in seconds.
 234 .IP "\fBVerify return code\fR" 4
 235 .IX Item "Verify return code"
 236 this is the return code when an \s-1SSL\s0 client certificate is verified.
 237 .SH "NOTES"
 238 .IX Header "NOTES"
 239 The \s-1PEM\s0 encoded session format uses the header and footer lines:
 240 .PP
 241 .Vb 2
 242 \& \-\-\-\-\-BEGIN SSL SESSION PARAMETERS\-\-\-\-\-
 243 \& \-\-\-\-\-END SSL SESSION PARAMETERS\-\-\-\-\-
 244 .Ve
 245 .PP
 246 Since the \s-1SSL\s0 session output contains the master key it is possible to read the contents
 247 of an encrypted session using this information. Therefore appropriate security precautions
 248 should be taken if the information is being output by a \*(L"real\*(R" application. This is
 249 however strongly discouraged and should only be used for debugging purposes.
 250 .SH "BUGS"
 251 .IX Header "BUGS"
 252 The cipher and start time should be printed out in human readable form.
 253 .SH "SEE ALSO"
 254 .IX Header "SEE ALSO"
 255 \&\fIciphers\fR\|(1), \fIs_server\fR\|(1)