ssl_ticket.h
Go to the documentation of this file.
/*
* Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
* 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.
*
* This file is part of mbed TLS (https://tls.mbed.org)
*/
#ifndef MBEDTLS_SSL_TICKET_H
#define MBEDTLS_SSL_TICKET_H
#if !defined(MBEDTLS_CONFIG_FILE)
#include "config.h"
#else
#include MBEDTLS_CONFIG_FILE
#endif
/*
* 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 "ssl.h"
#include "cipher.h"
#if defined(MBEDTLS_THREADING_C)
#include "threading.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
typedef struct mbedtls_ssl_ticket_key
{
unsigned char name[4];
uint32_t generation_time;
mbedtls_cipher_context_t ctx;
}
mbedtls_ssl_ticket_key;
typedef struct mbedtls_ssl_ticket_context
{
mbedtls_ssl_ticket_key keys[2];
unsigned char active;
uint32_t ticket_lifetime;
int (*f_rng)(void *, unsigned char *, size_t);
void *p_rng;
#if defined(MBEDTLS_THREADING_C)
mbedtls_threading_mutex_t 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 */
mbedtls_ssl_ticket_key
Information for session ticket protection.
Definition: ssl_ticket.h:53
mbedtls_ssl_ticket_context::active
unsigned char active
Definition: ssl_ticket.h:67
mbedtls_ssl_ticket_write
mbedtls_ssl_ticket_write_t mbedtls_ssl_ticket_write
Implementation of the ticket write callback.
Definition: ssl_ticket.h:122
mbedtls_ssl_ticket_setup
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)
Prepare context to be actually used.
mbedtls_ssl_ticket_free
void mbedtls_ssl_ticket_free(mbedtls_ssl_ticket_context *ctx)
Free a context's content and zeroize it.
mbedtls_ssl_ticket_write_t
int mbedtls_ssl_ticket_write_t(void *p_ticket, const mbedtls_ssl_session *session, unsigned char *start, const unsigned char *end, size_t *tlen, uint32_t *lifetime)
Callback type: generate and write session ticket.
Definition: ssl.h:1506
mbedtls_threading_mutex_t
Definition: threading.h:48
mbedtls_ssl_ticket_init
void mbedtls_ssl_ticket_init(mbedtls_ssl_ticket_context *ctx)
Initialize a ticket context. (Just make it ready for mbedtls_ssl_ticket_setup() or mbedtls_ssl_ticket...
mbedtls_ssl_ticket_parse_t
int mbedtls_ssl_ticket_parse_t(void *p_ticket, mbedtls_ssl_session *session, unsigned char *buf, size_t len)
Callback type: parse and load session ticket.
Definition: ssl.h:1565
mbedtls_ssl_ticket_key::generation_time
uint32_t generation_time
Definition: ssl_ticket.h:56
mbedtls_ssl_ticket_key::ctx
mbedtls_cipher_context_t ctx
Definition: ssl_ticket.h:57
mbedtls_ssl_ticket_context::p_rng
void * p_rng
Definition: ssl_ticket.h:73
mbedtls_ssl_ticket_key::name
unsigned char name[4]
Definition: ssl_ticket.h:55
mbedtls_ssl_ticket_context
Context for session ticket handling functions.
Definition: ssl_ticket.h:64
cipher.h
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
mbedtls_ssl_ticket_context::ticket_lifetime
uint32_t ticket_lifetime
Definition: ssl_ticket.h:69
ssl.h
SSL/TLS functions.
mbedtls_ssl_ticket_context::keys
mbedtls_ssl_ticket_key keys[2]
Definition: ssl_ticket.h:66
threading.h
Threading abstraction layer.
mbedtls_cipher_context_t
Definition: cipher.h:284
config.h
Configuration options (set of defines)
mbedtls_ssl_ticket_context
struct mbedtls_ssl_ticket_context mbedtls_ssl_ticket_context
Context for session ticket handling functions.
mbedtls_ssl_ticket_key
struct mbedtls_ssl_ticket_key mbedtls_ssl_ticket_key
Information for session ticket protection.
mbedtls_ssl_ticket_context::f_rng
int(* f_rng)(void *, unsigned char *, size_t)
Definition: ssl_ticket.h:72
mbedtls_ssl_ticket_parse
mbedtls_ssl_ticket_parse_t mbedtls_ssl_ticket_parse
Implementation of the ticket parse callback.
Definition: ssl_ticket.h:129
mbedtls_cipher_type_t
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:104
mbedtls_ssl_ticket_context::mutex
mbedtls_threading_mutex_t mutex
Definition: ssl_ticket.h:76