Merge from vendor branch GCC:
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_session_cache_mode.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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.  | 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<>.
32 .tr \(*W-|\(bv\*(Tr
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 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
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
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
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'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
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
112 .    \" corrections for vroff
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'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
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
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "SSL_CTX_set_session_cache_mode 3"
132 .TH SSL_CTX_set_session_cache_mode 3 "2006-11-19" "0.9.8d" "OpenSSL"
133 .SH "NAME"
134 SSL_CTX_set_session_cache_mode, SSL_CTX_get_session_cache_mode \- enable/disable session caching
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 1
138 \& #include <openssl/ssl.h>
139 .Ve
140 .PP
141 .Vb 2
142 \& long SSL_CTX_set_session_cache_mode(SSL_CTX ctx, long mode);
143 \& long SSL_CTX_get_session_cache_mode(SSL_CTX ctx);
144 .Ve
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 \&\fISSL_CTX_set_session_cache_mode()\fR enables/disables session caching
148 by setting the operational mode for \fBctx\fR to <mode>.
149 .PP
150 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently used cache mode.
151 .SH "NOTES"
152 .IX Header "NOTES"
153 The OpenSSL library can store/retrieve \s-1SSL/TLS\s0 sessions for later reuse.
154 The sessions can be held in memory for each \fBctx\fR, if more than one
155 \&\s-1SSL_CTX\s0 object is being maintained, the sessions are unique for each \s-1SSL_CTX\s0
156 object.
157 .PP
158 In order to reuse a session, a client must send the session's id to the
159 server. It can only send exactly one id.  The server then either 
160 agrees to reuse the session or it starts a full handshake (to create a new
161 session).
162 .PP
163 A server will lookup up the session in its internal session storage. If the
164 session is not found in internal storage or lookups for the internal storage
165 have been deactivated (\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0), the server will try
166 the external storage if available.
167 .PP
168 Since a client may try to reuse a session intended for use in a different
169 context, the session id context must be set by the server (see
170 \&\fISSL_CTX_set_session_id_context\fR\|(3)).
171 .PP
172 The following session cache modes and modifiers are available:
173 .IP "\s-1SSL_SESS_CACHE_OFF\s0" 4
174 .IX Item "SSL_SESS_CACHE_OFF"
175 No session caching for client or server takes place.
176 .IP "\s-1SSL_SESS_CACHE_CLIENT\s0" 4
177 .IX Item "SSL_SESS_CACHE_CLIENT"
178 Client sessions are added to the session cache. As there is no reliable way
179 for the OpenSSL library to know whether a session should be reused or which
180 session to choose (due to the abstract \s-1BIO\s0 layer the \s-1SSL\s0 engine does not
181 have details about the connection), the application must select the session
182 to be reused by using the \fISSL_set_session\fR\|(3)
183 function. This option is not activated by default.
184 .IP "\s-1SSL_SESS_CACHE_SERVER\s0" 4
185 .IX Item "SSL_SESS_CACHE_SERVER"
186 Server sessions are added to the session cache. When a client proposes a
187 session to be reused, the server looks for the corresponding session in (first)
188 the internal session cache (unless \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 is set),
189 then (second) in the external cache if available. If the session is found, the
190 server will try to reuse the session.  This is the default.
191 .IP "\s-1SSL_SESS_CACHE_BOTH\s0" 4
192 .IX Item "SSL_SESS_CACHE_BOTH"
193 Enable both \s-1SSL_SESS_CACHE_CLIENT\s0 and \s-1SSL_SESS_CACHE_SERVER\s0 at the same time.
194 .IP "\s-1SSL_SESS_CACHE_NO_AUTO_CLEAR\s0" 4
195 .IX Item "SSL_SESS_CACHE_NO_AUTO_CLEAR"
196 Normally the session cache is checked for expired sessions every
197 255 connections using the
198 \&\fISSL_CTX_flush_sessions\fR\|(3) function. Since
199 this may lead to a delay which cannot be controlled, the automatic
200 flushing may be disabled and
201 \&\fISSL_CTX_flush_sessions\fR\|(3) can be called
202 explicitly by the application.
203 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0" 4
204 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_LOOKUP"
205 By setting this flag, session-resume operations in an \s-1SSL/TLS\s0 server will not
206 automatically look up sessions in the internal cache, even if sessions are
207 automatically stored there. If external session caching callbacks are in use,
208 this flag guarantees that all lookups are directed to the external cache.
209 As automatic lookup only applies for \s-1SSL/TLS\s0 servers, the flag has no effect on
210 clients.
211 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0" 4
212 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_STORE"
213 Depending on the presence of \s-1SSL_SESS_CACHE_CLIENT\s0 and/or \s-1SSL_SESS_CACHE_SERVER\s0,
214 sessions negotiated in an \s-1SSL/TLS\s0 handshake may be cached for possible reuse.
215 Normally a new session is added to the internal cache as well as any external
216 session caching (callback) that is configured for the \s-1SSL_CTX\s0. This flag will
217 prevent sessions being stored in the internal cache (though the application can
218 add them manually using \fISSL_CTX_add_session\fR\|(3)). Note:
219 in any \s-1SSL/TLS\s0 servers where external caching is configured, any successful
220 session lookups in the external cache (ie. for session-resume requests) would
221 normally be copied into the local cache before processing continues \- this flag
222 prevents these additions to the internal cache as well.
223 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL\s0" 4
224 .IX Item "SSL_SESS_CACHE_NO_INTERNAL"
225 Enable both \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 and
226 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 at the same time.
227 .PP
228 The default mode is \s-1SSL_SESS_CACHE_SERVER\s0.
229 .SH "RETURN VALUES"
230 .IX Header "RETURN VALUES"
231 \&\fISSL_CTX_set_session_cache_mode()\fR returns the previously set cache mode.
232 .PP
233 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently set cache mode.
234 .SH "SEE ALSO"
235 .IX Header "SEE ALSO"
236 \&\fIssl\fR\|(3), \fISSL_set_session\fR\|(3),
237 \&\fISSL_session_reused\fR\|(3),
238 \&\fISSL_CTX_add_session\fR\|(3),
239 \&\fISSL_CTX_sess_number\fR\|(3),
240 \&\fISSL_CTX_sess_set_cache_size\fR\|(3),
241 \&\fISSL_CTX_sess_set_get_cb\fR\|(3),
242 \&\fISSL_CTX_set_session_id_context\fR\|(3),
243 \&\fISSL_CTX_set_timeout\fR\|(3),
244 \&\fISSL_CTX_flush_sessions\fR\|(3)
245 .SH "HISTORY"
246 .IX Header "HISTORY"
247 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 and \s-1SSL_SESS_CACHE_NO_INTERNAL\s0
248 were introduced in OpenSSL 0.9.6h.