Merge from vendor branch BZIP:
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_session_cache_mode.3
1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
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.  \*(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-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
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"
58 ..
59 .    nr % 0
60 .    rr F
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 "SSL_CTX_set_session_cache_mode 3"
127 .TH SSL_CTX_set_session_cache_mode 3 "2007-10-24" "0.9.8g" "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 SSL_CTX_set_session_cache_mode, SSL_CTX_get_session_cache_mode \- enable/disable session caching
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/ssl.h>
138 \&
139 \& long SSL_CTX_set_session_cache_mode(SSL_CTX ctx, long mode);
140 \& long SSL_CTX_get_session_cache_mode(SSL_CTX ctx);
141 .Ve
142 .SH "DESCRIPTION"
143 .IX Header "DESCRIPTION"
144 \&\fISSL_CTX_set_session_cache_mode()\fR enables/disables session caching
145 by setting the operational mode for \fBctx\fR to <mode>.
146 .PP
147 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently used cache mode.
148 .SH "NOTES"
149 .IX Header "NOTES"
150 The OpenSSL library can store/retrieve \s-1SSL/TLS\s0 sessions for later reuse.
151 The sessions can be held in memory for each \fBctx\fR, if more than one
152 \&\s-1SSL_CTX\s0 object is being maintained, the sessions are unique for each \s-1SSL_CTX\s0
153 object.
154 .PP
155 In order to reuse a session, a client must send the session's id to the
156 server. It can only send exactly one id.  The server then either 
157 agrees to reuse the session or it starts a full handshake (to create a new
158 session).
159 .PP
160 A server will lookup up the session in its internal session storage. If the
161 session is not found in internal storage or lookups for the internal storage
162 have been deactivated (\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0), the server will try
163 the external storage if available.
164 .PP
165 Since a client may try to reuse a session intended for use in a different
166 context, the session id context must be set by the server (see
167 \&\fISSL_CTX_set_session_id_context\fR\|(3)).
168 .PP
169 The following session cache modes and modifiers are available:
170 .IP "\s-1SSL_SESS_CACHE_OFF\s0" 4
171 .IX Item "SSL_SESS_CACHE_OFF"
172 No session caching for client or server takes place.
173 .IP "\s-1SSL_SESS_CACHE_CLIENT\s0" 4
174 .IX Item "SSL_SESS_CACHE_CLIENT"
175 Client sessions are added to the session cache. As there is no reliable way
176 for the OpenSSL library to know whether a session should be reused or which
177 session to choose (due to the abstract \s-1BIO\s0 layer the \s-1SSL\s0 engine does not
178 have details about the connection), the application must select the session
179 to be reused by using the \fISSL_set_session\fR\|(3)
180 function. This option is not activated by default.
181 .IP "\s-1SSL_SESS_CACHE_SERVER\s0" 4
182 .IX Item "SSL_SESS_CACHE_SERVER"
183 Server sessions are added to the session cache. When a client proposes a
184 session to be reused, the server looks for the corresponding session in (first)
185 the internal session cache (unless \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 is set),
186 then (second) in the external cache if available. If the session is found, the
187 server will try to reuse the session.  This is the default.
188 .IP "\s-1SSL_SESS_CACHE_BOTH\s0" 4
189 .IX Item "SSL_SESS_CACHE_BOTH"
190 Enable both \s-1SSL_SESS_CACHE_CLIENT\s0 and \s-1SSL_SESS_CACHE_SERVER\s0 at the same time.
191 .IP "\s-1SSL_SESS_CACHE_NO_AUTO_CLEAR\s0" 4
192 .IX Item "SSL_SESS_CACHE_NO_AUTO_CLEAR"
193 Normally the session cache is checked for expired sessions every
194 255 connections using the
195 \&\fISSL_CTX_flush_sessions\fR\|(3) function. Since
196 this may lead to a delay which cannot be controlled, the automatic
197 flushing may be disabled and
198 \&\fISSL_CTX_flush_sessions\fR\|(3) can be called
199 explicitly by the application.
200 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0" 4
201 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_LOOKUP"
202 By setting this flag, session-resume operations in an \s-1SSL/TLS\s0 server will not
203 automatically look up sessions in the internal cache, even if sessions are
204 automatically stored there. If external session caching callbacks are in use,
205 this flag guarantees that all lookups are directed to the external cache.
206 As automatic lookup only applies for \s-1SSL/TLS\s0 servers, the flag has no effect on
207 clients.
208 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0" 4
209 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_STORE"
210 Depending on the presence of \s-1SSL_SESS_CACHE_CLIENT\s0 and/or \s-1SSL_SESS_CACHE_SERVER\s0,
211 sessions negotiated in an \s-1SSL/TLS\s0 handshake may be cached for possible reuse.
212 Normally a new session is added to the internal cache as well as any external
213 session caching (callback) that is configured for the \s-1SSL_CTX\s0. This flag will
214 prevent sessions being stored in the internal cache (though the application can
215 add them manually using \fISSL_CTX_add_session\fR\|(3)). Note:
216 in any \s-1SSL/TLS\s0 servers where external caching is configured, any successful
217 session lookups in the external cache (ie. for session-resume requests) would
218 normally be copied into the local cache before processing continues \- this flag
219 prevents these additions to the internal cache as well.
220 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL\s0" 4
221 .IX Item "SSL_SESS_CACHE_NO_INTERNAL"
222 Enable both \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 and
223 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 at the same time.
224 .PP
225 The default mode is \s-1SSL_SESS_CACHE_SERVER\s0.
226 .SH "RETURN VALUES"
227 .IX Header "RETURN VALUES"
228 \&\fISSL_CTX_set_session_cache_mode()\fR returns the previously set cache mode.
229 .PP
230 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently set cache mode.
231 .SH "SEE ALSO"
232 .IX Header "SEE ALSO"
233 \&\fIssl\fR\|(3), \fISSL_set_session\fR\|(3),
234 \&\fISSL_session_reused\fR\|(3),
235 \&\fISSL_CTX_add_session\fR\|(3),
236 \&\fISSL_CTX_sess_number\fR\|(3),
237 \&\fISSL_CTX_sess_set_cache_size\fR\|(3),
238 \&\fISSL_CTX_sess_set_get_cb\fR\|(3),
239 \&\fISSL_CTX_set_session_id_context\fR\|(3),
240 \&\fISSL_CTX_set_timeout\fR\|(3),
241 \&\fISSL_CTX_flush_sessions\fR\|(3)
242 .SH "HISTORY"
243 .IX Header "HISTORY"
244 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 and \s-1SSL_SESS_CACHE_NO_INTERNAL\s0
245 were introduced in OpenSSL 0.9.6h.