1169e9b2e2c5b370fb2b2a02bf13059d24430cf7
[openssl.git] / doc / ssl / 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 EVP_CIPHER_CTX_init and HMAC_CTX_init 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 L<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>. The hmac context can be set using L<HMAC_Init_ex>.
57
58 When the client presents a session ticket, the callback function with be called 
59 with I<enc> set to 0 indicating that the I<cb> function should retrieve a set
60 of parameters. In this case I<name> and I<iv> have already been parsed out of
61 the session ticket. The OpenSSL library expects that the I<name> will be used
62 to retrieve a cryptographic parameters and that the cryptographic context
63 I<ctx> will be set with the retrieved parameters and the initialization vector
64 I<iv>. using a function like L<EVP_DecryptInit_ex>. The I<hctx> needs to be set
65 using L<HMAC_Init_ex>.
66
67 If the I<name> is still valid but a renewal of the ticket is required the
68 callback function should return 2. The library will call the callback again
69 with an argument of enc equal to 1 to set the new ticket.
70
71 The return value of the I<cb> function is used by OpenSSL to determine what
72 further processing will occur. The following return values have meaning:
73
74 =over 4
75
76 =item Z<>2
77
78 This indicates that the I<ctx> and I<hctx> have been set and the session can 
79 continue on those parameters. Additionally it indicates that the session
80 ticket is in a renewal period and should be replaced. The OpenSSL library will
81 call I<cb> again with an enc argument of 1 to set the new ticket (see RFC5077
82 3.3 paragraph 2).
83
84 =item Z<>1
85
86 This indicates that the I<ctx> and I<hctx> have been set and the session can 
87 continue on those parameters.
88
89 =item Z<>0
90
91 This indicates that it was not possible to set/retrieve a session ticket and 
92 the SSL/TLS session will continue by by negotiating a set of cryptographic
93 parameters or using the alternate SSL/TLS resumption mechanism, session ids.
94
95 If called with enc equal to 0 the library will call the I<cb> again to get
96 a new set of parameters.
97
98 =item less than 0
99
100 This indicates an error.
101
102 =back
103
104 =head1 NOTES
105
106 Session resumption shortcuts the TLS so that the client certificate
107 negotiation don't occur. It makes up for this by storing client certificate
108 an all other negotiated state information encrypted within the ticket. In a
109 resumed session the applications will have all this state information available
110 exactly as if a full negotiation had occurred.
111
112 If an attacker can obtain the key used to encrypt a session ticket, they can
113 obtain the master secret for any ticket using that key and decrypt any traffic
114 using that session: even if the ciphersuite supports forward secrecy. As
115 a result applications may wish to use multiple keys and avoid using long term
116 keys stored in files.
117
118 Applications can use longer keys to maintain a consistent level of security.
119 For example if a ciphersuite uses 256 bit ciphers but only a 128 bit ticket key
120 the overall security is only 128 bits because breaking the ticket key will
121 enable an attacker to obtain the session keys.
122
123 =head1 EXAMPLES
124
125 Reference Implementation:
126   SSL_CTX_set_tlsext_ticket_key_cb(SSL,ssl_tlsext_ticket_key_cb);
127   ....
128
129   static int ssl_tlsext_ticket_key_cb(SSL *s, unsigned char key_name[16], unsigned char *iv, EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc)
130   {
131       if (enc) { /* create new session */
132           if (RAND_bytes(iv, EVP_MAX_IV_LENGTH) ) {
133               return -1; /* insufficient random */
134           }
135   
136           key = currentkey(); /* something that you need to implement */
137           if ( !key ) {
138               /* current key doesn't exist or isn't valid */
139               key = createkey(); /* something that you need to implement.
140                                    * createkey needs to initialise, a name,
141                                    * an aes_key, a hmac_key and optionally
142                                    * an expire time. */
143               if ( !key ) { /* key couldn't be created */
144                   return 0;
145               }
146           }
147           memcpy(key_name, key->name, 16);
148   
149           EVP_EncryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL, key->aes_key, iv);
150           HMAC_Init_ex(&hctx, key->hmac_key, 16, EVP_sha256(), NULL);
151   
152           return 1;
153   
154       } else { /* retrieve session */
155           key = findkey(name);
156   
157           if  (!key || key->expire < now() ) {
158               return 0;
159           }
160   
161           HMAC_Init_ex(&hctx, key->hmac_key, 16, EVP_sha256(), NULL);
162           EVP_DecryptInit_ex(&ctx, EVP_aes_128_cbc(), NULL, key->aes_key, iv );
163
164           if (key->expire < ( now() - RENEW_TIME ) ) {
165               /* return 2 - this session will get a new ticket even though the current is still valid */
166               return 2;
167           }
168           return 1;
169   
170       }
171   }
172
173
174
175 =head1 RETURN VALUES
176
177 returns 0 to indicate the callback function was set.
178
179 =head1 SEE ALSO
180
181 L<ssl(3)>, L<SSL_set_session(3)>,
182 L<SSL_session_reused(3)>,
183 L<SSL_CTX_add_session(3)>,
184 L<SSL_CTX_sess_number(3)>,
185 L<SSL_CTX_sess_set_get_cb(3)>,
186 L<SSL_CTX_set_session_id_context(3)>,
187
188 =head1 HISTORY
189
190 This function was introduced in OpenSSL 0.9.8h
191
192 =cut