blob: a2d57fccebc834e0a77a6d0fb6e7fbacf95fd992 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Steven Cooreman63342772017-04-04 11:47:16 +0200353//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354//#define MBEDTLS_MD5_ALT
355//#define MBEDTLS_RIPEMD160_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356//#define MBEDTLS_SHA256_ALT
357//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000358
Paul Bakker90995b52013-06-24 19:20:35 +0200359/**
TRodziewicz75628d52021-06-18 12:56:27 +0200360 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200362 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100363 * alternate core implementation of symmetric crypto or hash function. Keep in
364 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200365 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200366 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200367 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200368 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200369 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370 * no longer provide the mbedtls_sha1_process() function, but it will still provide
371 * the other function (using your mbedtls_sha1_process() function) and the definition
372 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200373 * with this definition.
374 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200375 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100376 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
377 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200378 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200379 * Uncomment a macro to enable alternate implementation of the corresponding
380 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100381 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200382 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100383 * constitutes a security risk. If possible, we recommend avoiding
384 * dependencies on them, and considering stronger message digests
385 * and ciphers instead.
386 *
Janos Follath1231d212019-01-07 15:01:32 +0000387 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
388 * enabled, then the deterministic ECDH signature functions pass the
389 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
390 * alternative implementations should use the RNG only for generating
391 * the ephemeral key and nothing else. If this is not possible, then
392 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200393 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000394 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396//#define MBEDTLS_MD5_PROCESS_ALT
397//#define MBEDTLS_RIPEMD160_PROCESS_ALT
398//#define MBEDTLS_SHA1_PROCESS_ALT
399//#define MBEDTLS_SHA256_PROCESS_ALT
400//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200401//#define MBEDTLS_DES_SETKEY_ALT
402//#define MBEDTLS_DES_CRYPT_ECB_ALT
403//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200404//#define MBEDTLS_AES_SETKEY_ENC_ALT
405//#define MBEDTLS_AES_SETKEY_DEC_ALT
406//#define MBEDTLS_AES_ENCRYPT_ALT
407//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300408//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300409//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300410//#define MBEDTLS_ECDSA_VERIFY_ALT
411//#define MBEDTLS_ECDSA_SIGN_ALT
412//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200413
414/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200415 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200416 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200417 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200418 * hardware entropy collector.
419 *
420 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000421 * prototype as declared in library/entropy_poll.h, and accept NULL as first
422 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200423 *
424 * Uncomment to use your own hardware entropy collector.
425 */
426//#define MBEDTLS_ENTROPY_HARDWARE_ALT
427
428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200429 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000430 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100431 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000432 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100433 * Uncomment this macro to use precomputed AES tables stored in ROM.
434 * Comment this macro to generate AES tables in RAM at runtime.
435 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100436 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
437 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100438 * initialization time before the first AES operation can be performed.
439 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
440 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
441 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100442 *
443 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000446
447/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100448 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200449 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100450 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200451 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100452 * Uncommenting this macro omits 75% of the AES tables from
453 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
454 * by computing their values on the fly during operations
455 * (the tables are entry-wise rotations of one another).
456 *
457 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100458 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100459 * runtime. Specifically, one has to compare 4 accesses within
460 * different tables to 4 accesses with additional arithmetic
461 * operations within the same table. The performance gain/loss
462 * depends on the system and memory details.
463 *
464 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200465 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100466//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200467
468/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800469 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
470 *
471 * Use only 128-bit keys in AES operations to save ROM.
472 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800473 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800474 * or 256-bit keys.
475 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800476 * Uncommenting this macro reduces the size of AES code by ~300 bytes
477 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800478 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800479 * Module: library/aes.c
480 *
481 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800482 */
483//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
484
Gilles Peskinea8861e02023-09-05 20:20:51 +0200485/*
486 * Disable plain C implementation for AES.
487 *
488 * When the plain C implementation is enabled, and an implementation using a
489 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
490 * detection will be used to select between them.
491 *
492 * If only one implementation is present, runtime detection will not be used.
493 * This configuration will crash at runtime if running on a CPU without the
494 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
495 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
496 */
497//#define MBEDTLS_AES_USE_HARDWARE_ONLY
498
Arto Kinnunen732ca322023-04-14 14:26:10 +0800499/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200500 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200501 *
502 * Use less ROM for the Camellia implementation (saves about 768 bytes).
503 *
504 * Uncomment this macro to use less memory for Camellia.
505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200507
508/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200509 * \def MBEDTLS_CHECK_RETURN_WARNING
510 *
511 * If this macro is defined, emit a compile-time warning if application code
512 * calls a function without checking its return value, but the return value
513 * should generally be checked in portable applications.
514 *
515 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
516 * implemented. Otherwise this option has no effect.
517 *
518 * Uncomment to get warnings on using fallible functions without checking
519 * their return value.
520 *
521 * \note This feature is a work in progress.
522 * Warnings will be added to more functions in the future.
523 *
524 * \note A few functions are considered critical, and ignoring the return
525 * value of these functions will trigger a warning even if this
526 * macro is not defined. To completely disable return value check
527 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
528 */
529//#define MBEDTLS_CHECK_RETURN_WARNING
530
531/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200533 *
534 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200537
538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200539 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000540 *
541 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000544
545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000547 *
548 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000551
552/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100553 * \def MBEDTLS_CIPHER_MODE_OFB
554 *
555 * Enable Output Feedback mode (OFB) for symmetric ciphers.
556 */
557#define MBEDTLS_CIPHER_MODE_OFB
558
559/**
560 * \def MBEDTLS_CIPHER_MODE_XTS
561 *
562 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
563 */
564#define MBEDTLS_CIPHER_MODE_XTS
565
566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000568 *
569 * Enable NULL cipher.
570 * Warning: Only do so when you know what you are doing. This allows for
571 * encryption or channels without any security!
572 *
Ronald Croncee42702021-04-26 11:34:44 +0200573 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
575 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
576 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
577 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
578 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
579 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
580 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
581 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
582 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
583 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
584 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
585 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
586 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
587 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
588 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
589 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
590 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
591 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
592 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000593 *
594 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000597
598/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100599 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200600 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100601 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
602 * specific padding modes in the cipher layer with cipher modes that support
603 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200604 *
605 * If you disable all padding modes, only full blocks can be used with CBC.
606 *
607 * Enable padding modes in the cipher layer.
608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609#define MBEDTLS_CIPHER_PADDING_PKCS7
610#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
611#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
612#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200613
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200614/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
615 *
616 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800617 * Without this, CTR_DRBG uses a 256-bit key
618 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200619 */
620//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
621
Paul Bakker48e93c82013-08-14 12:21:18 +0200622/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200623 * Enable the verified implementations of ECDH primitives from Project Everest
624 * (currently only Curve25519). This feature changes the layout of ECDH
625 * contexts and therefore is a compatibility break for applications that access
626 * fields of a mbedtls_ecdh_context structure directly. See also
627 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000628 *
629 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
630 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200631 */
632//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
633
634/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100635 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200636 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100637 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
638 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200639 *
640 * Comment macros to disable the curve and functions for it
641 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200642/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
644#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
645#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
646#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
647#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
648#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
649#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
650#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
651#define MBEDTLS_ECP_DP_BP256R1_ENABLED
652#define MBEDTLS_ECP_DP_BP384R1_ENABLED
653#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200654/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200655#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000656#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200657
658/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200660 *
661 * Enable specific 'modulo p' routines for each NIST prime.
662 * Depending on the prime and architecture, makes operations 4 to 8 times
663 * faster on the corresponding curve.
664 *
665 * Comment this macro to disable NIST curves optimisation.
666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200668
669/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200670 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100671 *
672 * Enable "non-blocking" ECC operations that can return early and be resumed.
673 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200674 * This allows various functions to pause by returning
675 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
676 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
677 * order to further progress and eventually complete their operation. This is
678 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
679 * number of ECC operations a function may perform before pausing; see
680 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100681 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200682 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200683 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100684 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100685 * This option:
686 * - Adds xxx_restartable() variants of existing operations in the
687 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100688 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
689 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100690 * - ECDSA: signature generation & verification;
691 * - PK: signature generation & verification;
692 * - X509: certificate chain verification.
693 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
694 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
695 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
696 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000697 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100698 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100699 * - verification of the server's key exchange signature;
700 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100701 * - generation of the client's signature if client authentication is used,
702 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100703 *
704 * \note In the cases above, the usual SSL/TLS functions, such as
705 * mbedtls_ssl_handshake(), can now return
706 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200707 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100708 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
709 * restartable operations in PK, X.509 and TLS (see above) are not
710 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100711 * PSA, and are not restartable. These are temporary limitations that
712 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200713 *
Ron Eldor19779c42018-11-05 16:58:13 +0200714 * \note This option only works with the default software implementation of
715 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100716 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100717 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100718 * Requires: MBEDTLS_ECP_C
719 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100720 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100721 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200722//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100723
724/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200725 * Uncomment to enable using new bignum code in the ECC modules.
726 *
727 * \warning This is currently experimental, incomplete and therefore should not
728 * be used in production.
729 */
730//#define MBEDTLS_ECP_WITH_MPI_UINT
731
732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100734 *
735 * Enable deterministic ECDSA (RFC 6979).
736 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
737 * may result in a compromise of the long-term signing key. This is avoided by
738 * the deterministic variant.
739 *
John Durkop36a82e52020-10-26 09:39:05 -0700740 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100741 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100742 * Comment this macro to disable deterministic ECDSA.
743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100745
746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200748 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200749 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200750 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200751 * This enables the following ciphersuites (if other requisites are
752 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
754 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
755 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
756 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
757 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
758 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
759 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
760 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
761 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
762 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200765
766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200769 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200770 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 *
773 * This enables the following ciphersuites (if other requisites are
774 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
776 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
777 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
778 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
779 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
783 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
784 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100785 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100786 * \warning Using DHE constitutes a security risk as it
787 * is not possible to validate custom DH parameters.
788 * If possible, it is recommended users should consider
789 * preferring other methods of key exchange.
790 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100791 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200794
795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200797 *
798 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
799 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200800 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200801 *
802 * This enables the following ciphersuites (if other requisites are
803 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
805 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
806 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
807 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200812
813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200816 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
819 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200820 *
821 * This enables the following ciphersuites (if other requisites are
822 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
824 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
825 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
826 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
827 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
831 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
832 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835
836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200839 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
842 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
844 * This enables the following ciphersuites (if other requisites are
845 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
847 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
848 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
850 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
851 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
852 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
853 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
854 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
856 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
857 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860
861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200864 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
867 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
869 * This enables the following ciphersuites (if other requisites are
870 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
872 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
875 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100883 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100884 * \warning Using DHE constitutes a security risk as it
885 * is not possible to validate custom DH parameters.
886 * If possible, it is recommended users should consider
887 * preferring other methods of key exchange.
888 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100889 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200892
893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200896 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200898 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
899 * MBEDTLS_RSA_C
900 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200902 *
903 * This enables the following ciphersuites (if other requisites are
904 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200917
918/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200920 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200921 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200922 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200923 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
924 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
925 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200926 *
927 * This enables the following ciphersuites (if other requisites are
928 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200941
942/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100944 *
945 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
946 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200947 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
948 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
949 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100950 *
951 * This enables the following ciphersuites (if other requisites are
952 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965
966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100968 *
969 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
970 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200971 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
972 * MBEDTLS_RSA_C
973 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100974 *
975 * This enables the following ciphersuites (if other requisites are
976 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
978 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
979 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
980 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
981 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
983 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
984 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
985 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
986 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100989
990/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200991 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
992 *
993 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
994 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200995 * \warning This is currently experimental. EC J-PAKE support is based on the
996 * Thread v1.0.0 specification; incompatible changes to the specification
997 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200998 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200999 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001000 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001001 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1002 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001003 * \warning If SHA-256 is provided only by a PSA driver, you must call
1004 * psa_crypto_init() before the first hanshake (even if
1005 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1006 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001007 * This enables the following ciphersuites (if other requisites are
1008 * enabled as well):
1009 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1010 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001011//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001012
1013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001015 *
1016 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1017 * RFC 5915 and RFC 5480.
1018 *
1019 * Currently this means parsing the SpecifiedECDomain choice of EC
1020 * parameters (only known groups are supported, not arbitrary domains, to
1021 * avoid validation issues).
1022 *
1023 * Disable if you only need to support RFC 5915 + 5480 key formats.
1024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001026
1027/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001028 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1029 *
1030 * Enable the support for parsing public keys of type Short Weierstrass
1031 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001032 * compressed point format. This parsing is done through ECP module's functions.
1033 *
1034 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1035 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1036 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001037 */
1038#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1039
1040/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * Enable a dummy error function to make use of mbedtls_strerror() in
1044 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1045 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1048 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001049 *
1050 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001054
1055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001057 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001058 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001059 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001063
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001066 *
1067 * Enable functions that use the filesystem.
1068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001070
1071/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001073 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001074 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001075 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001076 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001077 * application.
1078 *
1079 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001082
1083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001085 *
1086 * Do not use built-in platform entropy functions.
1087 * This is useful if your platform does not support
1088 * standards like the /dev/urandom or Windows CryptoAPI.
1089 *
1090 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001091 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001093
1094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001096 *
1097 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1098 * default SHA-512 based one (if both are available).
1099 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001101 *
1102 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1103 * if you have performance concerns.
1104 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * This option is only useful if both MBEDTLS_SHA256_C and
1106 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001109
1110/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001111 * \def MBEDTLS_ENTROPY_NV_SEED
1112 *
1113 * Enable the non-volatile (NV) seed file-based entropy source.
1114 * (Also enables the NV seed read/write functions in the platform layer)
1115 *
1116 * This is crucial (if not required) on systems that do not have a
1117 * cryptographic entropy source (in hardware or kernel) available.
1118 *
1119 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1120 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001121 * \note The read/write functions that are used by the entropy source are
1122 * determined in the platform layer, and can be modified at runtime and/or
1123 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1124 *
1125 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001126 * with regular fopen(), please make sure you make a seedfile with the
1127 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1128 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001129 * and written to or you will get an entropy source error! The default
1130 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1131 * bytes from the file.
1132 *
1133 * \note The entropy collector will write to the seed file before entropy is
1134 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001135 */
1136//#define MBEDTLS_ENTROPY_NV_SEED
1137
Ronald Cron71016a92020-08-28 19:01:50 +02001138/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001139 *
Ronald Cron71016a92020-08-28 19:01:50 +02001140 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001141 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001142 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1143 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001144 *
1145 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001146 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001147 */
Ronald Cron71016a92020-08-28 19:01:50 +02001148//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001149
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001152 *
1153 * Enable debugging of buffer allocator memory issues. Automatically prints
1154 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1155 * function for 'debug output' of allocated memory.
1156 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001158 *
1159 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001162
1163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001165 *
1166 * Include backtrace information with each allocated block.
1167 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001169 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001170 *
1171 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001174
1175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001177 *
1178 * Support external private RSA keys (eg from a HSM) in the PK layer.
1179 *
1180 * Comment this macro to disable support for external private RSA keys.
1181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001183
1184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001186 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001187 * Enable support for PKCS#1 v1.5 encoding.
1188 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001189 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001190 *
Paul Bakker48377d92013-08-30 12:06:24 +02001191 * This enables support for PKCS#1 v1.5 operations.
1192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001194
1195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001197 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001198 * Enable support for PKCS#1 v2.1 encoding.
1199 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001200 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001201 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001202 * \warning If using a hash that is only provided by PSA drivers, you must
1203 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001204 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001205 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001208
Steven Cooreman6801f082021-02-19 17:21:22 +01001209/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1210 *
1211 * Enable support for platform built-in keys. If you enable this feature,
1212 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1213 * See the documentation of that function for more information.
1214 *
1215 * Built-in keys are typically derived from a hardware unique key or
1216 * stored in a secure element.
1217 *
1218 * Requires: MBEDTLS_PSA_CRYPTO_C.
1219 *
1220 * \warning This interface is experimental and may change or be removed
1221 * without notice.
1222 */
1223//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1224
Ronald Cron3768ac12021-01-26 16:58:00 +01001225/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1226 *
1227 * Enable support for PSA crypto client.
1228 *
1229 * \note This option allows to include the code necessary for a PSA
1230 * crypto client when the PSA crypto implementation is not included in
1231 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1232 * code to set and get PSA key attributes.
1233 * The development of PSA drivers partially relying on the library to
1234 * fulfill the hardware gaps is another possible usage of this option.
1235 *
1236 * \warning This interface is experimental and may change or be removed
1237 * without notice.
1238 */
1239//#define MBEDTLS_PSA_CRYPTO_CLIENT
1240
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001241/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1242 *
1243 * Make the PSA Crypto module use an external random generator provided
1244 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1245 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001246 * \note This random generator must deliver random numbers with cryptographic
1247 * quality and high performance. It must supply unpredictable numbers
1248 * with a uniform distribution. The implementation of this function
1249 * is responsible for ensuring that the random generator is seeded
1250 * with sufficient entropy. If you have a hardware TRNG which is slow
1251 * or delivers non-uniform output, declare it as an entropy source
1252 * with mbedtls_entropy_add_source() instead of enabling this option.
1253 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001254 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001255 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1256 * and define a function called mbedtls_psa_external_get_random()
1257 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001258 * ```
1259 * psa_status_t mbedtls_psa_external_get_random(
1260 * mbedtls_psa_external_random_context_t *context,
1261 * uint8_t *output, size_t output_size, size_t *output_length);
1262 * );
1263 * ```
1264 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001265 * The function must fill the \c output buffer with \c output_size bytes
1266 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001267 *
1268 * Requires: MBEDTLS_PSA_CRYPTO_C
1269 *
1270 * \warning If you enable this option, code that uses the PSA cryptography
1271 * interface will not use any of the entropy sources set up for
1272 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1273 * enables.
1274 *
1275 * \note This option is experimental and may be removed without notice.
1276 */
1277//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1278
Paul Bakker9dcc3222011-03-08 14:16:06 +00001279/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001280 * \def MBEDTLS_PSA_CRYPTO_SPM
1281 *
1282 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1283 * Partition Manager) integration which separates the code into two parts: a
1284 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1285 * Environment).
1286 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001287 * If you enable this option, your build environment must include a header
1288 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1289 * header files, or in another directory on the compiler's include search
1290 * path). Alternatively, your platform may customize the header
1291 * `psa/crypto_platform.h`, in which case it can skip or replace the
1292 * inclusion of `"crypto_spe.h"`.
1293 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 * Module: library/psa_crypto.c
1295 * Requires: MBEDTLS_PSA_CRYPTO_C
1296 *
1297 */
1298//#define MBEDTLS_PSA_CRYPTO_SPM
1299
1300/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001301 * Uncomment to enable p256-m. This is an alternative implementation of
1302 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1303 * Compared to the default implementation:
1304 *
1305 * - p256-m has a much smaller code size and RAM footprint.
1306 * - p256-m is only available via the PSA API. This includes the pk module
1307 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1308 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1309 * over the core arithmetic, or deterministic derivation of keys.
1310 *
1311 * We recommend enabling this option if your application uses the PSA API
1312 * and the only elliptic curve support it needs is ECDH and ECDSA over
1313 * SECP256R1.
1314 *
1315 * If you enable this option, you do not need to enable any ECC-related
1316 * MBEDTLS_xxx option. You do need to separately request support for the
1317 * cryptographic mechanisms through the PSA API:
1318 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1319 * configuration;
1320 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1321 * - #PSA_WANT_ECC_SECP_R1_256;
1322 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1323 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1324 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1325 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1326 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001327 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001328 * \note To benefit from the smaller code size of p256-m, make sure that you
1329 * do not enable any ECC-related option not supported by p256-m: this
1330 * would cause the built-in ECC implementation to be built as well, in
1331 * order to provide the required option.
1332 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001333 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1334 * SECP256R1 are disabled as they are not supported by this driver.
1335 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1336 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001337 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001338 */
1339//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1340
1341/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001342 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001343 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001344 * Enable support for entropy injection at first boot. This feature is
1345 * required on systems that do not have a built-in entropy source (TRNG).
1346 * This feature is currently not supported on systems that have a built-in
1347 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001348 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001349 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001350 *
1351 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001352//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001353
1354/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001355 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001356 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001357 * Assume all buffers passed to PSA functions are owned exclusively by the
1358 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001359 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001360 * This option may be enabled if all buffers passed to any PSA function reside
1361 * in memory that is accessible only to the PSA function during its execution.
1362 *
1363 * This option MUST be disabled whenever buffer arguments are in memory shared
1364 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001365 * across a trust boundary.
1366 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001367 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001368 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001369 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001370 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001371 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001372//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001373
1374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001376 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001377 * Do not use the Chinese Remainder Theorem
1378 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001379 *
1380 * Uncomment this macro to disable the use of CRT in RSA.
1381 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001384
1385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001387 *
1388 * Enable the checkup functions (*_self_test).
1389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001391
1392/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001393 * \def MBEDTLS_SHA256_SMALLER
1394 *
1395 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1396 * lower performance.
1397 *
Adam Wolf039080f2019-09-10 09:53:08 -05001398 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001399 * performance and size. This version optimizes more aggressively for size at
1400 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1401 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1402 * 30%.
1403 *
1404 * Uncomment to enable the smaller implementation of SHA256.
1405 */
1406//#define MBEDTLS_SHA256_SMALLER
1407
1408/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001409 * \def MBEDTLS_SHA512_SMALLER
1410 *
1411 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1412 * lower performance.
1413 *
1414 * Uncomment to enable the smaller implementation of SHA512.
1415 */
1416//#define MBEDTLS_SHA512_SMALLER
1417
1418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001420 *
1421 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001422 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001423 * with other servers, only debugging of failures is harder.
1424 *
1425 * The advantage of not sending alert messages, is that no information is given
1426 * about reasons for failures thus preventing adversaries of gaining intel.
1427 *
1428 * Enable sending of all alert messages
1429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001431
1432/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001433 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1434 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001435 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001436 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001437 * in the underlying transport. The CID functionality is described
1438 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001439 *
1440 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001441 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1442 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1443 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001444 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001445 * The maximum lengths of outgoing and incoming CIDs can be configured
1446 * through the options
1447 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1448 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1449 *
1450 * Requires: MBEDTLS_SSL_PROTO_DTLS
1451 *
1452 * Uncomment to enable the Connection ID extension.
1453 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001454#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1455
1456
1457/**
1458 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1459 *
1460 * Defines whether RFC 9146 (default) or the legacy version
1461 * (version draft-ietf-tls-dtls-connection-id-05,
1462 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1463 * is used.
1464 *
1465 * Set the value to 0 for the standard version, and
1466 * 1 for the legacy draft version.
1467 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001468 * \deprecated Support for the legacy version of the DTLS
1469 * Connection ID feature is deprecated. Please
1470 * switch to the standardized version defined
1471 * in RFC 9146 enabled by utilizing
1472 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1473 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1474 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001475 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1476 */
1477#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001478
1479/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001480 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1481 *
1482 * Enable asynchronous external private key operations in SSL. This allows
1483 * you to configure an SSL connection to call an external cryptographic
1484 * module to perform private key operations instead of performing the
1485 * operation inside the library.
1486 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001487 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001488 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001489//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001490
1491/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001492 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1493 *
1494 * Enable serialization of the TLS context structures, through use of the
1495 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1496 *
1497 * This pair of functions allows one side of a connection to serialize the
1498 * context associated with the connection, then free or re-use that context
1499 * while the serialized state is persisted elsewhere, and finally deserialize
1500 * that state to a live context for resuming read/write operations on the
1501 * connection. From a protocol perspective, the state of the connection is
1502 * unaffected, in particular this is entirely transparent to the peer.
1503 *
1504 * Note: this is distinct from TLS session resumption, which is part of the
1505 * protocol and fully visible by the peer. TLS session resumption enables
1506 * establishing new connections associated to a saved session with shorter,
1507 * lighter handshakes, while context serialization is a local optimization in
1508 * handling a single, potentially long-lived connection.
1509 *
1510 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1511 * saved after the handshake to allow for more efficient serialization, so if
1512 * you don't need this feature you'll save RAM by disabling it.
1513 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001514 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1515 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001516 * Comment to disable the context serialization APIs.
1517 */
1518#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1519
1520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001522 *
1523 * Enable the debug messages in SSL module for all issues.
1524 * Debug messages have been disabled in some places to prevent timing
1525 * attacks due to (unbalanced) debugging function calls.
1526 *
1527 * If you need all error reporting you should enable this during debugging,
1528 * but remove this for production servers that should log as well.
1529 *
1530 * Uncomment this macro to report all debug messages on errors introducing
1531 * a timing side-channel.
1532 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001537 *
1538 * Enable support for Encrypt-then-MAC, RFC 7366.
1539 *
1540 * This allows peers that both support it to use a more robust protection for
1541 * ciphersuites using CBC, providing deep resistance against timing attacks
1542 * on the padding or underlying cipher.
1543 *
1544 * This only affects CBC ciphersuites, and is useless if none is defined.
1545 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001546 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001547 *
1548 * Comment this macro to disable support for Encrypt-then-MAC
1549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001553 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001554 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1555 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001556 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001557 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001558 * attacks, but it is recommended to always use it (even if you disable
1559 * renegotiation), since it actually fixes a more fundamental issue in the
1560 * original SSL/TLS design, and has implications beyond Triple Handshake.
1561 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001562 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001563 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001564 * Comment this macro to disable support for Extended Master Secret.
1565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001567
Paul Bakkerd66f0702013-01-31 16:57:45 +01001568/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001569 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1570 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001571 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001572 * giving access to the peer's certificate after completion of the handshake.
1573 *
1574 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1575 * recommended to disable this option for reduced RAM usage.
1576 *
1577 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1578 * defined, but always returns \c NULL.
1579 *
1580 * \note This option has no influence on the protection against the
1581 * triple handshake attack. Even if it is disabled, Mbed TLS will
1582 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001583 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001584 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001585 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001586 *
1587 * Comment this macro to disable storing the peer's certificate
1588 * after the handshake.
1589 */
1590#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1591
1592/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001593 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001594 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001595 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001596 *
1597 * The two main uses of renegotiation are (1) refresh keys on long-lived
1598 * connections and (2) client authentication after the initial handshake.
1599 * If you don't need renegotiation, it's probably better to disable it, since
1600 * it has been associated with security issues in the past and is easy to
1601 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001602 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001603 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1604 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001605 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001606 *
1607 * \note Even if this option is disabled, both client and server are aware
1608 * of the Renegotiation Indication Extension (RFC 5746) used to
1609 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1610 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1611 * configuration of this extension).
1612 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001615
1616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001618 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001619 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001620 *
1621 * Comment this macro to disable support for the max_fragment_length extension
1622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001624
1625/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001626 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1627 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001628 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001629 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001630 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1631 *
1632 * Uncomment this macro to enable support for the record_size_limit extension
1633 */
1634//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1635
1636/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001638 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001639 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001640 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001641 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001642 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1643 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001644 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001645 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001646 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001647 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1648 * are only provided by PSA drivers, you must call psa_crypto_init() before
1649 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001650 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001651 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001654
1655/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001656 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001657 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001658 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001659 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001660 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001661 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001662 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001663 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001664 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001665 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001666 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1667 * directly performed by TLS 1.3 code. As a consequence, you must
1668 * call psa_crypto_init() before the first TLS 1.3 handshake.
1669 *
1670 * \note Cryptographic operations performed indirectly via another module
1671 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1672 * running handshake hash) only use PSA crypto if
1673 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001674 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001675 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001676 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001677#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001678
1679/**
Ronald Cronab65c522021-11-24 10:47:20 +01001680 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1681 *
1682 * Enable TLS 1.3 middlebox compatibility mode.
1683 *
1684 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1685 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1686 * expecting TLS 1.2 traffic.
1687 *
1688 * Turning on the compatibility mode comes at the cost of a few added bytes
1689 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1690 * that don't use it. Therefore, unless transmission bandwidth is critical and
1691 * you know that middlebox compatibility issues won't occur, it is therefore
1692 * recommended to set this option.
1693 *
1694 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001695 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1696 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001697 *
1698 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001699#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001700
1701/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001702 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1703 *
1704 * Enable TLS 1.3 PSK key exchange mode.
1705 *
1706 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1707 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1708 * effect on the build.
1709 *
1710 */
1711#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1712
1713/**
1714 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1715 *
1716 * Enable TLS 1.3 ephemeral key exchange mode.
1717 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001718 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001719 * MBEDTLS_X509_CRT_PARSE_C
1720 * and at least one of:
1721 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1722 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001723 *
1724 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1725 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1726 * effect on the build.
1727 *
1728 */
1729#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1730
1731/**
1732 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1733 *
1734 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1735 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001736 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001737 *
1738 * Comment to disable support for the PSK ephemeral key exchange mode in
1739 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1740 * have any effect on the build.
1741 *
1742 */
1743#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1744
1745/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 * \def MBEDTLS_SSL_EARLY_DATA
1747 *
1748 * Enable support for RFC 8446 TLS 1.3 early data.
1749 *
1750 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1751 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1752 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1753 *
1754 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1755 * is not enabled, this option does not have any effect on the build.
1756 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001757 * \note The maximum amount of early data can be set with
1758 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1759 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001761//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001762
1763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001765 *
1766 * Enable support for DTLS (all available versions).
1767 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001768 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001769 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001770 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001771 *
1772 * Comment this macro to disable support for DTLS
1773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001775
1776/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001778 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001779 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001780 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001781 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001784
1785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001787 *
1788 * Enable support for the anti-replay mechanism in DTLS.
1789 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 * Requires: MBEDTLS_SSL_TLS_C
1791 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001792 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001793 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001794 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001795 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001796 * Comment this to disable anti-replay in DTLS.
1797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001799
1800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001802 *
1803 * Enable support for HelloVerifyRequest on DTLS servers.
1804 *
1805 * This feature is highly recommended to prevent DTLS servers being used as
1806 * amplifiers in DoS attacks against other hosts. It should always be enabled
1807 * unless you know for sure amplification cannot be a problem in the
1808 * environment in which your server operates.
1809 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001810 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001811 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001812 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001813 *
1814 * Comment this to disable support for HelloVerifyRequest.
1815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001817
1818/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001819 * \def MBEDTLS_SSL_DTLS_SRTP
1820 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001821 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001822 * through the use_srtp extension.
1823 *
1824 * \note This feature provides the minimum functionality required
1825 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1826 * the associated SRTP packet protection key material.
1827 * In particular, the SRTP packet protection itself, as well as the
1828 * demultiplexing of RTP and DTLS packets at the datagram layer
1829 * (see Section 5 of RFC 5764), are not handled by this feature.
1830 * Instead, after successful completion of a handshake negotiating
1831 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001832 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001833 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1834 * (this is implemented in the SSL example programs).
1835 * The resulting key should then be passed to an SRTP stack.
1836 *
1837 * Setting this option enables the runtime API
1838 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1839 * through which the supported DTLS-SRTP protection
1840 * profiles can be configured. You must call this API at
1841 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001842 *
1843 * Requires: MBEDTLS_SSL_PROTO_DTLS
1844 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001845 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001846 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001847//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001848
1849/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001850 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1851 *
1852 * Enable server-side support for clients that reconnect from the same port.
1853 *
1854 * Some clients unexpectedly close the connection and try to reconnect using the
1855 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001856 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001857 * flag enables that support.
1858 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001859 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001860 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001861 * Comment this to disable support for clients reusing the source port.
1862 */
1863#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1864
1865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001867 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001868 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001869 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001870 * session store remains the responsibility of the application, though).
1871 * Server-side, you also need to provide callbacks for writing and parsing
1872 * tickets, including authenticated encryption and key management. Example
1873 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001874 *
1875 * Comment this macro to disable support for SSL session tickets
1876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001878
1879/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001881 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001882 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001883 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001885 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001886 * Comment this macro to disable support for server name indication in SSL
1887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001889
1890/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001891 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1892 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001893 * When this option is enabled, the SSL buffer will be resized automatically
1894 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001895 *
1896 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001897 */
1898//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1899
1900/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001901 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1902 *
1903 * Enable testing of the constant-flow nature of some sensitive functions with
1904 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001905 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001906 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001907 * This setting requires compiling with clang -fsanitize=memory. The test
1908 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001909 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001910 * \warning This macro is only used for extended testing; it is not considered
1911 * part of the library's API, so it may change or disappear at any time.
1912 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001913 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001914 */
1915//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1916
1917/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001918 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1919 *
1920 * Enable testing of the constant-flow nature of some sensitive functions with
1921 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001922 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001923 *
1924 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001925 * testing if the tests suites are run with valgrind's memcheck. This can be
1926 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1927 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001928 *
1929 * \warning This macro is only used for extended testing; it is not considered
1930 * part of the library's API, so it may change or disappear at any time.
1931 *
1932 * Uncomment to enable testing of the constant-flow nature of selected code.
1933 */
1934//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1935
1936/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001937 * \def MBEDTLS_TEST_HOOKS
1938 *
1939 * Enable features for invasive testing such as introspection functions and
1940 * hooks for fault injection. This enables additional unit tests.
1941 *
1942 * Merely enabling this feature should not change the behavior of the product.
1943 * It only adds new code, and new branching points where the default behavior
1944 * is the same as when this feature is disabled.
1945 * However, this feature increases the attack surface: there is an added
1946 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1947 * Therefore this feature must never be enabled in production.
1948 *
1949 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1950 * information.
1951 *
1952 * Uncomment to enable invasive tests.
1953 */
1954//#define MBEDTLS_TEST_HOOKS
1955
1956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001958 *
1959 * Provide your own alternate threading implementation.
1960 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001962 *
1963 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001966
1967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001969 *
1970 * Enable the pthread wrapper layer for the threading layer.
1971 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001973 *
1974 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001977
1978/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001979 * \def MBEDTLS_USE_PSA_CRYPTO
1980 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001981 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1982 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001983 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001984 * \note Development of this option is currently in progress, and parts of Mbed
1985 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001986 * will still continue to work as usual, so enabling this option should not
1987 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001988 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001989 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001990 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1991 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001992 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001993 * \note An important and desirable effect of this option is that it allows
1994 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1995 * 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 +02001996 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001997 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1998 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001999 *
2000 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002001 *
2002 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002003 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002004 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002006//#define MBEDTLS_USE_PSA_CRYPTO
2007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002009 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2010 *
John Durkop185764f2020-10-12 21:32:12 -07002011 * This setting allows support for cryptographic mechanisms through the PSA
2012 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002013 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002014 * When this option is disabled, the PSA API exposes the cryptographic
2015 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2016 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002017 *
2018 * When this option is enabled, the PSA API exposes the cryptographic
2019 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2020 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2021 * automatically enabled if required (i.e. if no PSA driver provides the
2022 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2023 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002024 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002025 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002026 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002027 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002028 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2029 * symbols is not completely finalized yet, and the configuration
2030 * tooling is not ideally adapted to having two separate configuration
2031 * files.
2032 * Future minor releases of Mbed TLS may make minor changes to those
2033 * symbols, but we will endeavor to provide a transition path.
2034 * Nonetheless, this option is considered mature enough to use in
2035 * production, as long as you accept that you may need to make
2036 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002037 */
2038//#define MBEDTLS_PSA_CRYPTO_CONFIG
2039
2040/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002041 * \def MBEDTLS_VERSION_FEATURES
2042 *
2043 * Allow run-time checking of compile-time enabled features. Thus allowing users
2044 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002045 * support via mbedtls_version_check_feature().
2046 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002047 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002048 *
2049 * Comment this to disable run-time checking and save ROM space
2050 */
2051#define MBEDTLS_VERSION_FEATURES
2052
2053/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002054 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2055 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002056 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002057 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2058 * the set of trusted certificates through a callback instead of a linked
2059 * list.
2060 *
2061 * This is useful for example in environments where a large number of trusted
2062 * certificates is present and storing them in a linked list isn't efficient
2063 * enough, or when the set of trusted certificates changes frequently.
2064 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002065 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002066 * `mbedtls_ssl_conf_ca_cb()` for more information.
2067 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002068 * Requires: MBEDTLS_X509_CRT_PARSE_C
2069 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002070 * Uncomment to enable trusted certificate callbacks.
2071 */
2072//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2073
2074/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002075 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002076 *
Chris Jones2c745862020-12-16 11:41:06 +00002077 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002078 *
Chris Jones2c745862020-12-16 11:41:06 +00002079 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002080 * and other functions/constants only used by these functions, thus reducing
2081 * the code footprint by several KB.
2082 */
Chris Jones2c745862020-12-16 11:41:06 +00002083//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002084
2085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002087 *
2088 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2089 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2090 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002091 * Requires: MBEDTLS_PKCS1_V21
2092 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002093 * Comment this macro to disallow using RSASSA-PSS in certificates.
2094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002096/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002097
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002098/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002099 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002100 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002101 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002102 * \{
2103 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002104
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002105/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002106 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002107 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002108 * Enable AES-NI support on x86-64 or x86-32.
2109 *
2110 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002111 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002112 * - GCC, x86-64, target not explicitly supporting AESNI:
2113 * requires MBEDTLS_HAVE_ASM.
2114 * - GCC, x86-32, target not explicitly supporting AESNI:
2115 * not supported.
2116 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2117 * For this assembly-less implementation, you must currently compile
2118 * `library/aesni.c` and `library/aes.c` with machine options to enable
2119 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2120 * `clang -maes -mpclmul`.
2121 * - Non-x86 targets: this option is silently ignored.
2122 * - Other compilers: this option is silently ignored.
2123 *
2124 * \note
2125 * Above, "GCC" includes compatible compilers such as Clang.
2126 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002127 *
2128 * Module: library/aesni.c
2129 * Caller: library/aes.c
2130 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002131 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002132 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002133 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002136
2137/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002138 * \def MBEDTLS_AESCE_C
2139 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002140 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002141 *
2142 * Module: library/aesce.c
2143 * Caller: library/aes.c
2144 *
Jerry Yuf015a932023-04-25 10:38:03 +08002145 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002146 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002147 * \warning Runtime detection only works on Linux. For non-Linux operating
2148 * system, Armv8-A Cryptographic Extensions must be supported by
2149 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002150 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002151 * \note Minimum compiler versions for this feature when targeting aarch64
2152 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2153 * Minimum compiler versions for this feature when targeting 32-bit
2154 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002155 *
2156 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2157 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002158 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002159 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002160 */
2161#define MBEDTLS_AESCE_C
2162
2163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002164 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002165 *
2166 * Enable the AES block cipher.
2167 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002168 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002169 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002170 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002171 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002173 * This module enables the following ciphersuites (if other requisites are
2174 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2177 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2179 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2180 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2183 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2184 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2185 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2186 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2187 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2189 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2198 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2199 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2200 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2201 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2202 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2203 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2204 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2205 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2206 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2207 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2208 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2209 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2211 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2212 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2213 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2214 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2215 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2216 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2217 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2218 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2219 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2220 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2221 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2222 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2223 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2224 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2225 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2227 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2228 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2229 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2230 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2231 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2232 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002233 *
Paul Bakkercff68422013-09-15 20:43:33 +02002234 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002235 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002237
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002240 *
2241 * Enable the generic ASN1 parser.
2242 *
2243 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002244 * Caller: library/x509.c
2245 * library/dhm.c
2246 * library/pkcs12.c
2247 * library/pkcs5.c
2248 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002251
2252/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002254 *
2255 * Enable the generic ASN1 writer.
2256 *
2257 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002258 * Caller: library/ecdsa.c
2259 * library/pkwrite.c
2260 * library/x509_create.c
2261 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002262 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002265
2266/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002268 *
2269 * Enable the Base64 module.
2270 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002271 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002272 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002273 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002274 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002277
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002278/**
Yanray Wange367e472023-10-31 17:23:04 +08002279 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2280 *
2281 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2282 *
2283 * \note This feature is incompatible with insecure block cipher,
2284 * MBEDTLS_DES_C, and cipher modes which always require decryption
2285 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002286 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2287 * this feature is incompatible with following supported PSA equivalence,
2288 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2289 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002290 *
2291 * Module: library/aes.c
2292 * library/aesce.c
2293 * library/aesni.c
2294 * library/aria.c
2295 * library/camellia.c
2296 * library/cipher.c
2297 */
2298//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2299
2300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002302 *
Paul Bakker9a736322012-11-14 12:39:52 +00002303 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002304 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002305 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002306 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002307 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002308 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002310 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002311 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002312 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002313 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002314 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002315 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002316 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002319
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002322 *
2323 * Enable the Camellia block cipher.
2324 *
Paul Bakker38119b12009-01-10 23:31:23 +00002325 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002326 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002327 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002328 * This module enables the following ciphersuites (if other requisites are
2329 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2331 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2332 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2333 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2336 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2340 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2343 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2344 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2345 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2349 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2351 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2352 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2354 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2355 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2357 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2358 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2360 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2361 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2362 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2364 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2365 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2366 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2368 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2369 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2370 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2371 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002374
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002375/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002376 * \def MBEDTLS_ARIA_C
2377 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002378 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002379 *
2380 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002381 * Caller: library/cipher.c
2382 *
2383 * This module enables the following ciphersuites (if other requisites are
2384 * enabled as well):
2385 *
2386 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2387 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2389 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2392 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2394 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2395 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2396 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2397 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2398 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2399 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2400 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2406 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2407 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2408 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2410 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2411 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2412 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2413 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2414 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2415 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2416 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2417 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2418 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2419 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2420 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2421 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2422 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2423 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002424 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002425#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002426
2427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002429 *
2430 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2431 *
2432 * Module: library/ccm.c
2433 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002434 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2435 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002436 *
2437 * This module enables the AES-CCM ciphersuites, if other requisites are
2438 * enabled as well.
2439 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002441
2442/**
Daniel King34b822c2016-05-15 17:28:08 -03002443 * \def MBEDTLS_CHACHA20_C
2444 *
2445 * Enable the ChaCha20 stream cipher.
2446 *
2447 * Module: library/chacha20.c
2448 */
2449#define MBEDTLS_CHACHA20_C
2450
2451/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002452 * \def MBEDTLS_CHACHAPOLY_C
2453 *
2454 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2455 *
2456 * Module: library/chachapoly.c
2457 *
2458 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2459 */
2460#define MBEDTLS_CHACHAPOLY_C
2461
2462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002464 *
2465 * Enable the generic cipher layer.
2466 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002467 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002468 * Caller: library/ccm.c
2469 * library/cmac.c
2470 * library/gcm.c
2471 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002472 * library/pkcs12.c
2473 * library/pkcs5.c
2474 * library/psa_crypto_aead.c
2475 * library/psa_crypto_mac.c
2476 * library/ssl_ciphersuites.c
2477 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002478 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002479 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2480 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002481 *
2482 * Uncomment to enable generic cipher wrappers.
2483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002485
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002486/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002487 * \def MBEDTLS_CMAC_C
2488 *
Simon Butcher327398a2016-10-05 14:09:11 +01002489 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2490 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002491 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002492 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2493 * implementation of the CMAC algorithm is provided by an alternate
2494 * implementation, that alternate implementation may opt to not support
2495 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2496 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002497 * Module: library/cmac.c
2498 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002499 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002500 *
2501 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002502#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002503
2504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002506 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002507 * Enable the CTR_DRBG AES-based random generator.
2508 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002509 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002510 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002511 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2512 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2513 * is used.
2514 *
2515 * \warning When using PSA, the user should call `psa_crypto_init()` before
2516 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2517 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002518 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2519 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002520 * \note To achieve a 256-bit security strength with CTR_DRBG,
2521 * you must use AES-256 *and* use sufficient entropy.
2522 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002523 *
2524 * Module: library/ctr_drbg.c
2525 * Caller:
2526 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002527 * Requires: MBEDTLS_AES_C or
2528 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2529 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002530 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002531 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002534
2535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002537 *
2538 * Enable the debug functions.
2539 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002540 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002541 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002542 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002543 * library/ssl_tls12_*.c
2544 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002545 *
2546 * This module provides debugging functions.
2547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002549
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002552 *
2553 * Enable the DES block cipher.
2554 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002555 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002556 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002557 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002558 *
Paul Bakkercff68422013-09-15 20:43:33 +02002559 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002560 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002561 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002562 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002565
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002568 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002569 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002570 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002571 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002572 * Caller: library/ssl_tls.c
2573 * library/ssl*_client.c
2574 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002575 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002576 * This module is used by the following key exchanges:
2577 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002578 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002579 * \warning Using DHE constitutes a security risk as it
2580 * is not possible to validate custom DH parameters.
2581 * If possible, it is recommended users should consider
2582 * preferring other methods of key exchange.
2583 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002584 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002587
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002590 *
2591 * Enable the elliptic curve Diffie-Hellman library.
2592 *
2593 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002594 * Caller: library/psa_crypto.c
2595 * library/ssl_tls.c
2596 * library/ssl*_client.c
2597 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002598 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002599 * This module is used by the following key exchanges:
2600 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002601 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002605
2606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002608 *
2609 * Enable the elliptic curve DSA library.
2610 *
2611 * Module: library/ecdsa.c
2612 * Caller:
2613 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002614 * This module is used by the following key exchanges:
2615 * ECDHE-ECDSA
2616 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002617 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2618 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2619 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002622
2623/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002624 * \def MBEDTLS_ECJPAKE_C
2625 *
2626 * Enable the elliptic curve J-PAKE library.
2627 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002628 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2629 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002630 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002631 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002632 * Module: library/ecjpake.c
2633 * Caller:
2634 *
2635 * This module is used by the following key exchanges:
2636 * ECJPAKE
2637 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002638 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002639 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002640 * \warning If using a hash that is only provided by PSA drivers, you must
2641 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002642 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002643#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002644
2645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002647 *
2648 * Enable the elliptic curve over GF(p) library.
2649 *
2650 * Module: library/ecp.c
2651 * Caller: library/ecdh.c
2652 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002653 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002654 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002658
2659/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002661 *
2662 * Enable the platform-specific entropy code.
2663 *
2664 * Module: library/entropy.c
2665 * Caller:
2666 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002668 *
2669 * This module provides a generic entropy pool
2670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002672
2673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002675 *
2676 * Enable error code to error string conversion.
2677 *
2678 * Module: library/error.c
2679 * Caller:
2680 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002682 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002684
2685/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002687 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002688 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002689 *
2690 * Module: library/gcm.c
2691 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002692 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2693 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002694 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002695 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2696 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002699
2700/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002701 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002702 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002703 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002704 * Can significantly increase throughput on systems without GCM hardware
2705 * acceleration (e.g., AESNI, AESCE).
2706 *
Matthias Schulz78266782024-02-08 13:54:48 +01002707 * The mbedtls_gcm_context size will increase by 3840 bytes.
2708 * The code size will increase by roughly 344 bytes.
2709 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002710 * Module: library/gcm.c
2711 *
2712 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002713 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002714//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002715
2716/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002717 * \def MBEDTLS_HKDF_C
2718 *
2719 * Enable the HKDF algorithm (RFC 5869).
2720 *
2721 * Module: library/hkdf.c
2722 * Caller:
2723 *
2724 * Requires: MBEDTLS_MD_C
2725 *
2726 * This module adds support for the Hashed Message Authentication Code
2727 * (HMAC)-based key derivation function (HKDF).
2728 */
2729#define MBEDTLS_HKDF_C
2730
2731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002733 *
2734 * Enable the HMAC_DRBG random generator.
2735 *
2736 * Module: library/hmac_drbg.c
2737 * Caller:
2738 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002740 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002741 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002744
2745/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002746 * \def MBEDTLS_LMS_C
2747 *
2748 * Enable the LMS stateful-hash asymmetric signature algorithm.
2749 *
2750 * Module: library/lms.c
2751 * Caller:
2752 *
Raef Colesab4f8742022-09-01 12:24:31 +01002753 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002754 *
Raef Colesab4f8742022-09-01 12:24:31 +01002755 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002756 */
2757#define MBEDTLS_LMS_C
2758
2759/**
Raef Colesab4f8742022-09-01 12:24:31 +01002760 * \def MBEDTLS_LMS_PRIVATE
2761 *
2762 * Enable LMS private-key operations and signing code. Functions enabled by this
2763 * option are experimental, and should not be used in production.
2764 *
2765 * Requires: MBEDTLS_LMS_C
2766 *
2767 * Uncomment to enable the LMS signature algorithm and private key operations.
2768 */
Raef Coles5127e852022-10-07 10:35:56 +01002769//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002770
2771/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002772 * \def MBEDTLS_NIST_KW_C
2773 *
2774 * Enable the Key Wrapping mode for 128-bit block ciphers,
2775 * as defined in NIST SP 800-38F. Only KW and KWP modes
2776 * are supported. At the moment, only AES is approved by NIST.
2777 *
2778 * Module: library/nist_kw.c
2779 *
2780 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2781 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002782#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002783
2784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002786 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002787 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002788 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002789 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2790 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002791 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002792 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002793 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002794 * Caller: library/constant_time.c
2795 * library/ecdsa.c
2796 * library/ecjpake.c
2797 * library/hkdf.c
2798 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002799 * library/pk.c
2800 * library/pkcs5.c
2801 * library/pkcs12.c
2802 * library/psa_crypto_ecp.c
2803 * library/psa_crypto_rsa.c
2804 * library/rsa.c
2805 * library/ssl_cookie.c
2806 * library/ssl_msg.c
2807 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002808 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002809 * library/x509_crt.c
2810 * library/x509write_crt.c
2811 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002812 *
2813 * Uncomment to enable generic message digest wrappers.
2814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002816
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002817/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002819 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002820 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002821 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002822 * Module: library/md5.c
2823 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002824 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002825 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002826 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002827 * This module is required for TLS 1.2 depending on the handshake parameters.
2828 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2829 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002830 *
2831 * \warning MD5 is considered a weak message digest and its use constitutes a
2832 * security risk. If possible, we recommend avoiding dependencies on
2833 * it, and considering stronger message digests instead.
2834 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002837
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002838/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002840 *
2841 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002842 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002843 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002844 *
2845 * Module: library/memory_buffer_alloc.c
2846 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002848 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002849 *
2850 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002853
2854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002856 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002857 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2858 *
Simon Butcherd567a232016-03-09 20:19:21 +00002859 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2860 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002861 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002862 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002863 * \note See also our Knowledge Base article about porting to a new
2864 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002865 * 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 +00002866 *
Andres AG788aa4a2016-09-14 14:32:09 +01002867 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002868 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002869 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002872
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002875 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002876 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002877 *
2878 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002879 * Caller: library/asn1write.c
2880 * library/pkcs5.c
2881 * library/pkparse.c
2882 * library/pkwrite.c
2883 * library/rsa.c
2884 * library/x509.c
2885 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002886 * library/x509_crl.c
2887 * library/x509_crt.c
2888 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002889 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002890 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002891 *
2892 * This modules translates between OIDs and internal values.
2893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002895
2896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002898 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002899 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002900 *
2901 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002902 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002903 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002904 * library/x509_crl.c
2905 * library/x509_crt.c
2906 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002907 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002909 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2910 *
2911 * \warning When parsing password-protected files, if MD5 is provided only by
2912 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002913 *
Paul Bakkercff68422013-09-15 20:43:33 +02002914 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002917
2918/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002920 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002921 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002922 *
2923 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002924 * Caller: library/pkwrite.c
2925 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002926 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002927 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002929 *
2930 * This modules adds support for encoding / writing PEM files.
2931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002933
2934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002936 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002937 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002938 *
2939 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002940 * Caller: library/psa_crypto_rsa.c
2941 * library/ssl_tls.c
2942 * library/ssl*_client.c
2943 * library/ssl*_server.c
2944 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002945 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002946 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002947 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002948 * Uncomment to enable generic public key wrappers.
2949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002951
2952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002954 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002955 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002956 *
2957 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002958 * Caller: library/x509_crt.c
2959 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002960 *
Yanray Wang072a0682023-12-05 10:53:04 +08002961 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002962 *
2963 * Uncomment to enable generic public key parse functions.
2964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002966
2967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002969 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002970 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002971 *
2972 * Module: library/pkwrite.c
2973 * Caller: library/x509write.c
2974 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002975 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002976 *
2977 * Uncomment to enable generic public key write functions.
2978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002980
2981/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002983 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002984 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002985 *
2986 * Module: library/pkcs5.c
2987 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002988 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002989 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002990 * \warning If using a hash that is only provided by PSA drivers, you must
2991 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002992 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002993 * This module adds support for the PKCS#5 functions.
2994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002996
2997/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002998 * \def MBEDTLS_PKCS7_C
2999 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003000 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003001 * RFC Link - https://tools.ietf.org/html/rfc2315
3002 *
3003 * Module: library/pkcs7.c
3004 *
3005 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003006 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3007 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003008 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003009 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003010 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003011#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003012
3013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003015 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003016 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003017 * Adds algorithms for parsing PKCS#8 encrypted private keys
3018 *
3019 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003020 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003021 *
Valerio Settie98ad592023-12-28 10:42:12 +01003022 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3023 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003024 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003025 * \warning If using a hash that is only provided by PSA drivers, you must
3026 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003027 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003028 * This module enables PKCS#12 functions.
3029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003031
3032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003034 *
3035 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003036 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3039 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003040 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003041 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003042 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003043 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003044 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003045 * Module: library/platform.c
3046 * Caller: Most other .c files
3047 *
3048 * This module enables abstraction of common (libc) functions.
3049 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003050#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003051
3052/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003053 * \def MBEDTLS_POLY1305_C
3054 *
3055 * Enable the Poly1305 MAC algorithm.
3056 *
3057 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003058 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003059 */
3060#define MBEDTLS_POLY1305_C
3061
3062/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003063 * \def MBEDTLS_PSA_CRYPTO_C
3064 *
3065 * Enable the Platform Security Architecture cryptography API.
3066 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003067 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003068 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003069 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003070 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003071 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3072 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3073 * is enabled in PSA (unless it's fully accelerated, see
3074 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003075 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003076#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003077
3078/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003079 * \def MBEDTLS_PSA_CRYPTO_SE_C
3080 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003081 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003082 * cryptography API.
3083 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003084 * \deprecated This feature is deprecated. Please switch to the PSA driver
3085 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003086 *
Ryan Everett32a64582024-03-05 18:16:18 +00003087 * \warning This feature is not thread-safe, and should not be used in a
3088 * multi-threaded environment.
3089 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003090 * Module: library/psa_crypto_se.c
3091 *
3092 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3093 *
3094 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003095//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003096
3097/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003098 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3099 *
3100 * Enable the Platform Security Architecture persistent key storage.
3101 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003102 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003103 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003104 * Requires: MBEDTLS_PSA_CRYPTO_C,
3105 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3106 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003107 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003108#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003109
3110/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003111 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003112 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003113 * Enable the emulation of the Platform Security Architecture
3114 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003115 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003116 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003117 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003118 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003119 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003120#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003121
3122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003124 *
3125 * Enable the RIPEMD-160 hash algorithm.
3126 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003127 * Module: library/ripemd160.c
3128 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003129 *
3130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003132
3133/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003135 *
3136 * Enable the RSA public-key cryptosystem.
3137 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003138 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003139 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003140 * Caller: library/pk.c
3141 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003143 * library/ssl*_client.c
3144 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003145 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003146 * This module is used by the following key exchanges:
3147 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003152
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003155 *
3156 * Enable the SHA1 cryptographic hash algorithm.
3157 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003158 * Module: library/sha1.c
3159 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003160 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003161 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003162 * This module is required for TLS 1.2 depending on the handshake parameters,
3163 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003164 *
3165 * \warning SHA-1 is considered a weak message digest and its use constitutes
3166 * a security risk. If possible, we recommend avoiding dependencies
3167 * on it, and considering stronger message digests instead.
3168 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003171
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003172/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003173 * \def MBEDTLS_SHA224_C
3174 *
3175 * Enable the SHA-224 cryptographic hash algorithm.
3176 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003177 * Module: library/sha256.c
3178 * Caller: library/md.c
3179 * library/ssl_cookie.c
3180 *
3181 * This module adds support for SHA-224.
3182 */
3183#define MBEDTLS_SHA224_C
3184
3185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003187 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003188 * Enable the SHA-256 cryptographic hash algorithm.
3189 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003190 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003191 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003192 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003193 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003194 * library/ssl*_client.c
3195 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003196 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003197 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003198 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003201
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003202/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003203 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003204 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003205 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3206 * with the ARMv8 cryptographic extensions if they are available at runtime.
3207 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003208 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003209 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003210 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003211 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003212 * \note Minimum compiler versions for this feature are Clang 4.0,
3213 * armclang 6.6 or GCC 6.0.
3214 *
3215 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3216 * armclang <= 6.9
3217 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003218 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3219 * That name is deprecated, but may still be used as an alternative form for this
3220 * option.
3221 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003222 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3223 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003224 *
3225 * Requires: MBEDTLS_SHA256_C.
3226 *
3227 * Module: library/sha256.c
3228 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003229 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003230 * and use them if available.
3231 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003232//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003233
Dave Rodgmand85277c2023-10-13 09:22:54 +01003234/**
3235 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3236 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003237 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003238 * This name is now deprecated, but may still be used as an alternative form for
3239 * this option.
3240 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003241//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3242
3243/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003244 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003245 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003246 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3247 * with the ARMv8 cryptographic extensions, which must be available at runtime
3248 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003249 *
3250 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003251 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003252 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003253 * \note Minimum compiler versions for this feature are Clang 4.0,
3254 * armclang 6.6 or GCC 6.0.
3255 *
3256 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3257 * armclang <= 6.9
3258 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003259 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003260 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003261 * option.
3262 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003263 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3264 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003265 *
3266 * Requires: MBEDTLS_SHA256_C.
3267 *
3268 * Module: library/sha256.c
3269 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003270 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003271 * unconditionally.
3272 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003273//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003274
Dave Rodgmand85277c2023-10-13 09:22:54 +01003275/**
3276 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3277 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003278 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003279 * This name is now deprecated, but may still be used as an alternative form for
3280 * this option.
3281 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003282//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3283
3284/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003285 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003286 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003287 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003288 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003289 * Module: library/sha512.c
3290 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003291 * library/psa_crypto_hash.c
3292 * library/ssl_tls.c
3293 * library/ssl*_client.c
3294 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003295 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003296 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003297 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003298#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003299
3300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003302 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003303 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003304 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003305 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003306 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003307 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003308 * library/ssl_tls.c
3309 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003310 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003311 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003314
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003315/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003316 * \def MBEDTLS_SHA3_C
3317 *
3318 * Enable the SHA3 cryptographic hash algorithm.
3319 *
3320 * Module: library/sha3.c
3321 *
3322 * This module adds support for SHA3.
3323 */
3324#define MBEDTLS_SHA3_C
3325
3326/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003327 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3328 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003329 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3330 * with the ARMv8 cryptographic extensions if they are available at runtime.
3331 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003332 *
3333 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3334 * for a non-Aarch64 build it will be silently ignored.
3335 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003336 * \note Minimum compiler versions for this feature are Clang 7.0,
3337 * armclang 6.9 or GCC 8.0.
3338 *
3339 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3340 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003341 *
3342 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3343 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3344 *
3345 * Requires: MBEDTLS_SHA512_C.
3346 *
3347 * Module: library/sha512.c
3348 *
3349 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3350 * and use them if available.
3351 */
3352//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3353
3354/**
3355 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3356 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003357 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3358 * with the ARMv8 cryptographic extensions, which must be available at runtime
3359 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003360 *
3361 * \note This allows builds with a smaller code size than with
3362 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3363 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003364 * \note Minimum compiler versions for this feature are Clang 7.0,
3365 * armclang 6.9 or GCC 8.0.
3366 *
3367 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3368 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003369 *
3370 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3371 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3372 *
3373 * Requires: MBEDTLS_SHA512_C.
3374 *
3375 * Module: library/sha512.c
3376 *
3377 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3378 * unconditionally.
3379 */
3380//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3381
3382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003384 *
3385 * Enable simple SSL cache implementation.
3386 *
3387 * Module: library/ssl_cache.c
3388 * Caller:
3389 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003393
3394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003396 *
3397 * Enable basic implementation of DTLS cookies for hello verification.
3398 *
3399 * Module: library/ssl_cookie.c
3400 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003403
3404/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003405 * \def MBEDTLS_SSL_TICKET_C
3406 *
3407 * Enable an implementation of TLS server-side callbacks for session tickets.
3408 *
3409 * Module: library/ssl_ticket.c
3410 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003411 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003412 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3413 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003414 */
3415#define MBEDTLS_SSL_TICKET_C
3416
3417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003419 *
3420 * Enable the SSL/TLS client code.
3421 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003422 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003423 * Caller:
3424 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003426 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 * This module is required for SSL/TLS client support.
3428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003430
Paul Bakker9a736322012-11-14 12:39:52 +00003431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003433 *
3434 * Enable the SSL/TLS server code.
3435 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003436 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003437 * Caller:
3438 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003440 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003441 * This module is required for SSL/TLS server support.
3442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003444
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003448 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003449 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003450 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003451 * Caller: library/ssl*_client.c
3452 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003453 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3455 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003456 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003457 * This module is required for SSL/TLS.
3458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003460
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003463 *
3464 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003465 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003466 * contexts are not shared between threads. If you do intend to use contexts
3467 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003468 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003469 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003470 *
3471 * Module: library/threading.c
3472 *
3473 * This allows different threading implementations (self-implemented or
3474 * provided).
3475 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * You will have to enable either MBEDTLS_THREADING_ALT or
3477 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003478 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003479 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003482
3483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003485 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003486 * Enable the semi-portable timing interface.
3487 *
Simon Butcherd567a232016-03-09 20:19:21 +00003488 * \note The provided implementation only works on POSIX/Unix (including Linux,
3489 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003490 * module and provide your own implementations of the callbacks needed by
3491 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3492 * your own implementation of the whole module by setting
3493 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003494 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003495 * \note The timing module will include time.h on suitable platforms
3496 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3497 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3498 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003499 * \note See also our Knowledge Base article about porting to a new
3500 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003501 * 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 +00003502 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003503 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003506
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003509 *
3510 * Enable run-time version information.
3511 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003512 * Module: library/version.c
3513 *
3514 * This module provides run-time version information.
3515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003517
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003520 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003521 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003522 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003524 * Caller: library/x509_crl.c
3525 * library/x509_crt.c
3526 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003527 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003528 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003529 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3530 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003531 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3532 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003533 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003534 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003537
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003540 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003542 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003543 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003544 * Caller: library/ssl_tls.c
3545 * library/ssl*_client.c
3546 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
3550 * This module is required for X.509 certificate parsing.
3551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553
3554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
3557 * Enable X.509 CRL parsing.
3558 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003559 * Module: library/x509_crl.c
3560 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003561 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
3564 * This module is required for X.509 CRL parsing.
3565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567
3568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 *
3571 * Enable X.509 Certificate Signing Request (CSR) parsing.
3572 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003573 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003574 * Caller: library/x509_crt_write.c
3575 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 *
3578 * This module is used for reading X.509 certificate request.
3579 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581
3582/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003585 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003586 *
3587 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003588 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003589 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003590 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3591 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003592 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3593 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003594 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595 * This module is the basis for creating X.509 certificates and CSRs.
3596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598
3599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003600 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003601 *
3602 * Enable creating X.509 certificates.
3603 *
3604 * Module: library/x509_crt_write.c
3605 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607 *
3608 * This module is required for X.509 certificate creation.
3609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611
3612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003614 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003615 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003616 *
3617 * Module: library/x509_csr_write.c
3618 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003621 * This module is required for X.509 certificate request writing.
3622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003623#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003624
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003625/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003626
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003627/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003628 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003629 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003630 * This section contains Mbed TLS build settings that are not associated
3631 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003632 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633 * \{
3634 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003635
Gilles Peskinea02c1242022-03-16 17:03:19 +01003636/**
3637 * \def MBEDTLS_CONFIG_FILE
3638 *
3639 * If defined, this is a header which will be included instead of
3640 * `"mbedtls/mbedtls_config.h"`.
3641 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003642 * Unlike other configuration options, this one must be defined on the
3643 * compiler command line: a definition in `mbedtls_config.h` would have
3644 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003645 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003646 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003647 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003648 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003649 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003650 * The value of this symbol is typically a path in double quotes, either
3651 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003652 */
3653//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3654
3655/**
3656 * \def MBEDTLS_USER_CONFIG_FILE
3657 *
3658 * If defined, this is a header which will be included after
3659 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003660 * This allows you to modify the default configuration, including the ability
3661 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003662 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003663 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003664 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003665 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003666 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003667 * The value of this symbol is typically a path in double quotes, either
3668 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003669 */
3670//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3671
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003672/**
3673 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3674 *
3675 * If defined, this is a header which will be included instead of
3676 * `"psa/crypto_config.h"`.
3677 * This header file specifies which cryptographic mechanisms are available
3678 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3679 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3680 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003681 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003682 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003683 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003684 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003685 * The value of this symbol is typically a path in double quotes, either
3686 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003687 */
3688//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3689
3690/**
3691 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3692 *
3693 * If defined, this is a header which will be included after
3694 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003695 * This allows you to modify the default configuration, including the ability
3696 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003697 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003698 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003699 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003700 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003701 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003702 * The value of this symbol is typically a path in double quotes, either
3703 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003704 */
3705//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3706
Gilles Peskineb1176f22023-02-22 22:07:28 +01003707/**
3708 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3709 *
3710 * If defined, this is a header which will be included instead of
3711 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3712 * as the one in Mbed TLS, but with definitions adapted to the platform on
3713 * which the library code will run.
3714 *
3715 * \note The required content of this header can vary from one version of
3716 * Mbed TLS to the next. Integrators who provide an alternative file
3717 * should review the changes in the original file whenever they
3718 * upgrade Mbed TLS.
3719 *
3720 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3721 * non-standard feature of the C language, so this feature is only available
3722 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3723 *
3724 * The value of this symbol is typically a path in double quotes, either
3725 * absolute or relative to a directory on the include search path.
3726 */
3727//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3728
3729/**
3730 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3731 *
3732 * If defined, this is a header which will be included instead of
3733 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3734 * as the one in Mbed TLS, but with definitions adapted to the environment
3735 * in which the library code will run. The typical use for this feature
3736 * is to provide alternative type definitions on the client side in
3737 * client-server integrations of PSA crypto, where operation structures
3738 * contain handles instead of cryptographic data.
3739 *
3740 * \note The required content of this header can vary from one version of
3741 * Mbed TLS to the next. Integrators who provide an alternative file
3742 * should review the changes in the original file whenever they
3743 * upgrade Mbed TLS.
3744 *
3745 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3746 * non-standard feature of the C language, so this feature is only available
3747 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3748 *
3749 * The value of this symbol is typically a path in double quotes, either
3750 * absolute or relative to a directory on the include search path.
3751 */
3752//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3753
Gilles Peskineba4162a2022-04-11 17:04:38 +02003754/** \} name SECTION: General configuration options */
3755
3756/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003757 * \name SECTION: Module configuration options
3758 *
3759 * This section allows for the setting of module specific sizes and
3760 * configuration options. The default values are already present in the
3761 * relevant header files and should suffice for the regular use cases.
3762 *
3763 * Our advice is to enable options and change their values here
3764 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003765 * \{
3766 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003767/* The Doxygen documentation here is used when a user comments out a
3768 * setting and runs doxygen themselves. On the other hand, when we typeset
3769 * the full documentation including disabled settings, the documentation
3770 * in specific modules' header files is used if present. When editing this
3771 * file, make sure that each option is documented in exactly one place,
3772 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3773 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003774
Paul Bakker088c5c52014-04-25 11:11:10 +02003775/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003776//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003777//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003778
Paul Bakker088c5c52014-04-25 11:11:10 +02003779/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3781//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3782//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3783//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3784//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003785
Paul Bakker088c5c52014-04-25 11:11:10 +02003786/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003787//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3788//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3789//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3790//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003791
Paul Bakker088c5c52014-04-25 11:11:10 +02003792/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003793//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003795
Paul Bakker088c5c52014-04-25 11:11:10 +02003796/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3798//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003799//#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 +01003800
Paul Bakker088c5c52014-04-25 11:11:10 +02003801/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003802//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003803
Paul Bakker088c5c52014-04-25 11:11:10 +02003804/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003805//#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 -04003806
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003807/** \def MBEDTLS_PLATFORM_STD_CALLOC
3808 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003809 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003810 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003811 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003812 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003813 * 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 -04003814 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3815 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003816 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003817 */
3818//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003819
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003820/** \def MBEDTLS_PLATFORM_STD_FREE
3821 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003822 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003823 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003824 * 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 -04003825 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3826 * 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 -04003827 */
3828//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003829//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003830//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003831//#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 +02003832//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3833//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003834/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003836//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3837//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003838//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3839//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3840//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003841
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003842/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003843/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003844//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3845//#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 +02003846//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003847//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003848//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3849//#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 +02003850//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3851//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003852/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003854//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003855//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3856//#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 +08003857//#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 +08003858//#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 +02003859
Gilles Peskine3f106f72021-09-23 17:42:39 +02003860/** \def MBEDTLS_CHECK_RETURN
3861 *
3862 * This macro is used at the beginning of the declaration of a function
3863 * to indicate that its return value should be checked. It should
3864 * instruct the compiler to emit a warning or an error if the function
3865 * is called without checking its return value.
3866 *
3867 * There is a default implementation for popular compilers in platform_util.h.
3868 * You can override the default implementation by defining your own here.
3869 *
3870 * If the implementation here is empty, this will effectively disable the
3871 * checking of functions' return values.
3872 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003873//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003874
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003875/** \def MBEDTLS_IGNORE_RETURN
3876 *
3877 * This macro requires one argument, which should be a C function call.
3878 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3879 * warning is suppressed.
3880 */
3881//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3882
Gilles Peskineed038902020-11-13 21:33:21 +01003883/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003884/**
Gilles Peskineed038902020-11-13 21:33:21 +01003885 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3886 * PSA crypto subsystem.
3887 *
3888 * If this option is unset:
3889 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003890 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003891 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3892 * on unspecified heuristics.
3893 */
3894//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3895
Steven Cooreman863470a2021-02-15 14:03:19 +01003896/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003897 * Restrict the PSA library to supporting a maximum amount of simultaneously
3898 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3899 * volatile key, or a persistent key which is loaded temporarily by the
3900 * library as part of a crypto operation in flight.
3901 *
3902 * If this option is unset, the library will fall back to a default value of
3903 * 32 keys.
3904 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003905//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003906
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003907/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003908//#define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024 /**< Minimum RSA key size that can be generated in bits (Minimum possible value is 128 bits) */
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003909
Paul Bakker088c5c52014-04-25 11:11:10 +02003910/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003911//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3912//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003913
Paul Bakker088c5c52014-04-25 11:11:10 +02003914/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003915
Angus Grattond8213d02016-05-25 20:56:48 +10003916/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3917 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003918 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003919 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003920 * This determines the size of the incoming TLS I/O buffer in such a way
3921 * that it is capable of holding the specified amount of plaintext data,
3922 * regardless of the protection mechanism used.
3923 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003924 * \note When using a value less than the default of 16KB on the client, it is
3925 * recommended to use the Maximum Fragment Length (MFL) extension to
3926 * inform the server about this limitation. On the server, there
3927 * is no supported, standardized way of informing the client about
3928 * restriction on the maximum size of incoming messages, and unless
3929 * the limitation has been communicated by other means, it is recommended
3930 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3931 * while keeping the default value of 16KB for the incoming buffer.
3932 *
David Horstmann95d516f2021-05-04 18:36:56 +01003933 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003934 */
3935//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3936
Gilles Peskined3d02902020-03-04 21:35:27 +01003937/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3938 *
3939 * The maximum length of CIDs used for incoming DTLS messages.
3940 *
3941 */
3942//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3943
3944/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3945 *
3946 * The maximum length of CIDs used for outgoing DTLS messages.
3947 *
3948 */
3949//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3950
TRodziewicze8dd7092021-05-12 14:19:11 +02003951/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003952 *
3953 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003954 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003955 *
3956 * The padding will always be chosen so that the length of the
3957 * padded plaintext is a multiple of the value of this option.
3958 *
3959 * Note: A value of \c 1 means that no padding will be used
3960 * for outgoing records.
3961 *
3962 * Note: On systems lacking division instructions,
3963 * a power of two should be preferred.
3964 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003965//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003966
Angus Grattond8213d02016-05-25 20:56:48 +10003967/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3968 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003969 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003970 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003971 * This determines the size of the outgoing TLS I/O buffer in such a way
3972 * that it is capable of holding the specified amount of plaintext data,
3973 * regardless of the protection mechanism used.
3974 *
Angus Grattond8213d02016-05-25 20:56:48 +10003975 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3976 * the default inward 16384 byte buffer to conform to the TLS specification.
3977 *
3978 * The minimum required outward buffer size is determined by the handshake
3979 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3980 * The specific size requirement depends on the configured ciphers and any
3981 * certificate data which is sent during the handshake.
3982 *
David Horstmann95d516f2021-05-04 18:36:56 +01003983 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003984 */
3985//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3986
Hanno Beckere0b150f2018-08-21 15:51:03 +01003987/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3988 *
3989 * Maximum number of heap-allocated bytes for the purpose of
3990 * DTLS handshake message reassembly and future message buffering.
3991 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003992 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003993 * to account for a reassembled handshake message of maximum size,
3994 * together with its reassembly bitmap.
3995 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003996 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003997 * should be sufficient for all practical situations as it allows
3998 * to reassembly a large handshake message (such as a certificate)
3999 * while buffering multiple smaller handshake messages.
4000 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004001 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004002//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004003
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004004//#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 +02004005//#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 +02004006
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004007/**
4008 * Complete list of ciphersuites to use, in order of preference.
4009 *
4010 * \warning No dependency checking is done on that field! This option can only
4011 * be used to restrict the set of available ciphersuites. It is your
4012 * responsibility to make sure the needed modules are active.
4013 *
4014 * Use this to save a few hundred bytes of ROM (default ordering of all
4015 * available ciphersuites) and a few to a few hundred bytes of RAM.
4016 *
4017 * The value below is only an example, not the default.
4018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004019//#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 +02004020
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004021/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004022 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4023 *
4024 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004025 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004026 *
4027 * It must be positive and smaller than UINT32_MAX.
4028 *
4029 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4030 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004031 */
4032//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4033
4034/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004035 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4036 *
Jerry Yucf913512023-11-14 11:06:52 +08004037 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004038 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004039 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004040 * - The client ticket age is the time difference between the time when the
4041 * client proposes to the server to use the ticket and the time the client
4042 * received the ticket from the server.
4043 * - The server ticket age is the time difference between the time when the
4044 * server receives a proposition from the client to use the ticket and the
4045 * time when the ticket was created by the server.
4046 *
Jerry Yucf913512023-11-14 11:06:52 +08004047 * The ages might be different due to the client and server clocks not running
4048 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4049 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4050 * 6s, thus in the worst case clients and servers must sync up their system time
4051 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004052 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004053 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004054 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004055//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004056
4057/**
4058 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4059 *
4060 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4061 *
4062 * This must be less than 256.
4063 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004064//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004065
4066/**
4067 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4068 *
4069 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4070 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4071 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4072 *
4073 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004074//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004075
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004076/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004077//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004078//#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 +01004079
Gilles Peskine611179c2022-04-13 23:04:48 +02004080/** \} name SECTION: Module configuration options */