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