xref: /freebsd/secure/usr.bin/openssl/man/openssl-sess_id.1 (revision e1e636193db45630c7881246d25902e57c43d24e)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL-SESS_ID 1ossl"
OPENSSL-SESS_ID 1ossl "2023-09-22" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
openssl-sess_id - SSL/TLS session handling command
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl sess_id [-help] [-inform \s-1DER\s0|\s-1PEM\s0] [-outform \s-1DER\s0|\s-1PEM\s0|\s-1NSS\s0] [-in filename] [-out filename] [-text] [-cert] [-noout] [-context \s-1ID\s0]
"DESCRIPTION"
Header "DESCRIPTION" This command processes the encoded version of the \s-1SSL\s0 session structure and optionally prints out \s-1SSL\s0 session details (for example the \s-1SSL\s0 session master key) in human readable format. Since this is a diagnostic tool that needs some knowledge of the \s-1SSL\s0 protocol to use properly, most users will not need to use it.

The precise format of the data can vary across OpenSSL versions and is not documented.

"OPTIONS"
Header "OPTIONS"
"-help" 4
Item "-help" Print out a usage message.
"-inform \s-1DER\s0|\s-1PEM\s0, -outform \s-1DER\s0|\s-1PEM\s0|\s-1NSS\s0" 4
Item "-inform DER|PEM, -outform DER|PEM|NSS" The input and output formats; the default is \s-1PEM.\s0 See openssl-format-options\|(1) for details. .Sp For \s-1NSS\s0 output, the session \s-1ID\s0 and master key are reported in \s-1NSS\s0 \*(L"keylog\*(R" format.
"-in filename" 4
Item "-in filename" This specifies the input filename to read session information from or standard input by default.
"-out filename" 4
Item "-out filename" This specifies the output filename to write session information to or standard output if this option is not specified.
"-text" 4
Item "-text" Prints out the various public or private key components in plain text in addition to the encoded version.
"-cert" 4
Item "-cert" If a certificate is present in the session it will be output using this option, if the -text option is also present then it will be printed out in text form.
"-noout" 4
Item "-noout" This option prevents output of the encoded version of the session.
"-context \s-1ID\s0" 4
Item "-context ID" This option can set the session id so the output session information uses the supplied \s-1ID.\s0 The \s-1ID\s0 can be any string of characters. This option won't normally be used.
"OUTPUT"
Header "OUTPUT" Typical output:

.Vb 10 SSL-Session: Protocol : TLSv1 Cipher : 0016 Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED Session-ID-ctx: 01000000 Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD Key-Arg : None Start Time: 948459261 Timeout : 300 (sec) Verify return code 0 (ok) .Ve

These are described below in more detail.

"Protocol" 4
Item "Protocol" This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3.
"Cipher" 4
Item "Cipher" The cipher used this is the actual raw \s-1SSL\s0 or \s-1TLS\s0 cipher code, see the \s-1SSL\s0 or \s-1TLS\s0 specifications for more information.
"Session-ID" 4
Item "Session-ID" The \s-1SSL\s0 session \s-1ID\s0 in hex format.
"Session-ID-ctx" 4
Item "Session-ID-ctx" The session \s-1ID\s0 context in hex format.
"Master-Key" 4
Item "Master-Key" This is the \s-1SSL\s0 session master key.
"Start Time" 4
Item "Start Time" This is the session start time represented as an integer in standard Unix format.
"Timeout" 4
Item "Timeout" The timeout in seconds.
"Verify return code" 4
Item "Verify return code" This is the return code when an \s-1SSL\s0 client certificate is verified.
"NOTES"
Header "NOTES" Since the \s-1SSL\s0 session output contains the master key it is possible to read the contents of an encrypted session using this information. Therefore, appropriate security precautions should be taken if the information is being output by a \*(L"real\*(R" application. This is however strongly discouraged and should only be used for debugging purposes.
"BUGS"
Header "BUGS" The cipher and start time should be printed out in human readable form.
"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1), \fBopenssl-ciphers\|(1), \fBopenssl-s_server\|(1)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.