Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / usr.bin / openssl / man / sess_id.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "SESS_ID 1"
127 .TH SESS_ID 1 "2012-01-04" "1.0.0f" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 sess_id \- SSL/TLS session handling utility
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBsess_id\fR
137 [\fB\-inform PEM|DER\fR]
138 [\fB\-outform PEM|DER\fR]
139 [\fB\-in filename\fR]
140 [\fB\-out filename\fR]
141 [\fB\-text\fR]
142 [\fB\-noout\fR]
143 [\fB\-context \s-1ID\s0\fR]
144 .SH "DESCRIPTION"
145 .IX Header "DESCRIPTION"
146 The \fBsess_id\fR process the encoded version of the \s-1SSL\s0 session structure
147 and optionally prints out \s-1SSL\s0 session details (for example the \s-1SSL\s0 session
148 master key) in human readable format. Since this is a diagnostic tool that
149 needs some knowledge of the \s-1SSL\s0 protocol to use properly, most users will
150 not need to use it.
151 .IP "\fB\-inform DER|PEM\fR" 4
152 .IX Item "-inform DER|PEM"
153 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
154 format containing session details. The precise format can vary from one version
155 to the next.  The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR
156 format base64 encoded with additional header and footer lines.
157 .IP "\fB\-outform DER|PEM\fR" 4
158 .IX Item "-outform DER|PEM"
159 This specifies the output format, the options have the same meaning as the 
160 \&\fB\-inform\fR option.
161 .IP "\fB\-in filename\fR" 4
162 .IX Item "-in filename"
163 This specifies the input filename to read session information from or standard
164 input by default.
165 .IP "\fB\-out filename\fR" 4
166 .IX Item "-out filename"
167 This specifies the output filename to write session information to or standard
168 output if this option is not specified.
169 .IP "\fB\-text\fR" 4
170 .IX Item "-text"
171 prints out the various public or private key components in
172 plain text in addition to the encoded version.
173 .IP "\fB\-cert\fR" 4
174 .IX Item "-cert"
175 if a certificate is present in the session it will be output using this option,
176 if the \fB\-text\fR option is also present then it will be printed out in text form.
177 .IP "\fB\-noout\fR" 4
178 .IX Item "-noout"
179 this option prevents output of the encoded version of the session.
180 .IP "\fB\-context \s-1ID\s0\fR" 4
181 .IX Item "-context ID"
182 this option can set the session id so the output session information uses the
183 supplied \s-1ID\s0. The \s-1ID\s0 can be any string of characters. This option wont normally
184 be used.
185 .SH "OUTPUT"
186 .IX Header "OUTPUT"
187 Typical output:
188 .PP
189 .Vb 10
190 \& SSL\-Session:
191 \&     Protocol  : TLSv1
192 \&     Cipher    : 0016
193 \&     Session\-ID: 871E62626C554CE95488823752CBD5F3673A3EF3DCE9C67BD916C809914B40ED
194 \&     Session\-ID\-ctx: 01000000
195 \&     Master\-Key: A7CEFC571974BE02CAC305269DC59F76EA9F0B180CB6642697A68251F2D2BB57E51DBBB4C7885573192AE9AEE220FACD
196 \&     Key\-Arg   : None
197 \&     Start Time: 948459261
198 \&     Timeout   : 300 (sec)
199 \&     Verify return code 0 (ok)
200 .Ve
201 .PP
202 Theses are described below in more detail.
203 .IP "\fBProtocol\fR" 4
204 .IX Item "Protocol"
205 this is the protocol in use TLSv1, SSLv3 or SSLv2.
206 .IP "\fBCipher\fR" 4
207 .IX Item "Cipher"
208 the cipher used this is the actual raw \s-1SSL\s0 or \s-1TLS\s0 cipher code, see the \s-1SSL\s0
209 or \s-1TLS\s0 specifications for more information.
210 .IP "\fBSession-ID\fR" 4
211 .IX Item "Session-ID"
212 the \s-1SSL\s0 session \s-1ID\s0 in hex format.
213 .IP "\fBSession-ID-ctx\fR" 4
214 .IX Item "Session-ID-ctx"
215 the session \s-1ID\s0 context in hex format.
216 .IP "\fBMaster-Key\fR" 4
217 .IX Item "Master-Key"
218 this is the \s-1SSL\s0 session master key.
219 .IP "\fBKey-Arg\fR" 4
220 .IX Item "Key-Arg"
221 the key argument, this is only used in \s-1SSL\s0 v2.
222 .IP "\fBStart Time\fR" 4
223 .IX Item "Start Time"
224 this is the session start time represented as an integer in standard Unix format.
225 .IP "\fBTimeout\fR" 4
226 .IX Item "Timeout"
227 the timeout in seconds.
228 .IP "\fBVerify return code\fR" 4
229 .IX Item "Verify return code"
230 this is the return code when an \s-1SSL\s0 client certificate is verified.
231 .SH "NOTES"
232 .IX Header "NOTES"
233 The \s-1PEM\s0 encoded session format uses the header and footer lines:
234 .PP
235 .Vb 2
236 \& \-\-\-\-\-BEGIN SSL SESSION PARAMETERS\-\-\-\-\-
237 \& \-\-\-\-\-END SSL SESSION PARAMETERS\-\-\-\-\-
238 .Ve
239 .PP
240 Since the \s-1SSL\s0 session output contains the master key it is possible to read the contents
241 of an encrypted session using this information. Therefore appropriate security precautions
242 should be taken if the information is being output by a \*(L"real\*(R" application. This is
243 however strongly discouraged and should only be used for debugging purposes.
244 .SH "BUGS"
245 .IX Header "BUGS"
246 The cipher and start time should be printed out in human readable form.
247 .SH "SEE ALSO"
248 .IX Header "SEE ALSO"
249 \&\fIciphers\fR\|(1), \fIs_server\fR\|(1)