secure/lib/libcrypto/man/SSL_CTX_set_tlsext_ticket_key_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_TLSEXT_TICKET_KEY_CB 3"
 132 .TH SSL_CTX_SET_TLSEXT_TICKET_KEY_CB 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_tlsext_ticket_key_cb \- set a callback for session ticket processing
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/tls1.h>
 143 \&
 144 \& long SSL_CTX_set_tlsext_ticket_key_cb(SSL_CTX sslctx,
 145 \&     int (*cb)(SSL *s, unsigned char key_name[16],
 146 \&               unsigned char iv[EVP_MAX_IV_LENGTH],
 147 \&               EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc));
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 \&\fISSL_CTX_set_tlsext_ticket_key_cb()\fR sets a callback function \fIcb\fR for handling
 152 session tickets for the ssl context \fIsslctx\fR. Session tickets, defined in
 153 \&\s-1RFC5077\s0 provide an enhanced session resumption capability where the server
 154 implementation is not required to maintain per session state. It only applies
 155 to \s-1TLS\s0 and there is no SSLv3 implementation.
 156 .PP
 157 The callback function \fIcb\fR will be called for every client instigated \s-1TLS\s0
 158 session when session ticket extension is presented in the \s-1TLS\s0 hello
 159 message. It is the responsibility of this function to create or retrieve the
 160 cryptographic parameters and to maintain their state.
 161 .PP
 162 The OpenSSL library uses your callback function to help implement a common \s-1TLS\s0
 163 ticket construction state according to \s-1RFC5077\s0 Section 4 such that per session
 164 state is unnecessary and a small set of cryptographic variables needs to be
 165 maintained by the callback function implementation.
 166 .PP
 167 In order to reuse a session, a \s-1TLS\s0 client must send the a session ticket
 168 extension to the server. The client can only send exactly one session ticket.
 169 The server, through the callback function, either agrees to reuse the session
 170 ticket information or it starts a full \s-1TLS\s0 handshake to create a new session
 171 ticket.
 172 .PP
 173 Before the callback function is started \fIctx\fR and \fIhctx\fR have been
 174 initialised with EVP_CIPHER_CTX_init and HMAC_CTX_init respectively.
 175 .PP
 176 For new sessions tickets, when the client doesn't present a session ticket, or
 177 an attempted retrieval of the ticket failed, or a renew option was indicated,
 178 the callback function will be called with \fIenc\fR equal to 1. The OpenSSL
 179 library expects that the function will set an arbitrary \fIname\fR, initialize
 180 \&\fIiv\fR, and set the cipher context \fIctx\fR and the hash context \fIhctx\fR.
 181 .PP
 182 The \fIname\fR is 16 characters long and is used as a key identifier.
 183 .PP
 184 The \fIiv\fR length is the length of the \s-1IV\s0 of the corresponding cipher. The
 185 maximum \s-1IV\s0 length is \fB\s-1EVP_MAX_IV_LENGTH\s0\fR bytes defined in \fBevp.h\fR.
 186 .PP
 187 The initialization vector \fIiv\fR should be a random value. The cipher context
 188 \&\fIctx\fR should use the initialisation vector \fIiv\fR. The cipher context can be
 189 set using \fIEVP_EncryptInit_ex\fR\|(3). The hmac context can be set using
 190 \&\fIHMAC_Init_ex\fR\|(3).
 191 .PP
 192 When the client presents a session ticket, the callback function with be called
 193 with \fIenc\fR set to 0 indicating that the \fIcb\fR function should retrieve a set
 194 of parameters. In this case \fIname\fR and \fIiv\fR have already been parsed out of
 195 the session ticket. The OpenSSL library expects that the \fIname\fR will be used
 196 to retrieve a cryptographic parameters and that the cryptographic context
 197 \&\fIctx\fR will be set with the retrieved parameters and the initialization vector
 198 \&\fIiv\fR. using a function like \fIEVP_DecryptInit_ex\fR\|(3). The \fIhctx\fR needs to be
 199 set using \fIHMAC_Init_ex\fR\|(3).
 200 .PP
 201 If the \fIname\fR is still valid but a renewal of the ticket is required the
 202 callback function should return 2. The library will call the callback again
 203 with an argument of enc equal to 1 to set the new ticket.
 204 .PP
 205 The return value of the \fIcb\fR function is used by OpenSSL to determine what
 206 further processing will occur. The following return values have meaning:
 207 .IP "2" 4
 208 .IX Item "2"
 209 This indicates that the \fIctx\fR and \fIhctx\fR have been set and the session can
 210 continue on those parameters. Additionally it indicates that the session
 211 ticket is in a renewal period and should be replaced. The OpenSSL library will
 212 call \fIcb\fR again with an enc argument of 1 to set the new ticket (see \s-1RFC5077
 213 3.3\s0 paragraph 2).
 214 .IP "1" 4
 215 .IX Item "1"
 216 This indicates that the \fIctx\fR and \fIhctx\fR have been set and the session can
 217 continue on those parameters.
 218 .IP "0" 4
 219 This indicates that it was not possible to set/retrieve a session ticket and
 220 the \s-1SSL/TLS\s0 session will continue by negotiating a set of cryptographic
 221 parameters or using the alternate \s-1SSL/TLS\s0 resumption mechanism, session ids.
 222 .Sp
 223 If called with enc equal to 0 the library will call the \fIcb\fR again to get
 224 a new set of parameters.
 225 .IP "less than 0" 4
 226 .IX Item "less than 0"
 227 This indicates an error.
 228 .SH "NOTES"
 229 .IX Header "NOTES"
 230 Session resumption shortcuts the \s-1TLS\s0 so that the client certificate
 231 negotiation don't occur. It makes up for this by storing client certificate
 232 an all other negotiated state information encrypted within the ticket. In a
 233 resumed session the applications will have all this state information available
 234 exactly as if a full negotiation had occurred.
 235 .PP
 236 If an attacker can obtain the key used to encrypt a session ticket, they can
 237 obtain the master secret for any ticket using that key and decrypt any traffic
 238 using that session: even if the cipher suite supports forward secrecy. As
 239 a result applications may wish to use multiple keys and avoid using long term
 240 keys stored in files.
 241 .PP
 242 Applications can use longer keys to maintain a consistent level of security.
 243 For example if a cipher suite uses 256 bit ciphers but only a 128 bit ticket key
 244 the overall security is only 128 bits because breaking the ticket key will
 245 enable an attacker to obtain the session keys.
 246 .SH "EXAMPLES"
 247 .IX Header "EXAMPLES"
 248 Reference Implementation:
 249 .PP
 250 .Vb 2
 251 \& SSL_CTX_set_tlsext_ticket_key_cb(SSL, ssl_tlsext_ticket_key_cb);
 252 \& ...
 253 \&
 254 \& static int ssl_tlsext_ticket_key_cb(SSL *s, unsigned char key_name[16],
 255 \&                                     unsigned char *iv, EVP_CIPHER_CTX *ctx,
 256 \&                                     HMAC_CTX *hctx, int enc)
 257 \& {
 258 \&     if (enc) { /* create new session */
 259 \&         if (RAND_bytes(iv, EVP_MAX_IV_LENGTH) <= 0)
 260 \&             return \-1; /* insufficient random */
 261 \&
 262 \&         key = currentkey(); /* something that you need to implement */
 263 \&         if (key == NULL) {
 264 \&             /* current key doesn\*(Aqt exist or isn\*(Aqt valid */
 265 \&             key = createkey(); /*
 266 \&                                 * Something that you need to implement.
 267 \&                                 * createkey needs to initialise a name,
 268 \&                                 * an aes_key, a hmac_key and optionally
 269 \&                                 * an expire time.
 270 \&                                 */
 271 \&             if (key == NULL) /* key couldn\*(Aqt be created */
 272 \&                 return 0;
 273 \&         }
 274 \&         memcpy(key_name, key\->name, 16);
 275 \&
 276 \&         EVP_EncryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL, key\->aes_key, iv);
 277 \&         HMAC_Init_ex(&hctx, key\->hmac_key, 16, EVP_sha256(), NULL);
 278 \&
 279 \&         return 1;
 280 \&
 281 \&     } else { /* retrieve session */
 282 \&         key = findkey(name);
 283 \&
 284 \&         if (key == NULL || key\->expire < now())
 285 \&             return 0;
 286 \&
 287 \&         HMAC_Init_ex(&hctx, key\->hmac_key, 16, EVP_sha256(), NULL);
 288 \&         EVP_DecryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL, key\->aes_key, iv);
 289 \&
 290 \&         if (key\->expire < now() \- RENEW_TIME) {
 291 \&             /*
 292 \&              * return 2 \- This session will get a new ticket even though the
 293 \&              * current one is still valid.
 294 \&              */
 295 \&             return 2;
 296 \&         }
 297 \&         return 1;
 298 \&     }
 299 \& }
 300 .Ve
 301 .SH "RETURN VALUES"
 302 .IX Header "RETURN VALUES"
 303 returns 0 to indicate the callback function was set.
 304 .SH "SEE ALSO"
 305 .IX Header "SEE ALSO"
 306 \&\fIssl\fR\|(7), \fISSL_set_session\fR\|(3),
 307 \&\fISSL_session_reused\fR\|(3),
 308 \&\fISSL_CTX_add_session\fR\|(3),
 309 \&\fISSL_CTX_sess_number\fR\|(3),
 310 \&\fISSL_CTX_sess_set_get_cb\fR\|(3),
 311 \&\fISSL_CTX_set_session_id_context\fR\|(3),
 312 .SH "COPYRIGHT"
 313 .IX Header "COPYRIGHT"
 314 Copyright 2014\-2018 The OpenSSL Project Authors. All Rights Reserved.
 315 .PP
 316 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 317 this file except in compliance with the License.  You can obtain a copy
 318 in the file \s-1LICENSE\s0 in the source distribution or at
 319 <https://www.openssl.org/source/license.html>.