2 * Copyright (C) 2009-2012 Free Software Foundation, Inc.
6 * This file is part of GnuTLS.
8 * The GnuTLS is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 2.1 of
11 * the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>
23 #include <gnutls_int.h>
24 #include <gnutls_errors.h>
25 #include <gnutls_datum.h>
26 #include <algorithms.h>
27 #include <gnutls_handshake.h>
28 #include <gnutls_num.h>
29 #include <gnutls_constate.h>
30 #include <gnutls_session_pack.h>
32 #include <ext/session_ticket.h>
33 #include <gnutls_mbuffers.h>
34 #include <gnutls_extensions.h>
35 #include <gnutls_constate.h>
37 #ifdef ENABLE_SESSION_TICKETS
39 #define KEY_NAME_SIZE SESSION_TICKET_KEY_NAME_SIZE
40 #define KEY_SIZE SESSION_TICKET_KEY_SIZE
41 #define IV_SIZE 12 /* GCM */
43 #define TAG_SIZE 16 /* GCM */
45 static int session_ticket_recv_params(gnutls_session_t session,
48 static int session_ticket_send_params(gnutls_session_t session,
49 gnutls_buffer_st * extdata);
50 static int session_ticket_unpack(gnutls_buffer_st * ps,
51 extension_priv_data_t * _priv);
52 static int session_ticket_pack(extension_priv_data_t _priv,
53 gnutls_buffer_st * ps);
54 static void session_ticket_deinit_data(extension_priv_data_t priv);
56 extension_entry_st ext_mod_session_ticket = {
57 .name = "SESSION TICKET",
58 .type = GNUTLS_EXTENSION_SESSION_TICKET,
59 .parse_type = GNUTLS_EXT_MANDATORY,
61 .recv_func = session_ticket_recv_params,
62 .send_func = session_ticket_send_params,
63 .pack_func = session_ticket_pack,
64 .unpack_func = session_ticket_unpack,
65 .deinit_func = session_ticket_deinit_data,
68 #define SESSION_KEY_SIZE (SESSION_TICKET_KEY_NAME_SIZE+SESSION_TICKET_KEY_SIZE)
70 #define KEY_POS (SESSION_TICKET_KEY_NAME_SIZE)
73 int session_ticket_enable;
74 int session_ticket_renew;
76 uint8_t *session_ticket;
77 int session_ticket_len;
79 uint8_t key[SESSION_KEY_SIZE];
80 } session_ticket_ext_st;
83 uint8_t key_name[KEY_NAME_SIZE];
85 uint8_t *encrypted_state;
86 uint16_t encrypted_state_len;
87 uint8_t tag[TAG_SIZE];
91 decrypt_ticket(gnutls_session_t session, session_ticket_ext_st * priv,
92 struct ticket_st *ticket)
94 cipher_hd_st cipher_hd;
95 gnutls_datum_t key, IV, state;
96 uint8_t final[TAG_SIZE];
97 time_t timestamp = gnutls_time(0);
100 /* Decrypt encrypted_state using 128-bit AES in CBC mode. */
101 key.data = (void *) &priv->key[KEY_POS];
103 IV.data = ticket->IV;
106 _gnutls_cipher_init(&cipher_hd,
107 cipher_to_entry(GNUTLS_CIPHER_AES_128_GCM),
113 ret = _gnutls_cipher_decrypt(&cipher_hd, ticket->encrypted_state,
114 ticket->encrypted_state_len);
120 _gnutls_cipher_tag(&cipher_hd, final, TAG_SIZE);
121 if (memcmp(ticket->tag, final, TAG_SIZE) != 0) {
123 ret = GNUTLS_E_DECRYPTION_FAILED;
127 /* Unpack security parameters. */
128 state.data = ticket->encrypted_state;
129 state.size = ticket->encrypted_state_len;
130 ret = _gnutls_session_unpack(session, &state);
137 session->internals.resumed_security_parameters.timestamp >
138 session->internals.expire_time
139 || session->internals.resumed_security_parameters.timestamp >
142 ret = GNUTLS_E_EXPIRED;
146 session->internals.resumed = RESUME_TRUE;
150 _gnutls_cipher_deinit(&cipher_hd);
157 encrypt_ticket(gnutls_session_t session, session_ticket_ext_st * priv,
158 struct ticket_st *ticket)
160 cipher_hd_st cipher_hd;
161 gnutls_datum_t key, IV;
162 gnutls_datum_t state = {NULL,0}, encrypted_state = {NULL,0};
167 /* Pack security parameters. */
168 ret = _gnutls_session_pack(session, &state);
174 encrypted_state.size = state.size;
175 encrypted_state.data = gnutls_malloc(encrypted_state.size);
176 if (!encrypted_state.data) {
178 ret = GNUTLS_E_MEMORY_ERROR;
181 memset(encrypted_state.data, 0, encrypted_state.size);
182 memcpy(encrypted_state.data, state.data, state.size);
184 /* Encrypt state using 128-bit AES in GCM mode. */
185 key.data = (void *) &priv->key[KEY_POS];
192 ret = _gnutls_rnd(GNUTLS_RND_NONCE, iv+4, IV_SIZE-4);
199 _gnutls_cipher_init(&cipher_hd,
200 cipher_to_entry(GNUTLS_CIPHER_AES_128_GCM),
207 ret = _gnutls_cipher_encrypt(&cipher_hd, encrypted_state.data,
208 encrypted_state.size);
214 _gnutls_cipher_tag(&cipher_hd, ticket->tag, TAG_SIZE);
216 /* Fill the ticket structure to compute MAC. */
217 memcpy(ticket->key_name, &priv->key[NAME_POS], KEY_NAME_SIZE);
218 memcpy(ticket->IV, IV.data, IV.size);
219 ticket->encrypted_state_len = encrypted_state.size;
220 ticket->encrypted_state = encrypted_state.data;
222 encrypted_state.data = NULL;
227 _gnutls_cipher_deinit(&cipher_hd);
230 _gnutls_free_datum(&state);
231 _gnutls_free_datum(&encrypted_state);
237 session_ticket_recv_params(gnutls_session_t session,
238 const uint8_t * data, size_t _data_size)
240 ssize_t data_size = _data_size;
241 session_ticket_ext_st *priv = NULL;
242 extension_priv_data_t epriv;
246 _gnutls_ext_get_session_data(session,
247 GNUTLS_EXTENSION_SESSION_TICKET,
254 if (!priv->session_ticket_enable)
257 if (session->security_parameters.entity == GNUTLS_SERVER) {
258 struct ticket_st ticket;
259 const uint8_t *encrypted_state;
262 /* The client requested a new session ticket. */
263 if (data_size == 0) {
264 priv->session_ticket_renew = 1;
268 DECR_LEN(data_size, KEY_NAME_SIZE);
269 memcpy(ticket.key_name, data, KEY_NAME_SIZE);
270 data += KEY_NAME_SIZE;
272 /* If the key name of the ticket does not match the one that we
273 hold, issue a new ticket. */
275 (ticket.key_name, &priv->key[NAME_POS],
277 priv->session_ticket_renew = 1;
281 DECR_LEN(data_size, IV_SIZE);
282 memcpy(ticket.IV, data, IV_SIZE);
285 DECR_LEN(data_size, 2);
286 ticket.encrypted_state_len = _gnutls_read_uint16(data);
289 encrypted_state = data;
291 DECR_LEN(data_size, ticket.encrypted_state_len);
292 data += ticket.encrypted_state_len;
294 DECR_LEN(data_size, TAG_SIZE);
295 memcpy(ticket.tag, data, TAG_SIZE);
297 ticket.encrypted_state =
298 gnutls_malloc(ticket.encrypted_state_len);
299 if (!ticket.encrypted_state) {
301 return GNUTLS_E_MEMORY_ERROR;
303 memcpy(ticket.encrypted_state, encrypted_state,
304 ticket.encrypted_state_len);
306 ret = decrypt_ticket(session, priv, &ticket);
307 gnutls_free(ticket.encrypted_state);
309 priv->session_ticket_renew = 1;
312 } else { /* Client */
314 if (data_size == 0) {
315 priv->session_ticket_renew = 1;
323 /* returns a positive number if we send the extension data, (0) if we
324 do not want to send it, and a negative number on failure.
327 session_ticket_send_params(gnutls_session_t session,
328 gnutls_buffer_st * extdata)
330 session_ticket_ext_st *priv = NULL;
331 extension_priv_data_t epriv;
335 _gnutls_ext_get_session_data(session,
336 GNUTLS_EXTENSION_SESSION_TICKET,
341 if (priv == NULL || !priv->session_ticket_enable)
344 if (session->security_parameters.entity == GNUTLS_SERVER) {
345 if (priv && priv->session_ticket_renew) {
346 return GNUTLS_E_INT_RET_0;
350 _gnutls_ext_get_resumed_session_data(session,
351 GNUTLS_EXTENSION_SESSION_TICKET,
356 /* no previous data. Just advertize it */
358 return GNUTLS_E_INT_RET_0;
360 /* previous data had session tickets disabled. Don't advertize. Ignore. */
361 if (!priv->session_ticket_enable)
364 if (priv->session_ticket_len > 0) {
366 _gnutls_buffer_append_data(extdata,
372 return gnutls_assert_val(ret);
374 return priv->session_ticket_len;
381 static void session_ticket_deinit_data(extension_priv_data_t epriv)
383 session_ticket_ext_st *priv = epriv.ptr;
385 gnutls_free(priv->session_ticket);
390 session_ticket_pack(extension_priv_data_t epriv, gnutls_buffer_st * ps)
392 session_ticket_ext_st *priv = epriv.ptr;
395 BUFFER_APPEND_PFX4(ps, priv->session_ticket,
396 priv->session_ticket_len);
397 BUFFER_APPEND_NUM(ps, priv->session_ticket_enable);
403 session_ticket_unpack(gnutls_buffer_st * ps, extension_priv_data_t * _priv)
405 session_ticket_ext_st *priv = NULL;
407 extension_priv_data_t epriv;
408 gnutls_datum_t ticket;
410 priv = gnutls_calloc(1, sizeof(*priv));
413 return GNUTLS_E_MEMORY_ERROR;
416 BUFFER_POP_DATUM(ps, &ticket);
417 priv->session_ticket = ticket.data;
418 priv->session_ticket_len = ticket.size;
419 BUFFER_POP_NUM(ps, priv->session_ticket_enable);
434 * gnutls_session_ticket_key_generate:
435 * @key: is a pointer to a #gnutls_datum_t which will contain a newly
438 * Generate a random key to encrypt security parameters within
441 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, or an
446 int gnutls_session_ticket_key_generate(gnutls_datum_t * key)
448 return gnutls_key_generate(key, SESSION_KEY_SIZE);
452 * gnutls_session_ticket_enable_client:
453 * @session: is a #gnutls_session_t structure.
455 * Request that the client should attempt session resumption using
458 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, or an
463 int gnutls_session_ticket_enable_client(gnutls_session_t session)
465 session_ticket_ext_st *priv = NULL;
466 extension_priv_data_t epriv;
470 return GNUTLS_E_INVALID_REQUEST;
473 priv = gnutls_calloc(1, sizeof(*priv));
476 return GNUTLS_E_MEMORY_ERROR;
478 priv->session_ticket_enable = 1;
481 _gnutls_ext_set_session_data(session,
482 GNUTLS_EXTENSION_SESSION_TICKET,
489 * gnutls_session_ticket_enable_server:
490 * @session: is a #gnutls_session_t structure.
491 * @key: key to encrypt session parameters.
493 * Request that the server should attempt session resumption using
494 * SessionTicket. @key must be initialized with
495 * gnutls_session_ticket_key_generate().
497 * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, or an
503 gnutls_session_ticket_enable_server(gnutls_session_t session,
504 const gnutls_datum_t * key)
506 session_ticket_ext_st *priv = NULL;
507 extension_priv_data_t epriv;
509 if (!session || !key || key->size != SESSION_KEY_SIZE) {
511 return GNUTLS_E_INVALID_REQUEST;
514 priv = gnutls_calloc(1, sizeof(*priv));
517 return GNUTLS_E_MEMORY_ERROR;
521 memcpy(&priv->key, key->data, key->size);
522 priv->session_ticket_enable = 1;
524 _gnutls_ext_set_session_data(session,
525 GNUTLS_EXTENSION_SESSION_TICKET,
531 int _gnutls_send_new_session_ticket(gnutls_session_t session, int again)
533 mbuffer_st *bufel = NULL;
534 uint8_t *data = NULL, *p;
537 struct ticket_st ticket;
539 session_ticket_ext_st *priv = NULL;
540 extension_priv_data_t epriv;
541 uint16_t epoch_saved = session->security_parameters.epoch_write;
545 _gnutls_ext_get_session_data(session,
546 GNUTLS_EXTENSION_SESSION_TICKET,
552 if (!priv->session_ticket_renew)
555 /* XXX: Temporarily set write algorithms to be used.
556 _gnutls_write_connection_state_init() does this job, but it also
557 triggers encryption, while NewSessionTicket should not be
558 encrypted in the record layer. */
560 _gnutls_epoch_set_keys(session,
561 session->security_parameters.
568 session->security_parameters.epoch_write =
569 session->security_parameters.epoch_next;
571 ret = encrypt_ticket(session, priv, &ticket);
572 session->security_parameters.epoch_write = epoch_saved;
579 KEY_NAME_SIZE + IV_SIZE + 2 +
580 ticket.encrypted_state_len + TAG_SIZE;
583 _gnutls_handshake_alloc(session,
587 gnutls_free(ticket.encrypted_state);
588 return GNUTLS_E_MEMORY_ERROR;
591 data = _mbuffer_get_udata_ptr(bufel);
594 _gnutls_write_uint32(session->internals.expire_time, p);
597 _gnutls_write_uint16(ticket_len, p);
600 memcpy(p, ticket.key_name, KEY_NAME_SIZE);
603 memcpy(p, ticket.IV, IV_SIZE);
606 _gnutls_write_uint16(ticket.encrypted_state_len, p);
609 memcpy(p, ticket.encrypted_state, ticket.encrypted_state_len);
610 gnutls_free(ticket.encrypted_state);
611 p += ticket.encrypted_state_len;
613 memcpy(p, ticket.tag, TAG_SIZE);
616 data_size = p - data;
618 session->internals.ticket_sent = 1;
620 return _gnutls_send_handshake(session, data_size ? bufel : NULL,
621 GNUTLS_HANDSHAKE_NEW_SESSION_TICKET);
624 int _gnutls_recv_new_session_ticket(gnutls_session_t session)
628 gnutls_buffer_st buf;
631 session_ticket_ext_st *priv = NULL;
632 extension_priv_data_t epriv;
635 _gnutls_ext_get_session_data(session,
636 GNUTLS_EXTENSION_SESSION_TICKET,
644 if (!priv->session_ticket_renew)
647 ret = _gnutls_recv_handshake(session,
648 GNUTLS_HANDSHAKE_NEW_SESSION_TICKET,
651 return gnutls_assert_val_fatal(ret);
654 data_size = buf.length;
656 DECR_LENGTH_COM(data_size, 4, ret =
657 GNUTLS_E_UNEXPECTED_PACKET_LENGTH;
659 /* skip over lifetime hint */
662 DECR_LENGTH_COM(data_size, 2, ret =
663 GNUTLS_E_UNEXPECTED_PACKET_LENGTH;
665 ticket_len = _gnutls_read_uint16(p);
668 DECR_LENGTH_COM(data_size, ticket_len, ret =
669 GNUTLS_E_UNEXPECTED_PACKET_LENGTH;
671 priv->session_ticket =
672 gnutls_realloc_fast(priv->session_ticket, ticket_len);
673 if (!priv->session_ticket) {
675 ret = GNUTLS_E_MEMORY_ERROR;
678 memcpy(priv->session_ticket, p, ticket_len);
679 priv->session_ticket_len = ticket_len;
681 /* Discard the current session ID. (RFC5077 3.4) */
683 _gnutls_generate_session_id(session->security_parameters.
685 &session->security_parameters.
689 gnutls_free(priv->session_ticket);
690 priv->session_ticket = NULL;
691 ret = GNUTLS_E_INTERNAL_ERROR;
697 _gnutls_buffer_clear(&buf);