doc/apps/sess_id.pod

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