doc/man1/openssl-sess_id.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-sess_id - SSL/TLS session handling utility
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<sess_id>
  10 [B<-help>]
  11 [B<-inform> B<DER>|B<PEM>]
  12 [B<-outform> B<DER>|B<PEM>|B<NSS>]
  13 [B<-in> I<filename>]
  14 [B<-out> I<filename>]
  15 [B<-text>]
  16 [B<-cert>]
  17 [B<-noout>]
  18 [B<-context> I<ID>]
  19
  20 =head1 DESCRIPTION
  21
  22 This command processes the encoded version of the SSL session
  23 structure and optionally prints out SSL session details (for example
  24 the SSL session master key) in human readable format. Since this is a
  25 diagnostic tool that needs some knowledge of the SSL protocol to use
  26 properly, most users will not need to use it.
  27
  28 The precise format of the data can vary across OpenSSL versions and
  29 is not documented.
  30
  31 =head1 OPTIONS
  32
  33 =over 4
  34
  35 =item B<-help>
  36
  37 Print out a usage message.
  38
  39 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>|B<NSS>
  40
  41 The input and output formats; the default is PEM.
  42 See L<openssl(1)/Format Options> for details.
  43
  44 For B<NSS> output, the session ID and master key are reported in NSS "keylog"
  45 format.
  46
  47 =item B<-in> I<filename>
  48
  49 This specifies the input filename to read session information from or standard
  50 input by default.
  51
  52 =item B<-out> I<filename>
  53
  54 This specifies the output filename to write session information to or standard
  55 output if this option is not specified.
  56
  57 =item B<-text>
  58
  59 Prints out the various public or private key components in
  60 plain text in addition to the encoded version.
  61
  62 =item B<-cert>
  63
  64 If a certificate is present in the session it will be output using this option,
  65 if the B<-text> option is also present then it will be printed out in text form.
  66
  67 =item B<-noout>
  68
  69 This option prevents output of the encoded version of the session.
  70
  71 =item B<-context> I<ID>
  72
  73 This option can set the session id so the output session information uses the
  74 supplied ID. The ID can be any string of characters. This option won't normally
  75 be used.
  76
  77 =back
  78
  79 =head1 OUTPUT
  80
  81 Typical output:
  82
  83  SSL-Session:
  84      Protocol  : TLSv1
  85      Cipher    : 0016
  86      Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
  87      Session-ID-ctx: 01000000
  88      Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
  89      Key-Arg   : None
  90      Start Time: 948459261
  91      Timeout   : 300 (sec)
  92      Verify return code 0 (ok)
  93
  94 Theses are described below in more detail.
  95
  96 =over 4
  97
  98 =item B<Protocol>
  99
 100 This is the protocol in use TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 or SSLv3.
 101
 102 =item B<Cipher>
 103
 104 The cipher used this is the actual raw SSL or TLS cipher code, see the SSL
 105 or TLS specifications for more information.
 106
 107 =item B<Session-ID>
 108
 109 The SSL session ID in hex format.
 110
 111 =item B<Session-ID-ctx>
 112
 113 The session ID context in hex format.
 114
 115 =item B<Master-Key>
 116
 117 This is the SSL session master key.
 118
 119 =item B<Start Time>
 120
 121 This is the session start time represented as an integer in standard
 122 Unix format.
 123
 124 =item B<Timeout>
 125
 126 The timeout in seconds.
 127
 128 =item B<Verify return code>
 129
 130 This is the return code when an SSL client certificate is verified.
 131
 132 =back
 133
 134 =head1 NOTES
 135
 136 Since the SSL session output contains the master key it is
 137 possible to read the contents of an encrypted session using this
 138 information. Therefore appropriate security precautions should be taken if
 139 the information is being output by a "real" application. This is however
 140 strongly discouraged and should only be used for debugging purposes.
 141
 142 =head1 BUGS
 143
 144 The cipher and start time should be printed out in human readable form.
 145
 146 =head1 SEE ALSO
 147
 148 L<openssl(1)>,
 149 L<openssl-ciphers(1)>,
 150 L<openssl-s_server(1)>
 151
 152 =head1 COPYRIGHT
 153
 154 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 155
 156 Licensed under the Apache License 2.0 (the "License").  You may not use
 157 this file except in compliance with the License.  You can obtain a copy
 158 in the file LICENSE in the source distribution or at
 159 L<https://www.openssl.org/source/license.html>.
 160
 161 =cut