1 | /**
|
---|
2 | * \file ssl_cache.h
|
---|
3 | *
|
---|
4 | * \brief SSL session cache implementation
|
---|
5 | */
|
---|
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 "config.h"
|
---|
29 | #else
|
---|
30 | #include MBEDTLS_CONFIG_FILE
|
---|
31 | #endif
|
---|
32 |
|
---|
33 | #include "ssl.h"
|
---|
34 |
|
---|
35 | #if defined(MBEDTLS_THREADING_C)
|
---|
36 | #include "threading.h"
|
---|
37 | #endif
|
---|
38 |
|
---|
39 | /**
|
---|
40 | * \name SECTION: Module settings
|
---|
41 | *
|
---|
42 | * The configuration options you can set for this module are in this section.
|
---|
43 | * Either change them in config.h or define them on the compiler command line.
|
---|
44 | * \{
|
---|
45 | */
|
---|
46 |
|
---|
47 | #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT)
|
---|
48 | #define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /*!< 1 day */
|
---|
49 | #endif
|
---|
50 |
|
---|
51 | #if !defined(MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES)
|
---|
52 | #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /*!< Maximum entries in cache */
|
---|
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 |
|
---|
64 | /**
|
---|
65 | * \brief This structure is used for storing cache entries
|
---|
66 | */
|
---|
67 | struct mbedtls_ssl_cache_entry
|
---|
68 | {
|
---|
69 | #if defined(MBEDTLS_HAVE_TIME)
|
---|
70 | mbedtls_time_t timestamp; /*!< entry timestamp */
|
---|
71 | #endif
|
---|
72 | mbedtls_ssl_session session; /*!< entry session */
|
---|
73 | #if defined(MBEDTLS_X509_CRT_PARSE_C)
|
---|
74 | mbedtls_x509_buf peer_cert; /*!< entry peer_cert */
|
---|
75 | #endif
|
---|
76 | mbedtls_ssl_cache_entry *next; /*!< chain pointer */
|
---|
77 | };
|
---|
78 |
|
---|
79 | /**
|
---|
80 | * \brief Cache context
|
---|
81 | */
|
---|
82 | struct mbedtls_ssl_cache_context
|
---|
83 | {
|
---|
84 | mbedtls_ssl_cache_entry *chain; /*!< start of the chain */
|
---|
85 | int timeout; /*!< cache entry timeout */
|
---|
86 | int max_entries; /*!< maximum entries */
|
---|
87 | #if defined(MBEDTLS_THREADING_C)
|
---|
88 | mbedtls_threading_mutex_t mutex; /*!< mutex */
|
---|
89 | #endif
|
---|
90 | };
|
---|
91 |
|
---|
92 | /**
|
---|
93 | * \brief Initialize an SSL cache context
|
---|
94 | *
|
---|
95 | * \param cache SSL cache context
|
---|
96 | */
|
---|
97 | void mbedtls_ssl_cache_init( mbedtls_ssl_cache_context *cache );
|
---|
98 |
|
---|
99 | /**
|
---|
100 | * \brief Cache get callback implementation
|
---|
101 | * (Thread-safe if MBEDTLS_THREADING_C is enabled)
|
---|
102 | *
|
---|
103 | * \param data SSL cache context
|
---|
104 | * \param session session to retrieve entry for
|
---|
105 | */
|
---|
106 | int mbedtls_ssl_cache_get( void *data, mbedtls_ssl_session *session );
|
---|
107 |
|
---|
108 | /**
|
---|
109 | * \brief Cache set callback implementation
|
---|
110 | * (Thread-safe if MBEDTLS_THREADING_C is enabled)
|
---|
111 | *
|
---|
112 | * \param data SSL cache context
|
---|
113 | * \param session session to store entry for
|
---|
114 | */
|
---|
115 | int mbedtls_ssl_cache_set( void *data, const mbedtls_ssl_session *session );
|
---|
116 |
|
---|
117 | #if defined(MBEDTLS_HAVE_TIME)
|
---|
118 | /**
|
---|
119 | * \brief Set the cache timeout
|
---|
120 | * (Default: MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT (1 day))
|
---|
121 | *
|
---|
122 | * A timeout of 0 indicates no timeout.
|
---|
123 | *
|
---|
124 | * \param cache SSL cache context
|
---|
125 | * \param timeout cache entry timeout in seconds
|
---|
126 | */
|
---|
127 | void mbedtls_ssl_cache_set_timeout( mbedtls_ssl_cache_context *cache, int timeout );
|
---|
128 | #endif /* MBEDTLS_HAVE_TIME */
|
---|
129 |
|
---|
130 | /**
|
---|
131 | * \brief Set the maximum number of cache entries
|
---|
132 | * (Default: MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES (50))
|
---|
133 | *
|
---|
134 | * \param cache SSL cache context
|
---|
135 | * \param max cache entry maximum
|
---|
136 | */
|
---|
137 | void mbedtls_ssl_cache_set_max_entries( mbedtls_ssl_cache_context *cache, int max );
|
---|
138 |
|
---|
139 | /**
|
---|
140 | * \brief Free referenced items in a cache context and clear memory
|
---|
141 | *
|
---|
142 | * \param cache SSL cache context
|
---|
143 | */
|
---|
144 | void mbedtls_ssl_cache_free( mbedtls_ssl_cache_context *cache );
|
---|
145 |
|
---|
146 | #ifdef __cplusplus
|
---|
147 | }
|
---|
148 | #endif
|
---|
149 |
|
---|
150 | #endif /* ssl_cache.h */
|
---|