blob: d01c1d1be70386cfc0d7f54142def2ffe2862cf2 [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/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +020032 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +000033 *
34 * This section sets support for features that are or are not needed
35 * within the modules that are enabled.
36 * \{
37 */
Paul Bakker5121ce52009-01-03 21:22:43 +000038
Paul Bakkerf3b86c12011-01-27 15:24:17 +000039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +010041 *
TRodziewiczd8540832021-06-10 15:16:50 +020042 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +020043 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +010044 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020045 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +010046 *
47 * You will need to provide a header "timing_alt.h" and an implementation at
48 * compile time.
49 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +010051
Paul Bakker90995b52013-06-24 19:20:35 +020052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020054 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020055 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020056 *
Paul Bakkere07f41d2013-04-19 09:08:57 +020057 * This enables the following ciphersuites (if other requisites are
58 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
60 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
61 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
62 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
63 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
64 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
65 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
66 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
67 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
68 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +020071
72/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +020074 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020075 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +020076 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +020078 *
79 * This enables the following ciphersuites (if other requisites are
80 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
82 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
83 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
84 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
85 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
86 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
87 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
88 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
89 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
90 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +010091 *
Hanno Beckerf9734b32017-10-03 12:09:22 +010092 * \warning Using DHE constitutes a security risk as it
93 * is not possible to validate custom DH parameters.
94 * If possible, it is recommended users should consider
95 * preferring other methods of key exchange.
96 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +010097 *
Paul Bakkere07f41d2013-04-19 09:08:57 +020098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200100
101/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200102 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200103 *
104 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
105 *
Janos Follath277bba82024-11-19 16:14:00 +0000106 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200107 *
108 * This enables the following ciphersuites (if other requisites are
109 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200110 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
111 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
112 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
113 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
114 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
115 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200118
119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200121 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200122 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200123 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
125 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200126 *
127 * This enables the following ciphersuites (if other requisites are
128 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
130 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
131 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
132 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
133 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
134 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
135 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
136 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
137 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
138 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
139 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
140 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200143
144/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200146 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200147 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200149 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
150 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200151 *
152 * This enables the following ciphersuites (if other requisites are
153 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
155 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
156 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
157 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
158 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
159 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
160 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
161 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
162 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
163 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
164 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
165 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100166 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100167 * \warning Using DHE constitutes a security risk as it
168 * is not possible to validate custom DH parameters.
169 * If possible, it is recommended users should consider
170 * preferring other methods of key exchange.
171 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100172 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200175
176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200178 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200179 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200180 *
Janos Follath277bba82024-11-19 16:14:00 +0000181 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200182 * MBEDTLS_RSA_C
183 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200185 *
186 * This enables the following ciphersuites (if other requisites are
187 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
189 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
190 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
191 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
192 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
193 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
195 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
196 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
197 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200200
201/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200203 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200204 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200205 *
Janos Follath277bba82024-11-19 16:14:00 +0000206 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
207 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200208 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200209 *
210 * This enables the following ciphersuites (if other requisites are
211 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200212 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
213 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
214 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
215 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
216 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
217 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
218 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
219 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
220 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
221 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200223#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200224
225/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100227 *
228 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
229 *
Janos Follath277bba82024-11-19 16:14:00 +0000230 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
231 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200232 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100233 *
234 * This enables the following ciphersuites (if other requisites are
235 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
237 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
238 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
239 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
240 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
241 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
242 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
243 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
244 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
245 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100248
249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100251 *
252 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
253 *
Janos Follath277bba82024-11-19 16:14:00 +0000254 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200255 * MBEDTLS_RSA_C
256 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100257 *
258 * This enables the following ciphersuites (if other requisites are
259 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
261 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
262 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
263 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
264 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
265 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
266 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
267 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
268 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
269 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200271#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100272
273/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200274 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
275 *
276 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
277 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200278 * \warning This is currently experimental. EC J-PAKE support is based on the
279 * Thread v1.0.0 specification; incompatible changes to the specification
280 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200281 *
Janos Follath277bba82024-11-19 16:14:00 +0000282 * Requires: MBEDTLS_ECJPAKE_C or PSA_WANT_ALG_JPAKE
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100283 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200284 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
285 *
286 * This enables the following ciphersuites (if other requisites are
287 * enabled as well):
288 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
289 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200290//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200291
292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100294 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295 * Enable a dummy error function to make use of mbedtls_strerror() in
296 * third party libraries easier when MBEDTLS_ERROR_C is disabled
297 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200298 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
300 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100301 *
302 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100306
307/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +0000309 *
310 * Enable the checkup functions (*_self_test).
311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +0000313
314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +0100316 *
317 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200318 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +0100319 * with other servers, only debugging of failures is harder.
320 *
321 * The advantage of not sending alert messages, is that no information is given
322 * about reasons for failures thus preventing adversaries of gaining intel.
323 *
324 * Enable sending of all alert messages
325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +0100327
328/**
Gilles Peskined3d02902020-03-04 21:35:27 +0100329 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
330 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +0100331 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +0100332 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +0100333 * in the underlying transport. The CID functionality is described
334 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +0100335 *
336 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +0000337 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
338 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
339 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +0100340 *
Gilles Peskined3d02902020-03-04 21:35:27 +0100341 * The maximum lengths of outgoing and incoming CIDs can be configured
342 * through the options
343 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
344 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
345 *
346 * Requires: MBEDTLS_SSL_PROTO_DTLS
347 *
348 * Uncomment to enable the Connection ID extension.
349 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200350#define MBEDTLS_SSL_DTLS_CONNECTION_ID
351
352
353/**
354 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
355 *
356 * Defines whether RFC 9146 (default) or the legacy version
357 * (version draft-ietf-tls-dtls-connection-id-05,
358 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
359 * is used.
360 *
361 * Set the value to 0 for the standard version, and
362 * 1 for the legacy draft version.
363 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +0100364 * \deprecated Support for the legacy version of the DTLS
365 * Connection ID feature is deprecated. Please
366 * switch to the standardized version defined
367 * in RFC 9146 enabled by utilizing
368 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
369 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
370 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200371 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
372 */
373#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +0100374
375/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200376 * \def MBEDTLS_SSL_ASYNC_PRIVATE
377 *
378 * Enable asynchronous external private key operations in SSL. This allows
379 * you to configure an SSL connection to call an external cryptographic
380 * module to perform private key operations instead of performing the
381 * operation inside the library.
382 *
Valerio Setti8841d6b2023-01-05 08:40:24 +0100383 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200384 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +0100385//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200386
387/**
Gilles Peskined3d02902020-03-04 21:35:27 +0100388 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
389 *
390 * Enable serialization of the TLS context structures, through use of the
391 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
392 *
393 * This pair of functions allows one side of a connection to serialize the
394 * context associated with the connection, then free or re-use that context
395 * while the serialized state is persisted elsewhere, and finally deserialize
396 * that state to a live context for resuming read/write operations on the
397 * connection. From a protocol perspective, the state of the connection is
398 * unaffected, in particular this is entirely transparent to the peer.
399 *
400 * Note: this is distinct from TLS session resumption, which is part of the
401 * protocol and fully visible by the peer. TLS session resumption enables
402 * establishing new connections associated to a saved session with shorter,
403 * lighter handshakes, while context serialization is a local optimization in
404 * handling a single, potentially long-lived connection.
405 *
406 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
407 * saved after the handshake to allow for more efficient serialization, so if
408 * you don't need this feature you'll save RAM by disabling it.
409 *
Przemek Stekiel460192e2022-10-03 08:55:29 +0200410 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
411 *
Gilles Peskined3d02902020-03-04 21:35:27 +0100412 * Comment to disable the context serialization APIs.
413 */
414#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
415
416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +0100418 *
419 * Enable the debug messages in SSL module for all issues.
420 * Debug messages have been disabled in some places to prevent timing
421 * attacks due to (unbalanced) debugging function calls.
422 *
423 * If you need all error reporting you should enable this during debugging,
424 * but remove this for production servers that should log as well.
425 *
426 * Uncomment this macro to report all debug messages on errors introducing
427 * a timing side-channel.
428 *
Paul Bakkerd66f0702013-01-31 16:57:45 +0100429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +0100431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200432/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100433 *
434 * Enable support for Encrypt-then-MAC, RFC 7366.
435 *
436 * This allows peers that both support it to use a more robust protection for
437 * ciphersuites using CBC, providing deep resistance against timing attacks
438 * on the padding or underlying cipher.
439 *
440 * This only affects CBC ciphersuites, and is useless if none is defined.
441 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200442 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100443 *
444 * Comment this macro to disable support for Encrypt-then-MAC
445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200449 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +0100450 * Enable support for RFC 7627: Session Hash and Extended Master Secret
451 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200452 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800453 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200454 * attacks, but it is recommended to always use it (even if you disable
455 * renegotiation), since it actually fixes a more fundamental issue in the
456 * original SSL/TLS design, and has implications beyond Triple Handshake.
457 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200458 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +0100459 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200460 * Comment this macro to disable support for Extended Master Secret.
461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200463
Paul Bakkerd66f0702013-01-31 16:57:45 +0100464/**
Hanno Beckerbb278f52019-02-05 17:04:00 +0000465 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
466 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +0000467 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +0000468 * giving access to the peer's certificate after completion of the handshake.
469 *
470 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
471 * recommended to disable this option for reduced RAM usage.
472 *
473 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
474 * defined, but always returns \c NULL.
475 *
476 * \note This option has no influence on the protection against the
477 * triple handshake attack. Even if it is disabled, Mbed TLS will
478 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800479 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +0000480 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +0100481 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +0000482 *
483 * Comment this macro to disable storing the peer's certificate
484 * after the handshake.
485 */
486#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
487
488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100490 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +0100491 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100492 *
493 * The two main uses of renegotiation are (1) refresh keys on long-lived
494 * connections and (2) client authentication after the initial handshake.
495 * If you don't need renegotiation, it's probably better to disable it, since
496 * it has been associated with security issues in the past and is easy to
497 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +0100498 *
jnmeurisse83f0a652023-09-16 18:12:18 +0200499 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
500 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +0000501 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +0100502 *
503 * \note Even if this option is disabled, both client and server are aware
504 * of the Renegotiation Indication Extension (RFC 5746) used to
505 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
506 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
507 * configuration of this extension).
508 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100511
512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +0200514 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200515 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +0200516 *
517 * Comment this macro to disable support for the max_fragment_length extension
518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +0200520
521/**
Jan Bruckner151f6422023-02-10 12:45:19 +0100522 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
523 *
Jan Brucknera0589e72023-03-15 11:04:45 +0100524 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +0100525 *
Jan Bruckner151f6422023-02-10 12:45:19 +0100526 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
527 *
528 * Uncomment this macro to enable support for the record_size_limit extension
529 */
530//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
531
532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200534 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100535 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200536 *
Janos Follath277bba82024-11-19 16:14:00 +0000537 * Requires: PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -0400538 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100539 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200542
543/**
Ronald Cron6f135e12021-12-08 16:57:54 +0100544 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100545 *
Ronald Cron6f135e12021-12-08 16:57:54 +0100546 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100547 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +0200548 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +0100549 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100550 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +0100551 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +0200552 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +0100553 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100554 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100555 */
Ronald Cron27eb68d2024-03-15 16:13:37 +0100556#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +0100557
558/**
Ronald Cronab65c522021-11-24 10:47:20 +0100559 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
560 *
561 * Enable TLS 1.3 middlebox compatibility mode.
562 *
563 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
564 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
565 * expecting TLS 1.2 traffic.
566 *
567 * Turning on the compatibility mode comes at the cost of a few added bytes
568 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
569 * that don't use it. Therefore, unless transmission bandwidth is critical and
570 * you know that middlebox compatibility issues won't occur, it is therefore
571 * recommended to set this option.
572 *
573 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +0100574 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
575 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +0100576 *
577 */
Ronald Cron27eb68d2024-03-15 16:13:37 +0100578#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +0100579
580/**
Ronald Crond8d2ea52022-10-04 15:48:06 +0200581 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
582 *
583 * Enable TLS 1.3 PSK key exchange mode.
584 *
585 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
586 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
587 * effect on the build.
588 *
589 */
590#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
591
592/**
593 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
594 *
595 * Enable TLS 1.3 ephemeral key exchange mode.
596 *
Przemek Stekielce05f542023-06-15 16:44:08 +0200597 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200598 * MBEDTLS_X509_CRT_PARSE_C
599 * and at least one of:
Janos Follath277bba82024-11-19 16:14:00 +0000600 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200601 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +0200602 *
603 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
604 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
605 * effect on the build.
606 *
607 */
608#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
609
610/**
611 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
612 *
613 * Enable TLS 1.3 PSK ephemeral key exchange mode.
614 *
Przemek Stekielce05f542023-06-15 16:44:08 +0200615 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +0200616 *
617 * Comment to disable support for the PSK ephemeral key exchange mode in
618 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
619 * have any effect on the build.
620 *
621 */
622#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
623
624/**
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 * \def MBEDTLS_SSL_EARLY_DATA
626 *
627 * Enable support for RFC 8446 TLS 1.3 early data.
628 *
629 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
630 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
631 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
632 *
633 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
634 * is not enabled, this option does not have any effect on the build.
635 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +0100636 * \note The maximum amount of early data can be set with
637 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
638 *
Gilles Peskine449bd832023-01-11 14:50:10 +0100639 */
Ronald Cronc2e110f2022-11-22 09:01:46 +0100640//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +0000641
642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100644 *
645 * Enable support for DTLS (all available versions).
646 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200647 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100648 *
TRodziewicz0f82ec62021-05-12 17:49:18 +0200649 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100650 *
651 * Comment this macro to disable support for DTLS
652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100654
655/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200657 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +0100658 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200659 *
Paul Bakker27e36d32014-04-08 12:33:37 +0200660 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200663
664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200666 *
667 * Enable support for the anti-replay mechanism in DTLS.
668 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 * Requires: MBEDTLS_SSL_TLS_C
670 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200671 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +0200672 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200673 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +0200674 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200675 * Comment this to disable anti-replay in DTLS.
676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +0200678
679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +0200681 *
682 * Enable support for HelloVerifyRequest on DTLS servers.
683 *
684 * This feature is highly recommended to prevent DTLS servers being used as
685 * amplifiers in DoS attacks against other hosts. It should always be enabled
686 * unless you know for sure amplification cannot be a problem in the
687 * environment in which your server operates.
688 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -0400689 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +0200690 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200691 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +0200692 *
693 * Comment this to disable support for HelloVerifyRequest.
694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +0200696
697/**
Johan Pascalb62bb512015-12-03 21:56:45 +0100698 * \def MBEDTLS_SSL_DTLS_SRTP
699 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200700 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +0200701 * through the use_srtp extension.
702 *
703 * \note This feature provides the minimum functionality required
704 * to negotiate the use of DTLS-SRTP and to allow the derivation of
705 * the associated SRTP packet protection key material.
706 * In particular, the SRTP packet protection itself, as well as the
707 * demultiplexing of RTP and DTLS packets at the datagram layer
708 * (see Section 5 of RFC 5764), are not handled by this feature.
709 * Instead, after successful completion of a handshake negotiating
710 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +0100711 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +0200712 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
713 * (this is implemented in the SSL example programs).
714 * The resulting key should then be passed to an SRTP stack.
715 *
716 * Setting this option enables the runtime API
717 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
718 * through which the supported DTLS-SRTP protection
719 * profiles can be configured. You must call this API at
720 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +0100721 *
722 * Requires: MBEDTLS_SSL_PROTO_DTLS
723 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +0200724 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +0100725 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +0200726//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +0100727
728/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +0200729 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
730 *
731 * Enable server-side support for clients that reconnect from the same port.
732 *
733 * Some clients unexpectedly close the connection and try to reconnect using the
734 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +0100735 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +0200736 * flag enables that support.
737 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +0200738 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +0200739 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +0200740 * Comment this to disable support for clients reusing the source port.
741 */
742#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
743
744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +0200746 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200747 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +0100748 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +0200749 * session store remains the responsibility of the application, though).
750 * Server-side, you also need to provide callbacks for writing and parsing
751 * tickets, including authenticated encryption and key management. Example
752 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +0200753 *
754 * Comment this macro to disable support for SSL session tickets
755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +0200757
758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +0200760 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200761 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +0200762 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200763 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +0000764 *
Paul Bakker0be444a2013-08-27 21:55:01 +0200765 * Comment this macro to disable support for server name indication in SSL
766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +0200768
769/**
Gilles Peskinef03bd812020-03-23 18:13:58 +0100770 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
771 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -0500772 * When this option is enabled, the SSL buffer will be resized automatically
773 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +0200774 *
775 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +0100776 */
777//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
778
779/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +0200780 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
781 *
782 * Enable testing of the constant-flow nature of some sensitive functions with
783 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +0200784 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +0200785 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +0200786 * This setting requires compiling with clang -fsanitize=memory. The test
787 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +0200788 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +0200789 * \warning This macro is only used for extended testing; it is not considered
790 * part of the library's API, so it may change or disappear at any time.
791 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +0200792 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +0200793 */
794//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
795
796/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +0200797 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
798 *
799 * Enable testing of the constant-flow nature of some sensitive functions with
800 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +0200801 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +0200802 *
803 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +0200804 * testing if the tests suites are run with valgrind's memcheck. This can be
805 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
806 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +0200807 *
808 * \warning This macro is only used for extended testing; it is not considered
809 * part of the library's API, so it may change or disappear at any time.
810 *
811 * Uncomment to enable testing of the constant-flow nature of selected code.
812 */
813//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
814
815/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +0200816 * \def MBEDTLS_TEST_HOOKS
817 *
818 * Enable features for invasive testing such as introspection functions and
819 * hooks for fault injection. This enables additional unit tests.
820 *
821 * Merely enabling this feature should not change the behavior of the product.
822 * It only adds new code, and new branching points where the default behavior
823 * is the same as when this feature is disabled.
824 * However, this feature increases the attack surface: there is an added
825 * risk of vulnerabilities, and more gadgets that can make exploits easier.
826 * Therefore this feature must never be enabled in production.
827 *
828 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
829 * information.
830 *
831 * Uncomment to enable invasive tests.
832 */
833//#define MBEDTLS_TEST_HOOKS
834
835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200837 *
838 * Allow run-time checking of compile-time enabled features. Thus allowing users
839 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200841 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200843 *
844 * Comment this to disable run-time checking and save ROM space
845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +0200847
848/**
Hanno Becker288dedc2019-03-27 11:00:53 +0000849 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
850 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +0300851 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +0000852 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
853 * the set of trusted certificates through a callback instead of a linked
854 * list.
855 *
856 * This is useful for example in environments where a large number of trusted
857 * certificates is present and storing them in a linked list isn't efficient
858 * enough, or when the set of trusted certificates changes frequently.
859 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +0300860 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +0000861 * `mbedtls_ssl_conf_ca_cb()` for more information.
862 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +0100863 * Requires: MBEDTLS_X509_CRT_PARSE_C
864 *
Hanno Becker288dedc2019-03-27 11:00:53 +0000865 * Uncomment to enable trusted certificate callbacks.
866 */
867//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
868
869/**
Hanno Becker612a2f12020-10-09 09:19:39 +0100870 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -0600871 *
Chris Jones2c745862020-12-16 11:41:06 +0000872 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -0600873 *
Chris Jones2c745862020-12-16 11:41:06 +0000874 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -0600875 * and other functions/constants only used by these functions, thus reducing
876 * the code footprint by several KB.
877 */
Chris Jones2c745862020-12-16 11:41:06 +0000878//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -0600879
880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +0200882 *
883 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
884 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
885 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +0300886 * Requires: MBEDTLS_PKCS1_V21
887 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +0200888 * Comment this macro to disallow using RSASSA-PSS in certificates.
889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200891/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000892
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000893/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200894 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +0000895 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200896 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +0000897 * \{
898 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000899
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000902 *
903 * Enable the debug functions.
904 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000905 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +0100906 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000907 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +0100908 * library/ssl_tls12_*.c
909 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000910 *
911 * This module provides debugging functions.
912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000914
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +0000917 *
918 * Enable error code to error string conversion.
919 *
920 * Module: library/error.c
921 * Caller:
922 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +0000924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +0000926
927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000929 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +0100930 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
931 *
Simon Butcherd567a232016-03-09 20:19:21 +0000932 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
933 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +0100934 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000935 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +0000936 * \note See also our Knowledge Base article about porting to a new
937 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +0100938 * 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 +0000939 *
Andres AG788aa4a2016-09-14 14:32:09 +0100940 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +0000941 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +0100942 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +0000943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000945
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000946/**
Nayna Jainc9deb182020-11-16 19:03:12 +0000947 * \def MBEDTLS_PKCS7_C
948 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +0000949 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +0000950 * RFC Link - https://tools.ietf.org/html/rfc2315
951 *
952 * Module: library/pkcs7.c
953 *
954 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -0600955 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
956 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +0000957 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +0000958 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +0000959 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +0000960#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +0000961
962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +0000964 *
965 * Enable simple SSL cache implementation.
966 *
967 * Module: library/ssl_cache.c
968 * Caller:
969 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +0000971 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +0000973
974/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +0200976 *
977 * Enable basic implementation of DTLS cookies for hello verification.
978 *
979 * Module: library/ssl_cookie.c
980 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +0200981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +0200983
984/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +0200985 * \def MBEDTLS_SSL_TICKET_C
986 *
987 * Enable an implementation of TLS server-side callbacks for session tickets.
988 *
989 * Module: library/ssl_ticket.c
990 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +0200991 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +0200992 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
993 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +0200994 */
995#define MBEDTLS_SSL_TICKET_C
996
997/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000999 *
1000 * Enable the SSL/TLS client code.
1001 *
Ronald Cronde1adee2022-03-07 16:20:30 +01001002 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001003 * Caller:
1004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001006 *
Janos Follath745e5612024-12-02 13:22:34 +00001007 * \warning You must call psa_crypto_init() before doing any TLS operations.
1008 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001009 * This module is required for SSL/TLS client support.
1010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001012
Paul Bakker9a736322012-11-14 12:39:52 +00001013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001015 *
1016 * Enable the SSL/TLS server code.
1017 *
Ronald Cronde1adee2022-03-07 16:20:30 +01001018 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001019 * Caller:
1020 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001022 *
Janos Follath745e5612024-12-02 13:22:34 +00001023 * \warning You must call psa_crypto_init() before doing any TLS operations.
1024 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001025 * This module is required for SSL/TLS server support.
1026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001028
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001031 *
Paul Bakkere29ab062011-05-18 13:26:54 +00001032 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001033 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001034 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01001035 * Caller: library/ssl*_client.c
1036 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
1039 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00001040 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001041 * This module is required for SSL/TLS.
1042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001044
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001047 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01001048 * Enable the semi-portable timing interface.
1049 *
Simon Butcherd567a232016-03-09 20:19:21 +00001050 * \note The provided implementation only works on POSIX/Unix (including Linux,
1051 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01001052 * module and provide your own implementations of the callbacks needed by
1053 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
1054 * your own implementation of the whole module by setting
1055 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001056 *
Andrzej Kurek57353692022-04-07 08:08:21 -04001057 * \note The timing module will include time.h on suitable platforms
1058 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
1059 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
1060 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001061 * \note See also our Knowledge Base article about porting to a new
1062 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01001063 * 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 +00001064 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001065 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02001066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001068
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001071 *
1072 * Enable run-time version information.
1073 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00001074 * Module: library/version.c
1075 *
1076 * This module provides run-time version information.
1077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00001079
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001080/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001082 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001083 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001084 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001085 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00001086 * Caller: library/x509_crl.c
1087 * library/x509_crt.c
1088 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001089 *
Janos Follath277bba82024-11-19 16:14:00 +00001090 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C
Przemek Stekiel278b6672022-08-03 09:50:38 +02001091 *
Janos Follath277bba82024-11-19 16:14:00 +00001092 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001093 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001094 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00001095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001097
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001100 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001101 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001102 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001103 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01001104 * Caller: library/ssl_tls.c
1105 * library/ssl*_client.c
1106 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001107 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001109 *
1110 * This module is required for X.509 certificate parsing.
1111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001113
1114/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001116 *
1117 * Enable X.509 CRL parsing.
1118 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001119 * Module: library/x509_crl.c
1120 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001121 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001123 *
1124 * This module is required for X.509 CRL parsing.
1125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001127
1128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001130 *
1131 * Enable X.509 Certificate Signing Request (CSR) parsing.
1132 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001133 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001134 * Caller: library/x509_crt_write.c
1135 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001137 *
1138 * This module is used for reading X.509 certificate request.
1139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001141
1142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001144 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001145 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001146 *
1147 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001148 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02001149 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02001150 *
Janos Follath277bba82024-11-19 16:14:00 +00001151 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001152 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001153 * This module is the basis for creating X.509 certificates and CSRs.
1154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001156
1157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001159 *
1160 * Enable creating X.509 certificates.
1161 *
1162 * Module: library/x509_crt_write.c
1163 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001165 *
1166 * This module is required for X.509 certificate creation.
1167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001169
1170/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001172 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001173 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001174 *
1175 * Module: library/x509_csr_write.c
1176 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001178 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001179 * This module is required for X.509 certificate request writing.
1180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001182
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001183/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00001184
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001185/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02001186 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001187 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02001188 * This section contains Mbed TLS build settings that are not associated
1189 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001190 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001191 * \{
1192 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001193
Gilles Peskinea02c1242022-03-16 17:03:19 +01001194/**
1195 * \def MBEDTLS_CONFIG_FILE
1196 *
1197 * If defined, this is a header which will be included instead of
1198 * `"mbedtls/mbedtls_config.h"`.
1199 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02001200 * Unlike other configuration options, this one must be defined on the
1201 * compiler command line: a definition in `mbedtls_config.h` would have
1202 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001203 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02001204 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01001205 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02001206 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001207 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02001208 * The value of this symbol is typically a path in double quotes, either
1209 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001210 */
1211//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
1212
1213/**
1214 * \def MBEDTLS_USER_CONFIG_FILE
1215 *
1216 * If defined, this is a header which will be included after
1217 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02001218 * This allows you to modify the default configuration, including the ability
1219 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001220 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02001221 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01001222 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02001223 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001224 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02001225 * The value of this symbol is typically a path in double quotes, either
1226 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01001227 */
1228//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
1229
Gilles Peskineba4162a2022-04-11 17:04:38 +02001230/** \} name SECTION: General configuration options */
1231
1232/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001233 * \name SECTION: Module configuration options
1234 *
1235 * This section allows for the setting of module specific sizes and
1236 * configuration options. The default values are already present in the
1237 * relevant header files and should suffice for the regular use cases.
1238 *
1239 * Our advice is to enable options and change their values here
1240 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001241 * \{
1242 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02001243/* The Doxygen documentation here is used when a user comments out a
1244 * setting and runs doxygen themselves. On the other hand, when we typeset
1245 * the full documentation including disabled settings, the documentation
1246 * in specific modules' header files is used if present. When editing this
1247 * file, make sure that each option is documented in exactly one place,
1248 * plus optionally a same-line Doxygen comment here if there is a Doxygen
1249 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001250
Paul Bakker088c5c52014-04-25 11:11:10 +02001251/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
1253//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker6e339b52013-07-03 13:37:05 +02001254
Paul Bakker088c5c52014-04-25 11:11:10 +02001255/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10001256
Angus Grattond8213d02016-05-25 20:56:48 +10001257/** \def MBEDTLS_SSL_IN_CONTENT_LEN
1258 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001259 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10001260 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001261 * This determines the size of the incoming TLS I/O buffer in such a way
1262 * that it is capable of holding the specified amount of plaintext data,
1263 * regardless of the protection mechanism used.
1264 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001265 * \note When using a value less than the default of 16KB on the client, it is
1266 * recommended to use the Maximum Fragment Length (MFL) extension to
1267 * inform the server about this limitation. On the server, there
1268 * is no supported, standardized way of informing the client about
1269 * restriction on the maximum size of incoming messages, and unless
1270 * the limitation has been communicated by other means, it is recommended
1271 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
1272 * while keeping the default value of 16KB for the incoming buffer.
1273 *
David Horstmann95d516f2021-05-04 18:36:56 +01001274 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10001275 */
1276//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
1277
Gilles Peskined3d02902020-03-04 21:35:27 +01001278/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
1279 *
1280 * The maximum length of CIDs used for incoming DTLS messages.
1281 *
1282 */
1283//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
1284
1285/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
1286 *
1287 * The maximum length of CIDs used for outgoing DTLS messages.
1288 *
1289 */
1290//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
1291
TRodziewicze8dd7092021-05-12 14:19:11 +02001292/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01001293 *
1294 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02001295 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01001296 *
1297 * The padding will always be chosen so that the length of the
1298 * padded plaintext is a multiple of the value of this option.
1299 *
1300 * Note: A value of \c 1 means that no padding will be used
1301 * for outgoing records.
1302 *
1303 * Note: On systems lacking division instructions,
1304 * a power of two should be preferred.
1305 */
TRodziewicze8dd7092021-05-12 14:19:11 +02001306//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01001307
Angus Grattond8213d02016-05-25 20:56:48 +10001308/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
1309 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001310 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10001311 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001312 * This determines the size of the outgoing TLS I/O buffer in such a way
1313 * that it is capable of holding the specified amount of plaintext data,
1314 * regardless of the protection mechanism used.
1315 *
Angus Grattond8213d02016-05-25 20:56:48 +10001316 * It is possible to save RAM by setting a smaller outward buffer, while keeping
1317 * the default inward 16384 byte buffer to conform to the TLS specification.
1318 *
1319 * The minimum required outward buffer size is determined by the handshake
1320 * protocol's usage. Handshaking will fail if the outward buffer is too small.
1321 * The specific size requirement depends on the configured ciphers and any
1322 * certificate data which is sent during the handshake.
1323 *
David Horstmann95d516f2021-05-04 18:36:56 +01001324 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10001325 */
1326//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
1327
Hanno Beckere0b150f2018-08-21 15:51:03 +01001328/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
1329 *
1330 * Maximum number of heap-allocated bytes for the purpose of
1331 * DTLS handshake message reassembly and future message buffering.
1332 *
Yuto Takano7828ca22021-08-10 11:26:15 +01001333 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01001334 * to account for a reassembled handshake message of maximum size,
1335 * together with its reassembly bitmap.
1336 *
Hanno Becker97a1c132018-08-28 14:42:15 +01001337 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01001338 * should be sufficient for all practical situations as it allows
1339 * to reassembly a large handshake message (such as a certificate)
1340 * while buffering multiple smaller handshake messages.
1341 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01001342 */
Hanno Becker159a37f2018-08-24 15:07:29 +01001343//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01001344
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01001345//#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 +02001346//#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 +02001347
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02001348/**
1349 * Complete list of ciphersuites to use, in order of preference.
1350 *
1351 * \warning No dependency checking is done on that field! This option can only
1352 * be used to restrict the set of available ciphersuites. It is your
1353 * responsibility to make sure the needed modules are active.
1354 *
1355 * Use this to save a few hundred bytes of ROM (default ordering of all
1356 * available ciphersuites) and a few to a few hundred bytes of RAM.
1357 *
1358 * The value below is only an example, not the default.
1359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360//#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 +02001361
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001362/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001363 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1364 *
1365 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08001366 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001367 *
1368 * It must be positive and smaller than UINT32_MAX.
1369 *
1370 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1371 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001372 */
1373//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1374
1375/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001376 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
1377 *
Jerry Yucf913512023-11-14 11:06:52 +08001378 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08001379 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001380 *
Jerry Yu034a8b72023-11-10 12:20:19 +08001381 * - The client ticket age is the time difference between the time when the
1382 * client proposes to the server to use the ticket and the time the client
1383 * received the ticket from the server.
1384 * - The server ticket age is the time difference between the time when the
1385 * server receives a proposition from the client to use the ticket and the
1386 * time when the ticket was created by the server.
1387 *
Jerry Yucf913512023-11-14 11:06:52 +08001388 * The ages might be different due to the client and server clocks not running
1389 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
1390 * per million (360 to 72 milliseconds per hour). Default tolerance window is
1391 * 6s, thus in the worst case clients and servers must sync up their system time
1392 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001393 *
Jerry Yu04fceb72023-11-15 09:52:46 +08001394 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001395 */
Gilles Peskined65ea422023-09-05 21:07:32 +02001396//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001397
1398/**
1399 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1400 *
1401 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1402 *
1403 * This must be less than 256.
1404 */
Gilles Peskined65ea422023-09-05 21:07:32 +02001405//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001406
1407/**
1408 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1409 *
1410 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1411 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1412 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
1413 *
1414 */
Gilles Peskined65ea422023-09-05 21:07:32 +02001415//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02001416
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01001417/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01001419//#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 +01001420
Gilles Peskine611179c2022-04-13 23:04:48 +02001421/** \} name SECTION: Module configuration options */