secure/lib/libcrypto/man/SSL_CTX_set_session_cache_mode.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_CTX_set_session_cache_mode, SSL_CTX_get_session_cache_mode \- enable/disable session caching
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& long SSL_CTX_set_session_cache_mode(SSL_CTX ctx, long mode);
 145 \& long SSL_CTX_get_session_cache_mode(SSL_CTX ctx);
 146 .Ve
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 \&\fISSL_CTX_set_session_cache_mode()\fR enables/disables session caching
 150 by setting the operational mode for \fBctx\fR to <mode>.
 151 .PP
 152 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently used cache mode.
 153 .SH "NOTES"
 154 .IX Header "NOTES"
 155 The OpenSSL library can store/retrieve \s-1SSL/TLS\s0 sessions for later reuse.
 156 The sessions can be held in memory for each \fBctx\fR, if more than one
 157 \&\s-1SSL_CTX\s0 object is being maintained, the sessions are unique for each \s-1SSL_CTX\s0
 158 object.
 159 .PP
 160 In order to reuse a session, a client must send the session's id to the
 161 server. It can only send exactly one id.  The server then either
 162 agrees to reuse the session or it starts a full handshake (to create a new
 163 session).
 164 .PP
 165 A server will look up the session in its internal session storage. If the
 166 session is not found in internal storage or lookups for the internal storage
 167 have been deactivated (\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0), the server will try
 168 the external storage if available.
 169 .PP
 170 Since a client may try to reuse a session intended for use in a different
 171 context, the session id context must be set by the server (see
 172 \&\fISSL_CTX_set_session_id_context\fR\|(3)).
 173 .PP
 174 The following session cache modes and modifiers are available:
 175 .IP "\s-1SSL_SESS_CACHE_OFF\s0" 4
 176 .IX Item "SSL_SESS_CACHE_OFF"
 177 No session caching for client or server takes place.
 178 .IP "\s-1SSL_SESS_CACHE_CLIENT\s0" 4
 179 .IX Item "SSL_SESS_CACHE_CLIENT"
 180 Client sessions are added to the session cache. As there is no reliable way
 181 for the OpenSSL library to know whether a session should be reused or which
 182 session to choose (due to the abstract \s-1BIO\s0 layer the \s-1SSL\s0 engine does not
 183 have details about the connection), the application must select the session
 184 to be reused by using the \fISSL_set_session\fR\|(3)
 185 function. This option is not activated by default.
 186 .IP "\s-1SSL_SESS_CACHE_SERVER\s0" 4
 187 .IX Item "SSL_SESS_CACHE_SERVER"
 188 Server sessions are added to the session cache. When a client proposes a
 189 session to be reused, the server looks for the corresponding session in (first)
 190 the internal session cache (unless \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 is set),
 191 then (second) in the external cache if available. If the session is found, the
 192 server will try to reuse the session.  This is the default.
 193 .IP "\s-1SSL_SESS_CACHE_BOTH\s0" 4
 194 .IX Item "SSL_SESS_CACHE_BOTH"
 195 Enable both \s-1SSL_SESS_CACHE_CLIENT\s0 and \s-1SSL_SESS_CACHE_SERVER\s0 at the same time.
 196 .IP "\s-1SSL_SESS_CACHE_NO_AUTO_CLEAR\s0" 4
 197 .IX Item "SSL_SESS_CACHE_NO_AUTO_CLEAR"
 198 Normally the session cache is checked for expired sessions every
 199 255 connections using the
 200 \&\fISSL_CTX_flush_sessions\fR\|(3) function. Since
 201 this may lead to a delay which cannot be controlled, the automatic
 202 flushing may be disabled and
 203 \&\fISSL_CTX_flush_sessions\fR\|(3) can be called
 204 explicitly by the application.
 205 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0" 4
 206 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_LOOKUP"
 207 By setting this flag, session-resume operations in an \s-1SSL/TLS\s0 server will not
 208 automatically look up sessions in the internal cache, even if sessions are
 209 automatically stored there. If external session caching callbacks are in use,
 210 this flag guarantees that all lookups are directed to the external cache.
 211 As automatic lookup only applies for \s-1SSL/TLS\s0 servers, the flag has no effect on
 212 clients.
 213 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0" 4
 214 .IX Item "SSL_SESS_CACHE_NO_INTERNAL_STORE"
 215 Depending on the presence of \s-1SSL_SESS_CACHE_CLIENT\s0 and/or \s-1SSL_SESS_CACHE_SERVER,\s0
 216 sessions negotiated in an \s-1SSL/TLS\s0 handshake may be cached for possible reuse.
 217 Normally a new session is added to the internal cache as well as any external
 218 session caching (callback) that is configured for the \s-1SSL_CTX.\s0 This flag will
 219 prevent sessions being stored in the internal cache (though the application can
 220 add them manually using \fISSL_CTX_add_session\fR\|(3)). Note:
 221 in any \s-1SSL/TLS\s0 servers where external caching is configured, any successful
 222 session lookups in the external cache (ie. for session-resume requests) would
 223 normally be copied into the local cache before processing continues \- this flag
 224 prevents these additions to the internal cache as well.
 225 .IP "\s-1SSL_SESS_CACHE_NO_INTERNAL\s0" 4
 226 .IX Item "SSL_SESS_CACHE_NO_INTERNAL"
 227 Enable both \s-1SSL_SESS_CACHE_NO_INTERNAL_LOOKUP\s0 and
 228 \&\s-1SSL_SESS_CACHE_NO_INTERNAL_STORE\s0 at the same time.
 229 .PP
 230 The default mode is \s-1SSL_SESS_CACHE_SERVER.\s0
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 \&\fISSL_CTX_set_session_cache_mode()\fR returns the previously set cache mode.
 234 .PP
 235 \&\fISSL_CTX_get_session_cache_mode()\fR returns the currently set cache mode.
 236 .SH "SEE ALSO"
 237 .IX Header "SEE ALSO"
 238 \&\fIssl\fR\|(7), \fISSL_set_session\fR\|(3),
 239 \&\fISSL_session_reused\fR\|(3),
 240 \&\fISSL_CTX_add_session\fR\|(3),
 241 \&\fISSL_CTX_sess_number\fR\|(3),
 242 \&\fISSL_CTX_sess_set_cache_size\fR\|(3),
 243 \&\fISSL_CTX_sess_set_get_cb\fR\|(3),
 244 \&\fISSL_CTX_set_session_id_context\fR\|(3),
 245 \&\fISSL_CTX_set_timeout\fR\|(3),
 246 \&\fISSL_CTX_flush_sessions\fR\|(3)
 247 .SH "COPYRIGHT"
 248 .IX Header "COPYRIGHT"
 249 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
 250 .PP
 251 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 252 this file except in compliance with the License.  You can obtain a copy
 253 in the file \s-1LICENSE\s0 in the source distribution or at
 254 <https://www.openssl.org/source/license.html>.