blob: 9a059e408030ae8ede0e409047865495d44b155e [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Minos Galanakisacd560f2024-12-12 15:30:05 +000025 * \name SECTION: Platform abstraction layer
26 *
27 * This section sets platform specific settings.
28 * \{
29 */
30
31/** \} name SECTION: Platform abstraction layer */
32
33/**
34 * \name SECTION: General configuration options
35 *
36 * This section sets configuration options
37 * that do not belong in any of the other categories.
38 * \{
39 */
40
41/** \} name SECTION: General configuration options */
42
43/**
44 * \name SECTION: TLS feature selection
45 *
46 * This section sets TLS options.
47 * \{
48 */
49
50/** \} name SECTION: TLS feature selection */
51
52/**
53 * \name SECTION: X.509 feature selection
54 *
55 * This section sets Certificate related options.
56 * \{
57 */
58
59/** \} name SECTION: X.509 feature selection */
60
61/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +020062 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +000063 *
64 * This section sets support for features that are or are not needed
65 * within the modules that are enabled.
66 * \{
67 */
Paul Bakker5121ce52009-01-03 21:22:43 +000068
Paul Bakkerf3b86c12011-01-27 15:24:17 +000069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +010071 *
TRodziewiczd8540832021-06-10 15:16:50 +020072 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +020073 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +010074 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +010076 *
77 * You will need to provide a header "timing_alt.h" and an implementation at
78 * compile time.
79 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020080//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +010081
Paul Bakker90995b52013-06-24 19:20:35 +020082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020083 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020084 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020085 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020086 *
Paul Bakkere07f41d2013-04-19 09:08:57 +020087 * This enables the following ciphersuites (if other requisites are
88 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020089 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
90 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
91 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
92 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
93 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
94 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
95 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
96 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
97 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
98 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200100#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200104 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200105 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200106 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200108 *
109 * This enables the following ciphersuites (if other requisites are
110 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
112 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
113 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
114 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
115 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
116 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
117 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
118 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
119 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
120 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100121 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100122 * \warning Using DHE constitutes a security risk as it
123 * is not possible to validate custom DH parameters.
124 * If possible, it is recommended users should consider
125 * preferring other methods of key exchange.
126 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100127 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200130
131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200133 *
134 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
135 *
Janos Follath277bba82024-11-19 16:14:00 +0000136 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200137 *
138 * This enables the following ciphersuites (if other requisites are
139 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200140 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
141 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
142 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
143 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
144 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
145 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200148
149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200151 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200152 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200153 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
155 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200156 *
157 * This enables the following ciphersuites (if other requisites are
158 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
160 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
161 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
162 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
163 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
164 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
165 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
166 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
167 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
168 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
169 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
170 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200173
174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200176 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200177 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200178 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
180 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200181 *
182 * This enables the following ciphersuites (if other requisites are
183 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
185 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
186 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
187 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
188 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
189 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
190 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
191 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
193 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
194 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
195 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100196 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100197 * \warning Using DHE constitutes a security risk as it
198 * is not possible to validate custom DH parameters.
199 * If possible, it is recommended users should consider
200 * preferring other methods of key exchange.
201 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100202 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200205
206/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200208 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200209 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200210 *
Janos Follath277bba82024-11-19 16:14:00 +0000211 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200212 * MBEDTLS_RSA_C
213 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200215 *
216 * This enables the following ciphersuites (if other requisites are
217 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
219 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
220 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
221 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
222 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
223 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
224 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
225 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
226 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
227 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200230
231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200233 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200234 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200235 *
Janos Follath277bba82024-11-19 16:14:00 +0000236 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
237 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200238 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200239 *
240 * This enables the following ciphersuites (if other requisites are
241 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
243 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
244 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
245 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
246 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
247 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
248 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
249 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
250 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
251 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200254
255/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100257 *
258 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
259 *
Janos Follath277bba82024-11-19 16:14:00 +0000260 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
261 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200262 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100263 *
264 * This enables the following ciphersuites (if other requisites are
265 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200266 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
267 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
268 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
270 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
271 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
272 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
273 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
274 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
275 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100278
279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100281 *
282 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
283 *
Janos Follath277bba82024-11-19 16:14:00 +0000284 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200285 * MBEDTLS_RSA_C
286 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100287 *
288 * This enables the following ciphersuites (if other requisites are
289 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
291 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
292 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
293 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
294 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
295 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
296 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
297 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
298 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
299 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100302
303/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200304 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
305 *
306 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
307 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200308 * \warning This is currently experimental. EC J-PAKE support is based on the
309 * Thread v1.0.0 specification; incompatible changes to the specification
310 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200311 *
Janos Follath277bba82024-11-19 16:14:00 +0000312 * Requires: MBEDTLS_ECJPAKE_C or PSA_WANT_ALG_JPAKE
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100313 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200314 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
315 *
316 * This enables the following ciphersuites (if other requisites are
317 * enabled as well):
318 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
319 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200320//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200321
322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100324 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325 * Enable a dummy error function to make use of mbedtls_strerror() in
326 * third party libraries easier when MBEDTLS_ERROR_C is disabled
327 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200328 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
330 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100331 *
332 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200335#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100336
337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200338 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +0100339 *
340 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200341 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +0100342 * with other servers, only debugging of failures is harder.
343 *
344 * The advantage of not sending alert messages, is that no information is given
345 * about reasons for failures thus preventing adversaries of gaining intel.
346 *
347 * Enable sending of all alert messages
348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200349#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +0100350
351/**
Gilles Peskined3d02902020-03-04 21:35:27 +0100352 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
353 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +0100354 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +0100355 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +0100356 * in the underlying transport. The CID functionality is described
357 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +0100358 *
359 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +0000360 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
361 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
362 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +0100363 *
Gilles Peskined3d02902020-03-04 21:35:27 +0100364 * The maximum lengths of outgoing and incoming CIDs can be configured
365 * through the options
366 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
367 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
368 *
369 * Requires: MBEDTLS_SSL_PROTO_DTLS
370 *
371 * Uncomment to enable the Connection ID extension.
372 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200373#define MBEDTLS_SSL_DTLS_CONNECTION_ID
374
375
376/**
377 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
378 *
379 * Defines whether RFC 9146 (default) or the legacy version
380 * (version draft-ietf-tls-dtls-connection-id-05,
381 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
382 * is used.
383 *
384 * Set the value to 0 for the standard version, and
385 * 1 for the legacy draft version.
386 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +0100387 * \deprecated Support for the legacy version of the DTLS
388 * Connection ID feature is deprecated. Please
389 * switch to the standardized version defined
390 * in RFC 9146 enabled by utilizing
391 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
392 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
393 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200394 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
395 */
396#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +0100397
398/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200399 * \def MBEDTLS_SSL_ASYNC_PRIVATE
400 *
401 * Enable asynchronous external private key operations in SSL. This allows
402 * you to configure an SSL connection to call an external cryptographic
403 * module to perform private key operations instead of performing the
404 * operation inside the library.
405 *
Valerio Setti8841d6b2023-01-05 08:40:24 +0100406 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200407 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +0100408//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200409
410/**
Gilles Peskined3d02902020-03-04 21:35:27 +0100411 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
412 *
413 * Enable serialization of the TLS context structures, through use of the
414 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
415 *
416 * This pair of functions allows one side of a connection to serialize the
417 * context associated with the connection, then free or re-use that context
418 * while the serialized state is persisted elsewhere, and finally deserialize
419 * that state to a live context for resuming read/write operations on the
420 * connection. From a protocol perspective, the state of the connection is
421 * unaffected, in particular this is entirely transparent to the peer.
422 *
423 * Note: this is distinct from TLS session resumption, which is part of the
424 * protocol and fully visible by the peer. TLS session resumption enables
425 * establishing new connections associated to a saved session with shorter,
426 * lighter handshakes, while context serialization is a local optimization in
427 * handling a single, potentially long-lived connection.
428 *
429 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
430 * saved after the handshake to allow for more efficient serialization, so if
431 * you don't need this feature you'll save RAM by disabling it.
432 *
Przemek Stekiel460192e2022-10-03 08:55:29 +0200433 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
434 *
Gilles Peskined3d02902020-03-04 21:35:27 +0100435 * Comment to disable the context serialization APIs.
436 */
437#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
438
439/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200440 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +0100441 *
442 * Enable the debug messages in SSL module for all issues.
443 * Debug messages have been disabled in some places to prevent timing
444 * attacks due to (unbalanced) debugging function calls.
445 *
446 * If you need all error reporting you should enable this during debugging,
447 * but remove this for production servers that should log as well.
448 *
449 * Uncomment this macro to report all debug messages on errors introducing
450 * a timing side-channel.
451 *
Paul Bakkerd66f0702013-01-31 16:57:45 +0100452 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +0100454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200455/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100456 *
457 * Enable support for Encrypt-then-MAC, RFC 7366.
458 *
459 * This allows peers that both support it to use a more robust protection for
460 * ciphersuites using CBC, providing deep resistance against timing attacks
461 * on the padding or underlying cipher.
462 *
463 * This only affects CBC ciphersuites, and is useless if none is defined.
464 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200465 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100466 *
467 * Comment this macro to disable support for Encrypt-then-MAC
468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200469#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200472 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +0100473 * Enable support for RFC 7627: Session Hash and Extended Master Secret
474 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200475 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800476 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200477 * attacks, but it is recommended to always use it (even if you disable
478 * renegotiation), since it actually fixes a more fundamental issue in the
479 * original SSL/TLS design, and has implications beyond Triple Handshake.
480 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200481 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +0100482 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200483 * Comment this macro to disable support for Extended Master Secret.
484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200486
Paul Bakkerd66f0702013-01-31 16:57:45 +0100487/**
Hanno Beckerbb278f52019-02-05 17:04:00 +0000488 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
489 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +0000490 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +0000491 * giving access to the peer's certificate after completion of the handshake.
492 *
493 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
494 * recommended to disable this option for reduced RAM usage.
495 *
496 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
497 * defined, but always returns \c NULL.
498 *
499 * \note This option has no influence on the protection against the
500 * triple handshake attack. Even if it is disabled, Mbed TLS will
501 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800502 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +0000503 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +0100504 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +0000505 *
506 * Comment this macro to disable storing the peer's certificate
507 * after the handshake.
508 */
509#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
510
511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200512 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100513 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +0100514 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100515 *
516 * The two main uses of renegotiation are (1) refresh keys on long-lived
517 * connections and (2) client authentication after the initial handshake.
518 * If you don't need renegotiation, it's probably better to disable it, since
519 * it has been associated with security issues in the past and is easy to
520 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +0100521 *
jnmeurisse83f0a652023-09-16 18:12:18 +0200522 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
523 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +0000524 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +0100525 *
526 * \note Even if this option is disabled, both client and server are aware
527 * of the Renegotiation Indication Extension (RFC 5746) used to
528 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
529 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
530 * configuration of this extension).
531 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100534
535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +0200537 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200538 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +0200539 *
540 * Comment this macro to disable support for the max_fragment_length extension
541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +0200543
544/**
Jan Bruckner151f6422023-02-10 12:45:19 +0100545 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
546 *
Jan Brucknera0589e72023-03-15 11:04:45 +0100547 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +0100548 *
Jan Bruckner151f6422023-02-10 12:45:19 +0100549 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
550 *
551 * Uncomment this macro to enable support for the record_size_limit extension
552 */
553//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
554
555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200557 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100558 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200559 *
Janos Follath277bba82024-11-19 16:14:00 +0000560 * Requires: PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -0400561 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100562 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200565
566/**
Ronald Cron6f135e12021-12-08 16:57:54 +0100567 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100568 *
Ronald Cron6f135e12021-12-08 16:57:54 +0100569 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100570 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +0200571 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +0100572 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100573 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +0100574 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +0200575 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +0100576 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100577 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100578 */
Ronald Cron27eb68d2024-03-15 16:13:37 +0100579#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100580
581/**
Ronald Cronab65c522021-11-24 10:47:20 +0100582 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
583 *
584 * Enable TLS 1.3 middlebox compatibility mode.
585 *
586 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
587 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
588 * expecting TLS 1.2 traffic.
589 *
590 * Turning on the compatibility mode comes at the cost of a few added bytes
591 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
592 * that don't use it. Therefore, unless transmission bandwidth is critical and
593 * you know that middlebox compatibility issues won't occur, it is therefore
594 * recommended to set this option.
595 *
596 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +0100597 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
598 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +0100599 *
600 */
Ronald Cron27eb68d2024-03-15 16:13:37 +0100601#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +0100602
603/**
Ronald Crond8d2ea52022-10-04 15:48:06 +0200604 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
605 *
606 * Enable TLS 1.3 PSK key exchange mode.
607 *
608 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
609 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
610 * effect on the build.
611 *
612 */
613#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
614
615/**
616 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
617 *
618 * Enable TLS 1.3 ephemeral key exchange mode.
619 *
Przemek Stekielce05f542023-06-15 16:44:08 +0200620 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200621 * MBEDTLS_X509_CRT_PARSE_C
622 * and at least one of:
Janos Follath277bba82024-11-19 16:14:00 +0000623 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200624 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +0200625 *
626 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
627 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
628 * effect on the build.
629 *
630 */
631#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
632
633/**
634 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
635 *
636 * Enable TLS 1.3 PSK ephemeral key exchange mode.
637 *
Przemek Stekielce05f542023-06-15 16:44:08 +0200638 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +0200639 *
640 * Comment to disable support for the PSK ephemeral key exchange mode in
641 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
642 * have any effect on the build.
643 *
644 */
645#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
646
647/**
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 * \def MBEDTLS_SSL_EARLY_DATA
649 *
650 * Enable support for RFC 8446 TLS 1.3 early data.
651 *
652 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
653 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
654 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
655 *
656 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
657 * is not enabled, this option does not have any effect on the build.
658 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +0100659 * \note The maximum amount of early data can be set with
660 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
661 *
Gilles Peskine449bd832023-01-11 14:50:10 +0100662 */
Ronald Cronc2e110f2022-11-22 09:01:46 +0100663//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +0000664
665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200666 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100667 *
668 * Enable support for DTLS (all available versions).
669 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200670 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100671 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200672 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100673 *
674 * Comment this macro to disable support for DTLS
675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100677
678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200680 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +0100681 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200682 *
Paul Bakker27e36d32014-04-08 12:33:37 +0200683 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200686
687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200689 *
690 * Enable support for the anti-replay mechanism in DTLS.
691 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692 * Requires: MBEDTLS_SSL_TLS_C
693 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200694 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +0200695 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200696 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +0200697 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200698 * Comment this to disable anti-replay in DTLS.
699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200701
702/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +0200704 *
705 * Enable support for HelloVerifyRequest on DTLS servers.
706 *
707 * This feature is highly recommended to prevent DTLS servers being used as
708 * amplifiers in DoS attacks against other hosts. It should always be enabled
709 * unless you know for sure amplification cannot be a problem in the
710 * environment in which your server operates.
711 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -0400712 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +0200713 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200714 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +0200715 *
716 * Comment this to disable support for HelloVerifyRequest.
717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +0200719
720/**
Johan Pascalb62bb512015-12-03 21:56:45 +0100721 * \def MBEDTLS_SSL_DTLS_SRTP
722 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200723 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +0200724 * through the use_srtp extension.
725 *
726 * \note This feature provides the minimum functionality required
727 * to negotiate the use of DTLS-SRTP and to allow the derivation of
728 * the associated SRTP packet protection key material.
729 * In particular, the SRTP packet protection itself, as well as the
730 * demultiplexing of RTP and DTLS packets at the datagram layer
731 * (see Section 5 of RFC 5764), are not handled by this feature.
732 * Instead, after successful completion of a handshake negotiating
733 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +0100734 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +0200735 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
736 * (this is implemented in the SSL example programs).
737 * The resulting key should then be passed to an SRTP stack.
738 *
739 * Setting this option enables the runtime API
740 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
741 * through which the supported DTLS-SRTP protection
742 * profiles can be configured. You must call this API at
743 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +0100744 *
745 * Requires: MBEDTLS_SSL_PROTO_DTLS
746 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +0200747 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +0100748 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +0200749//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +0100750
751/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +0200752 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
753 *
754 * Enable server-side support for clients that reconnect from the same port.
755 *
756 * Some clients unexpectedly close the connection and try to reconnect using the
757 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +0100758 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +0200759 * flag enables that support.
760 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +0200761 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +0200762 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +0200763 * Comment this to disable support for clients reusing the source port.
764 */
765#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
766
767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +0200769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200770 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +0100771 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +0200772 * session store remains the responsibility of the application, though).
773 * Server-side, you also need to provide callbacks for writing and parsing
774 * tickets, including authenticated encryption and key management. Example
775 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +0200776 *
777 * Comment this macro to disable support for SSL session tickets
778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +0200780
781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +0200783 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200784 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +0200785 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +0000787 *
Paul Bakker0be444a2013-08-27 21:55:01 +0200788 * Comment this macro to disable support for server name indication in SSL
789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +0200791
792/**
Gilles Peskinef03bd812020-03-23 18:13:58 +0100793 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
794 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -0500795 * When this option is enabled, the SSL buffer will be resized automatically
796 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +0200797 *
798 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +0100799 */
800//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
801
802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200804 *
805 * Allow run-time checking of compile-time enabled features. Thus allowing users
806 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200808 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200810 *
811 * Comment this to disable run-time checking and save ROM space
812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200814
815/**
Hanno Becker288dedc2019-03-27 11:00:53 +0000816 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
817 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +0300818 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +0000819 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
820 * the set of trusted certificates through a callback instead of a linked
821 * list.
822 *
823 * This is useful for example in environments where a large number of trusted
824 * certificates is present and storing them in a linked list isn't efficient
825 * enough, or when the set of trusted certificates changes frequently.
826 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +0300827 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +0000828 * `mbedtls_ssl_conf_ca_cb()` for more information.
829 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +0100830 * Requires: MBEDTLS_X509_CRT_PARSE_C
831 *
Hanno Becker288dedc2019-03-27 11:00:53 +0000832 * Uncomment to enable trusted certificate callbacks.
833 */
834//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
835
836/**
Hanno Becker612a2f12020-10-09 09:19:39 +0100837 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -0600838 *
Chris Jones2c745862020-12-16 11:41:06 +0000839 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -0600840 *
Chris Jones2c745862020-12-16 11:41:06 +0000841 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -0600842 * and other functions/constants only used by these functions, thus reducing
843 * the code footprint by several KB.
844 */
Chris Jones2c745862020-12-16 11:41:06 +0000845//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -0600846
847/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +0200849 *
850 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
851 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
852 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +0300853 * Requires: MBEDTLS_PKCS1_V21
854 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +0200855 * Comment this macro to disallow using RSASSA-PSS in certificates.
856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200858/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000859
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000860/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200861 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +0000862 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200863 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +0000864 * \{
865 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000866
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000869 *
870 * Enable the debug functions.
871 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000872 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +0100873 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000874 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +0100875 * library/ssl_tls12_*.c
876 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000877 *
878 * This module provides debugging functions.
879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000881
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +0000884 *
885 * Enable error code to error string conversion.
886 *
887 * Module: library/error.c
888 * Caller:
889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +0000891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +0000893
894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000896 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +0100897 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
898 *
Simon Butcherd567a232016-03-09 20:19:21 +0000899 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
900 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +0100901 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000902 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +0000903 * \note See also our Knowledge Base article about porting to a new
904 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +0100905 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +0000906 *
Andres AG788aa4a2016-09-14 14:32:09 +0100907 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000908 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +0100909 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +0000910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000912
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000913/**
Nayna Jainc9deb182020-11-16 19:03:12 +0000914 * \def MBEDTLS_PKCS7_C
915 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +0000916 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +0000917 * RFC Link - https://tools.ietf.org/html/rfc2315
918 *
919 * Module: library/pkcs7.c
920 *
921 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -0600922 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
923 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +0000924 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +0000925 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +0000926 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +0000927#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +0000928
929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +0000931 *
932 * Enable simple SSL cache implementation.
933 *
934 * Module: library/ssl_cache.c
935 * Caller:
936 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +0000938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +0000940
941/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +0200943 *
944 * Enable basic implementation of DTLS cookies for hello verification.
945 *
946 * Module: library/ssl_cookie.c
947 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +0200948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +0200950
951/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +0200952 * \def MBEDTLS_SSL_TICKET_C
953 *
954 * Enable an implementation of TLS server-side callbacks for session tickets.
955 *
956 * Module: library/ssl_ticket.c
957 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +0200958 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +0200959 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
960 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +0200961 */
962#define MBEDTLS_SSL_TICKET_C
963
964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000966 *
967 * Enable the SSL/TLS client code.
968 *
Ronald Cronde1adee2022-03-07 16:20:30 +0100969 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000970 * Caller:
971 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +0000973 *
Janos Follath745e5612024-12-02 13:22:34 +0000974 * \warning You must call psa_crypto_init() before doing any TLS operations.
975 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000976 * This module is required for SSL/TLS client support.
977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000979
Paul Bakker9a736322012-11-14 12:39:52 +0000980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000982 *
983 * Enable the SSL/TLS server code.
984 *
Ronald Cronde1adee2022-03-07 16:20:30 +0100985 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000986 * Caller:
987 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +0000989 *
Janos Follath745e5612024-12-02 13:22:34 +0000990 * \warning You must call psa_crypto_init() before doing any TLS operations.
991 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000992 * This module is required for SSL/TLS server support.
993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000995
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000996/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000998 *
Paul Bakkere29ab062011-05-18 13:26:54 +0000999 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001000 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001001 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01001002 * Caller: library/ssl*_client.c
1003 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
1006 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00001007 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001008 * This module is required for SSL/TLS.
1009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001011
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001012/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001014 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01001015 * Enable the semi-portable timing interface.
1016 *
Simon Butcherd567a232016-03-09 20:19:21 +00001017 * \note The provided implementation only works on POSIX/Unix (including Linux,
1018 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01001019 * module and provide your own implementations of the callbacks needed by
1020 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
1021 * your own implementation of the whole module by setting
1022 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001023 *
Andrzej Kurek57353692022-04-07 08:08:21 -04001024 * \note The timing module will include time.h on suitable platforms
1025 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
1026 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
1027 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001028 * \note See also our Knowledge Base article about porting to a new
1029 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01001030 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001031 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001032 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02001033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001035
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001038 *
1039 * Enable run-time version information.
1040 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00001041 * Module: library/version.c
1042 *
1043 * This module provides run-time version information.
1044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00001046
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001049 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001050 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001051 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001052 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00001053 * Caller: library/x509_crl.c
1054 * library/x509_crt.c
1055 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001056 *
Janos Follath277bba82024-11-19 16:14:00 +00001057 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C
Przemek Stekiel278b6672022-08-03 09:50:38 +02001058 *
Janos Follath277bba82024-11-19 16:14:00 +00001059 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001060 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001061 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00001062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001064
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001067 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001068 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001069 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001070 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01001071 * Caller: library/ssl_tls.c
1072 * library/ssl*_client.c
1073 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001074 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001076 *
1077 * This module is required for X.509 certificate parsing.
1078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001080
1081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001083 *
1084 * Enable X.509 CRL parsing.
1085 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001086 * Module: library/x509_crl.c
1087 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001088 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001090 *
1091 * This module is required for X.509 CRL parsing.
1092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001094
1095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001097 *
1098 * Enable X.509 Certificate Signing Request (CSR) parsing.
1099 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001100 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001101 * Caller: library/x509_crt_write.c
1102 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001104 *
1105 * This module is used for reading X.509 certificate request.
1106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001108
1109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001111 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001112 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001113 *
1114 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001115 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02001116 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02001117 *
Janos Follath277bba82024-11-19 16:14:00 +00001118 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001119 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001120 * This module is the basis for creating X.509 certificates and CSRs.
1121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001123
1124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001126 *
1127 * Enable creating X.509 certificates.
1128 *
1129 * Module: library/x509_crt_write.c
1130 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001132 *
1133 * This module is required for X.509 certificate creation.
1134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001136
1137/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001139 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001140 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001141 *
1142 * Module: library/x509_csr_write.c
1143 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001145 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001146 * This module is required for X.509 certificate request writing.
1147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001149
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001150/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00001151
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001152/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02001153 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001154 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02001155 * This section contains Mbed TLS build settings that are not associated
1156 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001157 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001158 * \{
1159 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001160
Gilles Peskinea02c1242022-03-16 17:03:19 +01001161/**
1162 * \def MBEDTLS_CONFIG_FILE
1163 *
1164 * If defined, this is a header which will be included instead of
1165 * `"mbedtls/mbedtls_config.h"`.
1166 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02001167 * Unlike other configuration options, this one must be defined on the
1168 * compiler command line: a definition in `mbedtls_config.h` would have
1169 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001170 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02001171 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01001172 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02001173 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001174 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02001175 * The value of this symbol is typically a path in double quotes, either
1176 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001177 */
1178//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
1179
1180/**
1181 * \def MBEDTLS_USER_CONFIG_FILE
1182 *
1183 * If defined, this is a header which will be included after
1184 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02001185 * This allows you to modify the default configuration, including the ability
1186 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001187 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02001188 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01001189 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02001190 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001191 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02001192 * The value of this symbol is typically a path in double quotes, either
1193 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001194 */
1195//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
1196
Gilles Peskineba4162a2022-04-11 17:04:38 +02001197/** \} name SECTION: General configuration options */
1198
1199/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001200 * \name SECTION: Module configuration options
1201 *
1202 * This section allows for the setting of module specific sizes and
1203 * configuration options. The default values are already present in the
1204 * relevant header files and should suffice for the regular use cases.
1205 *
1206 * Our advice is to enable options and change their values here
1207 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001208 * \{
1209 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02001210/* The Doxygen documentation here is used when a user comments out a
1211 * setting and runs doxygen themselves. On the other hand, when we typeset
1212 * the full documentation including disabled settings, the documentation
1213 * in specific modules' header files is used if present. When editing this
1214 * file, make sure that each option is documented in exactly one place,
1215 * plus optionally a same-line Doxygen comment here if there is a Doxygen
1216 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001217
Paul Bakker088c5c52014-04-25 11:11:10 +02001218/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
1220//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker6e339b52013-07-03 13:37:05 +02001221
Paul Bakker088c5c52014-04-25 11:11:10 +02001222/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10001223
Angus Grattond8213d02016-05-25 20:56:48 +10001224/** \def MBEDTLS_SSL_IN_CONTENT_LEN
1225 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001226 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10001227 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001228 * This determines the size of the incoming TLS I/O buffer in such a way
1229 * that it is capable of holding the specified amount of plaintext data,
1230 * regardless of the protection mechanism used.
1231 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001232 * \note When using a value less than the default of 16KB on the client, it is
1233 * recommended to use the Maximum Fragment Length (MFL) extension to
1234 * inform the server about this limitation. On the server, there
1235 * is no supported, standardized way of informing the client about
1236 * restriction on the maximum size of incoming messages, and unless
1237 * the limitation has been communicated by other means, it is recommended
1238 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
1239 * while keeping the default value of 16KB for the incoming buffer.
1240 *
David Horstmann95d516f2021-05-04 18:36:56 +01001241 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10001242 */
1243//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
1244
Gilles Peskined3d02902020-03-04 21:35:27 +01001245/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
1246 *
1247 * The maximum length of CIDs used for incoming DTLS messages.
1248 *
1249 */
1250//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
1251
1252/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
1253 *
1254 * The maximum length of CIDs used for outgoing DTLS messages.
1255 *
1256 */
1257//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
1258
TRodziewicze8dd7092021-05-12 14:19:11 +02001259/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01001260 *
1261 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02001262 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01001263 *
1264 * The padding will always be chosen so that the length of the
1265 * padded plaintext is a multiple of the value of this option.
1266 *
1267 * Note: A value of \c 1 means that no padding will be used
1268 * for outgoing records.
1269 *
1270 * Note: On systems lacking division instructions,
1271 * a power of two should be preferred.
1272 */
TRodziewicze8dd7092021-05-12 14:19:11 +02001273//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01001274
Angus Grattond8213d02016-05-25 20:56:48 +10001275/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
1276 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001277 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10001278 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001279 * This determines the size of the outgoing TLS I/O buffer in such a way
1280 * that it is capable of holding the specified amount of plaintext data,
1281 * regardless of the protection mechanism used.
1282 *
Angus Grattond8213d02016-05-25 20:56:48 +10001283 * It is possible to save RAM by setting a smaller outward buffer, while keeping
1284 * the default inward 16384 byte buffer to conform to the TLS specification.
1285 *
1286 * The minimum required outward buffer size is determined by the handshake
1287 * protocol's usage. Handshaking will fail if the outward buffer is too small.
1288 * The specific size requirement depends on the configured ciphers and any
1289 * certificate data which is sent during the handshake.
1290 *
David Horstmann95d516f2021-05-04 18:36:56 +01001291 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10001292 */
1293//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
1294
Hanno Beckere0b150f2018-08-21 15:51:03 +01001295/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
1296 *
1297 * Maximum number of heap-allocated bytes for the purpose of
1298 * DTLS handshake message reassembly and future message buffering.
1299 *
Yuto Takano7828ca22021-08-10 11:26:15 +01001300 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01001301 * to account for a reassembled handshake message of maximum size,
1302 * together with its reassembly bitmap.
1303 *
Hanno Becker97a1c132018-08-28 14:42:15 +01001304 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01001305 * should be sufficient for all practical situations as it allows
1306 * to reassembly a large handshake message (such as a certificate)
1307 * while buffering multiple smaller handshake messages.
1308 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01001309 */
Hanno Becker159a37f2018-08-24 15:07:29 +01001310//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01001311
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01001312//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 or 384 bits) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313//#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001314
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02001315/**
1316 * Complete list of ciphersuites to use, in order of preference.
1317 *
1318 * \warning No dependency checking is done on that field! This option can only
1319 * be used to restrict the set of available ciphersuites. It is your
1320 * responsibility to make sure the needed modules are active.
1321 *
1322 * Use this to save a few hundred bytes of ROM (default ordering of all
1323 * available ciphersuites) and a few to a few hundred bytes of RAM.
1324 *
1325 * The value below is only an example, not the default.
1326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327//#define MBEDTLS_SSL_CIPHERSUITES MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02001328
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001329/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001330 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1331 *
1332 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08001333 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001334 *
1335 * It must be positive and smaller than UINT32_MAX.
1336 *
1337 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1338 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001339 */
1340//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1341
1342/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001343 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
1344 *
Jerry Yucf913512023-11-14 11:06:52 +08001345 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08001346 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001347 *
Jerry Yu034a8b72023-11-10 12:20:19 +08001348 * - The client ticket age is the time difference between the time when the
1349 * client proposes to the server to use the ticket and the time the client
1350 * received the ticket from the server.
1351 * - The server ticket age is the time difference between the time when the
1352 * server receives a proposition from the client to use the ticket and the
1353 * time when the ticket was created by the server.
1354 *
Jerry Yucf913512023-11-14 11:06:52 +08001355 * The ages might be different due to the client and server clocks not running
1356 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
1357 * per million (360 to 72 milliseconds per hour). Default tolerance window is
1358 * 6s, thus in the worst case clients and servers must sync up their system time
1359 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001360 *
Jerry Yu04fceb72023-11-15 09:52:46 +08001361 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001362 */
Gilles Peskined65ea422023-09-05 21:07:32 +02001363//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001364
1365/**
1366 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1367 *
1368 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1369 *
1370 * This must be less than 256.
1371 */
Gilles Peskined65ea422023-09-05 21:07:32 +02001372//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001373
1374/**
1375 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1376 *
1377 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1378 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1379 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
1380 *
1381 */
Gilles Peskined65ea422023-09-05 21:07:32 +02001382//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001383
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01001384/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01001386//#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512 /**< Maximum length of a path/filename string in bytes including the null terminator character ('\0'). */
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01001387
Gilles Peskine611179c2022-04-13 23:04:48 +02001388/** \} name SECTION: Module configuration options */