mbed TLS v2.7.16
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 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  *
49  * This file is part of mbed TLS (https://tls.mbed.org)
50  */
51 #ifndef MBEDTLS_SSL_CACHE_H
52 #define MBEDTLS_SSL_CACHE_H
53 
54 #if !defined(MBEDTLS_CONFIG_FILE)
55 #include "config.h"
56 #else
57 #include MBEDTLS_CONFIG_FILE
58 #endif
59 
60 #include "ssl.h"
61 
62 #if defined(MBEDTLS_THREADING_C)
63 #include "threading.h"
64 #endif
65 
74 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
75 #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
76 #endif
77 
78 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
79 #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
80 #endif
81 
82 /* \} name SECTION: Module settings */
83 
84 #ifdef __cplusplus
85 extern "C" {
86 #endif
87 
90 
95 {
96 #if defined(MBEDTLS_HAVE_TIME)
98 #endif
100 #if defined(MBEDTLS_X509_CRT_PARSE_C)
102 #endif
104 };
105 
110 {
112  int timeout;
114 #if defined(MBEDTLS_THREADING_C)
115  mbedtls_threading_mutex_t mutex;
116 #endif
117 };
118 
125 
133 int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
134 
142 int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
143 
144 #if defined(MBEDTLS_HAVE_TIME)
145 
154 void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
155 #endif /* MBEDTLS_HAVE_TIME */
156 
165 
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 
177 #endif /* ssl_cache.h */
mbedtls_x509_buf peer_cert
Definition: ssl_cache.h:101
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:80
mbedtls_ssl_cache_entry * chain
Definition: ssl_cache.h:111
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.
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:97
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:94
Cache context.
Definition: ssl_cache.h:109
SSL/TLS functions.
mbedtls_ssl_cache_entry * next
Definition: ssl_cache.h:103
mbedtls_ssl_session session
Definition: ssl_cache.h:99