ssl_ticket.c 13.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
/*
 *  TLS server tickets callbacks implementation
 *
 *  Copyright (C) 2015, ARM Limited, All Rights Reserved
 *
 *  This file is part of mbed TLS (https://tls.mbed.org)
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#if !defined(MBEDTLS_CONFIG_FILE)
#include "mbedtls/config.h"
#else
#include MBEDTLS_CONFIG_FILE
#endif

#if defined(MBEDTLS_SSL_TICKET_C)

#include "mbedtls/ssl_ticket.h"

#if defined(MBEDTLS_PLATFORM_C)
#include "mbedtls/platform.h"
#else
36 37
#include <stdlib.h>
#define mbedtls_calloc    calloc
38 39 40 41 42
#define mbedtls_free       free
#endif

#include <string.h>

43 44 45 46 47 48 49 50 51 52 53
/* Implementation that should never be optimized out by the compiler */
static void mbedtls_zeroize( void *v, size_t n ) {
    volatile unsigned char *p = v; while( n-- ) *p++ = 0;
}

/*
 * Initialze context
 */
void mbedtls_ssl_ticket_init( mbedtls_ssl_ticket_context *ctx )
{
    memset( ctx, 0, sizeof( mbedtls_ssl_ticket_context ) );
54 55 56 57

#if defined(MBEDTLS_THREADING_C)
    mbedtls_mutex_init( &ctx->mutex );
#endif
58 59
}

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
#define MAX_KEY_BYTES 32    /* 256 bits */

/*
 * Generate/update a key
 */
static int ssl_ticket_gen_key( mbedtls_ssl_ticket_context *ctx,
                               unsigned char index )
{
    int ret;
    unsigned char buf[MAX_KEY_BYTES];
    mbedtls_ssl_ticket_key *key = ctx->keys + index;

#if defined(MBEDTLS_HAVE_TIME)
    key->generation_time = (uint32_t) time( NULL );
#endif

    if( ( ret = ctx->f_rng( ctx->p_rng, key->name, sizeof( key->name ) ) ) != 0 )
        return( ret );

    if( ( ret = ctx->f_rng( ctx->p_rng, buf, sizeof( buf ) ) ) != 0 )
        return( ret );

    /* With GCM and CCM, same context can encrypt & decrypt */
    ret = mbedtls_cipher_setkey( &key->ctx, buf,
                                 mbedtls_cipher_get_key_size( &key->ctx ),
                                 MBEDTLS_ENCRYPT );

    mbedtls_zeroize( buf, sizeof( buf ) );

    return( ret );
}

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/*
 * Rotate/generate keys if necessary
 */
static int ssl_ticket_update_keys( mbedtls_ssl_ticket_context *ctx )
{
#if !defined(MBEDTLS_HAVE_TIME)
    ((void) ctx);
#else
    if( ctx->ticket_lifetime != 0 )
    {
        uint32_t current_time = (uint32_t) time( NULL );
        uint32_t key_time = ctx->keys[ctx->active].generation_time;

        if( current_time > key_time &&
            current_time - key_time < ctx->ticket_lifetime )
        {
            return( 0 );
        }

        ctx->active = 1 - ctx->active;

        return( ssl_ticket_gen_key( ctx, ctx->active ) );
    }
    else
#endif /* MBEDTLS_HAVE_TIME */
        return( 0 );
}

120 121 122 123 124
/*
 * Setup context for actual use
 */
int mbedtls_ssl_ticket_setup( mbedtls_ssl_ticket_context *ctx,
    int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
125
    mbedtls_cipher_type_t cipher,
126 127 128
    uint32_t lifetime )
{
    int ret;
129
    const mbedtls_cipher_info_t *cipher_info;
130 131 132 133 134 135

    ctx->f_rng = f_rng;
    ctx->p_rng = p_rng;

    ctx->ticket_lifetime = lifetime;

136 137 138
    cipher_info = mbedtls_cipher_info_from_type( cipher);
    if( cipher_info == NULL )
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
139

140 141
    if( cipher_info->mode != MBEDTLS_MODE_GCM &&
        cipher_info->mode != MBEDTLS_MODE_CCM )
142
    {
143
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
144 145
    }

146 147
    if( cipher_info->key_length > 8 * MAX_KEY_BYTES )
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
148

149 150
    if( ( ret = mbedtls_cipher_setup( &ctx->keys[0].ctx, cipher_info ) ) != 0 ||
        ( ret = mbedtls_cipher_setup( &ctx->keys[1].ctx, cipher_info ) ) != 0 )
151
    {
152
        return( ret );
153 154
    }

155 156
    if( ( ret = ssl_ticket_gen_key( ctx, 0 ) ) != 0 ||
        ( ret = ssl_ticket_gen_key( ctx, 1 ) ) != 0 )
157
    {
158
        return( ret );
159 160
    }

161
    return( 0 );
162 163
}

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
/*
 * Serialize a session in the following format:
 *  0   .   n-1     session structure, n = sizeof(mbedtls_ssl_session)
 *  n   .   n+2     peer_cert length = m (0 if no certificate)
 *  n+3 .   n+2+m   peer cert ASN.1
 */
static int ssl_save_session( const mbedtls_ssl_session *session,
                             unsigned char *buf, size_t buf_len,
                             size_t *olen )
{
    unsigned char *p = buf;
    size_t left = buf_len;
#if defined(MBEDTLS_X509_CRT_PARSE_C)
    size_t cert_len;
#endif /* MBEDTLS_X509_CRT_PARSE_C */

    if( left < sizeof( mbedtls_ssl_session ) )
181
        return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
182 183 184 185 186 187 188 189 190 191 192 193

    memcpy( p, session, sizeof( mbedtls_ssl_session ) );
    p += sizeof( mbedtls_ssl_session );
    left -= sizeof( mbedtls_ssl_session );

#if defined(MBEDTLS_X509_CRT_PARSE_C)
    if( session->peer_cert == NULL )
        cert_len = 0;
    else
        cert_len = session->peer_cert->raw.len;

    if( left < 3 + cert_len )
194
        return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

    *p++ = (unsigned char)( cert_len >> 16 & 0xFF );
    *p++ = (unsigned char)( cert_len >>  8 & 0xFF );
    *p++ = (unsigned char)( cert_len       & 0xFF );

    if( session->peer_cert != NULL )
        memcpy( p, session->peer_cert->raw.p, cert_len );

    p += cert_len;
#endif /* MBEDTLS_X509_CRT_PARSE_C */

    *olen = p - buf;

    return( 0 );
}

/*
 * Unserialise session, see ssl_save_session()
 */
static int ssl_load_session( mbedtls_ssl_session *session,
                             const unsigned char *buf, size_t len )
{
    const unsigned char *p = buf;
    const unsigned char * const end = buf + len;
#if defined(MBEDTLS_X509_CRT_PARSE_C)
    size_t cert_len;
#endif /* MBEDTLS_X509_CRT_PARSE_C */

    if( p + sizeof( mbedtls_ssl_session ) > end )
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

    memcpy( session, p, sizeof( mbedtls_ssl_session ) );
    p += sizeof( mbedtls_ssl_session );

#if defined(MBEDTLS_X509_CRT_PARSE_C)
    if( p + 3 > end )
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

    cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
    p += 3;

    if( cert_len == 0 )
    {
        session->peer_cert = NULL;
    }
    else
    {
        int ret;

        if( p + cert_len > end )
            return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

247
        session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

        if( session->peer_cert == NULL )
            return( MBEDTLS_ERR_SSL_MALLOC_FAILED );

        mbedtls_x509_crt_init( session->peer_cert );

        if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
                                        p, cert_len ) ) != 0 )
        {
            mbedtls_x509_crt_free( session->peer_cert );
            mbedtls_free( session->peer_cert );
            session->peer_cert = NULL;
            return( ret );
        }

        p += cert_len;
    }
#endif /* MBEDTLS_X509_CRT_PARSE_C */

    if( p != end )
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

    return( 0 );
}

/*
274
 * Create session ticket, with the following structure:
275 276
 *
 *    struct {
277 278
 *        opaque key_name[4];
 *        opaque iv[12];
279
 *        opaque encrypted_state<0..2^16-1>;
280
 *        opaque tag[16];
281 282
 *    } ticket;
 *
283 284
 * The key_name, iv, and length of encrypted_state are the additional
 * authenticated data.
285
 */
286
int mbedtls_ssl_ticket_write( void *p_ticket,
287 288 289
                              const mbedtls_ssl_session *session,
                              unsigned char *start,
                              const unsigned char *end,
290 291
                              size_t *tlen,
                              uint32_t *ticket_lifetime )
292 293
{
    int ret;
294
    mbedtls_ssl_ticket_context *ctx = p_ticket;
295
    mbedtls_ssl_ticket_key *key;
296 297 298 299 300 301
    unsigned char *key_name = start;
    unsigned char *iv = start + 4;
    unsigned char *state_len_bytes = iv + 12;
    unsigned char *state = state_len_bytes + 2;
    unsigned char *tag;
    size_t clear_len, ciph_len;
302 303 304

    *tlen = 0;

305
    if( ctx == NULL || ctx->f_rng == NULL )
306 307
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

308 309 310
    /* We need at least 4 bytes for key_name, 12 for IV, 2 for len 16 for tag,
     * in addition to session itself, that will be checked when writing it. */
    if( end - start < 4 + 12 + 2 + 16 )
311 312
        return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );

313 314 315 316 317
#if defined(MBEDTLS_THREADING_C)
    if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
        return( ret );
#endif

318 319 320 321 322
    if( ( ret = ssl_ticket_update_keys( ctx ) ) != 0 )
        goto cleanup;

    key = &ctx->keys[ctx->active];

323 324
    *ticket_lifetime = ctx->ticket_lifetime;

325
    memcpy( key_name, key->name, 4 );
326

327
    if( ( ret = ctx->f_rng( ctx->p_rng, iv, 12 ) ) != 0 )
328
        goto cleanup;
329

330
    /* Dump session state */
331
    if( ( ret = ssl_save_session( session,
332 333
                                  state, end - state, &clear_len ) ) != 0 ||
        (unsigned long) clear_len > 65535 )
334 335 336
    {
         goto cleanup;
    }
337 338 339 340 341
    state_len_bytes[0] = ( clear_len >> 8 ) & 0xff;
    state_len_bytes[1] = ( clear_len      ) & 0xff;

    /* Encrypt and authenticate */
    tag = state + clear_len;
342
    if( ( ret = mbedtls_cipher_auth_encrypt( &key->ctx,
343 344
                    iv, 12, key_name, 4 + 12 + 2,
                    state, clear_len, state, &ciph_len, tag, 16 ) ) != 0 )
345
    {
346
        goto cleanup;
347
    }
348
    if( ciph_len != clear_len )
349
    {
350
        ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
351
        goto cleanup;
352 353
    }

354
    *tlen = 4 + 12 + 2 + 16 + ciph_len;
355

356 357 358 359 360 361 362
cleanup:
#if defined(MBEDTLS_THREADING_C)
    if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
        return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
#endif

    return( ret );
363 364
}

365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
/*
 * Select key based on name
 */
static mbedtls_ssl_ticket_key *ssl_ticket_select_key(
        mbedtls_ssl_ticket_context *ctx,
        const unsigned char name[4] )
{
    unsigned char i;

    for( i = 0; i < sizeof( ctx->keys ) / sizeof( *ctx->keys ); i++ )
        if( memcmp( name, ctx->keys[i].name, 4 ) == 0 )
            return( &ctx->keys[i] );

    return( NULL );
}

381 382 383
/*
 * Load session ticket (see mbedtls_ssl_ticket_write for structure)
 */
384
int mbedtls_ssl_ticket_parse( void *p_ticket,
385 386 387
                              mbedtls_ssl_session *session,
                              unsigned char *buf,
                              size_t len )
388 389
{
    int ret;
390
    mbedtls_ssl_ticket_context *ctx = p_ticket;
391
    mbedtls_ssl_ticket_key *key;
392
    unsigned char *key_name = buf;
393 394
    unsigned char *iv = buf + 4;
    unsigned char *enc_len_p = iv + 12;
395
    unsigned char *ticket = enc_len_p + 2;
396 397
    unsigned char *tag;
    size_t enc_len, clear_len;
398

399 400 401 402 403
    if( ctx == NULL || ctx->f_rng == NULL )
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

    /* See mbedtls_ssl_ticket_write() */
    if( len < 4 + 12 + 2 + 16 )
404 405
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

406 407 408 409 410
#if defined(MBEDTLS_THREADING_C)
    if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
        return( ret );
#endif

411 412 413
    if( ( ret = ssl_ticket_update_keys( ctx ) ) != 0 )
        goto cleanup;

414
    enc_len = ( enc_len_p[0] << 8 ) | enc_len_p[1];
415
    tag = ticket + enc_len;
416

417
    if( len != 4 + 12 + 2 + enc_len + 16 )
418 419 420 421
    {
        ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
        goto cleanup;
    }
422

423 424
    /* Select key */
    if( ( key = ssl_ticket_select_key( ctx, key_name ) ) == NULL )
425
    {
426 427 428
        /* We can't know for sure but this is a likely option unless we're
         * under attack - this is only informative anyway */
        ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
429
        goto cleanup;
430 431
    }

432
    /* Decrypt and authenticate */
433
    if( ( ret = mbedtls_cipher_auth_decrypt( &key->ctx, iv, 12,
434 435
                    key_name, 4 + 12 + 2, ticket, enc_len,
                    ticket, &clear_len, tag, 16 ) ) != 0 )
436
    {
437 438 439
        if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
            ret = MBEDTLS_ERR_SSL_INVALID_MAC;

440 441
        goto cleanup;
    }
442
    if( clear_len != enc_len )
443
    {
444
        ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
445
        goto cleanup;
446 447 448
    }

    /* Actually load session */
449
    if( ( ret = ssl_load_session( session, ticket, clear_len ) ) != 0 )
450
        goto cleanup;
451 452

#if defined(MBEDTLS_HAVE_TIME)
453
    {
454 455 456 457 458 459 460 461 462
        /* Check for expiration */
        time_t current_time = time( NULL );

        if( current_time < session->start ||
            (uint32_t)( current_time - session->start ) > ctx->ticket_lifetime )
        {
            ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
            goto cleanup;
        }
463
    }
464 465
#endif

466 467 468 469 470 471 472
cleanup:
#if defined(MBEDTLS_THREADING_C)
    if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
        return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
#endif

    return( ret );
473 474
}

475 476 477 478 479
/*
 * Free context
 */
void mbedtls_ssl_ticket_free( mbedtls_ssl_ticket_context *ctx )
{
480 481
    mbedtls_cipher_free( &ctx->keys[0].ctx );
    mbedtls_cipher_free( &ctx->keys[1].ctx );
482

483 484 485 486
#if defined(MBEDTLS_THREADING_C)
    mbedtls_mutex_free( &ctx->mutex );
#endif

487 488 489
    mbedtls_zeroize( ctx, sizeof( mbedtls_ssl_ticket_context ) );
}

490
#endif /* MBEDTLS_SSL_TICKET_C */