doc/apps/sess_id.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 sess_id - SSL/TLS session handling utility
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<sess_id>
  11 [B<-help>]
  12 [B<-inform PEM|DER>]
  13 [B<-outform PEM|DER|NSS>]
  14 [B<-in filename>]
  15 [B<-out filename>]
  16 [B<-text>]
  17 [B<-noout>]
  18 [B<-context ID>]
  19
  20 =head1 DESCRIPTION
  21
  22 The B<sess_id> process the encoded version of the SSL session structure
  23 and optionally prints out SSL session details (for example the SSL session
  24 master key) in human readable format. Since this is a diagnostic tool that
  25 needs some knowledge of the SSL protocol to use properly, most users will
  26 not need to use it.
  27
  28 =over 4
  29
  30 =item B<-help>
  31
  32 Print out a usage message.
  33
  34 =item B<-inform DER|PEM>
  35
  36 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  37 format containing session details. The precise format can vary from one version
  38 to the next.  The B<PEM> form is the default format: it consists of the B<DER>
  39 format base64 encoded with additional header and footer lines.
  40
  41 =item B<-outform DER|PEM|NSS>
  42
  43 This specifies the output format. The B<PEM> and B<DER> options have the same meaning
  44 as the B<-inform> option. The B<NSS> option outputs the session id and the master key
  45 in NSS keylog format.
  46
  47 =item B<-in filename>
  48
  49 This specifies the input filename to read session information from or standard
  50 input by default.
  51
  52 =item B<-out 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 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 wont 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.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 Unix format.
 122
 123 =item B<Timeout>
 124
 125 the timeout in seconds.
 126
 127 =item B<Verify return code>
 128
 129 this is the return code when an SSL client certificate is verified.
 130
 131 =back
 132
 133 =head1 NOTES
 134
 135 The PEM encoded session format uses the header and footer lines:
 136
 137  -----BEGIN SSL SESSION PARAMETERS-----
 138  -----END SSL SESSION PARAMETERS-----
 139
 140 Since the SSL session output contains the master key it is possible to read the contents
 141 of an encrypted session using this information. Therefore appropriate security precautions
 142 should be taken if the information is being output by a "real" application. This is
 143 however strongly discouraged and should only be used for debugging purposes.
 144
 145 =head1 BUGS
 146
 147 The cipher and start time should be printed out in human readable form.
 148
 149 =head1 SEE ALSO
 150
 151 L<ciphers(1)>, L<s_server(1)>
 152
 153 =cut