secure/lib/libssl/man/SSL_CTX_sess_set_get_cb.3

   1 .\" Automatically generated by Pod::Man 4.07 (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_sess_set_get_cb 3"
 132 .TH SSL_CTX_sess_set_get_cb 3 "2017-05-25" "1.0.2l" "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_sess_set_new_cb, SSL_CTX_sess_set_remove_cb, SSL_CTX_sess_set_get_cb, SSL_CTX_sess_get_new_cb, SSL_CTX_sess_get_remove_cb, SSL_CTX_sess_get_get_cb \- provide callback functions for server side external session caching
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
 145 \&                              int (*new_session_cb)(SSL *, SSL_SESSION *));
 146 \& void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
 147 \&           void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *));
 148 \& void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
 149 \&           SSL_SESSION (*get_session_cb)(SSL *, unsigned char *, int, int *));
 150 \&
 151 \& int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(struct ssl_st *ssl, SSL_SESSION *sess);
 152 \& void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
 153 \& SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(struct ssl_st *ssl, unsigned char *data, int len, int *copy);
 154 \&
 155 \& int (*new_session_cb)(struct ssl_st *ssl, SSL_SESSION *sess);
 156 \& void (*remove_session_cb)(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
 157 \& SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, unsigned char *data,
 158 \&               int len, int *copy);
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 \&\fISSL_CTX_sess_set_new_cb()\fR sets the callback function, which is automatically
 163 called whenever a new session was negotiated.
 164 .PP
 165 \&\fISSL_CTX_sess_set_remove_cb()\fR sets the callback function, which is
 166 automatically called whenever a session is removed by the \s-1SSL\s0 engine,
 167 because it is considered faulty or the session has become obsolete because
 168 of exceeding the timeout value.
 169 .PP
 170 \&\fISSL_CTX_sess_set_get_cb()\fR sets the callback function which is called,
 171 whenever a \s-1SSL/TLS\s0 client proposed to resume a session but the session
 172 could not be found in the internal session cache (see
 173 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
 174 (\s-1SSL/TLS\s0 server only.)
 175 .PP
 176 \&\fISSL_CTX_sess_get_new_cb()\fR, \fISSL_CTX_sess_get_remove_cb()\fR, and
 177 \&\fISSL_CTX_sess_get_get_cb()\fR allow to retrieve the function pointers of the
 178 provided callback functions. If a callback function has not been set,
 179 the \s-1NULL\s0 pointer is returned.
 180 .SH "NOTES"
 181 .IX Header "NOTES"
 182 In order to allow external session caching, synchronization with the internal
 183 session cache is realized via callback functions. Inside these callback
 184 functions, session can be saved to disk or put into a database using the
 185 \&\fId2i_SSL_SESSION\fR\|(3) interface.
 186 .PP
 187 The \fInew_session_cb()\fR is called, whenever a new session has been negotiated
 188 and session caching is enabled (see
 189 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
 190 The \fInew_session_cb()\fR is passed the \fBssl\fR connection and the ssl session
 191 \&\fBsess\fR. If the callback returns \fB0\fR, the session will be immediately
 192 removed again.
 193 .PP
 194 The \fIremove_session_cb()\fR is called, whenever the \s-1SSL\s0 engine removes a session
 195 from the internal cache. This happens when the session is removed because
 196 it is expired or when a connection was not shutdown cleanly. It also happens
 197 for all sessions in the internal session cache when
 198 \&\fISSL_CTX_free\fR\|(3) is called. The \fIremove_session_cb()\fR is passed
 199 the \fBctx\fR and the ssl session \fBsess\fR. It does not provide any feedback.
 200 .PP
 201 The \fIget_session_cb()\fR is only called on \s-1SSL/TLS\s0 servers with the session id
 202 proposed by the client. The \fIget_session_cb()\fR is always called, also when
 203 session caching was disabled. The \fIget_session_cb()\fR is passed the
 204 \&\fBssl\fR connection, the session id of length \fBlength\fR at the memory location
 205 \&\fBdata\fR. With the parameter \fBcopy\fR the callback can require the
 206 \&\s-1SSL\s0 engine to increment the reference count of the \s-1SSL_SESSION\s0 object,
 207 Normally the reference count is not incremented and therefore the
 208 session must not be explicitly freed with
 209 \&\fISSL_SESSION_free\fR\|(3).
 210 .SH "SEE ALSO"
 211 .IX Header "SEE ALSO"
 212 \&\fIssl\fR\|(3), \fId2i_SSL_SESSION\fR\|(3),
 213 \&\fISSL_CTX_set_session_cache_mode\fR\|(3),
 214 \&\fISSL_CTX_flush_sessions\fR\|(3),
 215 \&\fISSL_SESSION_free\fR\|(3),
 216 \&\fISSL_CTX_free\fR\|(3)