mbed TLS v2.28.0
ssl_cache.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
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 #ifndef MBEDTLS_SSL_CACHE_H
23 #define MBEDTLS_SSL_CACHE_H
24 
25 #if !defined(MBEDTLS_CONFIG_FILE)
26 #include "mbedtls/config.h"
27 #else
28 #include MBEDTLS_CONFIG_FILE
29 #endif
30 
31 #include "mbedtls/ssl.h"
32 
33 #if defined(MBEDTLS_THREADING_C)
34 #include "mbedtls/threading.h"
35 #endif
36 
45 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
46 #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
47 #endif
48 
49 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
50 #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
51 #endif
52 
53 /* \} name SECTION: Module settings */
54 
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58 
61 
66 {
67 #if defined(MBEDTLS_HAVE_TIME)
69 #endif
71 #if defined(MBEDTLS_X509_CRT_PARSE_C) && \
72  defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
74 #endif
76 };
77 
82 {
84  int timeout;
86 #if defined(MBEDTLS_THREADING_C)
88 #endif
89 };
90 
97 
105 int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
106 
114 int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
115 
116 #if defined(MBEDTLS_HAVE_TIME)
117 
126 void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
127 #endif /* MBEDTLS_HAVE_TIME */
128 
137 
144 
145 #ifdef __cplusplus
146 }
147 #endif
148 
149 #endif /* ssl_cache.h */
mbedtls_x509_buf peer_cert
Definition: ssl_cache.h:73
Configuration options (set of defines)
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))
time_t mbedtls_time_t
Definition: platform_time.h:51
mbedtls_ssl_cache_entry * chain
Definition: ssl_cache.h:83
Threading abstraction layer.
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)) ...
void mbedtls_ssl_cache_init(mbedtls_ssl_cache_context *cache)
Initialize an SSL cache context.
mbedtls_threading_mutex_t mutex
Definition: ssl_cache.h:87
int mbedtls_ssl_cache_get(void *data, mbedtls_ssl_session *session)
Cache get callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) ...
mbedtls_time_t timestamp
Definition: ssl_cache.h:68
int mbedtls_ssl_cache_set(void *data, const mbedtls_ssl_session *session)
Cache set callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) ...
void mbedtls_ssl_cache_free(mbedtls_ssl_cache_context *cache)
Free referenced items in a cache context and clear memory.
This structure is used for storing cache entries.
Definition: ssl_cache.h:65
Cache context.
Definition: ssl_cache.h:81
SSL/TLS functions.
mbedtls_ssl_cache_entry * next
Definition: ssl_cache.h:75
mbedtls_ssl_session session
Definition: ssl_cache.h:70