secure/lib/libssl/man/SSL_CTX_set_session_cache_mode.3

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