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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .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 "2020-04-21" "1.1.1g" "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 openssl\-sess_id, sess_id \- SSL/TLS session handling utility
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBsess_id\fR
 146 [\fB\-help\fR]
 147 [\fB\-inform PEM|DER\fR]
 148 [\fB\-outform PEM|DER|NSS\fR]
 149 [\fB\-in filename\fR]
 150 [\fB\-out filename\fR]
 151 [\fB\-text\fR]
 152 [\fB\-noout\fR]
 153 [\fB\-context \s-1ID\s0\fR]
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 The \fBsess_id\fR process the encoded version of the \s-1SSL\s0 session structure
 157 and optionally prints out \s-1SSL\s0 session details (for example the \s-1SSL\s0 session
 158 master key) in human readable format. Since this is a diagnostic tool that
 159 needs some knowledge of the \s-1SSL\s0 protocol to use properly, most users will
 160 not need to use it.
 161 .SH "OPTIONS"
 162 .IX Header "OPTIONS"
 163 .IP "\fB\-help\fR" 4
 164 .IX Item "-help"
 165 Print out a usage message.
 166 .IP "\fB\-inform DER|PEM\fR" 4
 167 .IX Item "-inform DER|PEM"
 168 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 169 format containing session details. The precise format can vary from one version
 170 to the next.  The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR
 171 format base64 encoded with additional header and footer lines.
 172 .IP "\fB\-outform DER|PEM|NSS\fR" 4
 173 .IX Item "-outform DER|PEM|NSS"
 174 This specifies the output format. The \fB\s-1PEM\s0\fR and \fB\s-1DER\s0\fR options have the same meaning
 175 and default as the \fB\-inform\fR option. The \fB\s-1NSS\s0\fR option outputs the session id and
 176 the master key in \s-1NSS\s0 keylog format.
 177 .IP "\fB\-in filename\fR" 4
 178 .IX Item "-in filename"
 179 This specifies the input filename to read session information from or standard
 180 input by default.
 181 .IP "\fB\-out filename\fR" 4
 182 .IX Item "-out filename"
 183 This specifies the output filename to write session information to or standard
 184 output if this option is not specified.
 185 .IP "\fB\-text\fR" 4
 186 .IX Item "-text"
 187 Prints out the various public or private key components in
 188 plain text in addition to the encoded version.
 189 .IP "\fB\-cert\fR" 4
 190 .IX Item "-cert"
 191 If a certificate is present in the session it will be output using this option,
 192 if the \fB\-text\fR option is also present then it will be printed out in text form.
 193 .IP "\fB\-noout\fR" 4
 194 .IX Item "-noout"
 195 This option prevents output of the encoded version of the session.
 196 .IP "\fB\-context \s-1ID\s0\fR" 4
 197 .IX Item "-context ID"
 198 This option can set the session id so the output session information uses the
 199 supplied \s-1ID.\s0 The \s-1ID\s0 can be any string of characters. This option won't normally
 200 be used.
 201 .SH "OUTPUT"
 202 .IX Header "OUTPUT"
 203 Typical output:
 204 .PP
 205 .Vb 10
 206 \& SSL\-Session:
 207 \&     Protocol  : TLSv1
 208 \&     Cipher    : 0016
 209 \&     Session\-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
 210 \&     Session\-ID\-ctx: 01000000
 211 \&     Master\-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
 212 \&     Key\-Arg   : None
 213 \&     Start Time: 948459261
 214 \&     Timeout   : 300 (sec)
 215 \&     Verify return code 0 (ok)
 216 .Ve
 217 .PP
 218 These are described below in more detail.
 219 .IP "\fBProtocol\fR" 4
 220 .IX Item "Protocol"
 221 This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3.
 222 .IP "\fBCipher\fR" 4
 223 .IX Item "Cipher"
 224 The cipher used this is the actual raw \s-1SSL\s0 or \s-1TLS\s0 cipher code, see the \s-1SSL\s0
 225 or \s-1TLS\s0 specifications for more information.
 226 .IP "\fBSession-ID\fR" 4
 227 .IX Item "Session-ID"
 228 The \s-1SSL\s0 session \s-1ID\s0 in hex format.
 229 .IP "\fBSession-ID-ctx\fR" 4
 230 .IX Item "Session-ID-ctx"
 231 The session \s-1ID\s0 context in hex format.
 232 .IP "\fBMaster-Key\fR" 4
 233 .IX Item "Master-Key"
 234 This is the \s-1SSL\s0 session master key.
 235 .IP "\fBStart Time\fR" 4
 236 .IX Item "Start Time"
 237 This is the session start time represented as an integer in standard
 238 Unix format.
 239 .IP "\fBTimeout\fR" 4
 240 .IX Item "Timeout"
 241 The timeout in seconds.
 242 .IP "\fBVerify return code\fR" 4
 243 .IX Item "Verify return code"
 244 This is the return code when an \s-1SSL\s0 client certificate is verified.
 245 .SH "NOTES"
 246 .IX Header "NOTES"
 247 The \s-1PEM\s0 encoded session format uses the header and footer lines:
 248 .PP
 249 .Vb 2
 250 \& \-\-\-\-\-BEGIN SSL SESSION PARAMETERS\-\-\-\-\-
 251 \& \-\-\-\-\-END SSL SESSION PARAMETERS\-\-\-\-\-
 252 .Ve
 253 .PP
 254 Since the \s-1SSL\s0 session output contains the master key it is
 255 possible to read the contents of an encrypted session using this
 256 information. Therefore appropriate security precautions should be taken if
 257 the information is being output by a \*(L"real\*(R" application. This is however
 258 strongly discouraged and should only be used for debugging purposes.
 259 .SH "BUGS"
 260 .IX Header "BUGS"
 261 The cipher and start time should be printed out in human readable form.
 262 .SH "SEE ALSO"
 263 .IX Header "SEE ALSO"
 264 \&\fBciphers\fR\|(1), \fBs_server\fR\|(1)
 265 .SH "COPYRIGHT"
 266 .IX Header "COPYRIGHT"
 267 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
 268 .PP
 269 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 270 this file except in compliance with the License.  You can obtain a copy
 271 in the file \s-1LICENSE\s0 in the source distribution or at
 272 <https://www.openssl.org/source/license.html>.