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