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 =over 4
  28
  29 =item B<-help>
  30
  31 Print out a usage message.
  32
  33 =item B<-inform DER|PEM>
  34
  35 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  36 format containing session details. The precise format can vary from one version
  37 to the next.  The B<PEM> form is the default format: it consists of the B<DER>
  38 format base64 encoded with additional header and footer lines.
  39
  40 =item B<-outform DER|PEM|NSS>
  41
  42 This specifies the output format. The B<PEM> and B<DER> options have the same meaning
  43 as the B<-inform> option. The B<NSS> option outputs the session id and the master key
  44 in NSS keylog format.
  45
  46 =item B<-in filename>
  47
  48 This specifies the input filename to read session information from or standard
  49 input by default.
  50
  51 =item B<-out filename>
  52
  53 This specifies the output filename to write session information to or standard
  54 output if this option is not specified.
  55
  56 =item B<-text>
  57
  58 prints out the various public or private key components in
  59 plain text in addition to the encoded version.
  60
  61 =item B<-cert>
  62
  63 if a certificate is present in the session it will be output using this option,
  64 if the B<-text> option is also present then it will be printed out in text form.
  65
  66 =item B<-noout>
  67
  68 this option prevents output of the encoded version of the session.
  69
  70 =item B<-context ID>
  71
  72 this option can set the session id so the output session information uses the
  73 supplied ID. The ID can be any string of characters. This option wont normally
  74 be used.
  75
  76 =back
  77
  78 =head1 OUTPUT
  79
  80 Typical output:
  81
  82  SSL-Session:
  83      Protocol  : TLSv1
  84      Cipher    : 0016
  85      Session-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
  86      Session-ID-ctx: 01000000
  87      Master-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
  88      Key-Arg   : None
  89      Start Time: 948459261
  90      Timeout   : 300 (sec)
  91      Verify return code 0 (ok)
  92
  93 Theses are described below in more detail.
  94
  95 =over 4
  96
  97 =item B<Protocol>
  98
  99 this is the protocol in use TLSv1.2, TLSv1.1, TLSv1 or SSLv3.
 100
 101 =item B<Cipher>
 102
 103 the cipher used this is the actual raw SSL or TLS cipher code, see the SSL
 104 or TLS specifications for more information.
 105
 106 =item B<Session-ID>
 107
 108 the SSL session ID in hex format.
 109
 110 =item B<Session-ID-ctx>
 111
 112 the session ID context in hex format.
 113
 114 =item B<Master-Key>
 115
 116 this is the SSL session master key.
 117
 118 =item B<Start Time>
 119
 120 this is the session start time represented as an integer in standard Unix format.
 121
 122 =item B<Timeout>
 123
 124 the timeout in seconds.
 125
 126 =item B<Verify return code>
 127
 128 this is the return code when an SSL client certificate is verified.
 129
 130 =back
 131
 132 =head1 NOTES
 133
 134 The PEM encoded session format uses the header and footer lines:
 135
 136  -----BEGIN SSL SESSION PARAMETERS-----
 137  -----END SSL SESSION PARAMETERS-----
 138
 139 Since the SSL session output contains the master key it is possible to read the contents
 140 of an encrypted session using this information. Therefore appropriate security precautions
 141 should be taken if the information is being output by a "real" application. This is
 142 however strongly discouraged and should only be used for debugging purposes.
 143
 144 =head1 BUGS
 145
 146 The cipher and start time should be printed out in human readable form.
 147
 148 =head1 SEE ALSO
 149
 150 L<ciphers(1)>, L<s_server(1)>
 151
 152 =cut
 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