mbed TLS v2.23.0

ssl_cache.h
Go to the documentation of this file.
1
6 /*
7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 *
22 * This file is part of mbed TLS (https://tls.mbed.org)
23 */
24 #ifndef MBEDTLS_SSL_CACHE_H
25 #define MBEDTLS_SSL_CACHE_H
26
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "mbedtls/config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32
33 #include "mbedtls/ssl.h"
34
35 #if defined(MBEDTLS_THREADING_C)
36 #include "mbedtls/threading.h"
37 #endif
38
47 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
48 #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
49 #endif
50
51 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
52 #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
53 #endif
54
55 /* \} name SECTION: Module settings */
56
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60
61 typedef struct mbedtls_ssl_cache_context mbedtls_ssl_cache_context;
62 typedef struct mbedtls_ssl_cache_entry mbedtls_ssl_cache_entry;
63
67 struct mbedtls_ssl_cache_entry
68 {
69 #if defined(MBEDTLS_HAVE_TIME)
70 mbedtls_time_t timestamp;
71 #endif
72 mbedtls_ssl_session session;
73 #if defined(MBEDTLS_X509_CRT_PARSE_C) && \
74 defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
75 mbedtls_x509_buf peer_cert;
76 #endif
77 mbedtls_ssl_cache_entry *next;
78 };
79
83 struct mbedtls_ssl_cache_context
84 {
85 mbedtls_ssl_cache_entry *chain;
86 int timeout;
87 int max_entries;
88 #if defined(MBEDTLS_THREADING_C)
89 mbedtls_threading_mutex_t mutex;
90 #endif
91 };
92
98 void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache );
99
107 int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
108
116 int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
117
118 #if defined(MBEDTLS_HAVE_TIME)
119
128 void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
129 #endif /* MBEDTLS_HAVE_TIME */
130
138 void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max );
139
145 void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache );
146
147 #ifdef __cplusplus
148 }
149 #endif
150
151 #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:868
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_time_t
time_t mbedtls_time_t
Definition: platform_time.h:53
mbedtls_ssl_cache_context
Cache context.
Definition: ssl_cache.h:84
mbedtls_ssl_cache_context::chain
mbedtls_ssl_cache_entry * chain
Definition: ssl_cache.h:85
mbedtls_ssl_cache_entry
This structure is used for storing cache entries.
Definition: ssl_cache.h:68
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:87
ssl.h
SSL/TLS functions.
mbedtls_ssl_cache_entry::peer_cert
mbedtls_x509_buf peer_cert
Definition: ssl_cache.h:75
threading.h
Threading abstraction layer.
mbedtls_ssl_cache_context::timeout
int timeout
Definition: ssl_cache.h:86
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:152
mbedtls_ssl_cache_entry::next
mbedtls_ssl_cache_entry * next
Definition: ssl_cache.h:77