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