ssl_cache.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_CACHE_H
#define MBEDTLS_SSL_CACHE_H
#if !defined(MBEDTLS_CONFIG_FILE)
#include "config.h"
#else
#include MBEDTLS_CONFIG_FILE
#endif
#include "ssl.h"
#if defined(MBEDTLS_THREADING_C)
#include "threading.h"
#endif
#if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
#endif
#if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
#endif
/* \} name SECTION: Module settings */
#ifdef __cplusplus
extern "C" {
#endif
typedef struct mbedtls_ssl_cache_context mbedtls_ssl_cache_context;
typedef struct mbedtls_ssl_cache_entry mbedtls_ssl_cache_entry;
struct mbedtls_ssl_cache_entry
{
#if defined(MBEDTLS_HAVE_TIME)
mbedtls_time_t timestamp;
#endif
mbedtls_ssl_session session;
#if defined(MBEDTLS_X509_CRT_PARSE_C)
mbedtls_x509_buf peer_cert;
#endif
mbedtls_ssl_cache_entry *next;
};
struct mbedtls_ssl_cache_context
{
mbedtls_ssl_cache_entry *chain;
int timeout;
int max_entries;
#if defined(MBEDTLS_THREADING_C)
mbedtls_threading_mutex_t mutex;
#endif
};
void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache );
int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
#if defined(MBEDTLS_HAVE_TIME)
void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
#endif /* MBEDTLS_HAVE_TIME */
void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max );
void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache );
#ifdef __cplusplus
}
#endif
#endif /* ssl_cache.h */
mbedtls_ssl_cache_get
int mbedtls_ssl_cache_get(void *data, mbedtls_ssl_session *session)
Cache get callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled)
mbedtls_ssl_cache_entry::timestamp
mbedtls_time_t timestamp
Definition: ssl_cache.h:70
mbedtls_ssl_session
Definition: ssl.h:789
mbedtls_ssl_cache_set_timeout
void mbedtls_ssl_cache_set_timeout(mbedtls_ssl_cache_context *cache, int timeout)
Set the cache timeout (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day))
mbedtls_threading_mutex_t
Definition: threading.h:48
mbedtls_time_t
time_t mbedtls_time_t
Definition: platform_time.h:53
mbedtls_ssl_cache_context
Cache context.
Definition: ssl_cache.h:82
mbedtls_ssl_cache_context::chain
mbedtls_ssl_cache_entry * chain
Definition: ssl_cache.h:84
mbedtls_ssl_cache_entry
This structure is used for storing cache entries.
Definition: ssl_cache.h:67
mbedtls_ssl_cache_entry::session
mbedtls_ssl_session session
Definition: ssl_cache.h:72
mbedtls_ssl_cache_set
int mbedtls_ssl_cache_set(void *data, const mbedtls_ssl_session *session)
Cache set callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled)
mbedtls_ssl_cache_init
void mbedtls_ssl_cache_init(mbedtls_ssl_cache_context *cache)
Initialize an SSL cache context.
mbedtls_ssl_cache_context::max_entries
int max_entries
Definition: ssl_cache.h:86
ssl.h
SSL/TLS functions.
mbedtls_ssl_cache_context::mutex
mbedtls_threading_mutex_t mutex
Definition: ssl_cache.h:88
mbedtls_ssl_cache_entry::peer_cert
mbedtls_x509_buf peer_cert
Definition: ssl_cache.h:74
threading.h
Threading abstraction layer.
mbedtls_ssl_cache_context::timeout
int timeout
Definition: ssl_cache.h:85
mbedtls_ssl_cache_free
void mbedtls_ssl_cache_free(mbedtls_ssl_cache_context *cache)
Free referenced items in a cache context and clear memory.
mbedtls_ssl_cache_set_max_entries
void mbedtls_ssl_cache_set_max_entries(mbedtls_ssl_cache_context *cache, int max)
Set the maximum number of cache entries (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50))
config.h
Configuration options (set of defines)
mbedtls_asn1_buf
Definition: asn1.h:134
mbedtls_ssl_cache_entry::next
mbedtls_ssl_cache_entry * next
Definition: ssl_cache.h:76