ssl_ticket.c 10.5 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 36 37 38 39 40 41
/*
 *  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
#define mbedtls_malloc     malloc
#define mbedtls_free       free
#endif

#include <string.h>

42 43 44 45 46 47 48 49 50 51 52
/* 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 ) );
53 54 55 56

#if defined(MBEDTLS_THREADING_C)
    mbedtls_mutex_init( &ctx->mutex );
#endif
57 58 59 60 61 62 63 64 65 66
}

/*
 * 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,
    uint32_t lifetime )
{
    int ret;
67
    unsigned char buf[32];
68 69 70 71 72 73

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

    ctx->ticket_lifetime = lifetime;

74 75 76 77 78 79
    if( ( ret = mbedtls_cipher_setup( &ctx->cipher,
                mbedtls_cipher_info_from_type(
                    MBEDTLS_CIPHER_AES_256_GCM ) ) ) != 0 )
    {
        goto cleanup;
    }
80

81
    if( ( ret = f_rng( p_rng, buf, sizeof( buf ) ) != 0 ) )
82
    {
83
        goto cleanup;
84 85
    }

86 87 88
    /* With GCM and CCM, same context can encrypt & decrypt */
    if( ( ret = mbedtls_cipher_setkey( &ctx->cipher, buf, 256,
                                       MBEDTLS_ENCRYPT ) ) != 0 )
89
    {
90
        goto cleanup;
91 92
    }

93
cleanup:
94 95
    mbedtls_zeroize( buf, sizeof( buf ) );

96 97 98 99
    if( ret != 0 )
        mbedtls_ssl_ticket_free( ctx );

    return( ret );
100 101
}

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/*
 * 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 ) )
119
        return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
120 121 122 123 124 125 126 127 128 129 130 131

    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 )
132
        return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

    *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 );

        session->peer_cert = mbedtls_malloc( sizeof( mbedtls_x509_crt ) );

        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 );
}

/*
212
 * Create session ticket, with the following structure:
213 214
 *
 *    struct {
215 216
 *        opaque key_name[4];
 *        opaque iv[12];
217
 *        opaque encrypted_state<0..2^16-1>;
218
 *        opaque tag[16];
219 220
 *    } ticket;
 *
221 222
 * The key_name, iv, and length of encrypted_state are the additional
 * authenticated data.
223
 */
224
int mbedtls_ssl_ticket_write( void *p_ticket,
225 226 227
                              const mbedtls_ssl_session *session,
                              unsigned char *start,
                              const unsigned char *end,
228 229
                              size_t *tlen,
                              uint32_t *ticket_lifetime )
230 231
{
    int ret;
232
    mbedtls_ssl_ticket_context *ctx = p_ticket;
233 234 235 236 237 238
    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;
239 240 241

    *tlen = 0;

242
    if( ctx == NULL || ctx->f_rng == NULL )
243 244
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );

245 246 247
    /* 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 )
248 249
        return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );

250 251 252 253 254 255 256
#if defined(MBEDTLS_THREADING_C)
    if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
        return( ret );
#endif

    *ticket_lifetime = ctx->ticket_lifetime;

257
    memcpy( key_name, ctx->key_name, 4 );
258

259
    if( ( ret = ctx->f_rng( ctx->p_rng, iv, 12 ) ) != 0 )
260
        goto cleanup;
261

262
    /* Dump session state */
263
    if( ( ret = ssl_save_session( session,
264 265
                                  state, end - state, &clear_len ) ) != 0 ||
        (unsigned long) clear_len > 65535 )
266 267 268
    {
         goto cleanup;
    }
269 270 271 272 273 274 275 276
    state_len_bytes[0] = ( clear_len >> 8 ) & 0xff;
    state_len_bytes[1] = ( clear_len      ) & 0xff;

    /* Encrypt and authenticate */
    tag = state + clear_len;
    if( ( ret = mbedtls_cipher_auth_encrypt( &ctx->cipher,
                    iv, 12, key_name, 4 + 12 + 2,
                    state, clear_len, state, &ciph_len, tag, 16 ) ) != 0 )
277
    {
278
        goto cleanup;
279
    }
280
    if( ciph_len != clear_len )
281
    {
282
        ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
283
        goto cleanup;
284 285
    }

286
    *tlen = 4 + 12 + 2 + 16 + ciph_len;
287

288 289 290 291 292 293 294
cleanup:
#if defined(MBEDTLS_THREADING_C)
    if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
        return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
#endif

    return( ret );
295 296 297 298 299
}

/*
 * Load session ticket (see mbedtls_ssl_ticket_write for structure)
 */
300
int mbedtls_ssl_ticket_parse( void *p_ticket,
301 302 303
                              mbedtls_ssl_session *session,
                              unsigned char *buf,
                              size_t len )
304 305
{
    int ret;
306
    mbedtls_ssl_ticket_context *ctx = p_ticket;
307
    unsigned char *key_name = buf;
308 309
    unsigned char *iv = buf + 4;
    unsigned char *enc_len_p = iv + 12;
310
    unsigned char *ticket = enc_len_p + 2;
311 312
    unsigned char *tag;
    size_t enc_len, clear_len;
313

314 315 316
    if( ctx == NULL || ctx->f_rng == NULL ||
        len < 4 + 12 + 2 + 16 )
    {
317
        return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
318
    }
319

320 321 322 323 324
#if defined(MBEDTLS_THREADING_C)
    if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
        return( ret );
#endif

325
    enc_len = ( enc_len_p[0] << 8 ) | enc_len_p[1];
326
    tag = ticket + enc_len;
327

328
    if( len != 4 + 12 + 2 + enc_len + 16 )
329 330 331 332
    {
        ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
        goto cleanup;
    }
333

334 335
    /* Check name (public data) */
    if( memcmp( key_name, ctx->key_name, 4 ) != 0 )
336
    {
337
        ret = MBEDTLS_ERR_SSL_INVALID_MAC;
338
        goto cleanup;
339 340
    }

341 342 343 344
    /* Decrypt and authenticate */
    if( ( ret = mbedtls_cipher_auth_decrypt( &ctx->cipher, iv, 12,
                    key_name, 4 + 12 + 2, ticket, enc_len,
                    ticket, &clear_len, tag, 16 ) ) != 0 )
345
    {
346
        /* TODO: convert AUTH_FAILED to INVALID_MAC */
347 348
        goto cleanup;
    }
349
    if( clear_len != enc_len )
350
    {
351
        ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
352
        goto cleanup;
353 354 355
    }

    /* Actually load session */
356
    if( ( ret = ssl_load_session( session, ticket, clear_len ) ) != 0 )
357
        goto cleanup;
358 359

#if defined(MBEDTLS_HAVE_TIME)
360
    {
361 362 363 364 365 366 367 368 369
        /* 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;
        }
370
    }
371 372
#endif

373 374 375 376 377 378 379
cleanup:
#if defined(MBEDTLS_THREADING_C)
    if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
        return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
#endif

    return( ret );
380 381
}

382 383 384 385 386
/*
 * Free context
 */
void mbedtls_ssl_ticket_free( mbedtls_ssl_ticket_context *ctx )
{
387
    mbedtls_cipher_free( &ctx->cipher );
388

389 390 391 392
#if defined(MBEDTLS_THREADING_C)
    mbedtls_mutex_free( &ctx->mutex );
#endif

393 394 395
    mbedtls_zeroize( ctx, sizeof( mbedtls_ssl_ticket_context ) );
}

396
#endif /* MBEDTLS_SSL_TICKET_C */