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