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