| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OPENSSL-SESS_ID 1SSL" |
| 58 |
.TH OPENSSL-SESS_ID 1SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
openssl\-sess_id \- SSL/TLS session handling command |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBopenssl\fR \fBsess_id\fR |
| 68 |
[\fB\-help\fR] |
| 69 |
[\fB\-inform\fR \fBDER\fR|\fBPEM\fR] |
| 70 |
[\fB\-outform\fR \fBDER\fR|\fBPEM\fR|\fBNSS\fR] |
| 71 |
[\fB\-in\fR \fIfilename\fR] |
| 72 |
[\fB\-out\fR \fIfilename\fR] |
| 73 |
[\fB\-text\fR] |
| 74 |
[\fB\-cert\fR] |
| 75 |
[\fB\-noout\fR] |
| 76 |
[\fB\-context\fR \fIID\fR] |
| 77 |
.SH DESCRIPTION |
| 78 |
.IX Header "DESCRIPTION" |
| 79 |
This command processes the encoded version of the SSL session |
| 80 |
structure and optionally prints out SSL session details (for example |
| 81 |
the SSL session master key) in human readable format. Since this is a |
| 82 |
diagnostic tool that needs some knowledge of the SSL protocol to use |
| 83 |
properly, most users will not need to use it. |
| 84 |
.PP |
| 85 |
The precise format of the data can vary across OpenSSL versions and |
| 86 |
is not documented. |
| 87 |
.SH OPTIONS |
| 88 |
.IX Header "OPTIONS" |
| 89 |
.IP \fB\-help\fR 4 |
| 90 |
.IX Item "-help" |
| 91 |
Print out a usage message. |
| 92 |
.IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR, \fB\-outform\fR \fBDER\fR|\fBPEM\fR|\fBNSS\fR" 4 |
| 93 |
.IX Item "-inform DER|PEM, -outform DER|PEM|NSS" |
| 94 |
The input and output formats; the default is PEM. |
| 95 |
See \fBopenssl\-format\-options\fR\|(1) for details. |
| 96 |
.Sp |
| 97 |
For \fBNSS\fR output, the session ID and master key are reported in NSS "keylog" |
| 98 |
format. |
| 99 |
.IP "\fB\-in\fR \fIfilename\fR" 4 |
| 100 |
.IX Item "-in filename" |
| 101 |
This specifies the input filename to read session information from or standard |
| 102 |
input by default. |
| 103 |
.IP "\fB\-out\fR \fIfilename\fR" 4 |
| 104 |
.IX Item "-out filename" |
| 105 |
This specifies the output filename to write session information to or standard |
| 106 |
output if this option is not specified. |
| 107 |
.IP \fB\-text\fR 4 |
| 108 |
.IX Item "-text" |
| 109 |
Prints out the various public or private key components in |
| 110 |
plain text in addition to the encoded version. |
| 111 |
.IP \fB\-cert\fR 4 |
| 112 |
.IX Item "-cert" |
| 113 |
If a certificate is present in the session it will be output using this option, |
| 114 |
if the \fB\-text\fR option is also present then it will be printed out in text form. |
| 115 |
.IP \fB\-noout\fR 4 |
| 116 |
.IX Item "-noout" |
| 117 |
This option prevents output of the encoded version of the session. |
| 118 |
.IP "\fB\-context\fR \fIID\fR" 4 |
| 119 |
.IX Item "-context ID" |
| 120 |
This option can set the session id so the output session information uses the |
| 121 |
supplied ID. The ID can be any string of characters. This option won't normally |
| 122 |
be used. |
| 123 |
.SH OUTPUT |
| 124 |
.IX Header "OUTPUT" |
| 125 |
Typical output: |
| 126 |
.PP |
| 127 |
.Vb 10 |
| 128 |
\& SSL\-Session: |
| 129 |
\& Protocol : TLSv1 |
| 130 |
\& Cipher : 0016 |
| 131 |
\& Session\-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED |
| 132 |
\& Session\-ID\-ctx: 01000000 |
| 133 |
\& Master\-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD |
| 134 |
\& Key\-Arg : None |
| 135 |
\& Start Time: 948459261 |
| 136 |
\& Timeout : 300 (sec) |
| 137 |
\& Verify return code 0 (ok) |
| 138 |
.Ve |
| 139 |
.PP |
| 140 |
These are described below in more detail. |
| 141 |
.IP \fBProtocol\fR 4 |
| 142 |
.IX Item "Protocol" |
| 143 |
This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3. |
| 144 |
.IP \fBCipher\fR 4 |
| 145 |
.IX Item "Cipher" |
| 146 |
The cipher used this is the actual raw SSL or TLS cipher code, see the SSL |
| 147 |
or TLS specifications for more information. |
| 148 |
.IP \fBSession-ID\fR 4 |
| 149 |
.IX Item "Session-ID" |
| 150 |
The SSL session ID in hex format. |
| 151 |
.IP \fBSession-ID-ctx\fR 4 |
| 152 |
.IX Item "Session-ID-ctx" |
| 153 |
The session ID context in hex format. |
| 154 |
.IP \fBMaster-Key\fR 4 |
| 155 |
.IX Item "Master-Key" |
| 156 |
This is the SSL session master key. |
| 157 |
.IP "\fBStart Time\fR" 4 |
| 158 |
.IX Item "Start Time" |
| 159 |
This is the session start time represented as an integer in standard |
| 160 |
Unix format. |
| 161 |
.IP \fBTimeout\fR 4 |
| 162 |
.IX Item "Timeout" |
| 163 |
The timeout in seconds. |
| 164 |
.IP "\fBVerify return code\fR" 4 |
| 165 |
.IX Item "Verify return code" |
| 166 |
This is the return code when an SSL client certificate is verified. |
| 167 |
.SH NOTES |
| 168 |
.IX Header "NOTES" |
| 169 |
Since the SSL session output contains the master key it is |
| 170 |
possible to read the contents of an encrypted session using this |
| 171 |
information. Therefore, appropriate security precautions should be taken if |
| 172 |
the information is being output by a "real" application. This is however |
| 173 |
strongly discouraged and should only be used for debugging purposes. |
| 174 |
.SH BUGS |
| 175 |
.IX Header "BUGS" |
| 176 |
The cipher and start time should be printed out in human readable form. |
| 177 |
.SH "SEE ALSO" |
| 178 |
.IX Header "SEE ALSO" |
| 179 |
\&\fBopenssl\fR\|(1), |
| 180 |
\&\fBopenssl\-ciphers\fR\|(1), |
| 181 |
\&\fBopenssl\-s_server\fR\|(1) |
| 182 |
.SH COPYRIGHT |
| 183 |
.IX Header "COPYRIGHT" |
| 184 |
Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved. |
| 185 |
.PP |
| 186 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 187 |
this file except in compliance with the License. You can obtain a copy |
| 188 |
in the file LICENSE in the source distribution or at |
| 189 |
<https://www.openssl.org/source/license.html>. |