blob: 57dab3fde3b36761373b45fc8f92f4a1cfd5bfb0 [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353//#define MBEDTLS_MD5_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000355
Paul Bakker90995b52013-06-24 19:20:35 +0200356/**
TRodziewicz75628d52021-06-18 12:56:27 +0200357 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200359 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100360 * alternate core implementation of symmetric crypto or hash function. Keep in
361 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200363 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200365 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200366 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200367 * no longer provide the mbedtls_sha1_process() function, but it will still provide
368 * the other function (using your mbedtls_sha1_process() function) and the definition
369 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200370 * with this definition.
371 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200372 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100373 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
374 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200375 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200376 * Uncomment a macro to enable alternate implementation of the corresponding
377 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100378 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200379 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100380 * constitutes a security risk. If possible, we recommend avoiding
381 * dependencies on them, and considering stronger message digests
382 * and ciphers instead.
383 *
Janos Follath1231d212019-01-07 15:01:32 +0000384 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
385 * enabled, then the deterministic ECDH signature functions pass the
386 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
387 * alternative implementations should use the RNG only for generating
388 * the ephemeral key and nothing else. If this is not possible, then
389 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200390 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000391 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393//#define MBEDTLS_MD5_PROCESS_ALT
394//#define MBEDTLS_RIPEMD160_PROCESS_ALT
395//#define MBEDTLS_SHA1_PROCESS_ALT
396//#define MBEDTLS_SHA256_PROCESS_ALT
397//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200398//#define MBEDTLS_DES_SETKEY_ALT
399//#define MBEDTLS_DES_CRYPT_ECB_ALT
400//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200401//#define MBEDTLS_AES_SETKEY_ENC_ALT
402//#define MBEDTLS_AES_SETKEY_DEC_ALT
403//#define MBEDTLS_AES_ENCRYPT_ALT
404//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300405//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300406//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300407//#define MBEDTLS_ECDSA_VERIFY_ALT
408//#define MBEDTLS_ECDSA_SIGN_ALT
409//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200410
411/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200412 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200413 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200414 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200415 * hardware entropy collector.
416 *
417 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000418 * prototype as declared in library/entropy_poll.h, and accept NULL as first
419 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200420 *
421 * Uncomment to use your own hardware entropy collector.
422 */
423//#define MBEDTLS_ENTROPY_HARDWARE_ALT
424
425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200426 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000427 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100428 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000429 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100430 * Uncomment this macro to use precomputed AES tables stored in ROM.
431 * Comment this macro to generate AES tables in RAM at runtime.
432 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100433 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
434 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100435 * initialization time before the first AES operation can be performed.
436 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
437 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
438 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100439 *
440 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200442//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000443
444/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100445 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200446 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100447 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200448 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100449 * Uncommenting this macro omits 75% of the AES tables from
450 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
451 * by computing their values on the fly during operations
452 * (the tables are entry-wise rotations of one another).
453 *
454 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100455 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100456 * runtime. Specifically, one has to compare 4 accesses within
457 * different tables to 4 accesses with additional arithmetic
458 * operations within the same table. The performance gain/loss
459 * depends on the system and memory details.
460 *
461 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200462 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100463//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200464
465/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800466 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
467 *
468 * Use only 128-bit keys in AES operations to save ROM.
469 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800470 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800471 * or 256-bit keys.
472 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800473 * Uncommenting this macro reduces the size of AES code by ~300 bytes
474 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800475 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800476 * Module: library/aes.c
477 *
478 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800479 */
480//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
481
Gilles Peskinea8861e02023-09-05 20:20:51 +0200482/*
483 * Disable plain C implementation for AES.
484 *
485 * When the plain C implementation is enabled, and an implementation using a
486 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
487 * detection will be used to select between them.
488 *
489 * If only one implementation is present, runtime detection will not be used.
490 * This configuration will crash at runtime if running on a CPU without the
491 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
492 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
493 */
494//#define MBEDTLS_AES_USE_HARDWARE_ONLY
495
Arto Kinnunen732ca322023-04-14 14:26:10 +0800496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200498 *
499 * Use less ROM for the Camellia implementation (saves about 768 bytes).
500 *
501 * Uncomment this macro to use less memory for Camellia.
502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200504
505/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200506 * \def MBEDTLS_CHECK_RETURN_WARNING
507 *
508 * If this macro is defined, emit a compile-time warning if application code
509 * calls a function without checking its return value, but the return value
510 * should generally be checked in portable applications.
511 *
512 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
513 * implemented. Otherwise this option has no effect.
514 *
515 * Uncomment to get warnings on using fallible functions without checking
516 * their return value.
517 *
518 * \note This feature is a work in progress.
519 * Warnings will be added to more functions in the future.
520 *
521 * \note A few functions are considered critical, and ignoring the return
522 * value of these functions will trigger a warning even if this
523 * macro is not defined. To completely disable return value check
524 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
525 */
526//#define MBEDTLS_CHECK_RETURN_WARNING
527
528/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200530 *
531 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200534
535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000537 *
538 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000541
542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000544 *
545 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000548
549/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100550 * \def MBEDTLS_CIPHER_MODE_OFB
551 *
552 * Enable Output Feedback mode (OFB) for symmetric ciphers.
553 */
554#define MBEDTLS_CIPHER_MODE_OFB
555
556/**
557 * \def MBEDTLS_CIPHER_MODE_XTS
558 *
559 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
560 */
561#define MBEDTLS_CIPHER_MODE_XTS
562
563/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000565 *
566 * Enable NULL cipher.
567 * Warning: Only do so when you know what you are doing. This allows for
568 * encryption or channels without any security!
569 *
Ronald Croncee42702021-04-26 11:34:44 +0200570 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
572 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
573 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
574 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
575 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
576 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
577 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
578 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
579 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
580 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
581 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
582 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
583 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
584 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
585 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
586 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
587 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
588 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
589 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000590 *
591 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000594
595/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100596 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200597 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100598 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
599 * specific padding modes in the cipher layer with cipher modes that support
600 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200601 *
602 * If you disable all padding modes, only full blocks can be used with CBC.
603 *
604 * Enable padding modes in the cipher layer.
605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606#define MBEDTLS_CIPHER_PADDING_PKCS7
607#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
608#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
609#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200610
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200611/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
612 *
613 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800614 * Without this, CTR_DRBG uses a 256-bit key
615 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200616 */
617//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
618
Paul Bakker48e93c82013-08-14 12:21:18 +0200619/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200620 * Enable the verified implementations of ECDH primitives from Project Everest
621 * (currently only Curve25519). This feature changes the layout of ECDH
622 * contexts and therefore is a compatibility break for applications that access
623 * fields of a mbedtls_ecdh_context structure directly. See also
624 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000625 *
626 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
627 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200628 */
629//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
630
631/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100632 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200633 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100634 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
635 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200636 *
637 * Comment macros to disable the curve and functions for it
638 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200639/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200640#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
641#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
642#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
643#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
644#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
645#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
646#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
647#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
648#define MBEDTLS_ECP_DP_BP256R1_ENABLED
649#define MBEDTLS_ECP_DP_BP384R1_ENABLED
650#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200651/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200652#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000653#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200654
655/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200657 *
658 * Enable specific 'modulo p' routines for each NIST prime.
659 * Depending on the prime and architecture, makes operations 4 to 8 times
660 * faster on the corresponding curve.
661 *
662 * Comment this macro to disable NIST curves optimisation.
663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200665
666/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200667 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100668 *
669 * Enable "non-blocking" ECC operations that can return early and be resumed.
670 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200671 * This allows various functions to pause by returning
672 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
673 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
674 * order to further progress and eventually complete their operation. This is
675 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
676 * number of ECC operations a function may perform before pausing; see
677 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100678 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200679 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200680 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100681 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100682 * This option:
683 * - Adds xxx_restartable() variants of existing operations in the
684 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100685 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
686 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100687 * - ECDSA: signature generation & verification;
688 * - PK: signature generation & verification;
689 * - X509: certificate chain verification.
690 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
691 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
692 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
693 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000694 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100695 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100696 * - verification of the server's key exchange signature;
697 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100698 * - generation of the client's signature if client authentication is used,
699 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100700 *
701 * \note In the cases above, the usual SSL/TLS functions, such as
702 * mbedtls_ssl_handshake(), can now return
703 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200704 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100705 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
706 * restartable operations in PK, X.509 and TLS (see above) are not
707 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100708 * PSA, and are not restartable. These are temporary limitations that
709 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200710 *
Ron Eldor19779c42018-11-05 16:58:13 +0200711 * \note This option only works with the default software implementation of
712 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100713 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100714 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100715 * Requires: MBEDTLS_ECP_C
716 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100717 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100718 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200719//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100720
721/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200722 * Uncomment to enable using new bignum code in the ECC modules.
723 *
724 * \warning This is currently experimental, incomplete and therefore should not
725 * be used in production.
726 */
727//#define MBEDTLS_ECP_WITH_MPI_UINT
728
729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200730 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100731 *
732 * Enable deterministic ECDSA (RFC 6979).
733 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
734 * may result in a compromise of the long-term signing key. This is avoided by
735 * the deterministic variant.
736 *
John Durkop36a82e52020-10-26 09:39:05 -0700737 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100738 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100739 * Comment this macro to disable deterministic ECDSA.
740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100742
743/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200745 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200746 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200747 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200748 * This enables the following ciphersuites (if other requisites are
749 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
751 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
752 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
753 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
754 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
755 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
756 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
757 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
758 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
759 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200762
763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200765 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200766 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200767 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200769 *
770 * This enables the following ciphersuites (if other requisites are
771 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
775 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
776 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
777 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
780 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
781 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100782 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100783 * \warning Using DHE constitutes a security risk as it
784 * is not possible to validate custom DH parameters.
785 * If possible, it is recommended users should consider
786 * preferring other methods of key exchange.
787 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100788 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200791
792/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200794 *
795 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
796 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200797 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200798 *
799 * This enables the following ciphersuites (if other requisites are
800 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
802 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
803 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
804 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
805 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
806 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200809
810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200812 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200813 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200814 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
816 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200817 *
818 * This enables the following ciphersuites (if other requisites are
819 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
823 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
824 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
825 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
828 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
829 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200830 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832
833/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200836 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
839 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
841 * This enables the following ciphersuites (if other requisites are
842 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200843 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
844 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
845 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
846 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
849 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
850 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
851 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
852 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200856#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200857
858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200861 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
864 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865 *
866 * This enables the following ciphersuites (if other requisites are
867 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
871 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
874 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
877 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100880 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100881 * \warning Using DHE constitutes a security risk as it
882 * is not possible to validate custom DH parameters.
883 * If possible, it is recommended users should consider
884 * preferring other methods of key exchange.
885 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100886 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200889
890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200892 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200893 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200895 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
896 * MBEDTLS_RSA_C
897 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
900 * This enables the following ciphersuites (if other requisites are
901 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200914
915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200917 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200918 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200919 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200920 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
921 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
922 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200923 *
924 * This enables the following ciphersuites (if other requisites are
925 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200938
939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100941 *
942 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
943 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200944 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
945 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
946 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100947 *
948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100962
963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965 *
966 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
967 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200968 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
969 * MBEDTLS_RSA_C
970 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100971 *
972 * This enables the following ciphersuites (if other requisites are
973 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
976 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
977 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
978 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
979 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
980 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
981 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
982 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
983 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100986
987/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200988 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
989 *
990 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
991 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200992 * \warning This is currently experimental. EC J-PAKE support is based on the
993 * Thread v1.0.0 specification; incompatible changes to the specification
994 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200995 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200996 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100997 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200998 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
999 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001000 * \warning If SHA-256 is provided only by a PSA driver, you must call
1001 * psa_crypto_init() before the first hanshake (even if
1002 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1003 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001004 * This enables the following ciphersuites (if other requisites are
1005 * enabled as well):
1006 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1007 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001008//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001009
1010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001012 *
1013 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1014 * RFC 5915 and RFC 5480.
1015 *
1016 * Currently this means parsing the SpecifiedECDomain choice of EC
1017 * parameters (only known groups are supported, not arbitrary domains, to
1018 * avoid validation issues).
1019 *
1020 * Disable if you only need to support RFC 5915 + 5480 key formats.
1021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001023
1024/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001025 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1026 *
1027 * Enable the support for parsing public keys of type Short Weierstrass
1028 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001029 * compressed point format. This parsing is done through ECP module's functions.
1030 *
1031 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1032 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1033 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001034 */
1035#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1036
1037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * Enable a dummy error function to make use of mbedtls_strerror() in
1041 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1042 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1045 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001046 *
1047 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001051
1052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001054 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001055 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001056 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001060
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001063 *
1064 * Enable functions that use the filesystem.
1065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001067
1068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001070 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001071 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001072 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001073 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001074 * application.
1075 *
1076 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001079
1080/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001082 *
1083 * Do not use built-in platform entropy functions.
1084 * This is useful if your platform does not support
1085 * standards like the /dev/urandom or Windows CryptoAPI.
1086 *
1087 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001090
1091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001093 *
1094 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1095 * default SHA-512 based one (if both are available).
1096 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001098 *
1099 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1100 * if you have performance concerns.
1101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * This option is only useful if both MBEDTLS_SHA256_C and
1103 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001106
1107/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001108 * \def MBEDTLS_ENTROPY_NV_SEED
1109 *
1110 * Enable the non-volatile (NV) seed file-based entropy source.
1111 * (Also enables the NV seed read/write functions in the platform layer)
1112 *
1113 * This is crucial (if not required) on systems that do not have a
1114 * cryptographic entropy source (in hardware or kernel) available.
1115 *
1116 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1117 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001118 * \note The read/write functions that are used by the entropy source are
1119 * determined in the platform layer, and can be modified at runtime and/or
1120 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1121 *
1122 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001123 * with regular fopen(), please make sure you make a seedfile with the
1124 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1125 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001126 * and written to or you will get an entropy source error! The default
1127 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1128 * bytes from the file.
1129 *
1130 * \note The entropy collector will write to the seed file before entropy is
1131 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001132 */
1133//#define MBEDTLS_ENTROPY_NV_SEED
1134
Ronald Cron71016a92020-08-28 19:01:50 +02001135/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001136 *
Ronald Cron71016a92020-08-28 19:01:50 +02001137 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001138 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001139 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1140 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001141 *
1142 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001143 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001144 */
Ronald Cron71016a92020-08-28 19:01:50 +02001145//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001146
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001147/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001149 *
1150 * Enable debugging of buffer allocator memory issues. Automatically prints
1151 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1152 * function for 'debug output' of allocated memory.
1153 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001155 *
1156 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001159
1160/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001162 *
1163 * Include backtrace information with each allocated block.
1164 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001166 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001167 *
1168 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001171
1172/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001174 *
1175 * Support external private RSA keys (eg from a HSM) in the PK layer.
1176 *
1177 * Comment this macro to disable support for external private RSA keys.
1178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001180
1181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001183 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001184 * Enable support for PKCS#1 v1.5 encoding.
1185 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001186 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001187 *
Paul Bakker48377d92013-08-30 12:06:24 +02001188 * This enables support for PKCS#1 v1.5 operations.
1189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001191
1192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001194 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001195 * Enable support for PKCS#1 v2.1 encoding.
1196 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001197 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001198 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001199 * \warning If using a hash that is only provided by PSA drivers, you must
1200 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001201 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001202 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001205
Steven Cooreman6801f082021-02-19 17:21:22 +01001206/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1207 *
1208 * Enable support for platform built-in keys. If you enable this feature,
1209 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1210 * See the documentation of that function for more information.
1211 *
1212 * Built-in keys are typically derived from a hardware unique key or
1213 * stored in a secure element.
1214 *
1215 * Requires: MBEDTLS_PSA_CRYPTO_C.
1216 *
1217 * \warning This interface is experimental and may change or be removed
1218 * without notice.
1219 */
1220//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1221
Ronald Cron3768ac12021-01-26 16:58:00 +01001222/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1223 *
1224 * Enable support for PSA crypto client.
1225 *
1226 * \note This option allows to include the code necessary for a PSA
1227 * crypto client when the PSA crypto implementation is not included in
1228 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1229 * code to set and get PSA key attributes.
1230 * The development of PSA drivers partially relying on the library to
1231 * fulfill the hardware gaps is another possible usage of this option.
1232 *
1233 * \warning This interface is experimental and may change or be removed
1234 * without notice.
1235 */
1236//#define MBEDTLS_PSA_CRYPTO_CLIENT
1237
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001238/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1239 *
1240 * Make the PSA Crypto module use an external random generator provided
1241 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1242 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001243 * \note This random generator must deliver random numbers with cryptographic
1244 * quality and high performance. It must supply unpredictable numbers
1245 * with a uniform distribution. The implementation of this function
1246 * is responsible for ensuring that the random generator is seeded
1247 * with sufficient entropy. If you have a hardware TRNG which is slow
1248 * or delivers non-uniform output, declare it as an entropy source
1249 * with mbedtls_entropy_add_source() instead of enabling this option.
1250 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001251 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001252 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1253 * and define a function called mbedtls_psa_external_get_random()
1254 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001255 * ```
1256 * psa_status_t mbedtls_psa_external_get_random(
1257 * mbedtls_psa_external_random_context_t *context,
1258 * uint8_t *output, size_t output_size, size_t *output_length);
1259 * );
1260 * ```
1261 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001262 * The function must fill the \c output buffer with \c output_size bytes
1263 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001264 *
1265 * Requires: MBEDTLS_PSA_CRYPTO_C
1266 *
1267 * \warning If you enable this option, code that uses the PSA cryptography
1268 * interface will not use any of the entropy sources set up for
1269 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1270 * enables.
1271 *
1272 * \note This option is experimental and may be removed without notice.
1273 */
1274//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1275
Paul Bakker9dcc3222011-03-08 14:16:06 +00001276/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001277 * \def MBEDTLS_PSA_CRYPTO_SPM
1278 *
1279 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1280 * Partition Manager) integration which separates the code into two parts: a
1281 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1282 * Environment).
1283 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001284 * If you enable this option, your build environment must include a header
1285 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1286 * header files, or in another directory on the compiler's include search
1287 * path). Alternatively, your platform may customize the header
1288 * `psa/crypto_platform.h`, in which case it can skip or replace the
1289 * inclusion of `"crypto_spe.h"`.
1290 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001291 * Module: library/psa_crypto.c
1292 * Requires: MBEDTLS_PSA_CRYPTO_C
1293 *
1294 */
1295//#define MBEDTLS_PSA_CRYPTO_SPM
1296
1297/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001298 * Uncomment to enable p256-m. This is an alternative implementation of
1299 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1300 * Compared to the default implementation:
1301 *
1302 * - p256-m has a much smaller code size and RAM footprint.
1303 * - p256-m is only available via the PSA API. This includes the pk module
1304 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1305 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1306 * over the core arithmetic, or deterministic derivation of keys.
1307 *
1308 * We recommend enabling this option if your application uses the PSA API
1309 * and the only elliptic curve support it needs is ECDH and ECDSA over
1310 * SECP256R1.
1311 *
1312 * If you enable this option, you do not need to enable any ECC-related
1313 * MBEDTLS_xxx option. You do need to separately request support for the
1314 * cryptographic mechanisms through the PSA API:
1315 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1316 * configuration;
1317 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1318 * - #PSA_WANT_ECC_SECP_R1_256;
1319 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1320 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1321 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1322 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1323 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001324 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001325 * \note To benefit from the smaller code size of p256-m, make sure that you
1326 * do not enable any ECC-related option not supported by p256-m: this
1327 * would cause the built-in ECC implementation to be built as well, in
1328 * order to provide the required option.
1329 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001330 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1331 * SECP256R1 are disabled as they are not supported by this driver.
1332 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1333 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001334 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001335 */
1336//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1337
1338/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001339 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001340 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001341 * Enable support for entropy injection at first boot. This feature is
1342 * required on systems that do not have a built-in entropy source (TRNG).
1343 * This feature is currently not supported on systems that have a built-in
1344 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001345 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001346 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001347 *
1348 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001349//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001350
1351/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001352 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001353 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001354 * Assume all buffers passed to PSA functions are owned exclusively by the
1355 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001356 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001357 * This option may be enabled if all buffers passed to any PSA function reside
1358 * in memory that is accessible only to the PSA function during its execution.
1359 *
1360 * This option MUST be disabled whenever buffer arguments are in memory shared
1361 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001362 * across a trust boundary.
1363 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001364 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001365 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001366 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001367 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001368 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001369//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001370
1371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001372 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001373 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001374 * Do not use the Chinese Remainder Theorem
1375 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001376 *
1377 * Uncomment this macro to disable the use of CRT in RSA.
1378 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001380//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001381
1382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001384 *
1385 * Enable the checkup functions (*_self_test).
1386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001387#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001388
1389/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001390 * \def MBEDTLS_SHA256_SMALLER
1391 *
1392 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1393 * lower performance.
1394 *
Adam Wolf039080f2019-09-10 09:53:08 -05001395 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001396 * performance and size. This version optimizes more aggressively for size at
1397 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1398 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1399 * 30%.
1400 *
1401 * Uncomment to enable the smaller implementation of SHA256.
1402 */
1403//#define MBEDTLS_SHA256_SMALLER
1404
1405/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001406 * \def MBEDTLS_SHA512_SMALLER
1407 *
1408 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1409 * lower performance.
1410 *
1411 * Uncomment to enable the smaller implementation of SHA512.
1412 */
1413//#define MBEDTLS_SHA512_SMALLER
1414
1415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001417 *
1418 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001419 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001420 * with other servers, only debugging of failures is harder.
1421 *
1422 * The advantage of not sending alert messages, is that no information is given
1423 * about reasons for failures thus preventing adversaries of gaining intel.
1424 *
1425 * Enable sending of all alert messages
1426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001428
1429/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001430 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1431 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001432 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001433 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001434 * in the underlying transport. The CID functionality is described
1435 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001436 *
1437 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001438 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1439 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1440 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001441 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001442 * The maximum lengths of outgoing and incoming CIDs can be configured
1443 * through the options
1444 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1445 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1446 *
1447 * Requires: MBEDTLS_SSL_PROTO_DTLS
1448 *
1449 * Uncomment to enable the Connection ID extension.
1450 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001451#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1452
1453
1454/**
1455 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1456 *
1457 * Defines whether RFC 9146 (default) or the legacy version
1458 * (version draft-ietf-tls-dtls-connection-id-05,
1459 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1460 * is used.
1461 *
1462 * Set the value to 0 for the standard version, and
1463 * 1 for the legacy draft version.
1464 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001465 * \deprecated Support for the legacy version of the DTLS
1466 * Connection ID feature is deprecated. Please
1467 * switch to the standardized version defined
1468 * in RFC 9146 enabled by utilizing
1469 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1470 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1471 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001472 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1473 */
1474#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001475
1476/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001477 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1478 *
1479 * Enable asynchronous external private key operations in SSL. This allows
1480 * you to configure an SSL connection to call an external cryptographic
1481 * module to perform private key operations instead of performing the
1482 * operation inside the library.
1483 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001484 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001485 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001486//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001487
1488/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001489 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1490 *
1491 * Enable serialization of the TLS context structures, through use of the
1492 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1493 *
1494 * This pair of functions allows one side of a connection to serialize the
1495 * context associated with the connection, then free or re-use that context
1496 * while the serialized state is persisted elsewhere, and finally deserialize
1497 * that state to a live context for resuming read/write operations on the
1498 * connection. From a protocol perspective, the state of the connection is
1499 * unaffected, in particular this is entirely transparent to the peer.
1500 *
1501 * Note: this is distinct from TLS session resumption, which is part of the
1502 * protocol and fully visible by the peer. TLS session resumption enables
1503 * establishing new connections associated to a saved session with shorter,
1504 * lighter handshakes, while context serialization is a local optimization in
1505 * handling a single, potentially long-lived connection.
1506 *
1507 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1508 * saved after the handshake to allow for more efficient serialization, so if
1509 * you don't need this feature you'll save RAM by disabling it.
1510 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001511 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1512 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001513 * Comment to disable the context serialization APIs.
1514 */
1515#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1516
1517/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001518 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001519 *
1520 * Enable the debug messages in SSL module for all issues.
1521 * Debug messages have been disabled in some places to prevent timing
1522 * attacks due to (unbalanced) debugging function calls.
1523 *
1524 * If you need all error reporting you should enable this during debugging,
1525 * but remove this for production servers that should log as well.
1526 *
1527 * Uncomment this macro to report all debug messages on errors introducing
1528 * a timing side-channel.
1529 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001534 *
1535 * Enable support for Encrypt-then-MAC, RFC 7366.
1536 *
1537 * This allows peers that both support it to use a more robust protection for
1538 * ciphersuites using CBC, providing deep resistance against timing attacks
1539 * on the padding or underlying cipher.
1540 *
1541 * This only affects CBC ciphersuites, and is useless if none is defined.
1542 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001543 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001544 *
1545 * Comment this macro to disable support for Encrypt-then-MAC
1546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001550 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001551 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1552 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001553 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001554 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001555 * attacks, but it is recommended to always use it (even if you disable
1556 * renegotiation), since it actually fixes a more fundamental issue in the
1557 * original SSL/TLS design, and has implications beyond Triple Handshake.
1558 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001559 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001560 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001561 * Comment this macro to disable support for Extended Master Secret.
1562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001564
Paul Bakkerd66f0702013-01-31 16:57:45 +01001565/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001566 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1567 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001568 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001569 * giving access to the peer's certificate after completion of the handshake.
1570 *
1571 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1572 * recommended to disable this option for reduced RAM usage.
1573 *
1574 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1575 * defined, but always returns \c NULL.
1576 *
1577 * \note This option has no influence on the protection against the
1578 * triple handshake attack. Even if it is disabled, Mbed TLS will
1579 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001580 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001581 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001582 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001583 *
1584 * Comment this macro to disable storing the peer's certificate
1585 * after the handshake.
1586 */
1587#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1588
1589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001591 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001592 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001593 *
1594 * The two main uses of renegotiation are (1) refresh keys on long-lived
1595 * connections and (2) client authentication after the initial handshake.
1596 * If you don't need renegotiation, it's probably better to disable it, since
1597 * it has been associated with security issues in the past and is easy to
1598 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001599 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001600 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1601 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001602 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001603 *
1604 * \note Even if this option is disabled, both client and server are aware
1605 * of the Renegotiation Indication Extension (RFC 5746) used to
1606 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1607 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1608 * configuration of this extension).
1609 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001611#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001612
1613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001615 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001616 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001617 *
1618 * Comment this macro to disable support for the max_fragment_length extension
1619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001621
1622/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001623 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1624 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001625 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001626 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001627 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1628 *
1629 * Uncomment this macro to enable support for the record_size_limit extension
1630 */
1631//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1632
1633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001635 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001636 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001637 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001638 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001639 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1640 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001641 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001642 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001643 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001644 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1645 * are only provided by PSA drivers, you must call psa_crypto_init() before
1646 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001647 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001648 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001651
1652/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001653 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001654 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001655 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001656 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001657 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001658 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001659 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001660 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001661 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001662 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001663 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1664 * directly performed by TLS 1.3 code. As a consequence, you must
1665 * call psa_crypto_init() before the first TLS 1.3 handshake.
1666 *
1667 * \note Cryptographic operations performed indirectly via another module
1668 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1669 * running handshake hash) only use PSA crypto if
1670 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001671 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001672 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001673 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001674#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001675
1676/**
Ronald Cronab65c522021-11-24 10:47:20 +01001677 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1678 *
1679 * Enable TLS 1.3 middlebox compatibility mode.
1680 *
1681 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1682 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1683 * expecting TLS 1.2 traffic.
1684 *
1685 * Turning on the compatibility mode comes at the cost of a few added bytes
1686 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1687 * that don't use it. Therefore, unless transmission bandwidth is critical and
1688 * you know that middlebox compatibility issues won't occur, it is therefore
1689 * recommended to set this option.
1690 *
1691 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001692 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1693 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001694 *
1695 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001696#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001697
1698/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001699 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1700 *
1701 * Enable TLS 1.3 PSK key exchange mode.
1702 *
1703 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1704 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1705 * effect on the build.
1706 *
1707 */
1708#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1709
1710/**
1711 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1712 *
1713 * Enable TLS 1.3 ephemeral key exchange mode.
1714 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001715 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001716 * MBEDTLS_X509_CRT_PARSE_C
1717 * and at least one of:
1718 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1719 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001720 *
1721 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1722 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1723 * effect on the build.
1724 *
1725 */
1726#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1727
1728/**
1729 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1730 *
1731 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1732 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001733 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001734 *
1735 * Comment to disable support for the PSK ephemeral key exchange mode in
1736 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1737 * have any effect on the build.
1738 *
1739 */
1740#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1741
1742/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 * \def MBEDTLS_SSL_EARLY_DATA
1744 *
1745 * Enable support for RFC 8446 TLS 1.3 early data.
1746 *
1747 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1748 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1749 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1750 *
1751 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1752 * is not enabled, this option does not have any effect on the build.
1753 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001754 * \note The maximum amount of early data can be set with
1755 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1756 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001758//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001759
1760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001762 *
1763 * Enable support for DTLS (all available versions).
1764 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001765 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001766 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001767 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001768 *
1769 * Comment this macro to disable support for DTLS
1770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001772
1773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001775 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001776 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001777 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001778 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001781
1782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001784 *
1785 * Enable support for the anti-replay mechanism in DTLS.
1786 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 * Requires: MBEDTLS_SSL_TLS_C
1788 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001789 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001790 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001791 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001792 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001793 * Comment this to disable anti-replay in DTLS.
1794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001796
1797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001799 *
1800 * Enable support for HelloVerifyRequest on DTLS servers.
1801 *
1802 * This feature is highly recommended to prevent DTLS servers being used as
1803 * amplifiers in DoS attacks against other hosts. It should always be enabled
1804 * unless you know for sure amplification cannot be a problem in the
1805 * environment in which your server operates.
1806 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001807 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001808 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001809 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001810 *
1811 * Comment this to disable support for HelloVerifyRequest.
1812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001814
1815/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001816 * \def MBEDTLS_SSL_DTLS_SRTP
1817 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001818 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001819 * through the use_srtp extension.
1820 *
1821 * \note This feature provides the minimum functionality required
1822 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1823 * the associated SRTP packet protection key material.
1824 * In particular, the SRTP packet protection itself, as well as the
1825 * demultiplexing of RTP and DTLS packets at the datagram layer
1826 * (see Section 5 of RFC 5764), are not handled by this feature.
1827 * Instead, after successful completion of a handshake negotiating
1828 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001829 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001830 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1831 * (this is implemented in the SSL example programs).
1832 * The resulting key should then be passed to an SRTP stack.
1833 *
1834 * Setting this option enables the runtime API
1835 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1836 * through which the supported DTLS-SRTP protection
1837 * profiles can be configured. You must call this API at
1838 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001839 *
1840 * Requires: MBEDTLS_SSL_PROTO_DTLS
1841 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001842 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001843 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001844//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001845
1846/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001847 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1848 *
1849 * Enable server-side support for clients that reconnect from the same port.
1850 *
1851 * Some clients unexpectedly close the connection and try to reconnect using the
1852 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001853 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001854 * flag enables that support.
1855 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001856 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001857 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001858 * Comment this to disable support for clients reusing the source port.
1859 */
1860#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1861
1862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001864 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001865 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001866 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001867 * session store remains the responsibility of the application, though).
1868 * Server-side, you also need to provide callbacks for writing and parsing
1869 * tickets, including authenticated encryption and key management. Example
1870 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001871 *
1872 * Comment this macro to disable support for SSL session tickets
1873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001875
1876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001878 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001879 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001880 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001882 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001883 * Comment this macro to disable support for server name indication in SSL
1884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001886
1887/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001888 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1889 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001890 * When this option is enabled, the SSL buffer will be resized automatically
1891 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001892 *
1893 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001894 */
1895//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1896
1897/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001898 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1899 *
1900 * Enable testing of the constant-flow nature of some sensitive functions with
1901 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001902 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001903 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001904 * This setting requires compiling with clang -fsanitize=memory. The test
1905 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001906 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001907 * \warning This macro is only used for extended testing; it is not considered
1908 * part of the library's API, so it may change or disappear at any time.
1909 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001910 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001911 */
1912//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1913
1914/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001915 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1916 *
1917 * Enable testing of the constant-flow nature of some sensitive functions with
1918 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001919 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001920 *
1921 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001922 * testing if the tests suites are run with valgrind's memcheck. This can be
1923 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1924 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001925 *
1926 * \warning This macro is only used for extended testing; it is not considered
1927 * part of the library's API, so it may change or disappear at any time.
1928 *
1929 * Uncomment to enable testing of the constant-flow nature of selected code.
1930 */
1931//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1932
1933/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001934 * \def MBEDTLS_TEST_HOOKS
1935 *
1936 * Enable features for invasive testing such as introspection functions and
1937 * hooks for fault injection. This enables additional unit tests.
1938 *
1939 * Merely enabling this feature should not change the behavior of the product.
1940 * It only adds new code, and new branching points where the default behavior
1941 * is the same as when this feature is disabled.
1942 * However, this feature increases the attack surface: there is an added
1943 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1944 * Therefore this feature must never be enabled in production.
1945 *
1946 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1947 * information.
1948 *
1949 * Uncomment to enable invasive tests.
1950 */
1951//#define MBEDTLS_TEST_HOOKS
1952
1953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001955 *
1956 * Provide your own alternate threading implementation.
1957 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001959 *
1960 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001963
1964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001966 *
1967 * Enable the pthread wrapper layer for the threading layer.
1968 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001970 *
1971 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001974
1975/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001976 * \def MBEDTLS_USE_PSA_CRYPTO
1977 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001978 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1979 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001980 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001981 * \note Development of this option is currently in progress, and parts of Mbed
1982 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001983 * will still continue to work as usual, so enabling this option should not
1984 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001985 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001986 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001987 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1988 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001989 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001990 * \note An important and desirable effect of this option is that it allows
1991 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1992 * 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 +02001993 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001994 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1995 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001996 *
1997 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001998 *
1999 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002000 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002001 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002003//#define MBEDTLS_USE_PSA_CRYPTO
2004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002006 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2007 *
John Durkop185764f2020-10-12 21:32:12 -07002008 * This setting allows support for cryptographic mechanisms through the PSA
2009 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002010 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002011 * When this option is disabled, the PSA API exposes the cryptographic
2012 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2013 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002014 *
2015 * When this option is enabled, the PSA API exposes the cryptographic
2016 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2017 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2018 * automatically enabled if required (i.e. if no PSA driver provides the
2019 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2020 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002021 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002022 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002023 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002024 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002025 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2026 * symbols is not completely finalized yet, and the configuration
2027 * tooling is not ideally adapted to having two separate configuration
2028 * files.
2029 * Future minor releases of Mbed TLS may make minor changes to those
2030 * symbols, but we will endeavor to provide a transition path.
2031 * Nonetheless, this option is considered mature enough to use in
2032 * production, as long as you accept that you may need to make
2033 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002034 */
2035//#define MBEDTLS_PSA_CRYPTO_CONFIG
2036
2037/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002038 * \def MBEDTLS_VERSION_FEATURES
2039 *
2040 * Allow run-time checking of compile-time enabled features. Thus allowing users
2041 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002042 * support via mbedtls_version_check_feature().
2043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002044 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002045 *
2046 * Comment this to disable run-time checking and save ROM space
2047 */
2048#define MBEDTLS_VERSION_FEATURES
2049
2050/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002051 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2052 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002053 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002054 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2055 * the set of trusted certificates through a callback instead of a linked
2056 * list.
2057 *
2058 * This is useful for example in environments where a large number of trusted
2059 * certificates is present and storing them in a linked list isn't efficient
2060 * enough, or when the set of trusted certificates changes frequently.
2061 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002062 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002063 * `mbedtls_ssl_conf_ca_cb()` for more information.
2064 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002065 * Requires: MBEDTLS_X509_CRT_PARSE_C
2066 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002067 * Uncomment to enable trusted certificate callbacks.
2068 */
2069//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2070
2071/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002072 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002073 *
Chris Jones2c745862020-12-16 11:41:06 +00002074 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002075 *
Chris Jones2c745862020-12-16 11:41:06 +00002076 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002077 * and other functions/constants only used by these functions, thus reducing
2078 * the code footprint by several KB.
2079 */
Chris Jones2c745862020-12-16 11:41:06 +00002080//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002081
2082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002084 *
2085 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2086 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2087 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002088 * Requires: MBEDTLS_PKCS1_V21
2089 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002090 * Comment this macro to disallow using RSASSA-PSS in certificates.
2091 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002093/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002094
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002095/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002096 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002097 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002098 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002099 * \{
2100 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002101
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002104 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002105 * Enable AES-NI support on x86-64 or x86-32.
2106 *
2107 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002108 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002109 * - GCC, x86-64, target not explicitly supporting AESNI:
2110 * requires MBEDTLS_HAVE_ASM.
2111 * - GCC, x86-32, target not explicitly supporting AESNI:
2112 * not supported.
2113 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2114 * For this assembly-less implementation, you must currently compile
2115 * `library/aesni.c` and `library/aes.c` with machine options to enable
2116 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2117 * `clang -maes -mpclmul`.
2118 * - Non-x86 targets: this option is silently ignored.
2119 * - Other compilers: this option is silently ignored.
2120 *
2121 * \note
2122 * Above, "GCC" includes compatible compilers such as Clang.
2123 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002124 *
2125 * Module: library/aesni.c
2126 * Caller: library/aes.c
2127 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002128 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002129 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002130 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002133
2134/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002135 * \def MBEDTLS_AESCE_C
2136 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002137 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002138 *
2139 * Module: library/aesce.c
2140 * Caller: library/aes.c
2141 *
Jerry Yuf015a932023-04-25 10:38:03 +08002142 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002143 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002144 * \warning Runtime detection only works on Linux. For non-Linux operating
2145 * system, Armv8-A Cryptographic Extensions must be supported by
2146 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002147 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002148 * \note Minimum compiler versions for this feature when targeting aarch64
2149 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2150 * Minimum compiler versions for this feature when targeting 32-bit
2151 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002152 *
2153 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2154 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002155 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002156 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002157 */
2158#define MBEDTLS_AESCE_C
2159
2160/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002161 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002162 *
2163 * Enable the AES block cipher.
2164 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002165 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002166 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002167 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002168 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002170 * This module enables the following ciphersuites (if other requisites are
2171 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2173 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2174 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2175 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2180 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2181 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2184 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2185 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2186 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2187 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2188 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2189 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2198 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2199 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2200 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2201 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2202 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2203 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2204 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2205 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2206 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2207 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2208 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2209 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2210 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2211 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2212 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2213 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2214 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2215 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2216 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2217 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2218 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2219 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2220 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2221 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2222 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2223 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2224 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2225 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2226 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2227 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2228 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2229 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002230 *
Paul Bakkercff68422013-09-15 20:43:33 +02002231 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002234
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002237 *
2238 * Enable the generic ASN1 parser.
2239 *
2240 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002241 * Caller: library/x509.c
2242 * library/dhm.c
2243 * library/pkcs12.c
2244 * library/pkcs5.c
2245 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002248
2249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002251 *
2252 * Enable the generic ASN1 writer.
2253 *
2254 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002255 * Caller: library/ecdsa.c
2256 * library/pkwrite.c
2257 * library/x509_create.c
2258 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002259 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002262
2263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002265 *
2266 * Enable the Base64 module.
2267 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002268 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002269 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002270 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002271 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002274
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002275/**
Yanray Wange367e472023-10-31 17:23:04 +08002276 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2277 *
2278 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2279 *
2280 * \note This feature is incompatible with insecure block cipher,
2281 * MBEDTLS_DES_C, and cipher modes which always require decryption
2282 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002283 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2284 * this feature is incompatible with following supported PSA equivalence,
2285 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2286 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002287 *
2288 * Module: library/aes.c
2289 * library/aesce.c
2290 * library/aesni.c
2291 * library/aria.c
2292 * library/camellia.c
2293 * library/cipher.c
2294 */
2295//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2296
2297/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002299 *
Paul Bakker9a736322012-11-14 12:39:52 +00002300 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002301 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002302 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002303 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002304 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002305 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002307 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002308 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002310 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002312 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002313 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002315#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002316
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002319 *
2320 * Enable the Camellia block cipher.
2321 *
Paul Bakker38119b12009-01-10 23:31:23 +00002322 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002323 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002324 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002325 * This module enables the following ciphersuites (if other requisites are
2326 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2328 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2329 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2333 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2334 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2335 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2336 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2337 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2341 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2343 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2345 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2346 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2347 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2348 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2349 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2350 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2351 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2352 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2356 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2357 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2358 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2359 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2361 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2362 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2363 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2364 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2365 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2366 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2367 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002371
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002372/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002373 * \def MBEDTLS_ARIA_C
2374 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002375 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002376 *
2377 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002378 * Caller: library/cipher.c
2379 *
2380 * This module enables the following ciphersuites (if other requisites are
2381 * enabled as well):
2382 *
2383 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2384 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2385 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2386 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2387 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2388 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2389 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2390 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2391 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2393 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2395 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2396 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2397 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2398 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2399 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2400 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2401 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2402 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2403 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2404 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2405 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2406 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2407 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2408 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2409 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2410 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2411 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2412 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2413 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2414 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2415 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2416 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2417 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2418 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2419 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2420 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002421 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002422#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002423
2424/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002426 *
2427 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2428 *
2429 * Module: library/ccm.c
2430 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002431 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2432 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002433 *
2434 * This module enables the AES-CCM ciphersuites, if other requisites are
2435 * enabled as well.
2436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002438
2439/**
Daniel King34b822c2016-05-15 17:28:08 -03002440 * \def MBEDTLS_CHACHA20_C
2441 *
2442 * Enable the ChaCha20 stream cipher.
2443 *
2444 * Module: library/chacha20.c
2445 */
2446#define MBEDTLS_CHACHA20_C
2447
2448/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002449 * \def MBEDTLS_CHACHAPOLY_C
2450 *
2451 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2452 *
2453 * Module: library/chachapoly.c
2454 *
2455 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2456 */
2457#define MBEDTLS_CHACHAPOLY_C
2458
2459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002461 *
2462 * Enable the generic cipher layer.
2463 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002464 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002465 * Caller: library/ccm.c
2466 * library/cmac.c
2467 * library/gcm.c
2468 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002469 * library/pkcs12.c
2470 * library/pkcs5.c
2471 * library/psa_crypto_aead.c
2472 * library/psa_crypto_mac.c
2473 * library/ssl_ciphersuites.c
2474 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002475 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002476 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2477 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002478 *
2479 * Uncomment to enable generic cipher wrappers.
2480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002482
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002483/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002484 * \def MBEDTLS_CMAC_C
2485 *
Simon Butcher327398a2016-10-05 14:09:11 +01002486 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2487 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002488 *
Thomas Daubneyefc65e12024-06-05 12:56:46 +01002489 * \note When the underlying implementation of the CMAC algorithm is provided
2490 * by an alternate implementation, that alternate implementation may opt
2491 * to not support AES-192 or 3DES as underlying block ciphers for the CMAC
2492 * operation.
Steven Cooremanc338cef2021-04-26 11:24:44 +02002493 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002494 * Module: library/cmac.c
2495 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002496 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002497 *
2498 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002499#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002500
2501/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002503 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002504 * Enable the CTR_DRBG AES-based random generator.
2505 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002506 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002507 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002508 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2509 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2510 * is used.
2511 *
2512 * \warning When using PSA, the user should call `psa_crypto_init()` before
2513 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2514 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002515 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2516 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002517 * \note To achieve a 256-bit security strength with CTR_DRBG,
2518 * you must use AES-256 *and* use sufficient entropy.
2519 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002520 *
2521 * Module: library/ctr_drbg.c
2522 * Caller:
2523 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002524 * Requires: MBEDTLS_AES_C or
2525 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2526 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002527 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002528 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002531
2532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002534 *
2535 * Enable the debug functions.
2536 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002537 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002538 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002539 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002540 * library/ssl_tls12_*.c
2541 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002542 *
2543 * This module provides debugging functions.
2544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002546
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002547/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002549 *
2550 * Enable the DES block cipher.
2551 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002552 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002553 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002554 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002555 *
Paul Bakkercff68422013-09-15 20:43:33 +02002556 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002557 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002558 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002559 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002562
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002563/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002565 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002566 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002567 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002568 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002569 * Caller: library/ssl_tls.c
2570 * library/ssl*_client.c
2571 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002572 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002573 * This module is used by the following key exchanges:
2574 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002575 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002576 * \warning Using DHE constitutes a security risk as it
2577 * is not possible to validate custom DH parameters.
2578 * If possible, it is recommended users should consider
2579 * preferring other methods of key exchange.
2580 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002581 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002584
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002587 *
2588 * Enable the elliptic curve Diffie-Hellman library.
2589 *
2590 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002591 * Caller: library/psa_crypto.c
2592 * library/ssl_tls.c
2593 * library/ssl*_client.c
2594 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002595 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002596 * This module is used by the following key exchanges:
2597 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002598 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002602
2603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002605 *
2606 * Enable the elliptic curve DSA library.
2607 *
2608 * Module: library/ecdsa.c
2609 * Caller:
2610 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002611 * This module is used by the following key exchanges:
2612 * ECDHE-ECDSA
2613 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002614 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2615 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2616 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002619
2620/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002621 * \def MBEDTLS_ECJPAKE_C
2622 *
2623 * Enable the elliptic curve J-PAKE library.
2624 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002625 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2626 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002627 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002628 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002629 * Module: library/ecjpake.c
2630 * Caller:
2631 *
2632 * This module is used by the following key exchanges:
2633 * ECJPAKE
2634 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002635 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002636 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002637 * \warning If using a hash that is only provided by PSA drivers, you must
2638 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002639 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002640#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002641
2642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002644 *
2645 * Enable the elliptic curve over GF(p) library.
2646 *
2647 * Module: library/ecp.c
2648 * Caller: library/ecdh.c
2649 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002650 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002651 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002655
2656/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002658 *
2659 * Enable the platform-specific entropy code.
2660 *
2661 * Module: library/entropy.c
2662 * Caller:
2663 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002665 *
2666 * This module provides a generic entropy pool
2667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002669
2670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002672 *
2673 * Enable error code to error string conversion.
2674 *
2675 * Module: library/error.c
2676 * Caller:
2677 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002679 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002681
2682/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002684 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002685 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002686 *
2687 * Module: library/gcm.c
2688 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002689 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2690 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002691 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002692 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2693 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002696
2697/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002698 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002699 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002700 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002701 * Can significantly increase throughput on systems without GCM hardware
2702 * acceleration (e.g., AESNI, AESCE).
2703 *
Matthias Schulz78266782024-02-08 13:54:48 +01002704 * The mbedtls_gcm_context size will increase by 3840 bytes.
2705 * The code size will increase by roughly 344 bytes.
2706 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002707 * Module: library/gcm.c
2708 *
2709 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002710 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002711//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002712
2713/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002714 * \def MBEDTLS_HKDF_C
2715 *
2716 * Enable the HKDF algorithm (RFC 5869).
2717 *
2718 * Module: library/hkdf.c
2719 * Caller:
2720 *
2721 * Requires: MBEDTLS_MD_C
2722 *
2723 * This module adds support for the Hashed Message Authentication Code
2724 * (HMAC)-based key derivation function (HKDF).
2725 */
2726#define MBEDTLS_HKDF_C
2727
2728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002730 *
2731 * Enable the HMAC_DRBG random generator.
2732 *
2733 * Module: library/hmac_drbg.c
2734 * Caller:
2735 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002737 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002738 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002741
2742/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002743 * \def MBEDTLS_LMS_C
2744 *
2745 * Enable the LMS stateful-hash asymmetric signature algorithm.
2746 *
2747 * Module: library/lms.c
2748 * Caller:
2749 *
Raef Colesab4f8742022-09-01 12:24:31 +01002750 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002751 *
Raef Colesab4f8742022-09-01 12:24:31 +01002752 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002753 */
2754#define MBEDTLS_LMS_C
2755
2756/**
Raef Colesab4f8742022-09-01 12:24:31 +01002757 * \def MBEDTLS_LMS_PRIVATE
2758 *
2759 * Enable LMS private-key operations and signing code. Functions enabled by this
2760 * option are experimental, and should not be used in production.
2761 *
2762 * Requires: MBEDTLS_LMS_C
2763 *
2764 * Uncomment to enable the LMS signature algorithm and private key operations.
2765 */
Raef Coles5127e852022-10-07 10:35:56 +01002766//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002767
2768/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002769 * \def MBEDTLS_NIST_KW_C
2770 *
2771 * Enable the Key Wrapping mode for 128-bit block ciphers,
2772 * as defined in NIST SP 800-38F. Only KW and KWP modes
2773 * are supported. At the moment, only AES is approved by NIST.
2774 *
2775 * Module: library/nist_kw.c
2776 *
2777 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2778 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002779#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002780
2781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002783 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002784 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002785 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002786 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2787 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002788 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002789 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002790 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002791 * Caller: library/constant_time.c
2792 * library/ecdsa.c
2793 * library/ecjpake.c
2794 * library/hkdf.c
2795 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002796 * library/pk.c
2797 * library/pkcs5.c
2798 * library/pkcs12.c
2799 * library/psa_crypto_ecp.c
2800 * library/psa_crypto_rsa.c
2801 * library/rsa.c
2802 * library/ssl_cookie.c
2803 * library/ssl_msg.c
2804 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002805 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002806 * library/x509_crt.c
2807 * library/x509write_crt.c
2808 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002809 *
2810 * Uncomment to enable generic message digest wrappers.
2811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002813
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002816 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002817 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002818 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002819 * Module: library/md5.c
2820 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002821 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002822 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002823 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002824 * This module is required for TLS 1.2 depending on the handshake parameters.
2825 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2826 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002827 *
2828 * \warning MD5 is considered a weak message digest and its use constitutes a
2829 * security risk. If possible, we recommend avoiding dependencies on
2830 * it, and considering stronger message digests instead.
2831 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002834
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002837 *
2838 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002839 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002840 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002841 *
2842 * Module: library/memory_buffer_alloc.c
2843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002845 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002846 *
2847 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002850
2851/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002853 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002854 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2855 *
Simon Butcherd567a232016-03-09 20:19:21 +00002856 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2857 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002858 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002859 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002860 * \note See also our Knowledge Base article about porting to a new
2861 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002862 * 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 +00002863 *
Andres AG788aa4a2016-09-14 14:32:09 +01002864 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002865 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002866 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002869
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002872 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002873 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002874 *
2875 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002876 * Caller: library/asn1write.c
2877 * library/pkcs5.c
2878 * library/pkparse.c
2879 * library/pkwrite.c
2880 * library/rsa.c
2881 * library/x509.c
2882 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002883 * library/x509_crl.c
2884 * library/x509_crt.c
2885 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002886 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002887 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002888 *
2889 * This modules translates between OIDs and internal values.
2890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002892
2893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002895 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002896 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002897 *
2898 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002899 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002900 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002901 * library/x509_crl.c
2902 * library/x509_crt.c
2903 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002904 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002906 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2907 *
2908 * \warning When parsing password-protected files, if MD5 is provided only by
2909 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002910 *
Paul Bakkercff68422013-09-15 20:43:33 +02002911 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002914
2915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002917 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002918 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002919 *
2920 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002921 * Caller: library/pkwrite.c
2922 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002923 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002924 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002926 *
2927 * This modules adds support for encoding / writing PEM files.
2928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002930
2931/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002933 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002934 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002935 *
2936 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002937 * Caller: library/psa_crypto_rsa.c
2938 * library/ssl_tls.c
2939 * library/ssl*_client.c
2940 * library/ssl*_server.c
2941 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002942 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002943 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002944 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002945 * Uncomment to enable generic public key wrappers.
2946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002948
2949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002951 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002952 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002953 *
2954 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002955 * Caller: library/x509_crt.c
2956 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002957 *
Yanray Wang072a0682023-12-05 10:53:04 +08002958 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002959 *
2960 * Uncomment to enable generic public key parse functions.
2961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002963
2964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002966 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002967 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002968 *
2969 * Module: library/pkwrite.c
2970 * Caller: library/x509write.c
2971 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002972 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002973 *
2974 * Uncomment to enable generic public key write functions.
2975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002977
2978/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002980 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002981 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002982 *
2983 * Module: library/pkcs5.c
2984 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002985 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002986 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002987 * \warning If using a hash that is only provided by PSA drivers, you must
2988 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002989 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002990 * This module adds support for the PKCS#5 functions.
2991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002993
2994/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002995 * \def MBEDTLS_PKCS7_C
2996 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002997 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002998 * RFC Link - https://tools.ietf.org/html/rfc2315
2999 *
3000 * Module: library/pkcs7.c
3001 *
3002 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003003 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3004 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003005 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003006 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003007 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003008#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003009
3010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003012 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003013 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003014 * Adds algorithms for parsing PKCS#8 encrypted private keys
3015 *
3016 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003017 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003018 *
Valerio Settie98ad592023-12-28 10:42:12 +01003019 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3020 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003021 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003022 * \warning If using a hash that is only provided by PSA drivers, you must
3023 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003024 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003025 * This module enables PKCS#12 functions.
3026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003028
3029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003031 *
3032 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003033 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3036 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003037 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003038 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003039 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003040 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003041 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003042 * Module: library/platform.c
3043 * Caller: Most other .c files
3044 *
3045 * This module enables abstraction of common (libc) functions.
3046 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003047#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003048
3049/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003050 * \def MBEDTLS_POLY1305_C
3051 *
3052 * Enable the Poly1305 MAC algorithm.
3053 *
3054 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003055 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003056 */
3057#define MBEDTLS_POLY1305_C
3058
3059/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003060 * \def MBEDTLS_PSA_CRYPTO_C
3061 *
3062 * Enable the Platform Security Architecture cryptography API.
3063 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003064 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003065 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003066 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003067 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003068 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3069 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3070 * is enabled in PSA (unless it's fully accelerated, see
3071 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003072 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003073#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003074
3075/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003076 * \def MBEDTLS_PSA_CRYPTO_SE_C
3077 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003078 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003079 * cryptography API.
3080 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003081 * \deprecated This feature is deprecated. Please switch to the PSA driver
3082 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003083 *
Ryan Everett32a64582024-03-05 18:16:18 +00003084 * \warning This feature is not thread-safe, and should not be used in a
3085 * multi-threaded environment.
3086 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003087 * Module: library/psa_crypto_se.c
3088 *
3089 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3090 *
3091 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003092//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003093
3094/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003095 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3096 *
3097 * Enable the Platform Security Architecture persistent key storage.
3098 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003099 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003100 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003101 * Requires: MBEDTLS_PSA_CRYPTO_C,
3102 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3103 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003104 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003105#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003106
3107/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003108 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003109 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003110 * Enable the emulation of the Platform Security Architecture
3111 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003112 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003113 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003114 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003115 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003116 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003117#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003118
3119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003121 *
3122 * Enable the RIPEMD-160 hash algorithm.
3123 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003124 * Module: library/ripemd160.c
3125 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003126 *
3127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003129
3130/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003132 *
3133 * Enable the RSA public-key cryptosystem.
3134 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003135 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003136 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003137 * Caller: library/pk.c
3138 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003140 * library/ssl*_client.c
3141 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003143 * This module is used by the following key exchanges:
3144 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003145 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003149
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003152 *
3153 * Enable the SHA1 cryptographic hash algorithm.
3154 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003155 * Module: library/sha1.c
3156 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003157 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003158 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003159 * This module is required for TLS 1.2 depending on the handshake parameters,
3160 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003161 *
3162 * \warning SHA-1 is considered a weak message digest and its use constitutes
3163 * a security risk. If possible, we recommend avoiding dependencies
3164 * on it, and considering stronger message digests instead.
3165 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003168
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003169/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003170 * \def MBEDTLS_SHA224_C
3171 *
3172 * Enable the SHA-224 cryptographic hash algorithm.
3173 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003174 * Module: library/sha256.c
3175 * Caller: library/md.c
3176 * library/ssl_cookie.c
3177 *
3178 * This module adds support for SHA-224.
3179 */
3180#define MBEDTLS_SHA224_C
3181
3182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003184 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003185 * Enable the SHA-256 cryptographic hash algorithm.
3186 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003187 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003188 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003189 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003190 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003191 * library/ssl*_client.c
3192 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003193 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003194 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003195 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003198
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003199/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003200 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003201 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003202 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3203 * with the ARMv8 cryptographic extensions if they are available at runtime.
3204 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003205 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003206 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003207 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003208 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003209 * \note Minimum compiler versions for this feature are Clang 4.0,
3210 * armclang 6.6 or GCC 6.0.
3211 *
3212 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3213 * armclang <= 6.9
3214 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003215 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3216 * That name is deprecated, but may still be used as an alternative form for this
3217 * option.
3218 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003219 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3220 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003221 *
3222 * Requires: MBEDTLS_SHA256_C.
3223 *
3224 * Module: library/sha256.c
3225 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003226 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003227 * and use them if available.
3228 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003229//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003230
Dave Rodgmand85277c2023-10-13 09:22:54 +01003231/**
3232 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3233 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003234 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003235 * This name is now deprecated, but may still be used as an alternative form for
3236 * this option.
3237 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003238//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3239
3240/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003241 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003242 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003243 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3244 * with the ARMv8 cryptographic extensions, which must be available at runtime
3245 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003246 *
3247 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003248 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003249 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003250 * \note Minimum compiler versions for this feature are Clang 4.0,
3251 * armclang 6.6 or GCC 6.0.
3252 *
3253 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3254 * armclang <= 6.9
3255 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003256 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003257 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003258 * option.
3259 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003260 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3261 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003262 *
3263 * Requires: MBEDTLS_SHA256_C.
3264 *
3265 * Module: library/sha256.c
3266 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003267 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003268 * unconditionally.
3269 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003270//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003271
Dave Rodgmand85277c2023-10-13 09:22:54 +01003272/**
3273 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3274 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003275 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003276 * This name is now deprecated, but may still be used as an alternative form for
3277 * this option.
3278 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003279//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3280
3281/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003282 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003283 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003284 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003285 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003286 * Module: library/sha512.c
3287 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003288 * library/psa_crypto_hash.c
3289 * library/ssl_tls.c
3290 * library/ssl*_client.c
3291 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003292 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003293 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003294 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003295#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003296
3297/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003298 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003299 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003300 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003301 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003302 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003303 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003304 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003305 * library/ssl_tls.c
3306 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003307 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003308 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003311
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003312/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003313 * \def MBEDTLS_SHA3_C
3314 *
3315 * Enable the SHA3 cryptographic hash algorithm.
3316 *
3317 * Module: library/sha3.c
3318 *
3319 * This module adds support for SHA3.
3320 */
3321#define MBEDTLS_SHA3_C
3322
3323/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003324 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3325 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003326 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3327 * with the ARMv8 cryptographic extensions if they are available at runtime.
3328 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003329 *
3330 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3331 * for a non-Aarch64 build it will be silently ignored.
3332 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003333 * \note Minimum compiler versions for this feature are Clang 7.0,
3334 * armclang 6.9 or GCC 8.0.
3335 *
3336 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3337 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003338 *
3339 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3340 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3341 *
3342 * Requires: MBEDTLS_SHA512_C.
3343 *
3344 * Module: library/sha512.c
3345 *
3346 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3347 * and use them if available.
3348 */
3349//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3350
3351/**
3352 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3353 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003354 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3355 * with the ARMv8 cryptographic extensions, which must be available at runtime
3356 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003357 *
3358 * \note This allows builds with a smaller code size than with
3359 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3360 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003361 * \note Minimum compiler versions for this feature are Clang 7.0,
3362 * armclang 6.9 or GCC 8.0.
3363 *
3364 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3365 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003366 *
3367 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3368 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3369 *
3370 * Requires: MBEDTLS_SHA512_C.
3371 *
3372 * Module: library/sha512.c
3373 *
3374 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3375 * unconditionally.
3376 */
3377//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3378
3379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003381 *
3382 * Enable simple SSL cache implementation.
3383 *
3384 * Module: library/ssl_cache.c
3385 * Caller:
3386 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003390
3391/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003393 *
3394 * Enable basic implementation of DTLS cookies for hello verification.
3395 *
3396 * Module: library/ssl_cookie.c
3397 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003400
3401/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003402 * \def MBEDTLS_SSL_TICKET_C
3403 *
3404 * Enable an implementation of TLS server-side callbacks for session tickets.
3405 *
3406 * Module: library/ssl_ticket.c
3407 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003408 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003409 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3410 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003411 */
3412#define MBEDTLS_SSL_TICKET_C
3413
3414/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003416 *
3417 * Enable the SSL/TLS client code.
3418 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003419 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003420 * Caller:
3421 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003423 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 * This module is required for SSL/TLS client support.
3425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003427
Paul Bakker9a736322012-11-14 12:39:52 +00003428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003430 *
3431 * Enable the SSL/TLS server code.
3432 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003433 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003434 * Caller:
3435 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003437 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003438 * This module is required for SSL/TLS server support.
3439 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003441
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003442/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003444 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003445 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003446 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003447 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003448 * Caller: library/ssl*_client.c
3449 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003450 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3452 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003453 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003454 * This module is required for SSL/TLS.
3455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003457
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003458/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003460 *
3461 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003462 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003463 * contexts are not shared between threads. If you do intend to use contexts
3464 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003465 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003466 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003467 *
3468 * Module: library/threading.c
3469 *
3470 * This allows different threading implementations (self-implemented or
3471 * provided).
3472 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473 * You will have to enable either MBEDTLS_THREADING_ALT or
3474 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003475 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003476 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003479
3480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003482 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003483 * Enable the semi-portable timing interface.
3484 *
Simon Butcherd567a232016-03-09 20:19:21 +00003485 * \note The provided implementation only works on POSIX/Unix (including Linux,
3486 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003487 * module and provide your own implementations of the callbacks needed by
3488 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3489 * your own implementation of the whole module by setting
3490 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003491 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003492 * \note The timing module will include time.h on suitable platforms
3493 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3494 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3495 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003496 * \note See also our Knowledge Base article about porting to a new
3497 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003498 * 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 +00003499 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003500 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003503
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003506 *
3507 * Enable run-time version information.
3508 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003509 * Module: library/version.c
3510 *
3511 * This module provides run-time version information.
3512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003514
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003515/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003517 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003518 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003519 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003521 * Caller: library/x509_crl.c
3522 * library/x509_crt.c
3523 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003524 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003525 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003526 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3527 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003528 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3529 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003530 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003531 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003534
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003537 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003538 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003539 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003540 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003541 * Caller: library/ssl_tls.c
3542 * library/ssl*_client.c
3543 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003546 *
3547 * This module is required for X.509 certificate parsing.
3548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550
3551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 *
3554 * Enable X.509 CRL parsing.
3555 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003556 * Module: library/x509_crl.c
3557 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560 *
3561 * This module is required for X.509 CRL parsing.
3562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003564
3565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567 *
3568 * Enable X.509 Certificate Signing Request (CSR) parsing.
3569 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003570 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003571 * Caller: library/x509_crt_write.c
3572 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003574 *
3575 * This module is used for reading X.509 certificate request.
3576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003578
3579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003582 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 *
3584 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003585 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003586 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003587 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3588 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003589 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3590 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003591 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003592 * This module is the basis for creating X.509 certificates and CSRs.
3593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595
3596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598 *
3599 * Enable creating X.509 certificates.
3600 *
3601 * Module: library/x509_crt_write.c
3602 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003604 *
3605 * This module is required for X.509 certificate creation.
3606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003608
3609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003612 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003613 *
3614 * Module: library/x509_csr_write.c
3615 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003618 * This module is required for X.509 certificate request writing.
3619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003621
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003622/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003623
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003624/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003625 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003626 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003627 * This section contains Mbed TLS build settings that are not associated
3628 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003629 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003630 * \{
3631 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003632
Gilles Peskinea02c1242022-03-16 17:03:19 +01003633/**
3634 * \def MBEDTLS_CONFIG_FILE
3635 *
3636 * If defined, this is a header which will be included instead of
3637 * `"mbedtls/mbedtls_config.h"`.
3638 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003639 * Unlike other configuration options, this one must be defined on the
3640 * compiler command line: a definition in `mbedtls_config.h` would have
3641 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003642 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003643 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003644 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003645 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003646 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003647 * The value of this symbol is typically a path in double quotes, either
3648 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003649 */
3650//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3651
3652/**
3653 * \def MBEDTLS_USER_CONFIG_FILE
3654 *
3655 * If defined, this is a header which will be included after
3656 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003657 * This allows you to modify the default configuration, including the ability
3658 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003659 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003660 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003661 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003662 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003663 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003664 * The value of this symbol is typically a path in double quotes, either
3665 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003666 */
3667//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3668
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003669/**
3670 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3671 *
3672 * If defined, this is a header which will be included instead of
3673 * `"psa/crypto_config.h"`.
3674 * This header file specifies which cryptographic mechanisms are available
3675 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3676 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3677 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003678 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003679 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003680 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003681 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003682 * The value of this symbol is typically a path in double quotes, either
3683 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003684 */
3685//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3686
3687/**
3688 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3689 *
3690 * If defined, this is a header which will be included after
3691 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003692 * This allows you to modify the default configuration, including the ability
3693 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003694 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003695 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003696 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003697 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003698 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003699 * The value of this symbol is typically a path in double quotes, either
3700 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003701 */
3702//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3703
Gilles Peskineb1176f22023-02-22 22:07:28 +01003704/**
3705 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3706 *
3707 * If defined, this is a header which will be included instead of
3708 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3709 * as the one in Mbed TLS, but with definitions adapted to the platform on
3710 * which the library code will run.
3711 *
3712 * \note The required content of this header can vary from one version of
3713 * Mbed TLS to the next. Integrators who provide an alternative file
3714 * should review the changes in the original file whenever they
3715 * upgrade Mbed TLS.
3716 *
3717 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3718 * non-standard feature of the C language, so this feature is only available
3719 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3720 *
3721 * The value of this symbol is typically a path in double quotes, either
3722 * absolute or relative to a directory on the include search path.
3723 */
3724//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3725
3726/**
3727 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3728 *
3729 * If defined, this is a header which will be included instead of
3730 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3731 * as the one in Mbed TLS, but with definitions adapted to the environment
3732 * in which the library code will run. The typical use for this feature
3733 * is to provide alternative type definitions on the client side in
3734 * client-server integrations of PSA crypto, where operation structures
3735 * contain handles instead of cryptographic data.
3736 *
3737 * \note The required content of this header can vary from one version of
3738 * Mbed TLS to the next. Integrators who provide an alternative file
3739 * should review the changes in the original file whenever they
3740 * upgrade Mbed TLS.
3741 *
3742 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3743 * non-standard feature of the C language, so this feature is only available
3744 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3745 *
3746 * The value of this symbol is typically a path in double quotes, either
3747 * absolute or relative to a directory on the include search path.
3748 */
3749//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3750
Gilles Peskineba4162a2022-04-11 17:04:38 +02003751/** \} name SECTION: General configuration options */
3752
3753/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003754 * \name SECTION: Module configuration options
3755 *
3756 * This section allows for the setting of module specific sizes and
3757 * configuration options. The default values are already present in the
3758 * relevant header files and should suffice for the regular use cases.
3759 *
3760 * Our advice is to enable options and change their values here
3761 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003762 * \{
3763 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003764/* The Doxygen documentation here is used when a user comments out a
3765 * setting and runs doxygen themselves. On the other hand, when we typeset
3766 * the full documentation including disabled settings, the documentation
3767 * in specific modules' header files is used if present. When editing this
3768 * file, make sure that each option is documented in exactly one place,
3769 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3770 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003771
Paul Bakker088c5c52014-04-25 11:11:10 +02003772/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003773//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003774//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003775
Paul Bakker088c5c52014-04-25 11:11:10 +02003776/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003777//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3778//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3779//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3780//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3781//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003782
Paul Bakker088c5c52014-04-25 11:11:10 +02003783/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3785//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3786//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3787//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003788
Paul Bakker088c5c52014-04-25 11:11:10 +02003789/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003790//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003791//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003792
Paul Bakker088c5c52014-04-25 11:11:10 +02003793/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3795//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003796//#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 +01003797
Paul Bakker088c5c52014-04-25 11:11:10 +02003798/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003799//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003800
Paul Bakker088c5c52014-04-25 11:11:10 +02003801/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003802//#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 -04003803
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003804/** \def MBEDTLS_PLATFORM_STD_CALLOC
3805 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003806 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003807 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003808 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003809 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003810 * 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 -04003811 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3812 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003813 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003814 */
3815//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003816
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003817/** \def MBEDTLS_PLATFORM_STD_FREE
3818 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003819 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003820 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003821 * 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 -04003822 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3823 * 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 -04003824 */
3825//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003826//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003827//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003828//#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 +02003829//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3830//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003831/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003832//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003833//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3834//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003835//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3836//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3837//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003838
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003839/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003841//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3842//#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 +02003843//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003844//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003845//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3846//#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 +02003847//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3848//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003849/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003850//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003851//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003852//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3853//#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 +08003854//#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 +08003855//#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 +02003856
Gilles Peskine3f106f72021-09-23 17:42:39 +02003857/** \def MBEDTLS_CHECK_RETURN
3858 *
3859 * This macro is used at the beginning of the declaration of a function
3860 * to indicate that its return value should be checked. It should
3861 * instruct the compiler to emit a warning or an error if the function
3862 * is called without checking its return value.
3863 *
3864 * There is a default implementation for popular compilers in platform_util.h.
3865 * You can override the default implementation by defining your own here.
3866 *
3867 * If the implementation here is empty, this will effectively disable the
3868 * checking of functions' return values.
3869 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003870//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003871
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003872/** \def MBEDTLS_IGNORE_RETURN
3873 *
3874 * This macro requires one argument, which should be a C function call.
3875 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3876 * warning is suppressed.
3877 */
3878//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3879
Gilles Peskineed038902020-11-13 21:33:21 +01003880/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003881/**
Gilles Peskineed038902020-11-13 21:33:21 +01003882 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3883 * PSA crypto subsystem.
3884 *
3885 * If this option is unset:
3886 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003887 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003888 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3889 * on unspecified heuristics.
3890 */
3891//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3892
Steven Cooreman863470a2021-02-15 14:03:19 +01003893/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003894 * Restrict the PSA library to supporting a maximum amount of simultaneously
3895 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3896 * volatile key, or a persistent key which is loaded temporarily by the
3897 * library as part of a crypto operation in flight.
3898 *
3899 * If this option is unset, the library will fall back to a default value of
3900 * 32 keys.
3901 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003902//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003903
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003904/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003905//#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 +00003906
Paul Bakker088c5c52014-04-25 11:11:10 +02003907/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003908//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3909//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003910
Paul Bakker088c5c52014-04-25 11:11:10 +02003911/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003912
Angus Grattond8213d02016-05-25 20:56:48 +10003913/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3914 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003915 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003916 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003917 * This determines the size of the incoming TLS I/O buffer in such a way
3918 * that it is capable of holding the specified amount of plaintext data,
3919 * regardless of the protection mechanism used.
3920 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003921 * \note When using a value less than the default of 16KB on the client, it is
3922 * recommended to use the Maximum Fragment Length (MFL) extension to
3923 * inform the server about this limitation. On the server, there
3924 * is no supported, standardized way of informing the client about
3925 * restriction on the maximum size of incoming messages, and unless
3926 * the limitation has been communicated by other means, it is recommended
3927 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3928 * while keeping the default value of 16KB for the incoming buffer.
3929 *
David Horstmann95d516f2021-05-04 18:36:56 +01003930 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003931 */
3932//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3933
Gilles Peskined3d02902020-03-04 21:35:27 +01003934/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3935 *
3936 * The maximum length of CIDs used for incoming DTLS messages.
3937 *
3938 */
3939//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3940
3941/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3942 *
3943 * The maximum length of CIDs used for outgoing DTLS messages.
3944 *
3945 */
3946//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3947
TRodziewicze8dd7092021-05-12 14:19:11 +02003948/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003949 *
3950 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003951 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003952 *
3953 * The padding will always be chosen so that the length of the
3954 * padded plaintext is a multiple of the value of this option.
3955 *
3956 * Note: A value of \c 1 means that no padding will be used
3957 * for outgoing records.
3958 *
3959 * Note: On systems lacking division instructions,
3960 * a power of two should be preferred.
3961 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003962//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003963
Angus Grattond8213d02016-05-25 20:56:48 +10003964/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3965 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003966 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003967 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003968 * This determines the size of the outgoing TLS I/O buffer in such a way
3969 * that it is capable of holding the specified amount of plaintext data,
3970 * regardless of the protection mechanism used.
3971 *
Angus Grattond8213d02016-05-25 20:56:48 +10003972 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3973 * the default inward 16384 byte buffer to conform to the TLS specification.
3974 *
3975 * The minimum required outward buffer size is determined by the handshake
3976 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3977 * The specific size requirement depends on the configured ciphers and any
3978 * certificate data which is sent during the handshake.
3979 *
David Horstmann95d516f2021-05-04 18:36:56 +01003980 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003981 */
3982//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3983
Hanno Beckere0b150f2018-08-21 15:51:03 +01003984/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3985 *
3986 * Maximum number of heap-allocated bytes for the purpose of
3987 * DTLS handshake message reassembly and future message buffering.
3988 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003989 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003990 * to account for a reassembled handshake message of maximum size,
3991 * together with its reassembly bitmap.
3992 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003993 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003994 * should be sufficient for all practical situations as it allows
3995 * to reassembly a large handshake message (such as a certificate)
3996 * while buffering multiple smaller handshake messages.
3997 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003998 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003999//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004000
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004001//#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 +02004002//#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 +02004003
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004004/**
4005 * Complete list of ciphersuites to use, in order of preference.
4006 *
4007 * \warning No dependency checking is done on that field! This option can only
4008 * be used to restrict the set of available ciphersuites. It is your
4009 * responsibility to make sure the needed modules are active.
4010 *
4011 * Use this to save a few hundred bytes of ROM (default ordering of all
4012 * available ciphersuites) and a few to a few hundred bytes of RAM.
4013 *
4014 * The value below is only an example, not the default.
4015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004016//#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 +02004017
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004018/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004019 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4020 *
4021 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004022 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004023 *
4024 * It must be positive and smaller than UINT32_MAX.
4025 *
4026 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4027 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004028 */
4029//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4030
4031/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004032 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4033 *
Jerry Yucf913512023-11-14 11:06:52 +08004034 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004035 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004036 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004037 * - The client ticket age is the time difference between the time when the
4038 * client proposes to the server to use the ticket and the time the client
4039 * received the ticket from the server.
4040 * - The server ticket age is the time difference between the time when the
4041 * server receives a proposition from the client to use the ticket and the
4042 * time when the ticket was created by the server.
4043 *
Jerry Yucf913512023-11-14 11:06:52 +08004044 * The ages might be different due to the client and server clocks not running
4045 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4046 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4047 * 6s, thus in the worst case clients and servers must sync up their system time
4048 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004049 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004050 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004051 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004052//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004053
4054/**
4055 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4056 *
4057 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4058 *
4059 * This must be less than 256.
4060 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004061//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004062
4063/**
4064 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4065 *
4066 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4067 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4068 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4069 *
4070 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004071//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004072
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004073/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004074//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004075//#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 +01004076
Gilles Peskine611179c2022-04-13 23:04:48 +02004077/** \} name SECTION: Module configuration options */