blob: 84b27e5008fe8dcb9e1f4d0981432eca7814961f [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000051 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010052 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000053 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000054 * library/constant_time.c
55 * library/padlock.h
Paul Bakker68041ec2009-04-19 21:17:55 +000056 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010057 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000058 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010059 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010060 * MBEDTLS_PADLOCK_C
61 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020062 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000065
Paul Bakkerf3b86c12011-01-27 15:24:17 +000066/**
Gilles Peskineed942f82017-06-08 15:19:20 +020067 * \def MBEDTLS_NO_UDBL_DIVISION
68 *
69 * The platform lacks support for double-width integer division (64-bit
70 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
71 *
72 * Used in:
73 * include/mbedtls/bignum.h
74 * library/bignum.c
75 *
76 * The bignum code uses double-width division to speed up some operations.
77 * Double-width division is often implemented in software that needs to
78 * be linked with the program. The presence of a double-width integer
79 * type is usually detected automatically through preprocessor macros,
80 * but the automatic detection cannot know whether the code needs to
81 * and can be linked with an implementation of division for that type.
82 * By default division is assumed to be usable if the type is present.
83 * Uncomment this option to prevent the use of double-width division.
84 *
85 * Note that division for the native integer type is always required.
86 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010087 * platform, but it need not support multiplication or division. In some
88 * cases it is also desirable to disable some double-width operations. For
89 * example, if double-width division is implemented in software, disabling
90 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020091 */
92//#define MBEDTLS_NO_UDBL_DIVISION
93
94/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020095 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
96 *
97 * The platform lacks support for 32x32 -> 64-bit multiplication.
98 *
99 * Used in:
100 * library/poly1305.c
101 *
102 * Some parts of the library may use multiplication of two unsigned 32-bit
103 * operands with a 64-bit result in order to speed up computations. On some
104 * platforms, this is not available in hardware and has to be implemented in
105 * software, usually in a library provided by the toolchain.
106 *
107 * Sometimes it is not desirable to have to link to that library. This option
108 * removes the dependency of that library on platforms that lack a hardware
109 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
110 *
111 * Note that depending on the compiler, this may decrease performance compared
112 * to using the library function provided by the toolchain.
113 */
114//#define MBEDTLS_NO_64BIT_MULTIPLICATION
115
116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000118 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000119 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000120 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200124
125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200128 * System has time.h and time().
129 * The time does not need to be correct, only time differences are used,
130 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100132 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
133 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
134 * MBEDTLS_PLATFORM_STD_TIME.
135 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400136 * Comment if your system does not support time functions.
137 *
138 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
139 * interface - timing.c will include time.h on suitable platforms
140 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
141 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100144
145/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * \def MBEDTLS_HAVE_TIME_DATE
147 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100148 * System has time.h, time(), and an implementation for
149 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100150 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200151 * the date should be correct). This is used to verify the validity period of
152 * X.509 certificates.
153 *
154 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100155 *
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100157 * behaves similarly to the gmtime_r() function from the C standard. Refer to
158 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100159 *
160 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100161 * mbedtls_platform_gmtime_r() at compile-time by using the macro
162 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200163 */
164#define MBEDTLS_HAVE_TIME_DATE
165
166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 *
169 * Enable the memory allocation layer.
170 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100172 * This allows different allocators (self-implemented or provided) to be
173 * provided to the platform abstraction layer.
174 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400175 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
177 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * free() function pointer at runtime.
179 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400180 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200181 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000182 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100183 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400184 * An overview of how the value of mbedtls_calloc is determined:
185 *
186 * - if !MBEDTLS_PLATFORM_MEMORY
187 * - mbedtls_calloc = calloc
188 * - if MBEDTLS_PLATFORM_MEMORY
189 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
190 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
191 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
192 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
193 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
194 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
195 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
196 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
197 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
198 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
199 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
200 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
201 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
202 *
203 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
204 * - if !MBEDTLS_PLATFORM_STD_CALLOC
205 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
206 *
207 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
208 *
209 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
210 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
211 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
212 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
213 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
214 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
215 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100217 *
218 * Enable this layer to allow use of alternative memory allocators.
219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100221
222/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200223 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200224 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200225 * Do not assign standard functions in the platform layer (e.g. calloc() to
226 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200227 *
228 * This makes sure there are no linking errors on platforms that do not support
229 * these functions. You will HAVE to provide alternatives, either at runtime
230 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
232 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200235 *
236 * Uncomment to prevent default assignment of standard functions in the
237 * platform layer.
238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200240
241/**
Janos Follathc351d182016-03-21 08:43:59 +0000242 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100243 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100244 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
245 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100246 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
248 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100249 * alternative printf function pointer.
250 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100252 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200253 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
254 * it will be enabled automatically by check_config.h
255 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200256 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000258 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100259 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
260 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100261 * Uncomment a macro to enable alternate implementation of specific base
262 * platform function
263 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200264//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100266//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267//#define MBEDTLS_PLATFORM_FPRINTF_ALT
268//#define MBEDTLS_PLATFORM_PRINTF_ALT
269//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200270//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100271//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100272//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800273//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100274
275/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200276 * Uncomment the macro to let Mbed TLS use your alternate implementation of
277 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
278 * platform_util.c.
279 *
280 * gmtime() is not a thread-safe function as defined in the C standard. The
281 * library will try to use safer implementations of this function, such as
282 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
283 * system, the implementation of mbedtls_platform_gmtime_r() will default to
284 * using the standard gmtime(). In this case, calls from the library to
285 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
286 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
287 * library are also guarded with this mutex to avoid race conditions. However,
288 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
289 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
290 * supplied at compile time.
291 */
292//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
293
294/**
295 * Uncomment the macro to let mbed TLS use your alternate implementation of
296 * mbedtls_platform_zeroize(). This replaces the default implementation in
297 * platform_util.c.
298 *
299 * mbedtls_platform_zeroize() is a widely used function across the library to
300 * zero a block of memory. The implementation is expected to be secure in the
301 * sense that it has been written to prevent the compiler from removing calls
302 * to mbedtls_platform_zeroize() as part of redundant code elimination
303 * optimizations. However, it is difficult to guarantee that calls to
304 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
305 * versions of the C language standards do not provide a secure implementation
306 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
307 * configure their own implementation of mbedtls_platform_zeroize(), for
308 * example by using directives specific to their compiler, features from newer
309 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
310 * their system (e.g explicit_bzero() in BSD).
311 */
312//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
313
314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100316 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000317 * Mark deprecated functions and features so that they generate a warning if
318 * used. Functionality deprecated in one version will usually be removed in the
319 * next version. You can enable this to help you prepare the transition to a
320 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100321 *
322 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100324 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000325 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100328
329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100331 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000332 * Remove deprecated functions and features so that they generate an error if
333 * used. Functionality deprecated in one version will usually be removed in the
334 * next version. You can enable this to help you prepare the transition to a
335 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100336 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000337 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100340
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100341/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000342
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000343/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000344 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000345 *
346 * This section sets support for features that are or are not needed
347 * within the modules that are enabled.
348 * \{
349 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000350
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100353 *
TRodziewiczd8540832021-06-10 15:16:50 +0200354 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200355 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100356 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100358 *
359 * You will need to provide a header "timing_alt.h" and an implementation at
360 * compile time.
361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100363
364/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100365 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200366 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100367 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100368 * alternate core implementation of a symmetric crypto, an arithmetic or hash
369 * module (e.g. platform specific assembly optimized implementations). Keep
370 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200371 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200372 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200374 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000376 * provide the "struct mbedtls_aes_context" definition and omit the base
377 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200378 * "aes.h" to include the new function definitions.
379 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200380 * Uncomment a macro to enable alternate implementation of the corresponding
381 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100382 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200383 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100384 * use constitutes a security risk. If possible, we recommend
385 * avoiding dependencies on them, and considering stronger message
386 * digests and ciphers instead.
387 *
Paul Bakker90995b52013-06-24 19:20:35 +0200388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000390//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200392//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300393//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200394//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200395//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000397//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000398//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100399//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300400//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300402//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000404//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200405//#define MBEDTLS_SHA1_ALT
406//#define MBEDTLS_SHA256_ALT
407//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000408
Janos Follathb0697532016-08-18 12:38:46 +0100409/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800410 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100411 * implemented with two .c files:
412 * - ecp.c
413 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000414 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
415 * macros as described above. The only difference is that you have to make sure
416 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100417 */
418//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200419
420/**
TRodziewicz75628d52021-06-18 12:56:27 +0200421 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200422 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100423 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
424 * alternate core implementation of symmetric crypto or hash function. Keep in
425 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200426 *
427 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200429 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
431 * no longer provide the mbedtls_sha1_process() function, but it will still provide
432 * the other function (using your mbedtls_sha1_process() function) and the definition
433 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200434 * with this definition.
435 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200436 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100437 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
438 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200439 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200440 * Uncomment a macro to enable alternate implementation of the corresponding
441 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100442 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200443 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100444 * constitutes a security risk. If possible, we recommend avoiding
445 * dependencies on them, and considering stronger message digests
446 * and ciphers instead.
447 *
Janos Follath1231d212019-01-07 15:01:32 +0000448 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
449 * enabled, then the deterministic ECDH signature functions pass the
450 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
451 * alternative implementations should use the RNG only for generating
452 * the ephemeral key and nothing else. If this is not possible, then
453 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200454 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000455 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457//#define MBEDTLS_MD5_PROCESS_ALT
458//#define MBEDTLS_RIPEMD160_PROCESS_ALT
459//#define MBEDTLS_SHA1_PROCESS_ALT
460//#define MBEDTLS_SHA256_PROCESS_ALT
461//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200462//#define MBEDTLS_DES_SETKEY_ALT
463//#define MBEDTLS_DES_CRYPT_ECB_ALT
464//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200465//#define MBEDTLS_AES_SETKEY_ENC_ALT
466//#define MBEDTLS_AES_SETKEY_DEC_ALT
467//#define MBEDTLS_AES_ENCRYPT_ALT
468//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300469//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300470//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300471//#define MBEDTLS_ECDSA_VERIFY_ALT
472//#define MBEDTLS_ECDSA_SIGN_ALT
473//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200474
475/**
Janos Follathc44ab972016-11-18 16:38:23 +0000476 * \def MBEDTLS_ECP_INTERNAL_ALT
477 *
478 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100479 *
480 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100481 * alternative core implementation of elliptic curve arithmetic. Keep in mind
482 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100483 *
484 * This partially replaces one function. The header file from mbed TLS is still
485 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
486 * is still present and it is used for group structures not supported by the
487 * alternative.
488 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100489 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100490 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100491 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
492 * able to fallback to curves not supported by the alternative implementation.
493 *
Janos Follathc44ab972016-11-18 16:38:23 +0000494 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
495 * and implementing the following functions:
496 * unsigned char mbedtls_internal_ecp_grp_capable(
497 * const mbedtls_ecp_group *grp )
498 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500499 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000500 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
501 * replacement functions implement arithmetic for the given group and 0
502 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500503 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000504 * called before and after each point operation and provide an opportunity to
505 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100506 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100507 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
508 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
509 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
510 * for the operation is supported by your implementation (i.e. your
511 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
512 * group is not supported by your implementation, then the original mbed TLS
513 * implementation of ecp_double_jac() is used instead, unless this fallback
514 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
515 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
516 *
517 * The function prototypes and the definition of mbedtls_ecp_group and
518 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
519 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
520 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100521 *
522 * Uncomment a macro to enable alternate implementation of the corresponding
523 * function.
524 */
525/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000526//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100527/* Turn off software fallback for curves not supported in hardware */
528//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100529/* Support for Weierstrass curves with Jacobi representation */
530//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
531//#define MBEDTLS_ECP_ADD_MIXED_ALT
532//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
533//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
534//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
535/* Support for curves with Montgomery arithmetic */
536//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
537//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
538//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
539
540/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200541 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200542 *
543 * Uncomment this macro to let mbed TLS use your own implementation of a
544 * hardware entropy collector.
545 *
546 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000547 * prototype as declared in library/entropy_poll.h, and accept NULL as first
548 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200549 *
550 * Uncomment to use your own hardware entropy collector.
551 */
552//#define MBEDTLS_ENTROPY_HARDWARE_ALT
553
554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000556 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100557 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000558 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100559 * Uncomment this macro to use precomputed AES tables stored in ROM.
560 * Comment this macro to generate AES tables in RAM at runtime.
561 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100562 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
563 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100564 * initialization time before the first AES operation can be performed.
565 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
566 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
567 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100568 *
569 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000572
573/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100574 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200575 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100576 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200577 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100578 * Uncommenting this macro omits 75% of the AES tables from
579 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
580 * by computing their values on the fly during operations
581 * (the tables are entry-wise rotations of one another).
582 *
583 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100584 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100585 * runtime. Specifically, one has to compare 4 accesses within
586 * different tables to 4 accesses with additional arithmetic
587 * operations within the same table. The performance gain/loss
588 * depends on the system and memory details.
589 *
590 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200591 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100592//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200593
594/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800595 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
596 *
597 * Use only 128-bit keys in AES operations to save ROM.
598 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800599 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800600 * or 256-bit keys.
601 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800602 * Uncommenting this macro reduces the size of AES code by ~300 bytes
603 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800604 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800605 * Module: library/aes.c
606 *
607 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800608 */
609//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
610
Gilles Peskinea8861e02023-09-05 20:20:51 +0200611/*
612 * Disable plain C implementation for AES.
613 *
614 * When the plain C implementation is enabled, and an implementation using a
615 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
616 * detection will be used to select between them.
617 *
618 * If only one implementation is present, runtime detection will not be used.
619 * This configuration will crash at runtime if running on a CPU without the
620 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
621 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
622 */
623//#define MBEDTLS_AES_USE_HARDWARE_ONLY
624
Arto Kinnunen732ca322023-04-14 14:26:10 +0800625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200627 *
628 * Use less ROM for the Camellia implementation (saves about 768 bytes).
629 *
630 * Uncomment this macro to use less memory for Camellia.
631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200633
634/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200635 * \def MBEDTLS_CHECK_RETURN_WARNING
636 *
637 * If this macro is defined, emit a compile-time warning if application code
638 * calls a function without checking its return value, but the return value
639 * should generally be checked in portable applications.
640 *
641 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
642 * implemented. Otherwise this option has no effect.
643 *
644 * Uncomment to get warnings on using fallible functions without checking
645 * their return value.
646 *
647 * \note This feature is a work in progress.
648 * Warnings will be added to more functions in the future.
649 *
650 * \note A few functions are considered critical, and ignoring the return
651 * value of these functions will trigger a warning even if this
652 * macro is not defined. To completely disable return value check
653 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
654 */
655//#define MBEDTLS_CHECK_RETURN_WARNING
656
657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200659 *
660 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200663
664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000666 *
667 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000670
671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000673 *
674 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000677
678/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100679 * \def MBEDTLS_CIPHER_MODE_OFB
680 *
681 * Enable Output Feedback mode (OFB) for symmetric ciphers.
682 */
683#define MBEDTLS_CIPHER_MODE_OFB
684
685/**
686 * \def MBEDTLS_CIPHER_MODE_XTS
687 *
688 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
689 */
690#define MBEDTLS_CIPHER_MODE_XTS
691
692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000694 *
695 * Enable NULL cipher.
696 * Warning: Only do so when you know what you are doing. This allows for
697 * encryption or channels without any security!
698 *
Ronald Croncee42702021-04-26 11:34:44 +0200699 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
701 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
702 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
703 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
704 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
705 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
706 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
707 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
708 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
709 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
710 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
711 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
712 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
713 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
714 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
715 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
716 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
717 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
718 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000719 *
720 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000723
724/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100725 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200726 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100727 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
728 * specific padding modes in the cipher layer with cipher modes that support
729 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200730 *
731 * If you disable all padding modes, only full blocks can be used with CBC.
732 *
733 * Enable padding modes in the cipher layer.
734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735#define MBEDTLS_CIPHER_PADDING_PKCS7
736#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
737#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
738#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200739
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200740/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
741 *
742 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800743 * Without this, CTR_DRBG uses a 256-bit key
744 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200745 */
746//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
747
Paul Bakker48e93c82013-08-14 12:21:18 +0200748/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200749 * Enable the verified implementations of ECDH primitives from Project Everest
750 * (currently only Curve25519). This feature changes the layout of ECDH
751 * contexts and therefore is a compatibility break for applications that access
752 * fields of a mbedtls_ecdh_context structure directly. See also
753 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
754 */
755//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
756
757/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100758 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200759 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100760 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
761 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200762 *
763 * Comment macros to disable the curve and functions for it
764 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200765/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
767#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
768#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
769#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
770#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
771#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
772#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
773#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
774#define MBEDTLS_ECP_DP_BP256R1_ENABLED
775#define MBEDTLS_ECP_DP_BP384R1_ENABLED
776#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200777/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200778#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000779#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200780
781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200783 *
784 * Enable specific 'modulo p' routines for each NIST prime.
785 * Depending on the prime and architecture, makes operations 4 to 8 times
786 * faster on the corresponding curve.
787 *
788 * Comment this macro to disable NIST curves optimisation.
789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200791
792/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200793 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100794 *
795 * Enable "non-blocking" ECC operations that can return early and be resumed.
796 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200797 * This allows various functions to pause by returning
798 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
799 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
800 * order to further progress and eventually complete their operation. This is
801 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
802 * number of ECC operations a function may perform before pausing; see
803 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100804 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200805 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200806 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100807 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100808 * This option:
809 * - Adds xxx_restartable() variants of existing operations in the
810 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100811 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
812 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100813 * - ECDSA: signature generation & verification;
814 * - PK: signature generation & verification;
815 * - X509: certificate chain verification.
816 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
817 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
818 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
819 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000820 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100821 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100822 * - verification of the server's key exchange signature;
823 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100824 * - generation of the client's signature if client authentication is used,
825 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100826 *
827 * \note In the cases above, the usual SSL/TLS functions, such as
828 * mbedtls_ssl_handshake(), can now return
829 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200830 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100831 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
832 * restartable operations in PK, X.509 and TLS (see above) are not
833 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100834 * PSA, and are not restartable. These are temporary limitations that
835 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200836 *
Ron Eldor19779c42018-11-05 16:58:13 +0200837 * \note This option only works with the default software implementation of
838 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100839 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100840 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100841 * Requires: MBEDTLS_ECP_C
842 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100843 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100844 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200845//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100846
847/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200848 * Uncomment to enable using new bignum code in the ECC modules.
849 *
850 * \warning This is currently experimental, incomplete and therefore should not
851 * be used in production.
852 */
853//#define MBEDTLS_ECP_WITH_MPI_UINT
854
855/**
856 * Uncomment to enable p256-m, which implements ECC key generation, ECDH,
857 * and ECDSA for SECP256R1 curves. This driver is used as an example to
858 * document how a third-party driver or software accelerator can be integrated
859 * to work alongside Mbed TLS.
860 *
861 * \warning p256-m has only been included to serve as a sample implementation
862 * of how a driver/accelerator can be integrated alongside Mbed TLS. It is not
863 * intended for use in production. p256-m files in Mbed TLS are not updated
864 * regularly, so they may not contain upstream fixes/improvements.
865 * DO NOT ENABLE/USE THIS MACRO IN PRODUCTION BUILDS!
866 */
867//#define MBEDTLS_P256M_EXAMPLE_DRIVER_ENABLED
868
869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100871 *
872 * Enable deterministic ECDSA (RFC 6979).
873 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
874 * may result in a compromise of the long-term signing key. This is avoided by
875 * the deterministic variant.
876 *
John Durkop36a82e52020-10-26 09:39:05 -0700877 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100878 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100879 * Comment this macro to disable deterministic ECDSA.
880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100882
883/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200885 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200886 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200887 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 * This enables the following ciphersuites (if other requisites are
889 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
891 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
892 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
893 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
894 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
895 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
896 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
897 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
898 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
899 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200902
903/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200905 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200906 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909 *
910 * This enables the following ciphersuites (if other requisites are
911 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
913 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
914 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
915 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
916 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
917 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
918 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
919 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
920 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
921 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100922 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100923 * \warning Using DHE constitutes a security risk as it
924 * is not possible to validate custom DH parameters.
925 * If possible, it is recommended users should consider
926 * preferring other methods of key exchange.
927 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100928 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200931
932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200934 *
935 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
936 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200937 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200938 *
939 * This enables the following ciphersuites (if other requisites are
940 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
942 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
943 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
944 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
945 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
946 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200949
950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200952 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200953 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200954 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
956 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200957 *
958 * This enables the following ciphersuites (if other requisites are
959 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
961 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
962 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
963 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
964 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
965 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
966 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
967 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
968 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
969 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200972
973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200975 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200976 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
979 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200980 *
981 * This enables the following ciphersuites (if other requisites are
982 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
984 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
985 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
986 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
987 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
988 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
989 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
990 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
991 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
992 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
993 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
994 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200995 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200997
998/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001000 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001001 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001002 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1004 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001005 *
1006 * This enables the following ciphersuites (if other requisites are
1007 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1009 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1010 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1011 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1012 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1013 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1014 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1015 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1016 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1017 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1018 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1019 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001020 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001021 * \warning Using DHE constitutes a security risk as it
1022 * is not possible to validate custom DH parameters.
1023 * If possible, it is recommended users should consider
1024 * preferring other methods of key exchange.
1025 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001026 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001029
1030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001032 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001033 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001034 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001035 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1036 * MBEDTLS_RSA_C
1037 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001039 *
1040 * This enables the following ciphersuites (if other requisites are
1041 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1043 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1044 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1045 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1046 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1047 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1048 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1049 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1050 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1051 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001054
1055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001057 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001058 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001059 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001060 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1061 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1062 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001063 *
1064 * This enables the following ciphersuites (if other requisites are
1065 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1067 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1068 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1069 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1070 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1071 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1072 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1073 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1074 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1075 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001078
1079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001081 *
1082 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1083 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001084 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1085 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1086 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001087 *
1088 * This enables the following ciphersuites (if other requisites are
1089 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1091 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1092 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1093 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1094 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1095 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1096 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1097 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1098 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1099 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001102
1103/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001105 *
1106 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1107 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001108 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1109 * MBEDTLS_RSA_C
1110 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001111 *
1112 * This enables the following ciphersuites (if other requisites are
1113 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1115 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1116 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1117 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1118 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1120 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1121 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1122 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1123 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001126
1127/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001128 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1129 *
1130 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1131 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001132 * \warning This is currently experimental. EC J-PAKE support is based on the
1133 * Thread v1.0.0 specification; incompatible changes to the specification
1134 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001135 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001136 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001137 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001138 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1139 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001140 * \warning If SHA-256 is provided only by a PSA driver, you must call
1141 * psa_crypto_init() before the first hanshake (even if
1142 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1143 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001144 * This enables the following ciphersuites (if other requisites are
1145 * enabled as well):
1146 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1147 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001148//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001149
1150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001152 *
1153 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1154 * RFC 5915 and RFC 5480.
1155 *
1156 * Currently this means parsing the SpecifiedECDomain choice of EC
1157 * parameters (only known groups are supported, not arbitrary domains, to
1158 * avoid validation issues).
1159 *
1160 * Disable if you only need to support RFC 5915 + 5480 key formats.
1161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001163
1164/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001165 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1166 *
1167 * Enable the support for parsing public keys of type Short Weierstrass
1168 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001169 * compressed point format. This parsing is done through ECP module's functions.
1170 *
1171 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1172 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1173 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001174 */
1175#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1176
1177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180 * Enable a dummy error function to make use of mbedtls_strerror() in
1181 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1182 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001183 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1185 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001186 *
1187 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001191
1192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001194 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001195 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001196 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001200
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001201/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001203 *
1204 * Enable functions that use the filesystem.
1205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001207
1208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001210 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001211 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001212 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001213 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001214 * application.
1215 *
1216 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001219
1220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001222 *
1223 * Do not use built-in platform entropy functions.
1224 * This is useful if your platform does not support
1225 * standards like the /dev/urandom or Windows CryptoAPI.
1226 *
1227 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001230
1231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001232 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001233 *
1234 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1235 * default SHA-512 based one (if both are available).
1236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001238 *
1239 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1240 * if you have performance concerns.
1241 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242 * This option is only useful if both MBEDTLS_SHA256_C and
1243 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001246
1247/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001248 * \def MBEDTLS_ENTROPY_NV_SEED
1249 *
1250 * Enable the non-volatile (NV) seed file-based entropy source.
1251 * (Also enables the NV seed read/write functions in the platform layer)
1252 *
1253 * This is crucial (if not required) on systems that do not have a
1254 * cryptographic entropy source (in hardware or kernel) available.
1255 *
1256 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1257 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001258 * \note The read/write functions that are used by the entropy source are
1259 * determined in the platform layer, and can be modified at runtime and/or
1260 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1261 *
1262 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001263 * with regular fopen(), please make sure you make a seedfile with the
1264 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1265 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001266 * and written to or you will get an entropy source error! The default
1267 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1268 * bytes from the file.
1269 *
1270 * \note The entropy collector will write to the seed file before entropy is
1271 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001272 */
1273//#define MBEDTLS_ENTROPY_NV_SEED
1274
Ronald Cron71016a92020-08-28 19:01:50 +02001275/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001276 *
Ronald Cron71016a92020-08-28 19:01:50 +02001277 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001278 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001279 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1280 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001281 *
1282 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001283 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001284 */
Ronald Cron71016a92020-08-28 19:01:50 +02001285//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001286
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001289 *
1290 * Enable debugging of buffer allocator memory issues. Automatically prints
1291 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1292 * function for 'debug output' of allocated memory.
1293 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001295 *
1296 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001299
1300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001302 *
1303 * Include backtrace information with each allocated block.
1304 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001306 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001307 *
1308 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001311
1312/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001314 *
1315 * Support external private RSA keys (eg from a HSM) in the PK layer.
1316 *
1317 * Comment this macro to disable support for external private RSA keys.
1318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001320
1321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001323 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001324 * Enable support for PKCS#1 v1.5 encoding.
1325 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001326 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001327 *
Paul Bakker48377d92013-08-30 12:06:24 +02001328 * This enables support for PKCS#1 v1.5 operations.
1329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001331
1332/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001334 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001335 * Enable support for PKCS#1 v2.1 encoding.
1336 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001337 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001338 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001339 * \warning If using a hash that is only provided by PSA drivers, you must
1340 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001341 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001342 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001345
Steven Cooreman6801f082021-02-19 17:21:22 +01001346/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1347 *
1348 * Enable support for platform built-in keys. If you enable this feature,
1349 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1350 * See the documentation of that function for more information.
1351 *
1352 * Built-in keys are typically derived from a hardware unique key or
1353 * stored in a secure element.
1354 *
1355 * Requires: MBEDTLS_PSA_CRYPTO_C.
1356 *
1357 * \warning This interface is experimental and may change or be removed
1358 * without notice.
1359 */
1360//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1361
Ronald Cron3768ac12021-01-26 16:58:00 +01001362/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1363 *
1364 * Enable support for PSA crypto client.
1365 *
1366 * \note This option allows to include the code necessary for a PSA
1367 * crypto client when the PSA crypto implementation is not included in
1368 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1369 * code to set and get PSA key attributes.
1370 * The development of PSA drivers partially relying on the library to
1371 * fulfill the hardware gaps is another possible usage of this option.
1372 *
1373 * \warning This interface is experimental and may change or be removed
1374 * without notice.
1375 */
1376//#define MBEDTLS_PSA_CRYPTO_CLIENT
1377
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001378/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1379 *
1380 * Make the PSA Crypto module use an external random generator provided
1381 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1382 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001383 * \note This random generator must deliver random numbers with cryptographic
1384 * quality and high performance. It must supply unpredictable numbers
1385 * with a uniform distribution. The implementation of this function
1386 * is responsible for ensuring that the random generator is seeded
1387 * with sufficient entropy. If you have a hardware TRNG which is slow
1388 * or delivers non-uniform output, declare it as an entropy source
1389 * with mbedtls_entropy_add_source() instead of enabling this option.
1390 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001391 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001392 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1393 * and define a function called mbedtls_psa_external_get_random()
1394 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001395 * ```
1396 * psa_status_t mbedtls_psa_external_get_random(
1397 * mbedtls_psa_external_random_context_t *context,
1398 * uint8_t *output, size_t output_size, size_t *output_length);
1399 * );
1400 * ```
1401 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001402 * The function must fill the \c output buffer with \c output_size bytes
1403 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001404 *
1405 * Requires: MBEDTLS_PSA_CRYPTO_C
1406 *
1407 * \warning If you enable this option, code that uses the PSA cryptography
1408 * interface will not use any of the entropy sources set up for
1409 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1410 * enables.
1411 *
1412 * \note This option is experimental and may be removed without notice.
1413 */
1414//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1415
Paul Bakker9dcc3222011-03-08 14:16:06 +00001416/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001417 * \def MBEDTLS_PSA_CRYPTO_SPM
1418 *
1419 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1420 * Partition Manager) integration which separates the code into two parts: a
1421 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1422 * Environment).
1423 *
1424 * Module: library/psa_crypto.c
1425 * Requires: MBEDTLS_PSA_CRYPTO_C
1426 *
1427 */
1428//#define MBEDTLS_PSA_CRYPTO_SPM
1429
1430/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001431 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001432 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001433 * Enable support for entropy injection at first boot. This feature is
1434 * required on systems that do not have a built-in entropy source (TRNG).
1435 * This feature is currently not supported on systems that have a built-in
1436 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001437 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001438 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001439 *
1440 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001441//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001442
1443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001445 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001446 * Do not use the Chinese Remainder Theorem
1447 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001448 *
1449 * Uncomment this macro to disable the use of CRT in RSA.
1450 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001453
1454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001456 *
1457 * Enable the checkup functions (*_self_test).
1458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001460
1461/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001462 * \def MBEDTLS_SHA256_SMALLER
1463 *
1464 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1465 * lower performance.
1466 *
Adam Wolf039080f2019-09-10 09:53:08 -05001467 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001468 * performance and size. This version optimizes more aggressively for size at
1469 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1470 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1471 * 30%.
1472 *
1473 * Uncomment to enable the smaller implementation of SHA256.
1474 */
1475//#define MBEDTLS_SHA256_SMALLER
1476
1477/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001478 * \def MBEDTLS_SHA512_SMALLER
1479 *
1480 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1481 * lower performance.
1482 *
1483 * Uncomment to enable the smaller implementation of SHA512.
1484 */
1485//#define MBEDTLS_SHA512_SMALLER
1486
1487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001489 *
1490 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001491 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001492 * with other servers, only debugging of failures is harder.
1493 *
1494 * The advantage of not sending alert messages, is that no information is given
1495 * about reasons for failures thus preventing adversaries of gaining intel.
1496 *
1497 * Enable sending of all alert messages
1498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001500
1501/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001502 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1503 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001504 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001505 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001506 * in the underlying transport. The CID functionality is described
1507 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001508 *
1509 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001510 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1511 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1512 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001513 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001514 * The maximum lengths of outgoing and incoming CIDs can be configured
1515 * through the options
1516 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1517 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1518 *
1519 * Requires: MBEDTLS_SSL_PROTO_DTLS
1520 *
1521 * Uncomment to enable the Connection ID extension.
1522 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001523#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1524
1525
1526/**
1527 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1528 *
1529 * Defines whether RFC 9146 (default) or the legacy version
1530 * (version draft-ietf-tls-dtls-connection-id-05,
1531 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1532 * is used.
1533 *
1534 * Set the value to 0 for the standard version, and
1535 * 1 for the legacy draft version.
1536 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001537 * \deprecated Support for the legacy version of the DTLS
1538 * Connection ID feature is deprecated. Please
1539 * switch to the standardized version defined
1540 * in RFC 9146 enabled by utilizing
1541 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1542 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1543 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001544 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1545 */
1546#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001547
1548/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001549 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1550 *
1551 * Enable asynchronous external private key operations in SSL. This allows
1552 * you to configure an SSL connection to call an external cryptographic
1553 * module to perform private key operations instead of performing the
1554 * operation inside the library.
1555 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001556 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001557 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001558//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001559
1560/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001561 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1562 *
1563 * Enable serialization of the TLS context structures, through use of the
1564 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1565 *
1566 * This pair of functions allows one side of a connection to serialize the
1567 * context associated with the connection, then free or re-use that context
1568 * while the serialized state is persisted elsewhere, and finally deserialize
1569 * that state to a live context for resuming read/write operations on the
1570 * connection. From a protocol perspective, the state of the connection is
1571 * unaffected, in particular this is entirely transparent to the peer.
1572 *
1573 * Note: this is distinct from TLS session resumption, which is part of the
1574 * protocol and fully visible by the peer. TLS session resumption enables
1575 * establishing new connections associated to a saved session with shorter,
1576 * lighter handshakes, while context serialization is a local optimization in
1577 * handling a single, potentially long-lived connection.
1578 *
1579 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1580 * saved after the handshake to allow for more efficient serialization, so if
1581 * you don't need this feature you'll save RAM by disabling it.
1582 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001583 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1584 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001585 * Comment to disable the context serialization APIs.
1586 */
1587#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1588
1589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001591 *
1592 * Enable the debug messages in SSL module for all issues.
1593 * Debug messages have been disabled in some places to prevent timing
1594 * attacks due to (unbalanced) debugging function calls.
1595 *
1596 * If you need all error reporting you should enable this during debugging,
1597 * but remove this for production servers that should log as well.
1598 *
1599 * Uncomment this macro to report all debug messages on errors introducing
1600 * a timing side-channel.
1601 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001603//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001606 *
1607 * Enable support for Encrypt-then-MAC, RFC 7366.
1608 *
1609 * This allows peers that both support it to use a more robust protection for
1610 * ciphersuites using CBC, providing deep resistance against timing attacks
1611 * on the padding or underlying cipher.
1612 *
1613 * This only affects CBC ciphersuites, and is useless if none is defined.
1614 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001615 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001616 *
1617 * Comment this macro to disable support for Encrypt-then-MAC
1618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001622 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001623 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1624 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001625 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001626 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001627 * attacks, but it is recommended to always use it (even if you disable
1628 * renegotiation), since it actually fixes a more fundamental issue in the
1629 * original SSL/TLS design, and has implications beyond Triple Handshake.
1630 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001631 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001632 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001633 * Comment this macro to disable support for Extended Master Secret.
1634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001636
Paul Bakkerd66f0702013-01-31 16:57:45 +01001637/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001638 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1639 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001640 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001641 * giving access to the peer's certificate after completion of the handshake.
1642 *
1643 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1644 * recommended to disable this option for reduced RAM usage.
1645 *
1646 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1647 * defined, but always returns \c NULL.
1648 *
1649 * \note This option has no influence on the protection against the
1650 * triple handshake attack. Even if it is disabled, Mbed TLS will
1651 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001652 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001653 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001654 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001655 *
1656 * Comment this macro to disable storing the peer's certificate
1657 * after the handshake.
1658 */
1659#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1660
1661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001663 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001664 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001665 *
1666 * The two main uses of renegotiation are (1) refresh keys on long-lived
1667 * connections and (2) client authentication after the initial handshake.
1668 * If you don't need renegotiation, it's probably better to disable it, since
1669 * it has been associated with security issues in the past and is easy to
1670 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001671 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001672 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001673 *
1674 * \note Even if this option is disabled, both client and server are aware
1675 * of the Renegotiation Indication Extension (RFC 5746) used to
1676 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1677 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1678 * configuration of this extension).
1679 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001682
1683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001685 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001686 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001687 *
1688 * Comment this macro to disable support for the max_fragment_length extension
1689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001691
1692/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001693 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1694 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001695 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001696 *
1697 * \warning This extension is currently in development and must NOT be used except
1698 * for testing purposes.
1699 *
1700 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1701 *
1702 * Uncomment this macro to enable support for the record_size_limit extension
1703 */
1704//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1705
1706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001708 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001709 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001710 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001711 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001712 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1713 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001714 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001715 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001716 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001717 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1718 * are only provided by PSA drivers, you must call psa_crypto_init() before
1719 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001720 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001721 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001722 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001724
1725/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001726 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001727 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001728 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001729 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001730 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1731 * pre-shared keys are not supported.
1732 * See docs/architecture/tls13-support.md for a description of the TLS
1733 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001734 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001735 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001736 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001737 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001738 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1739 * directly performed by TLS 1.3 code. As a consequence, you must
1740 * call psa_crypto_init() before the first TLS 1.3 handshake.
1741 *
1742 * \note Cryptographic operations performed indirectly via another module
1743 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1744 * running handshake hash) only use PSA crypto if
1745 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001746 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001747 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001748 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001749//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001750
1751/**
Ronald Cronab65c522021-11-24 10:47:20 +01001752 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1753 *
1754 * Enable TLS 1.3 middlebox compatibility mode.
1755 *
1756 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1757 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1758 * expecting TLS 1.2 traffic.
1759 *
1760 * Turning on the compatibility mode comes at the cost of a few added bytes
1761 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1762 * that don't use it. Therefore, unless transmission bandwidth is critical and
1763 * you know that middlebox compatibility issues won't occur, it is therefore
1764 * recommended to set this option.
1765 *
1766 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001767 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1768 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001769 *
1770 */
1771//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1772
1773/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001774 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1775 *
1776 * Enable TLS 1.3 PSK key exchange mode.
1777 *
1778 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1779 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1780 * effect on the build.
1781 *
1782 */
1783#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1784
1785/**
1786 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1787 *
1788 * Enable TLS 1.3 ephemeral key exchange mode.
1789 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001790 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001791 * MBEDTLS_X509_CRT_PARSE_C
1792 * and at least one of:
1793 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1794 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001795 *
1796 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1797 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1798 * effect on the build.
1799 *
1800 */
1801#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1802
1803/**
1804 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1805 *
1806 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1807 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001808 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001809 *
1810 * Comment to disable support for the PSK ephemeral key exchange mode in
1811 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1812 * have any effect on the build.
1813 *
1814 */
1815#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1816
1817/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 * \def MBEDTLS_SSL_EARLY_DATA
1819 *
1820 * Enable support for RFC 8446 TLS 1.3 early data.
1821 *
1822 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1823 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1824 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1825 *
1826 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1827 * is not enabled, this option does not have any effect on the build.
1828 *
1829 * This feature is experimental, not completed and thus not ready for
1830 * production.
1831 *
1832 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001833//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001834
1835/**
Jerry Yu16f68532022-11-05 10:50:06 +08001836 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1837 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001838 * The default maximum amount of 0-RTT data. See the documentation of
1839 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1840 *
1841 * It must be positive and smaller than UINT32_MAX.
1842 *
1843 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1844 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001845 *
1846 * This feature is experimental, not completed and thus not ready for
1847 * production.
1848 *
1849 */
1850#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1851
1852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001854 *
1855 * Enable support for DTLS (all available versions).
1856 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001857 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001858 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001859 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001860 *
1861 * Comment this macro to disable support for DTLS
1862 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001864
1865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001867 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001868 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001869 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001870 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001873
1874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001876 *
1877 * Enable support for the anti-replay mechanism in DTLS.
1878 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 * Requires: MBEDTLS_SSL_TLS_C
1880 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001881 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001882 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001883 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001884 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001885 * Comment this to disable anti-replay in DTLS.
1886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001888
1889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001891 *
1892 * Enable support for HelloVerifyRequest on DTLS servers.
1893 *
1894 * This feature is highly recommended to prevent DTLS servers being used as
1895 * amplifiers in DoS attacks against other hosts. It should always be enabled
1896 * unless you know for sure amplification cannot be a problem in the
1897 * environment in which your server operates.
1898 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001899 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001900 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001901 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001902 *
1903 * Comment this to disable support for HelloVerifyRequest.
1904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001906
1907/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001908 * \def MBEDTLS_SSL_DTLS_SRTP
1909 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001910 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001911 * through the use_srtp extension.
1912 *
1913 * \note This feature provides the minimum functionality required
1914 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1915 * the associated SRTP packet protection key material.
1916 * In particular, the SRTP packet protection itself, as well as the
1917 * demultiplexing of RTP and DTLS packets at the datagram layer
1918 * (see Section 5 of RFC 5764), are not handled by this feature.
1919 * Instead, after successful completion of a handshake negotiating
1920 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001921 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001922 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1923 * (this is implemented in the SSL example programs).
1924 * The resulting key should then be passed to an SRTP stack.
1925 *
1926 * Setting this option enables the runtime API
1927 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1928 * through which the supported DTLS-SRTP protection
1929 * profiles can be configured. You must call this API at
1930 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001931 *
1932 * Requires: MBEDTLS_SSL_PROTO_DTLS
1933 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001934 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001935 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001936//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001937
1938/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001939 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1940 *
1941 * Enable server-side support for clients that reconnect from the same port.
1942 *
1943 * Some clients unexpectedly close the connection and try to reconnect using the
1944 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001945 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001946 * flag enables that support.
1947 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001948 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001949 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001950 * Comment this to disable support for clients reusing the source port.
1951 */
1952#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1953
1954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001956 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001957 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001958 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001959 * session store remains the responsibility of the application, though).
1960 * Server-side, you also need to provide callbacks for writing and parsing
1961 * tickets, including authenticated encryption and key management. Example
1962 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001963 *
1964 * Comment this macro to disable support for SSL session tickets
1965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001967
1968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001970 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001971 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001972 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001974 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001975 * Comment this macro to disable support for server name indication in SSL
1976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001978
1979/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001980 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1981 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001982 * When this option is enabled, the SSL buffer will be resized automatically
1983 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001984 *
1985 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001986 */
1987//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1988
1989/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001990 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1991 *
1992 * Enable testing of the constant-flow nature of some sensitive functions with
1993 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001994 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001995 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001996 * This setting requires compiling with clang -fsanitize=memory. The test
1997 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001998 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001999 * \warning This macro is only used for extended testing; it is not considered
2000 * part of the library's API, so it may change or disappear at any time.
2001 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002002 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002003 */
2004//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2005
2006/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002007 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2008 *
2009 * Enable testing of the constant-flow nature of some sensitive functions with
2010 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002011 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002012 *
2013 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002014 * testing if the tests suites are run with valgrind's memcheck. This can be
2015 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2016 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002017 *
2018 * \warning This macro is only used for extended testing; it is not considered
2019 * part of the library's API, so it may change or disappear at any time.
2020 *
2021 * Uncomment to enable testing of the constant-flow nature of selected code.
2022 */
2023//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2024
2025/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002026 * \def MBEDTLS_TEST_HOOKS
2027 *
2028 * Enable features for invasive testing such as introspection functions and
2029 * hooks for fault injection. This enables additional unit tests.
2030 *
2031 * Merely enabling this feature should not change the behavior of the product.
2032 * It only adds new code, and new branching points where the default behavior
2033 * is the same as when this feature is disabled.
2034 * However, this feature increases the attack surface: there is an added
2035 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2036 * Therefore this feature must never be enabled in production.
2037 *
2038 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2039 * information.
2040 *
2041 * Uncomment to enable invasive tests.
2042 */
2043//#define MBEDTLS_TEST_HOOKS
2044
2045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002047 *
2048 * Provide your own alternate threading implementation.
2049 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002051 *
2052 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002055
2056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002058 *
2059 * Enable the pthread wrapper layer for the threading layer.
2060 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002062 *
2063 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002066
2067/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002068 * \def MBEDTLS_USE_PSA_CRYPTO
2069 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002070 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2071 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002072 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002073 * \note Development of this option is currently in progress, and parts of Mbed
2074 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002075 * will still continue to work as usual, so enabling this option should not
2076 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002077 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002078 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002079 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2080 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002081 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002082 * \note An important and desirable effect of this option is that it allows
2083 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2084 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02002085 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002086 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2087 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002088 *
2089 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002090 *
2091 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002092 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002093 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002095//#define MBEDTLS_USE_PSA_CRYPTO
2096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002098 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2099 *
John Durkop185764f2020-10-12 21:32:12 -07002100 * This setting allows support for cryptographic mechanisms through the PSA
2101 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002102 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002103 * When this option is disabled, the PSA API exposes the cryptographic
2104 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2105 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002106 *
2107 * When this option is enabled, the PSA API exposes the cryptographic
2108 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2109 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2110 * automatically enabled if required (i.e. if no PSA driver provides the
2111 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2112 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002113 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002114 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002115 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002116 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002117 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2118 * symbols is not completely finalized yet, and the configuration
2119 * tooling is not ideally adapted to having two separate configuration
2120 * files.
2121 * Future minor releases of Mbed TLS may make minor changes to those
2122 * symbols, but we will endeavor to provide a transition path.
2123 * Nonetheless, this option is considered mature enough to use in
2124 * production, as long as you accept that you may need to make
2125 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002126 */
2127//#define MBEDTLS_PSA_CRYPTO_CONFIG
2128
2129/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002130 * \def MBEDTLS_VERSION_FEATURES
2131 *
2132 * Allow run-time checking of compile-time enabled features. Thus allowing users
2133 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002134 * support via mbedtls_version_check_feature().
2135 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002136 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002137 *
2138 * Comment this to disable run-time checking and save ROM space
2139 */
2140#define MBEDTLS_VERSION_FEATURES
2141
2142/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002143 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2144 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002145 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002146 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2147 * the set of trusted certificates through a callback instead of a linked
2148 * list.
2149 *
2150 * This is useful for example in environments where a large number of trusted
2151 * certificates is present and storing them in a linked list isn't efficient
2152 * enough, or when the set of trusted certificates changes frequently.
2153 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002154 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002155 * `mbedtls_ssl_conf_ca_cb()` for more information.
2156 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002157 * Requires: MBEDTLS_X509_CRT_PARSE_C
2158 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002159 * Uncomment to enable trusted certificate callbacks.
2160 */
2161//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2162
2163/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002164 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002165 *
Chris Jones2c745862020-12-16 11:41:06 +00002166 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002167 *
Chris Jones2c745862020-12-16 11:41:06 +00002168 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002169 * and other functions/constants only used by these functions, thus reducing
2170 * the code footprint by several KB.
2171 */
Chris Jones2c745862020-12-16 11:41:06 +00002172//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002173
2174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002176 *
2177 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2178 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2179 *
2180 * Comment this macro to disallow using RSASSA-PSS in certificates.
2181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002183/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002184
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002185/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002186 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002187 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002188 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002189 * \{
2190 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002191
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002194 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002195 * Enable AES-NI support on x86-64 or x86-32.
2196 *
2197 * \note AESNI is only supported with certain compilers and target options:
2198 * - Visual Studio 2013: supported.
2199 * - GCC, x86-64, target not explicitly supporting AESNI:
2200 * requires MBEDTLS_HAVE_ASM.
2201 * - GCC, x86-32, target not explicitly supporting AESNI:
2202 * not supported.
2203 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2204 * For this assembly-less implementation, you must currently compile
2205 * `library/aesni.c` and `library/aes.c` with machine options to enable
2206 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2207 * `clang -maes -mpclmul`.
2208 * - Non-x86 targets: this option is silently ignored.
2209 * - Other compilers: this option is silently ignored.
2210 *
2211 * \note
2212 * Above, "GCC" includes compatible compilers such as Clang.
2213 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002214 *
2215 * Module: library/aesni.c
2216 * Caller: library/aes.c
2217 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002218 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002219 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002220 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002223
2224/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002225 * \def MBEDTLS_AESCE_C
2226 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002227 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002228 *
2229 * Module: library/aesce.c
2230 * Caller: library/aes.c
2231 *
Jerry Yuf015a932023-04-25 10:38:03 +08002232 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002233 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002234 * \warning Runtime detection only works on Linux. For non-Linux operating
2235 * system, Armv8-A Cryptographic Extensions must be supported by
2236 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002237 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002238 * \note Minimum compiler versions for this feature are Clang 4.0,
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002239 * armclang 6.6, GCC 6.0 or MSVC 2019 version 16.11.2.
2240 *
2241 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2242 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002243 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002244 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002245 */
2246#define MBEDTLS_AESCE_C
2247
2248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002250 *
2251 * Enable the AES block cipher.
2252 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002253 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002254 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002255 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002256 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002257 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002258 * This module enables the following ciphersuites (if other requisites are
2259 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2261 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2262 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2263 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2264 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2265 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2266 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2267 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2268 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2270 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2271 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2272 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2273 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2274 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2275 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2276 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2277 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2278 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2279 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2280 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2281 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2282 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2283 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2284 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2285 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2286 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2289 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2290 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2291 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2292 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2293 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2294 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2295 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2296 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2297 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2298 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2299 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2300 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2301 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2302 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2303 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2304 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2305 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2306 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2307 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2308 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2309 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2310 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2311 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2312 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2313 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2314 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2315 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2316 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2317 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002318 *
Paul Bakkercff68422013-09-15 20:43:33 +02002319 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002322
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002325 *
2326 * Enable the generic ASN1 parser.
2327 *
2328 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002329 * Caller: library/x509.c
2330 * library/dhm.c
2331 * library/pkcs12.c
2332 * library/pkcs5.c
2333 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002336
2337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002338 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002339 *
2340 * Enable the generic ASN1 writer.
2341 *
2342 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002343 * Caller: library/ecdsa.c
2344 * library/pkwrite.c
2345 * library/x509_create.c
2346 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002347 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002350
2351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002353 *
2354 * Enable the Base64 module.
2355 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002356 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002357 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002358 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002359 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002360 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002362
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002363/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002365 *
Paul Bakker9a736322012-11-14 12:39:52 +00002366 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002367 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002368 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002369 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002370 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002371 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002372 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002373 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002374 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002375 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002376 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002377 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002378 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002379 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002382
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002385 *
2386 * Enable the Camellia block cipher.
2387 *
Paul Bakker38119b12009-01-10 23:31:23 +00002388 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002389 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002390 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002391 * This module enables the following ciphersuites (if other requisites are
2392 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2395 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2396 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2398 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2399 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2400 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2401 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2403 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2405 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2406 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2407 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2408 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2412 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2413 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2414 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2415 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2416 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2417 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2418 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2419 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2420 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2421 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2422 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2423 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2424 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2425 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2426 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2427 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2428 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2429 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2430 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2431 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2432 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2433 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2434 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002437
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002438/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002439 * \def MBEDTLS_ARIA_C
2440 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002441 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002442 *
2443 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002444 * Caller: library/cipher.c
2445 *
2446 * This module enables the following ciphersuites (if other requisites are
2447 * enabled as well):
2448 *
2449 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2450 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2451 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2452 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2453 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2454 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2455 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2456 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2457 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2458 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2459 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2460 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2461 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2462 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2463 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2464 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2465 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2466 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2467 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2468 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2469 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2470 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2471 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2472 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2473 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2474 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2475 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2476 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2477 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2478 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2479 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2480 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2481 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2482 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2483 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2484 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2485 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2486 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002487 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002488#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002489
2490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002492 *
2493 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2494 *
2495 * Module: library/ccm.c
2496 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002497 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2498 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002499 *
2500 * This module enables the AES-CCM ciphersuites, if other requisites are
2501 * enabled as well.
2502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002504
2505/**
Daniel King34b822c2016-05-15 17:28:08 -03002506 * \def MBEDTLS_CHACHA20_C
2507 *
2508 * Enable the ChaCha20 stream cipher.
2509 *
2510 * Module: library/chacha20.c
2511 */
2512#define MBEDTLS_CHACHA20_C
2513
2514/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002515 * \def MBEDTLS_CHACHAPOLY_C
2516 *
2517 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2518 *
2519 * Module: library/chachapoly.c
2520 *
2521 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2522 */
2523#define MBEDTLS_CHACHAPOLY_C
2524
2525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002527 *
2528 * Enable the generic cipher layer.
2529 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002530 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002531 * Caller: library/ccm.c
2532 * library/cmac.c
2533 * library/gcm.c
2534 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002535 * library/pkcs12.c
2536 * library/pkcs5.c
2537 * library/psa_crypto_aead.c
2538 * library/psa_crypto_mac.c
2539 * library/ssl_ciphersuites.c
2540 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002541 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002542 *
2543 * Uncomment to enable generic cipher wrappers.
2544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002546
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002547/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002548 * \def MBEDTLS_CMAC_C
2549 *
Simon Butcher327398a2016-10-05 14:09:11 +01002550 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2551 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002552 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002553 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2554 * implementation of the CMAC algorithm is provided by an alternate
2555 * implementation, that alternate implementation may opt to not support
2556 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2557 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002558 * Module: library/cmac.c
2559 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002560 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002561 *
2562 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002563#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002564
2565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002567 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002568 * Enable the CTR_DRBG AES-based random generator.
2569 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002570 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002571 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002572 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2573 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002574 * \note To achieve a 256-bit security strength with CTR_DRBG,
2575 * you must use AES-256 *and* use sufficient entropy.
2576 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002577 *
2578 * Module: library/ctr_drbg.c
2579 * Caller:
2580 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002582 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002583 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002586
2587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002589 *
2590 * Enable the debug functions.
2591 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002592 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002593 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002594 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002595 * library/ssl_tls12_*.c
2596 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002597 *
2598 * This module provides debugging functions.
2599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002601
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002604 *
2605 * Enable the DES block cipher.
2606 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002607 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002608 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002609 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002610 *
Paul Bakkercff68422013-09-15 20:43:33 +02002611 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002612 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002613 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002614 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002617
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002620 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002621 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002622 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002623 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002624 * Caller: library/ssl_tls.c
2625 * library/ssl*_client.c
2626 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002627 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002628 * This module is used by the following key exchanges:
2629 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002630 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002631 * \warning Using DHE constitutes a security risk as it
2632 * is not possible to validate custom DH parameters.
2633 * If possible, it is recommended users should consider
2634 * preferring other methods of key exchange.
2635 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002636 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002639
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002640/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002642 *
2643 * Enable the elliptic curve Diffie-Hellman library.
2644 *
2645 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002646 * Caller: library/psa_crypto.c
2647 * library/ssl_tls.c
2648 * library/ssl*_client.c
2649 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002650 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002651 * This module is used by the following key exchanges:
2652 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002653 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002657
2658/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002660 *
2661 * Enable the elliptic curve DSA library.
2662 *
2663 * Module: library/ecdsa.c
2664 * Caller:
2665 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002666 * This module is used by the following key exchanges:
2667 * ECDHE-ECDSA
2668 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002669 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2670 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2671 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002674
2675/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002676 * \def MBEDTLS_ECJPAKE_C
2677 *
2678 * Enable the elliptic curve J-PAKE library.
2679 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002680 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2681 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002682 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002683 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002684 * Module: library/ecjpake.c
2685 * Caller:
2686 *
2687 * This module is used by the following key exchanges:
2688 * ECJPAKE
2689 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002690 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002691 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002692 * \warning If using a hash that is only provided by PSA drivers, you must
2693 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002694 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002695#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002696
2697/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002699 *
2700 * Enable the elliptic curve over GF(p) library.
2701 *
2702 * Module: library/ecp.c
2703 * Caller: library/ecdh.c
2704 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002705 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002706 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002710
2711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002713 *
2714 * Enable the platform-specific entropy code.
2715 *
2716 * Module: library/entropy.c
2717 * Caller:
2718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002720 *
2721 * This module provides a generic entropy pool
2722 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002724
2725/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002727 *
2728 * Enable error code to error string conversion.
2729 *
2730 * Module: library/error.c
2731 * Caller:
2732 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002736
2737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002739 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002740 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002741 *
2742 * Module: library/gcm.c
2743 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002744 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2745 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002746 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002747 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2748 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002751
2752/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002753 * \def MBEDTLS_HKDF_C
2754 *
2755 * Enable the HKDF algorithm (RFC 5869).
2756 *
2757 * Module: library/hkdf.c
2758 * Caller:
2759 *
2760 * Requires: MBEDTLS_MD_C
2761 *
2762 * This module adds support for the Hashed Message Authentication Code
2763 * (HMAC)-based key derivation function (HKDF).
2764 */
2765#define MBEDTLS_HKDF_C
2766
2767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002769 *
2770 * Enable the HMAC_DRBG random generator.
2771 *
2772 * Module: library/hmac_drbg.c
2773 * Caller:
2774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002776 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002777 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002780
2781/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002782 * \def MBEDTLS_LMS_C
2783 *
2784 * Enable the LMS stateful-hash asymmetric signature algorithm.
2785 *
2786 * Module: library/lms.c
2787 * Caller:
2788 *
Raef Colesab4f8742022-09-01 12:24:31 +01002789 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002790 *
Raef Colesab4f8742022-09-01 12:24:31 +01002791 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002792 */
2793#define MBEDTLS_LMS_C
2794
2795/**
Raef Colesab4f8742022-09-01 12:24:31 +01002796 * \def MBEDTLS_LMS_PRIVATE
2797 *
2798 * Enable LMS private-key operations and signing code. Functions enabled by this
2799 * option are experimental, and should not be used in production.
2800 *
2801 * Requires: MBEDTLS_LMS_C
2802 *
2803 * Uncomment to enable the LMS signature algorithm and private key operations.
2804 */
Raef Coles5127e852022-10-07 10:35:56 +01002805//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002806
2807/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002808 * \def MBEDTLS_NIST_KW_C
2809 *
2810 * Enable the Key Wrapping mode for 128-bit block ciphers,
2811 * as defined in NIST SP 800-38F. Only KW and KWP modes
2812 * are supported. At the moment, only AES is approved by NIST.
2813 *
2814 * Module: library/nist_kw.c
2815 *
2816 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2817 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002818#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002819
2820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002823 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002824 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002825 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2826 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002827 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002828 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002829 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002830 * Caller: library/constant_time.c
2831 * library/ecdsa.c
2832 * library/ecjpake.c
2833 * library/hkdf.c
2834 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002835 * library/pk.c
2836 * library/pkcs5.c
2837 * library/pkcs12.c
2838 * library/psa_crypto_ecp.c
2839 * library/psa_crypto_rsa.c
2840 * library/rsa.c
2841 * library/ssl_cookie.c
2842 * library/ssl_msg.c
2843 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002844 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002845 * library/x509_crt.c
2846 * library/x509write_crt.c
2847 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002848 *
2849 * Uncomment to enable generic message digest wrappers.
2850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002852
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002853/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002855 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002856 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002857 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002858 * Module: library/md5.c
2859 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002860 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002861 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002862 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002863 * This module is required for TLS 1.2 depending on the handshake parameters.
2864 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2865 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002866 *
2867 * \warning MD5 is considered a weak message digest and its use constitutes a
2868 * security risk. If possible, we recommend avoiding dependencies on
2869 * it, and considering stronger message digests instead.
2870 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002873
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002876 *
2877 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002878 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002879 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002880 *
2881 * Module: library/memory_buffer_alloc.c
2882 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * Requires: MBEDTLS_PLATFORM_C
2884 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002885 *
2886 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002889
2890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002892 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002893 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2894 *
Simon Butcherd567a232016-03-09 20:19:21 +00002895 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2896 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002897 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002898 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002899 * \note See also our Knowledge Base article about porting to a new
2900 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002901 * 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 +00002902 *
Andres AG788aa4a2016-09-14 14:32:09 +01002903 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002904 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002905 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002908
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002911 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002912 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002913 *
2914 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002915 * Caller: library/asn1write.c
2916 * library/pkcs5.c
2917 * library/pkparse.c
2918 * library/pkwrite.c
2919 * library/rsa.c
2920 * library/x509.c
2921 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002922 * library/x509_crl.c
2923 * library/x509_crt.c
2924 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002925 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002926 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002927 *
2928 * This modules translates between OIDs and internal values.
2929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002931
2932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002934 *
2935 * Enable VIA Padlock support on x86.
2936 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002937 * Module: library/padlock.c
2938 * Caller: library/aes.c
2939 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002941 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002942 * This modules adds support for the VIA PadLock on x86.
2943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002945
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002948 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002949 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002950 *
2951 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002952 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002953 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002954 * library/x509_crl.c
2955 * library/x509_crt.c
2956 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002957 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002959 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2960 *
2961 * \warning When parsing password-protected files, if MD5 is provided only by
2962 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002963 *
Paul Bakkercff68422013-09-15 20:43:33 +02002964 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002967
2968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002970 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002971 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002972 *
2973 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002974 * Caller: library/pkwrite.c
2975 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002976 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002979 *
2980 * This modules adds support for encoding / writing PEM files.
2981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002983
2984/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002986 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002987 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002988 *
2989 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002990 * Caller: library/psa_crypto_rsa.c
2991 * library/ssl_tls.c
2992 * library/ssl*_client.c
2993 * library/ssl*_server.c
2994 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002995 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002996 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002997 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002998 * Uncomment to enable generic public key wrappers.
2999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003001
3002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003004 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003005 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003006 *
3007 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003008 * Caller: library/x509_crt.c
3009 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003010 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003012 *
3013 * Uncomment to enable generic public key parse functions.
3014 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003016
3017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003019 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003020 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003021 *
3022 * Module: library/pkwrite.c
3023 * Caller: library/x509write.c
3024 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003026 *
3027 * Uncomment to enable generic public key write functions.
3028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003030
3031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003034 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003035 *
3036 * Module: library/pkcs5.c
3037 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003038 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003039 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003040 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003041 * \warning If using a hash that is only provided by PSA drivers, you must
3042 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003043 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003044 * This module adds support for the PKCS#5 functions.
3045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003047
3048/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003049 * \def MBEDTLS_PKCS7_C
3050 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003051 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003052 * RFC Link - https://tools.ietf.org/html/rfc2315
3053 *
3054 * Module: library/pkcs7.c
3055 *
3056 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003057 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3058 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003059 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003060 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003061 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003062#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003063
3064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003066 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003067 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003068 * Adds algorithms for parsing PKCS#8 encrypted private keys
3069 *
3070 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003071 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003072 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003073 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
3074 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
3075 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003076 * \warning If using a hash that is only provided by PSA drivers, you must
3077 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003078 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003079 * This module enables PKCS#12 functions.
3080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003082
3083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003085 *
3086 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003087 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003088 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3090 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003091 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003092 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003093 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003094 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003095 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003096 * Module: library/platform.c
3097 * Caller: Most other .c files
3098 *
3099 * This module enables abstraction of common (libc) functions.
3100 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003101#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003102
3103/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003104 * \def MBEDTLS_POLY1305_C
3105 *
3106 * Enable the Poly1305 MAC algorithm.
3107 *
3108 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003109 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003110 */
3111#define MBEDTLS_POLY1305_C
3112
3113/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003114 * \def MBEDTLS_PSA_CRYPTO_C
3115 *
3116 * Enable the Platform Security Architecture cryptography API.
3117 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003118 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003119 *
Przemek Stekielea805b42022-05-02 10:30:03 +02003120 * Requires: MBEDTLS_CIPHER_C,
3121 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003122 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003123 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003124 *
3125 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003126#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003127
3128/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003129 * \def MBEDTLS_PSA_CRYPTO_SE_C
3130 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003131 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003132 * cryptography API.
3133 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003134 * \deprecated This feature is deprecated. Please switch to the PSA driver
3135 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003136 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003137 * Module: library/psa_crypto_se.c
3138 *
3139 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3140 *
3141 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003142//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003143
3144/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003145 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3146 *
3147 * Enable the Platform Security Architecture persistent key storage.
3148 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003149 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003150 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003151 * Requires: MBEDTLS_PSA_CRYPTO_C,
3152 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3153 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003154 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003155#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003156
3157/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003158 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003159 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003160 * Enable the emulation of the Platform Security Architecture
3161 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003162 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003163 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003164 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003165 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003166 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003167#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003168
3169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003171 *
3172 * Enable the RIPEMD-160 hash algorithm.
3173 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003174 * Module: library/ripemd160.c
3175 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003176 *
3177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003179
3180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003182 *
3183 * Enable the RSA public-key cryptosystem.
3184 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003186 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003187 * Caller: library/pk.c
3188 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003189 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003190 * library/ssl*_client.c
3191 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003192 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003193 * This module is used by the following key exchanges:
3194 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003195 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003199
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003202 *
3203 * Enable the SHA1 cryptographic hash algorithm.
3204 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003205 * Module: library/sha1.c
3206 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003207 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003208 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003209 * This module is required for TLS 1.2 depending on the handshake parameters,
3210 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003211 *
3212 * \warning SHA-1 is considered a weak message digest and its use constitutes
3213 * a security risk. If possible, we recommend avoiding dependencies
3214 * on it, and considering stronger message digests instead.
3215 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003218
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003219/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003220 * \def MBEDTLS_SHA224_C
3221 *
3222 * Enable the SHA-224 cryptographic hash algorithm.
3223 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003224 * Module: library/sha256.c
3225 * Caller: library/md.c
3226 * library/ssl_cookie.c
3227 *
3228 * This module adds support for SHA-224.
3229 */
3230#define MBEDTLS_SHA224_C
3231
3232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003234 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003235 * Enable the SHA-256 cryptographic hash algorithm.
3236 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003237 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003238 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003239 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003240 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003241 * library/ssl*_client.c
3242 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003243 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003244 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003245 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003248
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003249/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003250 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3251 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003252 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3253 * with the ARMv8 cryptographic extensions if they are available at runtime.
3254 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003255 *
3256 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3257 * for a non-Aarch64 build it will be silently ignored.
3258 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003259 * \note Minimum compiler versions for this feature are Clang 4.0,
3260 * armclang 6.6 or GCC 6.0.
3261 *
3262 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3263 * armclang <= 6.9
3264 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003265 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3266 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3267 *
3268 * Requires: MBEDTLS_SHA256_C.
3269 *
3270 * Module: library/sha256.c
3271 *
3272 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3273 * and use them if available.
3274 */
3275//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3276
3277/**
3278 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3279 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003280 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3281 * with the ARMv8 cryptographic extensions, which must be available at runtime
3282 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003283 *
3284 * \note This allows builds with a smaller code size than with
3285 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3286 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003287 * \note Minimum compiler versions for this feature are Clang 4.0,
3288 * armclang 6.6 or GCC 6.0.
3289 *
3290 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3291 * armclang <= 6.9
3292 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003293 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3294 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3295 *
3296 * Requires: MBEDTLS_SHA256_C.
3297 *
3298 * Module: library/sha256.c
3299 *
3300 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3301 * unconditionally.
3302 */
3303//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3304
3305/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003306 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003307 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003308 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003309 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003310 * Module: library/sha512.c
3311 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003312 * library/psa_crypto_hash.c
3313 * library/ssl_tls.c
3314 * library/ssl*_client.c
3315 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003316 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003317 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003318 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003319#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003320
3321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003323 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003324 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003326 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003327 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003328 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003329 * library/ssl_tls.c
3330 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003331 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003332 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003335
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003336/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003337 * \def MBEDTLS_SHA3_C
3338 *
3339 * Enable the SHA3 cryptographic hash algorithm.
3340 *
3341 * Module: library/sha3.c
3342 *
3343 * This module adds support for SHA3.
3344 */
3345#define MBEDTLS_SHA3_C
3346
3347/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003348 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3349 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003350 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3351 * with the ARMv8 cryptographic extensions if they are available at runtime.
3352 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003353 *
3354 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3355 * for a non-Aarch64 build it will be silently ignored.
3356 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003357 * \note Minimum compiler versions for this feature are Clang 7.0,
3358 * armclang 6.9 or GCC 8.0.
3359 *
3360 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3361 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003362 *
3363 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3364 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3365 *
3366 * Requires: MBEDTLS_SHA512_C.
3367 *
3368 * Module: library/sha512.c
3369 *
3370 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3371 * and use them if available.
3372 */
3373//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3374
3375/**
3376 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3377 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003378 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3379 * with the ARMv8 cryptographic extensions, which must be available at runtime
3380 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003381 *
3382 * \note This allows builds with a smaller code size than with
3383 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3384 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003385 * \note Minimum compiler versions for this feature are Clang 7.0,
3386 * armclang 6.9 or GCC 8.0.
3387 *
3388 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3389 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003390 *
3391 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3392 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3393 *
3394 * Requires: MBEDTLS_SHA512_C.
3395 *
3396 * Module: library/sha512.c
3397 *
3398 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3399 * unconditionally.
3400 */
3401//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3402
3403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003405 *
3406 * Enable simple SSL cache implementation.
3407 *
3408 * Module: library/ssl_cache.c
3409 * Caller:
3410 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003414
3415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003417 *
3418 * Enable basic implementation of DTLS cookies for hello verification.
3419 *
3420 * Module: library/ssl_cookie.c
3421 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003424
3425/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003426 * \def MBEDTLS_SSL_TICKET_C
3427 *
3428 * Enable an implementation of TLS server-side callbacks for session tickets.
3429 *
3430 * Module: library/ssl_ticket.c
3431 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003432 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003433 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3434 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003435 */
3436#define MBEDTLS_SSL_TICKET_C
3437
3438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003440 *
3441 * Enable the SSL/TLS client code.
3442 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003443 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003444 * Caller:
3445 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003447 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003448 * This module is required for SSL/TLS client support.
3449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003451
Paul Bakker9a736322012-11-14 12:39:52 +00003452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003454 *
3455 * Enable the SSL/TLS server code.
3456 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003457 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 * Caller:
3459 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003461 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003462 * This module is required for SSL/TLS server support.
3463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003465
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003468 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003469 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003470 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003471 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003472 * Caller: library/ssl*_client.c
3473 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003474 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3476 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003477 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003478 * This module is required for SSL/TLS.
3479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003481
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003484 *
3485 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003486 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003487 * contexts are not shared between threads. If you do intend to use contexts
3488 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003489 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003490 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003491 *
3492 * Module: library/threading.c
3493 *
3494 * This allows different threading implementations (self-implemented or
3495 * provided).
3496 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * You will have to enable either MBEDTLS_THREADING_ALT or
3498 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003499 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003500 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003503
3504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003506 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003507 * Enable the semi-portable timing interface.
3508 *
Simon Butcherd567a232016-03-09 20:19:21 +00003509 * \note The provided implementation only works on POSIX/Unix (including Linux,
3510 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003511 * module and provide your own implementations of the callbacks needed by
3512 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3513 * your own implementation of the whole module by setting
3514 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003515 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003516 * \note The timing module will include time.h on suitable platforms
3517 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3518 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3519 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003520 * \note See also our Knowledge Base article about porting to a new
3521 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003522 * 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 +00003523 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003524 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003526#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003527
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003528/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003529 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003530 *
3531 * Enable run-time version information.
3532 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003533 * Module: library/version.c
3534 *
3535 * This module provides run-time version information.
3536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003538
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003541 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003542 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003543 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003545 * Caller: library/x509_crl.c
3546 * library/x509_crt.c
3547 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003548 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003549 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003550 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3551 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003552 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3553 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003554 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003558
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003561 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003563 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003564 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003565 * Caller: library/ssl_tls.c
3566 * library/ssl*_client.c
3567 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003568 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 *
3571 * This module is required for X.509 certificate parsing.
3572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003574
3575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 *
3578 * Enable X.509 CRL parsing.
3579 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003580 * Module: library/x509_crl.c
3581 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584 *
3585 * This module is required for X.509 CRL parsing.
3586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003588
3589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003591 *
3592 * Enable X.509 Certificate Signing Request (CSR) parsing.
3593 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003594 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595 * Caller: library/x509_crt_write.c
3596 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598 *
3599 * This module is used for reading X.509 certificate request.
3600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602
3603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003606 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607 *
3608 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003609 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003610 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003611 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3612 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003613 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3614 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003615 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003616 * This module is the basis for creating X.509 certificates and CSRs.
3617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003619
3620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 *
3623 * Enable creating X.509 certificates.
3624 *
3625 * Module: library/x509_crt_write.c
3626 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003628 *
3629 * This module is required for X.509 certificate creation.
3630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003631#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003632
3633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003635 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003636 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003637 *
3638 * Module: library/x509_csr_write.c
3639 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003641 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003642 * This module is required for X.509 certificate request writing.
3643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003644#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003645
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003646/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003647
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003648/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003649 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003650 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003651 * This section contains Mbed TLS build settings that are not associated
3652 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003653 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003654 * \{
3655 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003656
Gilles Peskinea02c1242022-03-16 17:03:19 +01003657/**
3658 * \def MBEDTLS_CONFIG_FILE
3659 *
3660 * If defined, this is a header which will be included instead of
3661 * `"mbedtls/mbedtls_config.h"`.
3662 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003663 * Unlike other configuration options, this one must be defined on the
3664 * compiler command line: a definition in `mbedtls_config.h` would have
3665 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003666 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003667 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003668 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003669 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003670 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003671 * The value of this symbol is typically a path in double quotes, either
3672 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003673 */
3674//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3675
3676/**
3677 * \def MBEDTLS_USER_CONFIG_FILE
3678 *
3679 * If defined, this is a header which will be included after
3680 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003681 * This allows you to modify the default configuration, including the ability
3682 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003683 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003684 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003685 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003686 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003687 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003688 * The value of this symbol is typically a path in double quotes, either
3689 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003690 */
3691//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3692
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003693/**
3694 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3695 *
3696 * If defined, this is a header which will be included instead of
3697 * `"psa/crypto_config.h"`.
3698 * This header file specifies which cryptographic mechanisms are available
3699 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3700 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3701 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003702 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003703 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003704 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003705 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003706 * The value of this symbol is typically a path in double quotes, either
3707 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003708 */
3709//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3710
3711/**
3712 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3713 *
3714 * If defined, this is a header which will be included after
3715 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003716 * This allows you to modify the default configuration, including the ability
3717 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003718 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003719 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003720 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003721 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003722 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003723 * The value of this symbol is typically a path in double quotes, either
3724 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003725 */
3726//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3727
Gilles Peskineb1176f22023-02-22 22:07:28 +01003728/**
3729 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3730 *
3731 * If defined, this is a header which will be included instead of
3732 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3733 * as the one in Mbed TLS, but with definitions adapted to the platform on
3734 * which the library code will run.
3735 *
3736 * \note The required content of this header can vary from one version of
3737 * Mbed TLS to the next. Integrators who provide an alternative file
3738 * should review the changes in the original file whenever they
3739 * upgrade Mbed TLS.
3740 *
3741 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3742 * non-standard feature of the C language, so this feature is only available
3743 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3744 *
3745 * The value of this symbol is typically a path in double quotes, either
3746 * absolute or relative to a directory on the include search path.
3747 */
3748//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3749
3750/**
3751 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3752 *
3753 * If defined, this is a header which will be included instead of
3754 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3755 * as the one in Mbed TLS, but with definitions adapted to the environment
3756 * in which the library code will run. The typical use for this feature
3757 * is to provide alternative type definitions on the client side in
3758 * client-server integrations of PSA crypto, where operation structures
3759 * contain handles instead of cryptographic data.
3760 *
3761 * \note The required content of this header can vary from one version of
3762 * Mbed TLS to the next. Integrators who provide an alternative file
3763 * should review the changes in the original file whenever they
3764 * upgrade Mbed TLS.
3765 *
3766 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3767 * non-standard feature of the C language, so this feature is only available
3768 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3769 *
3770 * The value of this symbol is typically a path in double quotes, either
3771 * absolute or relative to a directory on the include search path.
3772 */
3773//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3774
Gilles Peskineba4162a2022-04-11 17:04:38 +02003775/** \} name SECTION: General configuration options */
3776
3777/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003778 * \name SECTION: Module configuration options
3779 *
3780 * This section allows for the setting of module specific sizes and
3781 * configuration options. The default values are already present in the
3782 * relevant header files and should suffice for the regular use cases.
3783 *
3784 * Our advice is to enable options and change their values here
3785 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003786 * \{
3787 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003788/* The Doxygen documentation here is used when a user comments out a
3789 * setting and runs doxygen themselves. On the other hand, when we typeset
3790 * the full documentation including disabled settings, the documentation
3791 * in specific modules' header files is used if present. When editing this
3792 * file, make sure that each option is documented in exactly one place,
3793 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3794 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003795
Paul Bakker088c5c52014-04-25 11:11:10 +02003796/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003797//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003799
Paul Bakker088c5c52014-04-25 11:11:10 +02003800/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003801//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3802//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3803//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3804//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3805//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003806
Paul Bakker088c5c52014-04-25 11:11:10 +02003807/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3809//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3810//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3811//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003812
Paul Bakker088c5c52014-04-25 11:11:10 +02003813/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003814//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003815//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003816
Paul Bakker088c5c52014-04-25 11:11:10 +02003817/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003818//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3819//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003820//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32 /**< Default minimum number of bytes required for the hardware entropy source mbedtls_hardware_poll() before entropy is released */
Paul Bakkere1b665e2013-12-11 16:02:58 +01003821
Paul Bakker088c5c52014-04-25 11:11:10 +02003822/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003823//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003824
Paul Bakker088c5c52014-04-25 11:11:10 +02003825/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003826//#define MBEDTLS_PLATFORM_STD_MEM_HDR <stdlib.h> /**< Header to include if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS is defined. Don't define if no header is needed. */
Andrzej Kurek84356a12023-05-06 08:33:56 -04003827
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003828/** \def MBEDTLS_PLATFORM_STD_CALLOC
3829 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003830 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003831 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003832 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003833 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003834 * If the product is 0, the function may either return NULL or a valid pointer to an array of size 0 which is a valid input to the deallocation function.
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003835 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3836 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003837 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003838 */
3839//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003840
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003841/** \def MBEDTLS_PLATFORM_STD_FREE
3842 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003843 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003844 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003845 * A non-null parameter will always be a pointer previously returned by #MBEDTLS_PLATFORM_STD_CALLOC and not yet freed.
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003846 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3847 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply).
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003848 */
3849//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003850//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003851//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003852//#define MBEDTLS_PLATFORM_STD_TIME time /**< Default time to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3854//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003855/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003856//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003857//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3858//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003859//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3860//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3861//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003862
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003863/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003865//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3866//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_FREE for requirements. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003867//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003868//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003869//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3870//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003871//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3872//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003873/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003874//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003875//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003876//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3877//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Jerry Yuf181e542023-02-23 17:16:26 +08003878//#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t //#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t /**< Default milliseconds time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled. It must be signed, and at least 64 bits. If it is changed from the default, MBEDTLS_PRINTF_MS_TIME must be updated to match.*/
Jerry Yu10ce5402023-02-21 15:39:02 +08003879//#define MBEDTLS_PRINTF_MS_TIME PRId64 /**< Default fmt for printf. That's avoid compiler warning if mbedtls_ms_time_t is redefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003880
Gilles Peskine3f106f72021-09-23 17:42:39 +02003881/** \def MBEDTLS_CHECK_RETURN
3882 *
3883 * This macro is used at the beginning of the declaration of a function
3884 * to indicate that its return value should be checked. It should
3885 * instruct the compiler to emit a warning or an error if the function
3886 * is called without checking its return value.
3887 *
3888 * There is a default implementation for popular compilers in platform_util.h.
3889 * You can override the default implementation by defining your own here.
3890 *
3891 * If the implementation here is empty, this will effectively disable the
3892 * checking of functions' return values.
3893 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003894//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003895
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003896/** \def MBEDTLS_IGNORE_RETURN
3897 *
3898 * This macro requires one argument, which should be a C function call.
3899 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3900 * warning is suppressed.
3901 */
3902//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3903
Gilles Peskineed038902020-11-13 21:33:21 +01003904/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003905/**
Gilles Peskineed038902020-11-13 21:33:21 +01003906 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3907 * PSA crypto subsystem.
3908 *
3909 * If this option is unset:
3910 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003911 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003912 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3913 * on unspecified heuristics.
3914 */
3915//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3916
Steven Cooreman863470a2021-02-15 14:03:19 +01003917/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003918 * Restrict the PSA library to supporting a maximum amount of simultaneously
3919 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3920 * volatile key, or a persistent key which is loaded temporarily by the
3921 * library as part of a crypto operation in flight.
3922 *
3923 * If this option is unset, the library will fall back to a default value of
3924 * 32 keys.
3925 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003926//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003927
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003928/* RSA OPTIONS */
3929#define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024 /**< Minimum RSA key size that can be generated in bits (Minimum possible value is 128 bits) */
3930
Paul Bakker088c5c52014-04-25 11:11:10 +02003931/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003932//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3933//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003934
Paul Bakker088c5c52014-04-25 11:11:10 +02003935/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003936
Angus Grattond8213d02016-05-25 20:56:48 +10003937/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3938 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003939 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003940 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003941 * This determines the size of the incoming TLS I/O buffer in such a way
3942 * that it is capable of holding the specified amount of plaintext data,
3943 * regardless of the protection mechanism used.
3944 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003945 * \note When using a value less than the default of 16KB on the client, it is
3946 * recommended to use the Maximum Fragment Length (MFL) extension to
3947 * inform the server about this limitation. On the server, there
3948 * is no supported, standardized way of informing the client about
3949 * restriction on the maximum size of incoming messages, and unless
3950 * the limitation has been communicated by other means, it is recommended
3951 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3952 * while keeping the default value of 16KB for the incoming buffer.
3953 *
David Horstmann95d516f2021-05-04 18:36:56 +01003954 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003955 */
3956//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3957
Gilles Peskined3d02902020-03-04 21:35:27 +01003958/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3959 *
3960 * The maximum length of CIDs used for incoming DTLS messages.
3961 *
3962 */
3963//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3964
3965/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3966 *
3967 * The maximum length of CIDs used for outgoing DTLS messages.
3968 *
3969 */
3970//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3971
TRodziewicze8dd7092021-05-12 14:19:11 +02003972/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003973 *
3974 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003975 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003976 *
3977 * The padding will always be chosen so that the length of the
3978 * padded plaintext is a multiple of the value of this option.
3979 *
3980 * Note: A value of \c 1 means that no padding will be used
3981 * for outgoing records.
3982 *
3983 * Note: On systems lacking division instructions,
3984 * a power of two should be preferred.
3985 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003986//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003987
Angus Grattond8213d02016-05-25 20:56:48 +10003988/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3989 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003990 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003991 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003992 * This determines the size of the outgoing TLS I/O buffer in such a way
3993 * that it is capable of holding the specified amount of plaintext data,
3994 * regardless of the protection mechanism used.
3995 *
Angus Grattond8213d02016-05-25 20:56:48 +10003996 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3997 * the default inward 16384 byte buffer to conform to the TLS specification.
3998 *
3999 * The minimum required outward buffer size is determined by the handshake
4000 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4001 * The specific size requirement depends on the configured ciphers and any
4002 * certificate data which is sent during the handshake.
4003 *
David Horstmann95d516f2021-05-04 18:36:56 +01004004 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004005 */
4006//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4007
Hanno Beckere0b150f2018-08-21 15:51:03 +01004008/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4009 *
4010 * Maximum number of heap-allocated bytes for the purpose of
4011 * DTLS handshake message reassembly and future message buffering.
4012 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004013 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004014 * to account for a reassembled handshake message of maximum size,
4015 * together with its reassembly bitmap.
4016 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004017 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004018 * should be sufficient for all practical situations as it allows
4019 * to reassembly a large handshake message (such as a certificate)
4020 * while buffering multiple smaller handshake messages.
4021 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004022 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004023//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004024
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004025//#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 +02004026//#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 +02004027
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004028/**
4029 * Complete list of ciphersuites to use, in order of preference.
4030 *
4031 * \warning No dependency checking is done on that field! This option can only
4032 * be used to restrict the set of available ciphersuites. It is your
4033 * responsibility to make sure the needed modules are active.
4034 *
4035 * Use this to save a few hundred bytes of ROM (default ordering of all
4036 * available ciphersuites) and a few to a few hundred bytes of RAM.
4037 *
4038 * The value below is only an example, not the default.
4039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004040//#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 +02004041
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004042/**
4043 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4044 *
4045 * Maximum time difference in milliseconds tolerated between the age of a
4046 * ticket from the server and client point of view.
4047 * From the client point of view, the age of a ticket is the time difference
4048 * between the time when the client proposes to the server to use the ticket
4049 * (time of writing of the Pre-Shared Key Extension including the ticket) and
4050 * the time the client received the ticket from the server.
4051 * From the server point of view, the age of a ticket is the time difference
4052 * between the time when the server receives a proposition from the client
4053 * to use the ticket and the time when the ticket was created by the server.
4054 * The server age is expected to be always greater than the client one and
4055 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
4056 * maximum difference tolerated for the server to accept the ticket.
4057 * This is not used in TLS 1.2.
4058 *
4059 */
4060#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
4061
4062/**
4063 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4064 *
4065 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4066 *
4067 * This must be less than 256.
4068 */
4069#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
4070
4071/**
4072 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4073 *
4074 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4075 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4076 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4077 *
4078 */
4079#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
4080
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004081/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004082//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004083//#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 +01004084
Gilles Peskine611179c2022-04-13 23:04:48 +02004085/** \} name SECTION: Module configuration options */