ssl_ticket.h

Go to the documentation of this file.

/*
 *  Copyright The Mbed TLS Contributors
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may
 *  not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
#ifndef MBEDTLS_SSL_TICKET_H
#define MBEDTLS_SSL_TICKET_H
#include "mbedtls/private_access.h"

#include "mbedtls/build_info.h"

/*
 * This implementation of the session ticket callbacks includes key
 * management, rotating the keys periodically in order to preserve forward
 * secrecy, when MBEDTLS_HAVE_TIME is defined.
 */

#include "mbedtls/ssl.h"
#include "mbedtls/cipher.h"

#if defined(MBEDTLS_THREADING_C)
#include "mbedtls/threading.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef struct mbedtls_ssl_ticket_key
{
    unsigned char MBEDTLS_PRIVATE(name)[4];          
    uint32_t MBEDTLS_PRIVATE(generation_time);       
    mbedtls_cipher_context_t MBEDTLS_PRIVATE(ctx);   
}
mbedtls_ssl_ticket_key;

typedef struct mbedtls_ssl_ticket_context
{
    mbedtls_ssl_ticket_key MBEDTLS_PRIVATE(keys)[2]; 
    unsigned char MBEDTLS_PRIVATE(active);           
    uint32_t MBEDTLS_PRIVATE(ticket_lifetime);       
    int  (*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
    void *MBEDTLS_PRIVATE(p_rng);                    
#if defined(MBEDTLS_THREADING_C)
    mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
#endif
}
mbedtls_ssl_ticket_context;

void mbedtls_ssl_ticket_init( mbedtls_ssl_ticket_context *ctx );

int mbedtls_ssl_ticket_setup( mbedtls_ssl_ticket_context *ctx,
    int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
    mbedtls_cipher_type_t cipher,
    uint32_t lifetime );

mbedtls_ssl_ticket_write_t mbedtls_ssl_ticket_write;

mbedtls_ssl_ticket_parse_t mbedtls_ssl_ticket_parse;

void mbedtls_ssl_ticket_free( mbedtls_ssl_ticket_context *ctx );

#ifdef __cplusplus
}
#endif

#endif /* ssl_ticket.h */