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