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