076f4c40ce966ce4f68ad37f92080ec4d08b3922
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_session_cache_mode.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "SSL_CTX_set_session_cache_mode 3"
136 .TH SSL_CTX_set_session_cache_mode 3 "2015-06-12" "1.0.1o" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 SSL_CTX_set_session_cache_mode, SSL_CTX_get_session_cache_mode \- enable/disable session caching
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/ssl.h>
147 \&
148 \& long SSL_CTX_set_session_cache_mode(SSL_CTX ctx, long mode);
149 \& long SSL_CTX_get_session_cache_mode(SSL_CTX ctx);
150 .Ve
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 \&\fISSL_CTX_set_session_cache_mode()\fR enables/disables session caching
154 by setting the operational mode for \fBctx\fR to <mode>.
155 .PP
156 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently used cache mode.
157 .SH "NOTES"
158 .IX Header "NOTES"
159 The OpenSSL library can store/retrieve \s-1SSL/TLS\s0 sessions for later reuse.
160 The sessions can be held in memory for each \fBctx\fR, if more than one
161 \&\s-1SSL_CTX\s0 object is being maintained, the sessions are unique for each \s-1SSL_CTX\s0
162 object.
163 .PP
164 In order to reuse a session, a client must send the session's id to the
165 server. It can only send exactly one id.  The server then either 
166 agrees to reuse the session or it starts a full handshake (to create a new
167 session).
168 .PP
169 A server will lookup up the session in its internal session storage. If the
170 session is not found in internal storage or lookups for the internal storage
171 have been deactivated (\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0), the server will try
172 the external storage if available.
173 .PP
174 Since a client may try to reuse a session intended for use in a different
175 context, the session id context must be set by the server (see
176 \&\fISSL_CTX_set_session_id_context\fR\|(3)).
177 .PP
178 The following session cache modes and modifiers are available:
179 .IP "\s-1SSL_SESS_CACHE_OFF\s0" 4
180 .IX Item "SSL_SESS_CACHE_OFF"
181 No session caching for client or server takes place.
182 .IP "\s-1SSL_SESS_CACHE_CLIENT\s0" 4
183 .IX Item "SSL_SESS_CACHE_CLIENT"
184 Client sessions are added to the session cache. As there is no reliable way
185 for the OpenSSL library to know whether a session should be reused or which
186 session to choose (due to the abstract \s-1BIO\s0 layer the \s-1SSL\s0 engine does not
187 have details about the connection), the application must select the session
188 to be reused by using the \fISSL_set_session\fR\|(3)
189 function. This option is not activated by default.
190 .IP "\s-1SSL_SESS_CACHE_SERVER\s0" 4
191 .IX Item "SSL_SESS_CACHE_SERVER"
192 Server sessions are added to the session cache. When a client proposes a
193 session to be reused, the server looks for the corresponding session in (first)
194 the internal session cache (unless \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 is set),
195 then (second) in the external cache if available. If the session is found, the
196 server will try to reuse the session.  This is the default.
197 .IP "\s-1SSL_SESS_CACHE_BOTH\s0" 4
198 .IX Item "SSL_SESS_CACHE_BOTH"
199 Enable both \s-1SSL_SESS_CACHE_CLIENT\s0 and \s-1SSL_SESS_CACHE_SERVER\s0 at the same time.
200 .IP "\s-1SSL_SESS_CACHE_NO_AUTO_CLEAR\s0" 4
201 .IX Item "SSL_SESS_CACHE_NO_AUTO_CLEAR"
202 Normally the session cache is checked for expired sessions every
203 255 connections using the
204 \&\fISSL_CTX_flush_sessions\fR\|(3) function. Since
205 this may lead to a delay which cannot be controlled, the automatic
206 flushing may be disabled and
207 \&\fISSL_CTX_flush_sessions\fR\|(3) can be called
208 explicitly by the application.
209 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0" 4
210 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_LOOKUP"
211 By setting this flag, session-resume operations in an \s-1SSL/TLS\s0 server will not
212 automatically look up sessions in the internal cache, even if sessions are
213 automatically stored there. If external session caching callbacks are in use,
214 this flag guarantees that all lookups are directed to the external cache.
215 As automatic lookup only applies for \s-1SSL/TLS\s0 servers, the flag has no effect on
216 clients.
217 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0" 4
218 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_STORE"
219 Depending on the presence of \s-1SSL_SESS_CACHE_CLIENT\s0 and/or \s-1SSL_SESS_CACHE_SERVER,\s0
220 sessions negotiated in an \s-1SSL/TLS\s0 handshake may be cached for possible reuse.
221 Normally a new session is added to the internal cache as well as any external
222 session caching (callback) that is configured for the \s-1SSL_CTX.\s0 This flag will
223 prevent sessions being stored in the internal cache (though the application can
224 add them manually using \fISSL_CTX_add_session\fR\|(3)). Note:
225 in any \s-1SSL/TLS\s0 servers where external caching is configured, any successful
226 session lookups in the external cache (ie. for session-resume requests) would
227 normally be copied into the local cache before processing continues \- this flag
228 prevents these additions to the internal cache as well.
229 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL\s0" 4
230 .IX Item "SSL_SESS_CACHE_NO_INTERNAL"
231 Enable both \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 and
232 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 at the same time.
233 .PP
234 The default mode is \s-1SSL_SESS_CACHE_SERVER.\s0
235 .SH "RETURN VALUES"
236 .IX Header "RETURN VALUES"
237 \&\fISSL_CTX_set_session_cache_mode()\fR returns the previously set cache mode.
238 .PP
239 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently set cache mode.
240 .SH "SEE ALSO"
241 .IX Header "SEE ALSO"
242 \&\fIssl\fR\|(3), \fISSL_set_session\fR\|(3),
243 \&\fISSL_session_reused\fR\|(3),
244 \&\fISSL_CTX_add_session\fR\|(3),
245 \&\fISSL_CTX_sess_number\fR\|(3),
246 \&\fISSL_CTX_sess_set_cache_size\fR\|(3),
247 \&\fISSL_CTX_sess_set_get_cb\fR\|(3),
248 \&\fISSL_CTX_set_session_id_context\fR\|(3),
249 \&\fISSL_CTX_set_timeout\fR\|(3),
250 \&\fISSL_CTX_flush_sessions\fR\|(3)
251 .SH "HISTORY"
252 .IX Header "HISTORY"
253 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 and \s-1SSL_SESS_CACHE_NO_INTERNAL\s0
254 were introduced in OpenSSL 0.9.6h.