Place return values after examples in doc
[openssl.git] / doc / man3 / SSL_CTX_set_tlsext_ticket_key_cb.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_set_tlsext_ticket_key_cb - set a callback for session ticket processing
6
7 =head1 SYNOPSIS
8
9  #include <openssl/tls1.h>
10
11  long SSL_CTX_set_tlsext_ticket_key_cb(SSL_CTX sslctx,
12      int (*cb)(SSL *s, unsigned char key_name[16],
13                unsigned char iv[EVP_MAX_IV_LENGTH],
14                EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc));
15
16 =head1 DESCRIPTION
17
18 SSL_CTX_set_tlsext_ticket_key_cb() sets a callback function I<cb> for handling
19 session tickets for the ssl context I<sslctx>. Session tickets, defined in
20 RFC5077 provide an enhanced session resumption capability where the server
21 implementation is not required to maintain per session state. It only applies
22 to TLS and there is no SSLv3 implementation.
23
24 The callback function I<cb> will be called for every client instigated TLS
25 session when session ticket extension is presented in the TLS hello
26 message. It is the responsibility of this function to create or retrieve the
27 cryptographic parameters and to maintain their state.
28
29 The OpenSSL library uses your callback function to help implement a common TLS
30 ticket construction state according to RFC5077 Section 4 such that per session
31 state is unnecessary and a small set of cryptographic variables needs to be
32 maintained by the callback function implementation.
33
34 In order to reuse a session, a TLS client must send the a session ticket
35 extension to the server. The client can only send exactly one session ticket.
36 The server, through the callback function, either agrees to reuse the session
37 ticket information or it starts a full TLS handshake to create a new session
38 ticket.
39
40 Before the callback function is started I<ctx> and I<hctx> have been
41 initialised with L<EVP_CIPHER_CTX_reset(3)> and L<HMAC_CTX_reset(3)> respectively.
42
43 For new sessions tickets, when the client doesn't present a session ticket, or
44 an attempted retrieval of the ticket failed, or a renew option was indicated,
45 the callback function will be called with I<enc> equal to 1. The OpenSSL
46 library expects that the function will set an arbitrary I<name>, initialize
47 I<iv>, and set the cipher context I<ctx> and the hash context I<hctx>.
48
49 The I<name> is 16 characters long and is used as a key identifier.
50
51 The I<iv> length is the length of the IV of the corresponding cipher. The
52 maximum IV length is B<EVP_MAX_IV_LENGTH> bytes defined in B<evp.h>.
53
54 The initialization vector I<iv> should be a random value. The cipher context
55 I<ctx> should use the initialisation vector I<iv>. The cipher context can be
56 set using L<EVP_EncryptInit_ex(3)>. The hmac context can be set using
57 L<HMAC_Init_ex(3)>.
58
59 When the client presents a session ticket, the callback function with be called
60 with I<enc> set to 0 indicating that the I<cb> function should retrieve a set
61 of parameters. In this case I<name> and I<iv> have already been parsed out of
62 the session ticket. The OpenSSL library expects that the I<name> will be used
63 to retrieve a cryptographic parameters and that the cryptographic context
64 I<ctx> will be set with the retrieved parameters and the initialization vector
65 I<iv>. using a function like L<EVP_DecryptInit_ex(3)>. The I<hctx> needs to be
66 set using L<HMAC_Init_ex(3)>.
67
68 If the I<name> is still valid but a renewal of the ticket is required the
69 callback function should return 2. The library will call the callback again
70 with an argument of enc equal to 1 to set the new ticket.
71
72 The return value of the I<cb> function is used by OpenSSL to determine what
73 further processing will occur. The following return values have meaning:
74
75 =over 4
76
77 =item Z<>2
78
79 This indicates that the I<ctx> and I<hctx> have been set and the session can
80 continue on those parameters. Additionally it indicates that the session
81 ticket is in a renewal period and should be replaced. The OpenSSL library will
82 call I<cb> again with an enc argument of 1 to set the new ticket (see RFC5077
83 3.3 paragraph 2).
84
85 =item Z<>1
86
87 This indicates that the I<ctx> and I<hctx> have been set and the session can
88 continue on those parameters.
89
90 =item Z<>0
91
92 This indicates that it was not possible to set/retrieve a session ticket and
93 the SSL/TLS session will continue by negotiating a set of cryptographic
94 parameters or using the alternate SSL/TLS resumption mechanism, session ids.
95
96 If called with enc equal to 0 the library will call the I<cb> again to get
97 a new set of parameters.
98
99 =item less than 0
100
101 This indicates an error.
102
103 =back
104
105 =head1 NOTES
106
107 Session resumption shortcuts the TLS so that the client certificate
108 negotiation don't occur. It makes up for this by storing client certificate
109 an all other negotiated state information encrypted within the ticket. In a
110 resumed session the applications will have all this state information available
111 exactly as if a full negotiation had occurred.
112
113 If an attacker can obtain the key used to encrypt a session ticket, they can
114 obtain the master secret for any ticket using that key and decrypt any traffic
115 using that session: even if the cipher suite supports forward secrecy. As
116 a result applications may wish to use multiple keys and avoid using long term
117 keys stored in files.
118
119 Applications can use longer keys to maintain a consistent level of security.
120 For example if a cipher suite uses 256 bit ciphers but only a 128 bit ticket key
121 the overall security is only 128 bits because breaking the ticket key will
122 enable an attacker to obtain the session keys.
123
124 =head1 RETURN VALUES
125
126 returns 0 to indicate the callback function was set.
127
128 =head1 EXAMPLES
129
130 Reference Implementation:
131
132  SSL_CTX_set_tlsext_ticket_key_cb(SSL, ssl_tlsext_ticket_key_cb);
133  ...
134
135  static int ssl_tlsext_ticket_key_cb(SSL *s, unsigned char key_name[16],
136                                      unsigned char *iv, EVP_CIPHER_CTX *ctx,
137                                      HMAC_CTX *hctx, int enc)
138  {
139      if (enc) { /* create new session */
140          if (RAND_bytes(iv, EVP_MAX_IV_LENGTH) <= 0)
141              return -1; /* insufficient random */
142
143          key = currentkey(); /* something that you need to implement */
144          if (key == NULL) {
145              /* current key doesn't exist or isn't valid */
146              key = createkey(); /*
147                                  * Something that you need to implement.
148                                  * createkey needs to initialise a name,
149                                  * an aes_key, a hmac_key and optionally
150                                  * an expire time.
151                                  */
152              if (key == NULL) /* key couldn't be created */
153                  return 0;
154          }
155          memcpy(key_name, key->name, 16);
156
157          EVP_EncryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL, key->aes_key, iv);
158          HMAC_Init_ex(&hctx, key->hmac_key, 16, EVP_sha256(), NULL);
159
160          return 1;
161
162      } else { /* retrieve session */
163          key = findkey(name);
164
165          if (key == NULL || key->expire < now())
166              return 0;
167
168          HMAC_Init_ex(&hctx, key->hmac_key, 16, EVP_sha256(), NULL);
169          EVP_DecryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL, key->aes_key, iv);
170
171          if (key->expire < now() - RENEW_TIME) {
172              /*
173               * return 2 - This session will get a new ticket even though the
174               * current one is still valid.
175               */
176              return 2;
177          }
178          return 1;
179      }
180  }
181
182 =head1 SEE ALSO
183
184 L<ssl(7)>, L<SSL_set_session(3)>,
185 L<SSL_session_reused(3)>,
186 L<SSL_CTX_add_session(3)>,
187 L<SSL_CTX_sess_number(3)>,
188 L<SSL_CTX_sess_set_get_cb(3)>,
189 L<SSL_CTX_set_session_id_context(3)>,
190
191 =head1 COPYRIGHT
192
193 Copyright 2014-2018 The OpenSSL Project Authors. All Rights Reserved.
194
195 Licensed under the Apache License 2.0 (the "License").  You may not use
196 this file except in compliance with the License.  You can obtain a copy
197 in the file LICENSE in the source distribution or at
198 L<https://www.openssl.org/source/license.html>.
199
200 =cut