mbed TLS v3.4.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 #include "mbedtls/private_access.h"
25 
26 #include "mbedtls/build_info.h"
27 
28 #include "mbedtls/ssl.h"
29 
30 #if defined(MBEDTLS_THREADING_C)
31 #include "mbedtls/threading.h"
32 #endif
33 
42 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
43 #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
44 #endif
45 
46 #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
47 #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
48 #endif
49 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
58 
63 #if defined(MBEDTLS_HAVE_TIME)
65 #endif
66 
67  unsigned char MBEDTLS_PRIVATE(session_id)[32];
68  size_t MBEDTLS_PRIVATE(session_id_len);
69 
70  unsigned char *MBEDTLS_PRIVATE(session);
71  size_t MBEDTLS_PRIVATE(session_len);
72 
74 };
75 
81  int MBEDTLS_PRIVATE(timeout);
82  int MBEDTLS_PRIVATE(max_entries);
83 #if defined(MBEDTLS_THREADING_C)
84  mbedtls_threading_mutex_t MBEDTLS_PRIVATE(mutex);
85 #endif
86 };
87 
94 
106 int mbedtls_ssl_cache_get(void *data,
107  unsigned char const *session_id,
108  size_t session_id_len,
109  mbedtls_ssl_session *session);
110 
121 int mbedtls_ssl_cache_set(void *data,
122  unsigned char const *session_id,
123  size_t session_id_len,
124  const mbedtls_ssl_session *session);
125 
139 int mbedtls_ssl_cache_remove(void *data,
140  unsigned char const *session_id,
141  size_t session_id_len);
142 
143 #if defined(MBEDTLS_HAVE_TIME)
144 
154 #endif /* MBEDTLS_HAVE_TIME */
155 
164 
171 
172 #ifdef __cplusplus
173 }
174 #endif
175 
176 #endif /* ssl_cache.h */
#define MBEDTLS_PRIVATE(member)
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:39
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.
Macro wrapper for struct's members.
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:62
Build-time configuration info.
Cache context.
Definition: ssl_cache.h:79
int mbedtls_ssl_cache_get(void *data, unsigned char const *session_id, size_t session_id_len, mbedtls_ssl_session *session)
Cache get callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) ...
SSL/TLS functions.
int mbedtls_ssl_cache_remove(void *data, unsigned char const *session_id, size_t session_id_len)
Remove the cache entry by the session ID (Thread-safe if MBEDTLS_THREADING_C is enabled) ...
int mbedtls_ssl_cache_set(void *data, unsigned char const *session_id, size_t session_id_len, const mbedtls_ssl_session *session)
Cache set callback implementation (Thread-safe if MBEDTLS_THREADING_C is enabled) ...