secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_cb.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_TICKET_CB 3"
 132 .TH SSL_CTX_SET_SESSION_TICKET_CB 3 "2018-11-20" "1.1.1a" "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_ticket_cb, SSL_SESSION_get0_ticket_appdata, SSL_SESSION_set1_ticket_appdata, SSL_CTX_generate_session_ticket_fn, SSL_CTX_decrypt_session_ticket_fn \- manage session ticket application data
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& typedef int (*SSL_CTX_generate_session_ticket_fn)(SSL *s, void *arg);
 145 \& typedef SSL_TICKET_RETURN (*SSL_CTX_decrypt_session_ticket_fn)(SSL *s, SSL_SESSION *ss,
 146 \&                                                                const unsigned char *keyname,
 147 \&                                                                size_t keyname_len,
 148 \&                                                                SSL_TICKET_STATUS status,
 149 \&                                                                void *arg);
 150 \& int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
 151 \&                                   SSL_CTX_generate_session_ticket_fn gen_cb,
 152 \&                                   SSL_CTX_decrypt_session_ticket_fn dec_cb,
 153 \&                                   void *arg);
 154 \& int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len);
 155 \& int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fISSL_CTX_set_set_session_ticket_cb()\fR sets the application callbacks \fBgen_cb\fR
 160 and \fBdec_cb\fR that are used by a server to set and get application data stored
 161 with a session, and placed into a session ticket. Either callback function may
 162 be set to \s-1NULL.\s0 The value of \fBarg\fR is passed to the callbacks.
 163 .PP
 164 \&\fBgen_cb\fR is the application defined callback invoked when a session ticket is
 165 about to be created. The application can call \fISSL_SESSION_set1_ticket_appdata()\fR
 166 at this time to add application data to the session ticket. The value of \fBarg\fR
 167 is the same as that given to \fISSL_CTX_set_session_ticket_cb()\fR. The \fBgen_cb\fR
 168 callback is defined as type \fBSSL_CTX_generate_session_ticket_fn\fR.
 169 .PP
 170 \&\fBdec_cb\fR is the application defined callback invoked after session ticket
 171 decryption has been attempted and any session ticket application data is
 172 available. If ticket decryption was successful then the \fBss\fR argument contains
 173 the session data. The \fBkeyname\fR and \fBkeyname_len\fR arguments identify the key
 174 used to decrypt the session ticket. The \fBstatus\fR argument is the result of the
 175 ticket decryption. See the \s-1NOTES\s0 section below for further details. The value
 176 of \fBarg\fR is the same as that given to \fISSL_CTX_set_session_ticket_cb()\fR. The
 177 \&\fBdec_cb\fR callback is defined as type \fBSSL_CTX_decrypt_session_ticket_fn\fR.
 178 .PP
 179 \&\fISSL_SESSION_set1_ticket_appdata()\fR sets the application data specified by
 180 \&\fBdata\fR and \fBlen\fR into \fBss\fR which is then placed into any generated session
 181 tickets. It can be called at any time before a session ticket is created to
 182 update the data placed into the session ticket. However, given that sessions
 183 and tickets are created by the handshake, the \fBgen_cb\fR is provided to notify
 184 the application that a session ticket is about to be generated.
 185 .PP
 186 \&\fISSL_SESSION_get0_ticket_appdata()\fR assigns \fBdata\fR to the session ticket
 187 application data and assigns \fBlen\fR to the length of the session ticket
 188 application data from \fBss\fR. The application data can be set via
 189 \&\fISSL_SESSION_set1_ticket_appdata()\fR or by a session ticket. \s-1NULL\s0 will be assigned
 190 to \fBdata\fR and 0 will be assigned to \fBlen\fR if there is no session ticket
 191 application data. \fISSL_SESSION_get0_ticket_appdata()\fR can be called any time
 192 after a session has been created. The \fBdec_cb\fR is provided to notify the
 193 application that a session ticket has just been decrypted.
 194 .SH "NOTES"
 195 .IX Header "NOTES"
 196 When the \fBdec_cb\fR callback is invoked, the \s-1SSL_SESSION\s0 \fBss\fR has not yet been
 197 assigned to the \s-1SSL\s0 \fBs\fR. The \fBstatus\fR indicates the result of the ticket
 198 decryption. The callback must check the \fBstatus\fR value before performing any
 199 action, as it is called even if ticket decryption fails.
 200 .PP
 201 The \fBkeyname\fR and \fBkeyname_len\fR arguments to \fBdec_cb\fR may be used to identify
 202 the key that was used to encrypt the session ticket.
 203 .PP
 204 The \fBstatus\fR argument can be any of these values:
 205 .IP "\s-1SSL_TICKET_EMPTY\s0" 4
 206 .IX Item "SSL_TICKET_EMPTY"
 207 Empty ticket present. No ticket data will be used and a new ticket should be
 208 sent to the client. This only occurs in TLSv1.2 or below. In TLSv1.3 it is not
 209 valid for a client to send an empty ticket.
 210 .IP "\s-1SSL_TICKET_NO_DECRYPT\s0" 4
 211 .IX Item "SSL_TICKET_NO_DECRYPT"
 212 The ticket couldn't be decrypted. No ticket data will be used and a new ticket
 213 should be sent to the client.
 214 .IP "\s-1SSL_TICKET_SUCCESS\s0" 4
 215 .IX Item "SSL_TICKET_SUCCESS"
 216 A ticket was successfully decrypted, any session ticket application data should
 217 be available. A new ticket should not be sent to the client.
 218 .IP "\s-1SSL_TICKET_SUCCESS_RENEW\s0" 4
 219 .IX Item "SSL_TICKET_SUCCESS_RENEW"
 220 Same as \fB\s-1SSL_TICKET_SUCCESS\s0\fR, but a new ticket should be sent to the client.
 221 .PP
 222 The return value can be any of these values:
 223 .IP "\s-1SSL_TICKET_RETURN_ABORT\s0" 4
 224 .IX Item "SSL_TICKET_RETURN_ABORT"
 225 The handshake should be aborted, either because of an error or because of some
 226 policy. Note that in TLSv1.3 a client may send more than one ticket in a single
 227 handshake. Therefore just because one ticket is unacceptable it does not mean
 228 that all of them are. For this reason this option should be used with caution.
 229 .IP "\s-1SSL_TICKET_RETURN_IGNORE\s0" 4
 230 .IX Item "SSL_TICKET_RETURN_IGNORE"
 231 Do not use a ticket (if one was available). Do not send a renewed ticket to the
 232 client.
 233 .IP "\s-1SSL_TICKET_RETURN_IGNORE_RENEW\s0" 4
 234 .IX Item "SSL_TICKET_RETURN_IGNORE_RENEW"
 235 Do not use a ticket (if one was available). Send a renewed ticket to the client.
 236 .Sp
 237 If the callback does not wish to change the default ticket behaviour then it
 238 should return this value if \fBstatus\fR is \fB\s-1SSL_TICKET_EMPTY\s0\fR or
 239 \&\fB\s-1SSL_TICKET_NO_DECRYPT\s0\fR.
 240 .IP "\s-1SSL_TICKET_RETURN_USE\s0" 4
 241 .IX Item "SSL_TICKET_RETURN_USE"
 242 Use the ticket. Do not send a renewed ticket to the client. It is an error for
 243 the callback to return this value if \fBstatus\fR has a value other than
 244 \&\fB\s-1SSL_TICKET_SUCCESS\s0\fR or \fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR.
 245 .Sp
 246 If the callback does not wish to change the default ticket behaviour then it
 247 should return this value if \fBstatus\fR is \fB\s-1SSL_TICKET_SUCCESS\s0\fR.
 248 .IP "\s-1SSL_TICKET_RETURN_USE_RENEW\s0" 4
 249 .IX Item "SSL_TICKET_RETURN_USE_RENEW"
 250 Use the ticket. Send a renewed ticket to the client. It is an error for the
 251 callback to return this value if \fBstatus\fR has a value other than
 252 \&\fB\s-1SSL_TICKET_SUCCESS\s0\fR or \fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR.
 253 .Sp
 254 If the callback does not wish to change the default ticket behaviour then it
 255 should return this value if \fBstatus\fR is \fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR.
 256 .PP
 257 If \fBstatus\fR has the value \fB\s-1SSL_TICKET_EMPTY\s0\fR or \fB\s-1SSL_TICKET_NO_DECRYPT\s0\fR then
 258 no session data will be available and the callback must not use the \fBss\fR
 259 argument. If \fBstatus\fR has the value \fB\s-1SSL_TICKET_SUCCESS\s0\fR or
 260 \&\fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR then the application can call
 261 \&\fISSL_SESSION_get0_ticket_appdata()\fR using the session provided in the \fBss\fR
 262 argument to retrieve the application data.
 263 .PP
 264 When the \fBgen_cb\fR callback is invoked, the \fISSL_get_session()\fR function can be
 265 used to retrieve the \s-1SSL_SESSION\s0 for \fISSL_SESSION_set1_ticket_appdata()\fR.
 266 .PP
 267 By default, in TLSv1.2 and below, a new session ticket is not issued on a
 268 successful resumption and therefore \fBgen_cb\fR will not be called. In TLSv1.3 the
 269 default behaviour is to always issue a new ticket on resumption. In both cases
 270 this behaviour can be changed if a ticket key callback is in use (see
 271 \&\fISSL_CTX_set_tlsext_ticket_key_cb\fR\|(3)).
 272 .SH "RETURN VALUES"
 273 .IX Header "RETURN VALUES"
 274 The \fISSL_CTX_set_session_ticket_cb()\fR, \fISSL_SESSION_set1_ticket_appdata()\fR and
 275 \&\fISSL_SESSION_get0_ticket_appdata()\fR functions return 1 on success and 0 on
 276 failure.
 277 .PP
 278 The \fBgen_cb\fR callback must return 1 to continue the connection. A return of 0
 279 will terminate the connection with an \s-1INTERNAL_ERROR\s0 alert.
 280 .PP
 281 The \fBdec_cb\fR callback must return a value as described in \s-1NOTES\s0 above.
 282 .SH "SEE ALSO"
 283 .IX Header "SEE ALSO"
 284 \&\fIssl\fR\|(7),
 285 \&\fISSL_get_session\fR\|(3)
 286 .SH "HISTORY"
 287 .IX Header "HISTORY"
 288 \&\fISSL_CTX_set_session_ticket_cb()\fR, \fISSSL_SESSION_set1_ticket_appdata()\fR and
 289 \&\fISSL_SESSION_get_ticket_appdata()\fR were added to OpenSSL 1.1.1.
 290 .SH "COPYRIGHT"
 291 .IX Header "COPYRIGHT"
 292 Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
 293 .PP
 294 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 295 this file except in compliance with the License.  You can obtain a copy
 296 in the file \s-1LICENSE\s0 in the source distribution or at
 297 <https://www.openssl.org/source/license.html>.