blob: 5b972a916acb009955ec8be62486f8cb6706df99 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Steven Cooreman63342772017-04-04 11:47:16 +0200353//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354//#define MBEDTLS_MD5_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000356
Paul Bakker90995b52013-06-24 19:20:35 +0200357/**
TRodziewicz75628d52021-06-18 12:56:27 +0200358 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200359 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200360 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100361 * alternate core implementation of symmetric crypto or hash function. Keep in
362 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200365 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200366 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200367 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * no longer provide the mbedtls_sha1_process() function, but it will still provide
369 * the other function (using your mbedtls_sha1_process() function) and the definition
370 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200371 * with this definition.
372 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200373 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100374 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
375 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200376 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200377 * Uncomment a macro to enable alternate implementation of the corresponding
378 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100379 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200380 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100381 * constitutes a security risk. If possible, we recommend avoiding
382 * dependencies on them, and considering stronger message digests
383 * and ciphers instead.
384 *
Janos Follath1231d212019-01-07 15:01:32 +0000385 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
386 * enabled, then the deterministic ECDH signature functions pass the
387 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
388 * alternative implementations should use the RNG only for generating
389 * the ephemeral key and nothing else. If this is not possible, then
390 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200391 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000392 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_MD5_PROCESS_ALT
395//#define MBEDTLS_RIPEMD160_PROCESS_ALT
396//#define MBEDTLS_SHA1_PROCESS_ALT
397//#define MBEDTLS_SHA256_PROCESS_ALT
398//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200399//#define MBEDTLS_DES_SETKEY_ALT
400//#define MBEDTLS_DES_CRYPT_ECB_ALT
401//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200402//#define MBEDTLS_AES_SETKEY_ENC_ALT
403//#define MBEDTLS_AES_SETKEY_DEC_ALT
404//#define MBEDTLS_AES_ENCRYPT_ALT
405//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300406//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300407//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300408//#define MBEDTLS_ECDSA_VERIFY_ALT
409//#define MBEDTLS_ECDSA_SIGN_ALT
410//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200411
412/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200413 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200414 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200415 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200416 * hardware entropy collector.
417 *
418 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000419 * prototype as declared in library/entropy_poll.h, and accept NULL as first
420 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200421 *
422 * Uncomment to use your own hardware entropy collector.
423 */
424//#define MBEDTLS_ENTROPY_HARDWARE_ALT
425
426/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000428 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100429 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000430 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100431 * Uncomment this macro to use precomputed AES tables stored in ROM.
432 * Comment this macro to generate AES tables in RAM at runtime.
433 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100434 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
435 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100436 * initialization time before the first AES operation can be performed.
437 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
438 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
439 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100440 *
441 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000444
445/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100446 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200447 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100448 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200449 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100450 * Uncommenting this macro omits 75% of the AES tables from
451 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
452 * by computing their values on the fly during operations
453 * (the tables are entry-wise rotations of one another).
454 *
455 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100456 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100457 * runtime. Specifically, one has to compare 4 accesses within
458 * different tables to 4 accesses with additional arithmetic
459 * operations within the same table. The performance gain/loss
460 * depends on the system and memory details.
461 *
462 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200463 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100464//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200465
466/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800467 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
468 *
469 * Use only 128-bit keys in AES operations to save ROM.
470 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800471 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800472 * or 256-bit keys.
473 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800474 * Uncommenting this macro reduces the size of AES code by ~300 bytes
475 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800476 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800477 * Module: library/aes.c
478 *
479 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800480 */
481//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
482
Gilles Peskinea8861e02023-09-05 20:20:51 +0200483/*
484 * Disable plain C implementation for AES.
485 *
486 * When the plain C implementation is enabled, and an implementation using a
487 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
488 * detection will be used to select between them.
489 *
490 * If only one implementation is present, runtime detection will not be used.
491 * This configuration will crash at runtime if running on a CPU without the
492 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
493 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
494 */
495//#define MBEDTLS_AES_USE_HARDWARE_ONLY
496
Arto Kinnunen732ca322023-04-14 14:26:10 +0800497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200498 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200499 *
500 * Use less ROM for the Camellia implementation (saves about 768 bytes).
501 *
502 * Uncomment this macro to use less memory for Camellia.
503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200504//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200505
506/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200507 * \def MBEDTLS_CHECK_RETURN_WARNING
508 *
509 * If this macro is defined, emit a compile-time warning if application code
510 * calls a function without checking its return value, but the return value
511 * should generally be checked in portable applications.
512 *
513 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
514 * implemented. Otherwise this option has no effect.
515 *
516 * Uncomment to get warnings on using fallible functions without checking
517 * their return value.
518 *
519 * \note This feature is a work in progress.
520 * Warnings will be added to more functions in the future.
521 *
522 * \note A few functions are considered critical, and ignoring the return
523 * value of these functions will trigger a warning even if this
524 * macro is not defined. To completely disable return value check
525 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
526 */
527//#define MBEDTLS_CHECK_RETURN_WARNING
528
529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200531 *
532 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200535
536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000538 *
539 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000542
543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000545 *
546 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000549
550/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100551 * \def MBEDTLS_CIPHER_MODE_OFB
552 *
553 * Enable Output Feedback mode (OFB) for symmetric ciphers.
554 */
555#define MBEDTLS_CIPHER_MODE_OFB
556
557/**
558 * \def MBEDTLS_CIPHER_MODE_XTS
559 *
560 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
561 */
562#define MBEDTLS_CIPHER_MODE_XTS
563
564/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000566 *
567 * Enable NULL cipher.
568 * Warning: Only do so when you know what you are doing. This allows for
569 * encryption or channels without any security!
570 *
Ronald Croncee42702021-04-26 11:34:44 +0200571 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
573 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
574 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
575 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
576 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
577 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
578 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
579 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
580 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
581 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
582 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
583 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
584 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
585 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
586 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
587 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
588 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
589 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
590 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000591 *
592 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000595
596/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100597 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200598 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100599 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
600 * specific padding modes in the cipher layer with cipher modes that support
601 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200602 *
603 * If you disable all padding modes, only full blocks can be used with CBC.
604 *
605 * Enable padding modes in the cipher layer.
606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607#define MBEDTLS_CIPHER_PADDING_PKCS7
608#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
609#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
610#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200611
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200612/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
613 *
614 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800615 * Without this, CTR_DRBG uses a 256-bit key
616 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200617 */
618//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
619
Paul Bakker48e93c82013-08-14 12:21:18 +0200620/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200621 * Enable the verified implementations of ECDH primitives from Project Everest
622 * (currently only Curve25519). This feature changes the layout of ECDH
623 * contexts and therefore is a compatibility break for applications that access
624 * fields of a mbedtls_ecdh_context structure directly. See also
625 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000626 *
627 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
628 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200629 */
630//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
631
632/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100633 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200634 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100635 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
636 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200637 *
638 * Comment macros to disable the curve and functions for it
639 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200640/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
642#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
643#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
644#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
645#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
646#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
647#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
648#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
649#define MBEDTLS_ECP_DP_BP256R1_ENABLED
650#define MBEDTLS_ECP_DP_BP384R1_ENABLED
651#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200652/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200653#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000654#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200655
656/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200657 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200658 *
659 * Enable specific 'modulo p' routines for each NIST prime.
660 * Depending on the prime and architecture, makes operations 4 to 8 times
661 * faster on the corresponding curve.
662 *
663 * Comment this macro to disable NIST curves optimisation.
664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200666
667/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200668 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100669 *
670 * Enable "non-blocking" ECC operations that can return early and be resumed.
671 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200672 * This allows various functions to pause by returning
673 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
674 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
675 * order to further progress and eventually complete their operation. This is
676 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
677 * number of ECC operations a function may perform before pausing; see
678 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100679 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200680 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200681 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100682 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100683 * This option:
684 * - Adds xxx_restartable() variants of existing operations in the
685 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100686 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
687 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100688 * - ECDSA: signature generation & verification;
689 * - PK: signature generation & verification;
690 * - X509: certificate chain verification.
691 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
692 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
693 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
694 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000695 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100696 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100697 * - verification of the server's key exchange signature;
698 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100699 * - generation of the client's signature if client authentication is used,
700 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100701 *
702 * \note In the cases above, the usual SSL/TLS functions, such as
703 * mbedtls_ssl_handshake(), can now return
704 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200705 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100706 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
707 * restartable operations in PK, X.509 and TLS (see above) are not
708 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100709 * PSA, and are not restartable. These are temporary limitations that
710 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200711 *
Ron Eldor19779c42018-11-05 16:58:13 +0200712 * \note This option only works with the default software implementation of
713 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100714 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100715 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100716 * Requires: MBEDTLS_ECP_C
717 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100718 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100719 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200720//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100721
722/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200723 * Uncomment to enable using new bignum code in the ECC modules.
724 *
725 * \warning This is currently experimental, incomplete and therefore should not
726 * be used in production.
727 */
728//#define MBEDTLS_ECP_WITH_MPI_UINT
729
730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200731 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100732 *
733 * Enable deterministic ECDSA (RFC 6979).
734 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
735 * may result in a compromise of the long-term signing key. This is avoided by
736 * the deterministic variant.
737 *
John Durkop36a82e52020-10-26 09:39:05 -0700738 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100739 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100740 * Comment this macro to disable deterministic ECDSA.
741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200742#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100743
744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200746 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200747 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200748 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200749 * This enables the following ciphersuites (if other requisites are
750 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
752 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
753 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
754 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
755 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
756 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
757 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
758 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
759 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
760 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200763
764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200767 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200770 *
771 * This enables the following ciphersuites (if other requisites are
772 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
776 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
777 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
781 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
782 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100783 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100784 * \warning Using DHE constitutes a security risk as it
785 * is not possible to validate custom DH parameters.
786 * If possible, it is recommended users should consider
787 * preferring other methods of key exchange.
788 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100789 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200792
793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200795 *
796 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
797 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200798 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200799 *
800 * This enables the following ciphersuites (if other requisites are
801 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
803 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
804 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
805 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
806 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
807 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200810
811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200814 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200815 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
817 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200818 *
819 * This enables the following ciphersuites (if other requisites are
820 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
824 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
825 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
829 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
830 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833
834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200837 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
840 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
842 * This enables the following ciphersuites (if other requisites are
843 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
845 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
846 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
850 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
851 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
852 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858
859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200862 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
865 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
867 * This enables the following ciphersuites (if other requisites are
868 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100881 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100882 * \warning Using DHE constitutes a security risk as it
883 * is not possible to validate custom DH parameters.
884 * If possible, it is recommended users should consider
885 * preferring other methods of key exchange.
886 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100887 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890
891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200894 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200896 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
897 * MBEDTLS_RSA_C
898 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
901 * This enables the following ciphersuites (if other requisites are
902 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200913 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200915
916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200918 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200919 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200920 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200921 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
922 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
923 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200924 *
925 * This enables the following ciphersuites (if other requisites are
926 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200939
940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100942 *
943 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
944 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200945 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
946 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
947 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 *
949 * This enables the following ciphersuites (if other requisites are
950 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100963
964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100966 *
967 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
968 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200969 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
970 * MBEDTLS_RSA_C
971 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100972 *
973 * This enables the following ciphersuites (if other requisites are
974 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
976 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
977 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
978 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
979 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
980 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
981 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
982 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
983 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
984 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100987
988/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200989 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
990 *
991 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
992 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200993 * \warning This is currently experimental. EC J-PAKE support is based on the
994 * Thread v1.0.0 specification; incompatible changes to the specification
995 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200996 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200997 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100998 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200999 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1000 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001001 * \warning If SHA-256 is provided only by a PSA driver, you must call
1002 * psa_crypto_init() before the first hanshake (even if
1003 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1004 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001005 * This enables the following ciphersuites (if other requisites are
1006 * enabled as well):
1007 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1008 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001009//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001010
1011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001013 *
1014 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1015 * RFC 5915 and RFC 5480.
1016 *
1017 * Currently this means parsing the SpecifiedECDomain choice of EC
1018 * parameters (only known groups are supported, not arbitrary domains, to
1019 * avoid validation issues).
1020 *
1021 * Disable if you only need to support RFC 5915 + 5480 key formats.
1022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001024
1025/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001026 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1027 *
1028 * Enable the support for parsing public keys of type Short Weierstrass
1029 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001030 * compressed point format. This parsing is done through ECP module's functions.
1031 *
1032 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1033 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1034 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001035 */
1036#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1037
1038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * Enable a dummy error function to make use of mbedtls_strerror() in
1042 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1043 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001044 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1046 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001047 *
1048 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001052
1053/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001055 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001056 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001057 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001061
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001064 *
1065 * Enable functions that use the filesystem.
1066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001068
1069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001071 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001072 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001073 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001074 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001075 * application.
1076 *
1077 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001080
1081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001083 *
1084 * Do not use built-in platform entropy functions.
1085 * This is useful if your platform does not support
1086 * standards like the /dev/urandom or Windows CryptoAPI.
1087 *
1088 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001091
1092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001094 *
1095 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1096 * default SHA-512 based one (if both are available).
1097 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001099 *
1100 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1101 * if you have performance concerns.
1102 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * This option is only useful if both MBEDTLS_SHA256_C and
1104 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001107
1108/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001109 * \def MBEDTLS_ENTROPY_NV_SEED
1110 *
1111 * Enable the non-volatile (NV) seed file-based entropy source.
1112 * (Also enables the NV seed read/write functions in the platform layer)
1113 *
1114 * This is crucial (if not required) on systems that do not have a
1115 * cryptographic entropy source (in hardware or kernel) available.
1116 *
1117 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1118 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001119 * \note The read/write functions that are used by the entropy source are
1120 * determined in the platform layer, and can be modified at runtime and/or
1121 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1122 *
1123 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001124 * with regular fopen(), please make sure you make a seedfile with the
1125 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1126 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001127 * and written to or you will get an entropy source error! The default
1128 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1129 * bytes from the file.
1130 *
1131 * \note The entropy collector will write to the seed file before entropy is
1132 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001133 */
1134//#define MBEDTLS_ENTROPY_NV_SEED
1135
Ronald Cron71016a92020-08-28 19:01:50 +02001136/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001137 *
Ronald Cron71016a92020-08-28 19:01:50 +02001138 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001139 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001140 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1141 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001142 *
1143 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001144 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001145 */
Ronald Cron71016a92020-08-28 19:01:50 +02001146//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001147
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001148/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001150 *
1151 * Enable debugging of buffer allocator memory issues. Automatically prints
1152 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1153 * function for 'debug output' of allocated memory.
1154 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001156 *
1157 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001158 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001160
1161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001163 *
1164 * Include backtrace information with each allocated block.
1165 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001167 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001168 *
1169 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001172
1173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001175 *
1176 * Support external private RSA keys (eg from a HSM) in the PK layer.
1177 *
1178 * Comment this macro to disable support for external private RSA keys.
1179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001181
1182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001184 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001185 * Enable support for PKCS#1 v1.5 encoding.
1186 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001187 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001188 *
Paul Bakker48377d92013-08-30 12:06:24 +02001189 * This enables support for PKCS#1 v1.5 operations.
1190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001192
1193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001195 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001196 * Enable support for PKCS#1 v2.1 encoding.
1197 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001198 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001199 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001200 * \warning If using a hash that is only provided by PSA drivers, you must
1201 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001202 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001203 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001206
Steven Cooreman6801f082021-02-19 17:21:22 +01001207/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1208 *
1209 * Enable support for platform built-in keys. If you enable this feature,
1210 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1211 * See the documentation of that function for more information.
1212 *
1213 * Built-in keys are typically derived from a hardware unique key or
1214 * stored in a secure element.
1215 *
1216 * Requires: MBEDTLS_PSA_CRYPTO_C.
1217 *
1218 * \warning This interface is experimental and may change or be removed
1219 * without notice.
1220 */
1221//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1222
Ronald Cron3768ac12021-01-26 16:58:00 +01001223/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1224 *
1225 * Enable support for PSA crypto client.
1226 *
1227 * \note This option allows to include the code necessary for a PSA
1228 * crypto client when the PSA crypto implementation is not included in
1229 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1230 * code to set and get PSA key attributes.
1231 * The development of PSA drivers partially relying on the library to
1232 * fulfill the hardware gaps is another possible usage of this option.
1233 *
1234 * \warning This interface is experimental and may change or be removed
1235 * without notice.
1236 */
1237//#define MBEDTLS_PSA_CRYPTO_CLIENT
1238
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001239/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1240 *
1241 * Make the PSA Crypto module use an external random generator provided
1242 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1243 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001244 * \note This random generator must deliver random numbers with cryptographic
1245 * quality and high performance. It must supply unpredictable numbers
1246 * with a uniform distribution. The implementation of this function
1247 * is responsible for ensuring that the random generator is seeded
1248 * with sufficient entropy. If you have a hardware TRNG which is slow
1249 * or delivers non-uniform output, declare it as an entropy source
1250 * with mbedtls_entropy_add_source() instead of enabling this option.
1251 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001252 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001253 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1254 * and define a function called mbedtls_psa_external_get_random()
1255 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001256 * ```
1257 * psa_status_t mbedtls_psa_external_get_random(
1258 * mbedtls_psa_external_random_context_t *context,
1259 * uint8_t *output, size_t output_size, size_t *output_length);
1260 * );
1261 * ```
1262 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001263 * The function must fill the \c output buffer with \c output_size bytes
1264 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001265 *
1266 * Requires: MBEDTLS_PSA_CRYPTO_C
1267 *
1268 * \warning If you enable this option, code that uses the PSA cryptography
1269 * interface will not use any of the entropy sources set up for
1270 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1271 * enables.
1272 *
1273 * \note This option is experimental and may be removed without notice.
1274 */
1275//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1276
Paul Bakker9dcc3222011-03-08 14:16:06 +00001277/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001278 * \def MBEDTLS_PSA_CRYPTO_SPM
1279 *
1280 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1281 * Partition Manager) integration which separates the code into two parts: a
1282 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1283 * Environment).
1284 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001285 * If you enable this option, your build environment must include a header
1286 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1287 * header files, or in another directory on the compiler's include search
1288 * path). Alternatively, your platform may customize the header
1289 * `psa/crypto_platform.h`, in which case it can skip or replace the
1290 * inclusion of `"crypto_spe.h"`.
1291 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292 * Module: library/psa_crypto.c
1293 * Requires: MBEDTLS_PSA_CRYPTO_C
1294 *
1295 */
1296//#define MBEDTLS_PSA_CRYPTO_SPM
1297
1298/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001299 * Uncomment to enable p256-m. This is an alternative implementation of
1300 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1301 * Compared to the default implementation:
1302 *
1303 * - p256-m has a much smaller code size and RAM footprint.
1304 * - p256-m is only available via the PSA API. This includes the pk module
1305 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1306 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1307 * over the core arithmetic, or deterministic derivation of keys.
1308 *
1309 * We recommend enabling this option if your application uses the PSA API
1310 * and the only elliptic curve support it needs is ECDH and ECDSA over
1311 * SECP256R1.
1312 *
1313 * If you enable this option, you do not need to enable any ECC-related
1314 * MBEDTLS_xxx option. You do need to separately request support for the
1315 * cryptographic mechanisms through the PSA API:
1316 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1317 * configuration;
1318 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1319 * - #PSA_WANT_ECC_SECP_R1_256;
1320 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1321 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1322 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1323 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1324 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001325 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001326 * \note To benefit from the smaller code size of p256-m, make sure that you
1327 * do not enable any ECC-related option not supported by p256-m: this
1328 * would cause the built-in ECC implementation to be built as well, in
1329 * order to provide the required option.
1330 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001331 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1332 * SECP256R1 are disabled as they are not supported by this driver.
1333 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1334 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001335 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001336 */
1337//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1338
1339/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001340 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001341 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001342 * Enable support for entropy injection at first boot. This feature is
1343 * required on systems that do not have a built-in entropy source (TRNG).
1344 * This feature is currently not supported on systems that have a built-in
1345 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001346 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001347 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001348 *
1349 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001350//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001351
1352/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001353 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001354 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001355 * Assume all buffers passed to PSA functions are owned exclusively by the
1356 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001357 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001358 * This option may be enabled if all buffers passed to any PSA function reside
1359 * in memory that is accessible only to the PSA function during its execution.
1360 *
1361 * This option MUST be disabled whenever buffer arguments are in memory shared
1362 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001363 * across a trust boundary.
1364 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001365 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001366 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001367 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001368 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001369 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001370//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001371
1372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001374 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001375 * Do not use the Chinese Remainder Theorem
1376 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001377 *
1378 * Uncomment this macro to disable the use of CRT in RSA.
1379 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001382
1383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001385 *
1386 * Enable the checkup functions (*_self_test).
1387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001389
1390/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001391 * \def MBEDTLS_SHA256_SMALLER
1392 *
1393 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1394 * lower performance.
1395 *
Adam Wolf039080f2019-09-10 09:53:08 -05001396 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001397 * performance and size. This version optimizes more aggressively for size at
1398 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1399 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1400 * 30%.
1401 *
1402 * Uncomment to enable the smaller implementation of SHA256.
1403 */
1404//#define MBEDTLS_SHA256_SMALLER
1405
1406/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001407 * \def MBEDTLS_SHA512_SMALLER
1408 *
1409 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1410 * lower performance.
1411 *
1412 * Uncomment to enable the smaller implementation of SHA512.
1413 */
1414//#define MBEDTLS_SHA512_SMALLER
1415
1416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001418 *
1419 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001420 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001421 * with other servers, only debugging of failures is harder.
1422 *
1423 * The advantage of not sending alert messages, is that no information is given
1424 * about reasons for failures thus preventing adversaries of gaining intel.
1425 *
1426 * Enable sending of all alert messages
1427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001429
1430/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001431 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1432 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001433 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001434 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001435 * in the underlying transport. The CID functionality is described
1436 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 *
1438 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001439 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1440 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1441 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001442 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001443 * The maximum lengths of outgoing and incoming CIDs can be configured
1444 * through the options
1445 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1446 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1447 *
1448 * Requires: MBEDTLS_SSL_PROTO_DTLS
1449 *
1450 * Uncomment to enable the Connection ID extension.
1451 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001452#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1453
1454
1455/**
1456 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1457 *
1458 * Defines whether RFC 9146 (default) or the legacy version
1459 * (version draft-ietf-tls-dtls-connection-id-05,
1460 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1461 * is used.
1462 *
1463 * Set the value to 0 for the standard version, and
1464 * 1 for the legacy draft version.
1465 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001466 * \deprecated Support for the legacy version of the DTLS
1467 * Connection ID feature is deprecated. Please
1468 * switch to the standardized version defined
1469 * in RFC 9146 enabled by utilizing
1470 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1471 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1472 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001473 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1474 */
1475#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001476
1477/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001478 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1479 *
1480 * Enable asynchronous external private key operations in SSL. This allows
1481 * you to configure an SSL connection to call an external cryptographic
1482 * module to perform private key operations instead of performing the
1483 * operation inside the library.
1484 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001485 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001486 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001487//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001488
1489/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001490 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1491 *
1492 * Enable serialization of the TLS context structures, through use of the
1493 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1494 *
1495 * This pair of functions allows one side of a connection to serialize the
1496 * context associated with the connection, then free or re-use that context
1497 * while the serialized state is persisted elsewhere, and finally deserialize
1498 * that state to a live context for resuming read/write operations on the
1499 * connection. From a protocol perspective, the state of the connection is
1500 * unaffected, in particular this is entirely transparent to the peer.
1501 *
1502 * Note: this is distinct from TLS session resumption, which is part of the
1503 * protocol and fully visible by the peer. TLS session resumption enables
1504 * establishing new connections associated to a saved session with shorter,
1505 * lighter handshakes, while context serialization is a local optimization in
1506 * handling a single, potentially long-lived connection.
1507 *
1508 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1509 * saved after the handshake to allow for more efficient serialization, so if
1510 * you don't need this feature you'll save RAM by disabling it.
1511 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001512 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1513 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001514 * Comment to disable the context serialization APIs.
1515 */
1516#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1517
1518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001519 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001520 *
1521 * Enable the debug messages in SSL module for all issues.
1522 * Debug messages have been disabled in some places to prevent timing
1523 * attacks due to (unbalanced) debugging function calls.
1524 *
1525 * If you need all error reporting you should enable this during debugging,
1526 * but remove this for production servers that should log as well.
1527 *
1528 * Uncomment this macro to report all debug messages on errors introducing
1529 * a timing side-channel.
1530 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001533
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001535 *
1536 * Enable support for Encrypt-then-MAC, RFC 7366.
1537 *
1538 * This allows peers that both support it to use a more robust protection for
1539 * ciphersuites using CBC, providing deep resistance against timing attacks
1540 * on the padding or underlying cipher.
1541 *
1542 * This only affects CBC ciphersuites, and is useless if none is defined.
1543 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001544 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001545 *
1546 * Comment this macro to disable support for Encrypt-then-MAC
1547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001551 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001552 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1553 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001554 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001555 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001556 * attacks, but it is recommended to always use it (even if you disable
1557 * renegotiation), since it actually fixes a more fundamental issue in the
1558 * original SSL/TLS design, and has implications beyond Triple Handshake.
1559 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001560 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001561 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001562 * Comment this macro to disable support for Extended Master Secret.
1563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001565
Paul Bakkerd66f0702013-01-31 16:57:45 +01001566/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001567 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1568 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001569 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001570 * giving access to the peer's certificate after completion of the handshake.
1571 *
1572 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1573 * recommended to disable this option for reduced RAM usage.
1574 *
1575 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1576 * defined, but always returns \c NULL.
1577 *
1578 * \note This option has no influence on the protection against the
1579 * triple handshake attack. Even if it is disabled, Mbed TLS will
1580 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001581 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001582 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001583 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001584 *
1585 * Comment this macro to disable storing the peer's certificate
1586 * after the handshake.
1587 */
1588#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1589
1590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001592 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001593 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001594 *
1595 * The two main uses of renegotiation are (1) refresh keys on long-lived
1596 * connections and (2) client authentication after the initial handshake.
1597 * If you don't need renegotiation, it's probably better to disable it, since
1598 * it has been associated with security issues in the past and is easy to
1599 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001600 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001601 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1602 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001603 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001604 *
1605 * \note Even if this option is disabled, both client and server are aware
1606 * of the Renegotiation Indication Extension (RFC 5746) used to
1607 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1608 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1609 * configuration of this extension).
1610 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001613
1614/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001616 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001617 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001618 *
1619 * Comment this macro to disable support for the max_fragment_length extension
1620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001622
1623/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001624 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1625 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001626 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001627 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001628 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1629 *
1630 * Uncomment this macro to enable support for the record_size_limit extension
1631 */
1632//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1633
1634/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001636 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001637 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001638 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001639 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001640 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1641 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001642 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001643 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001644 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001645 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1646 * are only provided by PSA drivers, you must call psa_crypto_init() before
1647 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001648 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001649 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001652
1653/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001654 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001655 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001656 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001657 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001658 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001659 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001660 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001661 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001662 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001663 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001664 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1665 * directly performed by TLS 1.3 code. As a consequence, you must
1666 * call psa_crypto_init() before the first TLS 1.3 handshake.
1667 *
1668 * \note Cryptographic operations performed indirectly via another module
1669 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1670 * running handshake hash) only use PSA crypto if
1671 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001672 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001673 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001674 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001675#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001676
1677/**
Ronald Cronab65c522021-11-24 10:47:20 +01001678 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1679 *
1680 * Enable TLS 1.3 middlebox compatibility mode.
1681 *
1682 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1683 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1684 * expecting TLS 1.2 traffic.
1685 *
1686 * Turning on the compatibility mode comes at the cost of a few added bytes
1687 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1688 * that don't use it. Therefore, unless transmission bandwidth is critical and
1689 * you know that middlebox compatibility issues won't occur, it is therefore
1690 * recommended to set this option.
1691 *
1692 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001693 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1694 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001695 *
1696 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001697#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001698
1699/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001700 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1701 *
1702 * Enable TLS 1.3 PSK key exchange mode.
1703 *
1704 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1705 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1706 * effect on the build.
1707 *
1708 */
1709#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1710
1711/**
1712 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1713 *
1714 * Enable TLS 1.3 ephemeral key exchange mode.
1715 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001716 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001717 * MBEDTLS_X509_CRT_PARSE_C
1718 * and at least one of:
1719 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1720 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001721 *
1722 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1723 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1724 * effect on the build.
1725 *
1726 */
1727#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1728
1729/**
1730 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1731 *
1732 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1733 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001734 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001735 *
1736 * Comment to disable support for the PSK ephemeral key exchange mode in
1737 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1738 * have any effect on the build.
1739 *
1740 */
1741#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1742
1743/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 * \def MBEDTLS_SSL_EARLY_DATA
1745 *
1746 * Enable support for RFC 8446 TLS 1.3 early data.
1747 *
1748 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1749 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1750 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1751 *
1752 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1753 * is not enabled, this option does not have any effect on the build.
1754 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001755 * \note The maximum amount of early data can be set with
1756 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1757 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001759//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001760
1761/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001763 *
1764 * Enable support for DTLS (all available versions).
1765 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001766 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001767 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001768 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001769 *
1770 * Comment this macro to disable support for DTLS
1771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001772#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001773
1774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001776 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001777 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001778 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001779 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001782
1783/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001784 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001785 *
1786 * Enable support for the anti-replay mechanism in DTLS.
1787 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 * Requires: MBEDTLS_SSL_TLS_C
1789 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001790 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001791 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001792 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001793 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001794 * Comment this to disable anti-replay in DTLS.
1795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001797
1798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001800 *
1801 * Enable support for HelloVerifyRequest on DTLS servers.
1802 *
1803 * This feature is highly recommended to prevent DTLS servers being used as
1804 * amplifiers in DoS attacks against other hosts. It should always be enabled
1805 * unless you know for sure amplification cannot be a problem in the
1806 * environment in which your server operates.
1807 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001808 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001809 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001810 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001811 *
1812 * Comment this to disable support for HelloVerifyRequest.
1813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001815
1816/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001817 * \def MBEDTLS_SSL_DTLS_SRTP
1818 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001819 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001820 * through the use_srtp extension.
1821 *
1822 * \note This feature provides the minimum functionality required
1823 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1824 * the associated SRTP packet protection key material.
1825 * In particular, the SRTP packet protection itself, as well as the
1826 * demultiplexing of RTP and DTLS packets at the datagram layer
1827 * (see Section 5 of RFC 5764), are not handled by this feature.
1828 * Instead, after successful completion of a handshake negotiating
1829 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001830 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001831 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1832 * (this is implemented in the SSL example programs).
1833 * The resulting key should then be passed to an SRTP stack.
1834 *
1835 * Setting this option enables the runtime API
1836 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1837 * through which the supported DTLS-SRTP protection
1838 * profiles can be configured. You must call this API at
1839 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001840 *
1841 * Requires: MBEDTLS_SSL_PROTO_DTLS
1842 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001843 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001844 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001845//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001846
1847/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001848 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1849 *
1850 * Enable server-side support for clients that reconnect from the same port.
1851 *
1852 * Some clients unexpectedly close the connection and try to reconnect using the
1853 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001854 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001855 * flag enables that support.
1856 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001857 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001858 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001859 * Comment this to disable support for clients reusing the source port.
1860 */
1861#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1862
1863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001865 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001866 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001867 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001868 * session store remains the responsibility of the application, though).
1869 * Server-side, you also need to provide callbacks for writing and parsing
1870 * tickets, including authenticated encryption and key management. Example
1871 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001872 *
1873 * Comment this macro to disable support for SSL session tickets
1874 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001876
1877/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001879 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001880 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001881 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001883 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001884 * Comment this macro to disable support for server name indication in SSL
1885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001887
1888/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001889 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1890 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001891 * When this option is enabled, the SSL buffer will be resized automatically
1892 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001893 *
1894 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001895 */
1896//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1897
1898/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001899 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1900 *
1901 * Enable testing of the constant-flow nature of some sensitive functions with
1902 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001903 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001904 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001905 * This setting requires compiling with clang -fsanitize=memory. The test
1906 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001907 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001908 * \warning This macro is only used for extended testing; it is not considered
1909 * part of the library's API, so it may change or disappear at any time.
1910 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001911 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001912 */
1913//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1914
1915/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001916 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1917 *
1918 * Enable testing of the constant-flow nature of some sensitive functions with
1919 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001920 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001921 *
1922 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001923 * testing if the tests suites are run with valgrind's memcheck. This can be
1924 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1925 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001926 *
1927 * \warning This macro is only used for extended testing; it is not considered
1928 * part of the library's API, so it may change or disappear at any time.
1929 *
1930 * Uncomment to enable testing of the constant-flow nature of selected code.
1931 */
1932//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1933
1934/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001935 * \def MBEDTLS_TEST_HOOKS
1936 *
1937 * Enable features for invasive testing such as introspection functions and
1938 * hooks for fault injection. This enables additional unit tests.
1939 *
1940 * Merely enabling this feature should not change the behavior of the product.
1941 * It only adds new code, and new branching points where the default behavior
1942 * is the same as when this feature is disabled.
1943 * However, this feature increases the attack surface: there is an added
1944 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1945 * Therefore this feature must never be enabled in production.
1946 *
1947 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1948 * information.
1949 *
1950 * Uncomment to enable invasive tests.
1951 */
1952//#define MBEDTLS_TEST_HOOKS
1953
1954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001956 *
1957 * Provide your own alternate threading implementation.
1958 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001960 *
1961 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001962 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001964
1965/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001967 *
1968 * Enable the pthread wrapper layer for the threading layer.
1969 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001971 *
1972 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001975
1976/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001977 * \def MBEDTLS_USE_PSA_CRYPTO
1978 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001979 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1980 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001981 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001982 * \note Development of this option is currently in progress, and parts of Mbed
1983 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001984 * will still continue to work as usual, so enabling this option should not
1985 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001986 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001987 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001988 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1989 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001990 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001991 * \note An important and desirable effect of this option is that it allows
1992 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1993 * 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 +02001994 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001995 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1996 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001997 *
1998 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001999 *
2000 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002001 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002002 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002004//#define MBEDTLS_USE_PSA_CRYPTO
2005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002007 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2008 *
John Durkop185764f2020-10-12 21:32:12 -07002009 * This setting allows support for cryptographic mechanisms through the PSA
2010 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002011 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002012 * When this option is disabled, the PSA API exposes the cryptographic
2013 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2014 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002015 *
2016 * When this option is enabled, the PSA API exposes the cryptographic
2017 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2018 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2019 * automatically enabled if required (i.e. if no PSA driver provides the
2020 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2021 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002022 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002023 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002024 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002025 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002026 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2027 * symbols is not completely finalized yet, and the configuration
2028 * tooling is not ideally adapted to having two separate configuration
2029 * files.
2030 * Future minor releases of Mbed TLS may make minor changes to those
2031 * symbols, but we will endeavor to provide a transition path.
2032 * Nonetheless, this option is considered mature enough to use in
2033 * production, as long as you accept that you may need to make
2034 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002035 */
2036//#define MBEDTLS_PSA_CRYPTO_CONFIG
2037
2038/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002039 * \def MBEDTLS_VERSION_FEATURES
2040 *
2041 * Allow run-time checking of compile-time enabled features. Thus allowing users
2042 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002043 * support via mbedtls_version_check_feature().
2044 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002045 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002046 *
2047 * Comment this to disable run-time checking and save ROM space
2048 */
2049#define MBEDTLS_VERSION_FEATURES
2050
2051/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002052 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2053 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002054 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002055 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2056 * the set of trusted certificates through a callback instead of a linked
2057 * list.
2058 *
2059 * This is useful for example in environments where a large number of trusted
2060 * certificates is present and storing them in a linked list isn't efficient
2061 * enough, or when the set of trusted certificates changes frequently.
2062 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002063 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002064 * `mbedtls_ssl_conf_ca_cb()` for more information.
2065 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002066 * Requires: MBEDTLS_X509_CRT_PARSE_C
2067 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002068 * Uncomment to enable trusted certificate callbacks.
2069 */
2070//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2071
2072/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002073 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002074 *
Chris Jones2c745862020-12-16 11:41:06 +00002075 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002076 *
Chris Jones2c745862020-12-16 11:41:06 +00002077 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002078 * and other functions/constants only used by these functions, thus reducing
2079 * the code footprint by several KB.
2080 */
Chris Jones2c745862020-12-16 11:41:06 +00002081//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002082
2083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002085 *
2086 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2087 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2088 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002089 * Requires: MBEDTLS_PKCS1_V21
2090 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002091 * Comment this macro to disallow using RSASSA-PSS in certificates.
2092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002094/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002095
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002096/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002097 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002098 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002099 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002100 * \{
2101 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002102
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002103/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002105 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002106 * Enable AES-NI support on x86-64 or x86-32.
2107 *
2108 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002109 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002110 * - GCC, x86-64, target not explicitly supporting AESNI:
2111 * requires MBEDTLS_HAVE_ASM.
2112 * - GCC, x86-32, target not explicitly supporting AESNI:
2113 * not supported.
2114 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2115 * For this assembly-less implementation, you must currently compile
2116 * `library/aesni.c` and `library/aes.c` with machine options to enable
2117 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2118 * `clang -maes -mpclmul`.
2119 * - Non-x86 targets: this option is silently ignored.
2120 * - Other compilers: this option is silently ignored.
2121 *
2122 * \note
2123 * Above, "GCC" includes compatible compilers such as Clang.
2124 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002125 *
2126 * Module: library/aesni.c
2127 * Caller: library/aes.c
2128 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002129 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002130 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002131 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002134
2135/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002136 * \def MBEDTLS_AESCE_C
2137 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002138 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002139 *
2140 * Module: library/aesce.c
2141 * Caller: library/aes.c
2142 *
Jerry Yuf015a932023-04-25 10:38:03 +08002143 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002144 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002145 * \warning Runtime detection only works on Linux. For non-Linux operating
2146 * system, Armv8-A Cryptographic Extensions must be supported by
2147 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002148 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002149 * \note Minimum compiler versions for this feature when targeting aarch64
2150 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2151 * Minimum compiler versions for this feature when targeting 32-bit
2152 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002153 *
2154 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2155 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002156 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002157 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002158 */
2159#define MBEDTLS_AESCE_C
2160
2161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002162 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002163 *
2164 * Enable the AES block cipher.
2165 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002166 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002167 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002168 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002169 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002171 * This module enables the following ciphersuites (if other requisites are
2172 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2174 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2175 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2176 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2178 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2180 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2181 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2182 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2184 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2185 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2186 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2187 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2189 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2190 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2191 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2192 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2193 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2194 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2195 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2196 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2197 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2198 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2199 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2200 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2201 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2202 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2203 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2204 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2205 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2206 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2207 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2208 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2209 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2211 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2212 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2213 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2214 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2215 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2216 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2217 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2218 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2219 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2220 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2221 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2222 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2223 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2224 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2225 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2226 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2227 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2228 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2229 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2230 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002231 *
Paul Bakkercff68422013-09-15 20:43:33 +02002232 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002234#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002235
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002238 *
2239 * Enable the generic ASN1 parser.
2240 *
2241 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002242 * Caller: library/x509.c
2243 * library/dhm.c
2244 * library/pkcs12.c
2245 * library/pkcs5.c
2246 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002249
2250/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002252 *
2253 * Enable the generic ASN1 writer.
2254 *
2255 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002256 * Caller: library/ecdsa.c
2257 * library/pkwrite.c
2258 * library/x509_create.c
2259 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002260 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002263
2264/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002266 *
2267 * Enable the Base64 module.
2268 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002269 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002270 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002271 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002272 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002275
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002276/**
Yanray Wange367e472023-10-31 17:23:04 +08002277 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2278 *
2279 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2280 *
2281 * \note This feature is incompatible with insecure block cipher,
2282 * MBEDTLS_DES_C, and cipher modes which always require decryption
2283 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002284 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2285 * this feature is incompatible with following supported PSA equivalence,
2286 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2287 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002288 *
2289 * Module: library/aes.c
2290 * library/aesce.c
2291 * library/aesni.c
2292 * library/aria.c
2293 * library/camellia.c
2294 * library/cipher.c
2295 */
2296//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2297
2298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002300 *
Paul Bakker9a736322012-11-14 12:39:52 +00002301 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002302 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002303 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002304 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002305 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002306 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002307 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002308 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002309 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002311 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002312 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002313 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002314 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002317
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002320 *
2321 * Enable the Camellia block cipher.
2322 *
Paul Bakker38119b12009-01-10 23:31:23 +00002323 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002324 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002325 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002326 * This module enables the following ciphersuites (if other requisites are
2327 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2329 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2330 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2331 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2333 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2334 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2335 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2336 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2337 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2338 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2341 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2342 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2343 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2345 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2347 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2348 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2349 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2350 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2352 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2353 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2358 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2359 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2361 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2362 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2363 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2364 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2366 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2367 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2368 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2369 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002370 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002372
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002373/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002374 * \def MBEDTLS_ARIA_C
2375 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002376 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002377 *
2378 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002379 * Caller: library/cipher.c
2380 *
2381 * This module enables the following ciphersuites (if other requisites are
2382 * enabled as well):
2383 *
2384 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2386 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2387 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2389 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2392 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2394 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2395 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2396 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2397 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2398 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2399 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2400 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2406 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2407 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2408 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2409 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2410 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2411 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2412 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2413 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2414 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2415 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2416 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2417 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2418 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2419 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2420 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2421 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002422 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002423#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002424
2425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002427 *
2428 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2429 *
2430 * Module: library/ccm.c
2431 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002432 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2433 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002434 *
2435 * This module enables the AES-CCM ciphersuites, if other requisites are
2436 * enabled as well.
2437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002439
2440/**
Daniel King34b822c2016-05-15 17:28:08 -03002441 * \def MBEDTLS_CHACHA20_C
2442 *
2443 * Enable the ChaCha20 stream cipher.
2444 *
2445 * Module: library/chacha20.c
2446 */
2447#define MBEDTLS_CHACHA20_C
2448
2449/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002450 * \def MBEDTLS_CHACHAPOLY_C
2451 *
2452 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2453 *
2454 * Module: library/chachapoly.c
2455 *
2456 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2457 */
2458#define MBEDTLS_CHACHAPOLY_C
2459
2460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002462 *
2463 * Enable the generic cipher layer.
2464 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002465 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002466 * Caller: library/ccm.c
2467 * library/cmac.c
2468 * library/gcm.c
2469 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002470 * library/pkcs12.c
2471 * library/pkcs5.c
2472 * library/psa_crypto_aead.c
2473 * library/psa_crypto_mac.c
2474 * library/ssl_ciphersuites.c
2475 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002476 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002477 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2478 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002479 *
2480 * Uncomment to enable generic cipher wrappers.
2481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002483
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002484/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002485 * \def MBEDTLS_CMAC_C
2486 *
Simon Butcher327398a2016-10-05 14:09:11 +01002487 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2488 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002489 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002490 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2491 * implementation of the CMAC algorithm is provided by an alternate
2492 * implementation, that alternate implementation may opt to not support
2493 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2494 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002495 * Module: library/cmac.c
2496 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002497 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002498 *
2499 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002500#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002501
2502/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002504 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002505 * Enable the CTR_DRBG AES-based random generator.
2506 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002507 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002508 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002509 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2510 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2511 * is used.
2512 *
2513 * \warning When using PSA, the user should call `psa_crypto_init()` before
2514 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2515 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002516 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2517 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002518 * \note To achieve a 256-bit security strength with CTR_DRBG,
2519 * you must use AES-256 *and* use sufficient entropy.
2520 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002521 *
2522 * Module: library/ctr_drbg.c
2523 * Caller:
2524 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002525 * Requires: MBEDTLS_AES_C or
2526 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2527 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002528 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002529 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002532
2533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002535 *
2536 * Enable the debug functions.
2537 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002538 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002539 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002540 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002541 * library/ssl_tls12_*.c
2542 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002543 *
2544 * This module provides debugging functions.
2545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002547
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002550 *
2551 * Enable the DES block cipher.
2552 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002553 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002554 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002555 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002556 *
Paul Bakkercff68422013-09-15 20:43:33 +02002557 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002558 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002559 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002560 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002563
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002564/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002566 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002567 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002568 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002569 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002570 * Caller: library/ssl_tls.c
2571 * library/ssl*_client.c
2572 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002573 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002574 * This module is used by the following key exchanges:
2575 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002576 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002577 * \warning Using DHE constitutes a security risk as it
2578 * is not possible to validate custom DH parameters.
2579 * If possible, it is recommended users should consider
2580 * preferring other methods of key exchange.
2581 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002582 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002585
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002588 *
2589 * Enable the elliptic curve Diffie-Hellman library.
2590 *
2591 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002592 * Caller: library/psa_crypto.c
2593 * library/ssl_tls.c
2594 * library/ssl*_client.c
2595 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002596 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002597 * This module is used by the following key exchanges:
2598 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002599 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002603
2604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002606 *
2607 * Enable the elliptic curve DSA library.
2608 *
2609 * Module: library/ecdsa.c
2610 * Caller:
2611 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002612 * This module is used by the following key exchanges:
2613 * ECDHE-ECDSA
2614 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002615 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2616 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2617 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002620
2621/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002622 * \def MBEDTLS_ECJPAKE_C
2623 *
2624 * Enable the elliptic curve J-PAKE library.
2625 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002626 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2627 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002628 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002629 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002630 * Module: library/ecjpake.c
2631 * Caller:
2632 *
2633 * This module is used by the following key exchanges:
2634 * ECJPAKE
2635 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002636 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002637 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002638 * \warning If using a hash that is only provided by PSA drivers, you must
2639 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002640 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002641#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002642
2643/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002645 *
2646 * Enable the elliptic curve over GF(p) library.
2647 *
2648 * Module: library/ecp.c
2649 * Caller: library/ecdh.c
2650 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002651 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002652 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002656
2657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002659 *
2660 * Enable the platform-specific entropy code.
2661 *
2662 * Module: library/entropy.c
2663 * Caller:
2664 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002666 *
2667 * This module provides a generic entropy pool
2668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002670
2671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002673 *
2674 * Enable error code to error string conversion.
2675 *
2676 * Module: library/error.c
2677 * Caller:
2678 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002682
2683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002685 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002686 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002687 *
2688 * Module: library/gcm.c
2689 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002690 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2691 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002692 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002693 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2694 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002697
2698/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002699 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002700 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002701 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002702 * Can significantly increase throughput on systems without GCM hardware
2703 * acceleration (e.g., AESNI, AESCE).
2704 *
Matthias Schulz78266782024-02-08 13:54:48 +01002705 * The mbedtls_gcm_context size will increase by 3840 bytes.
2706 * The code size will increase by roughly 344 bytes.
2707 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002708 * Module: library/gcm.c
2709 *
2710 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002711 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002712//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002713
2714/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002715 * \def MBEDTLS_HKDF_C
2716 *
2717 * Enable the HKDF algorithm (RFC 5869).
2718 *
2719 * Module: library/hkdf.c
2720 * Caller:
2721 *
2722 * Requires: MBEDTLS_MD_C
2723 *
2724 * This module adds support for the Hashed Message Authentication Code
2725 * (HMAC)-based key derivation function (HKDF).
2726 */
2727#define MBEDTLS_HKDF_C
2728
2729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002731 *
2732 * Enable the HMAC_DRBG random generator.
2733 *
2734 * Module: library/hmac_drbg.c
2735 * Caller:
2736 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002738 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002739 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002742
2743/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002744 * \def MBEDTLS_LMS_C
2745 *
2746 * Enable the LMS stateful-hash asymmetric signature algorithm.
2747 *
2748 * Module: library/lms.c
2749 * Caller:
2750 *
Raef Colesab4f8742022-09-01 12:24:31 +01002751 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002752 *
Raef Colesab4f8742022-09-01 12:24:31 +01002753 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002754 */
2755#define MBEDTLS_LMS_C
2756
2757/**
Raef Colesab4f8742022-09-01 12:24:31 +01002758 * \def MBEDTLS_LMS_PRIVATE
2759 *
2760 * Enable LMS private-key operations and signing code. Functions enabled by this
2761 * option are experimental, and should not be used in production.
2762 *
2763 * Requires: MBEDTLS_LMS_C
2764 *
2765 * Uncomment to enable the LMS signature algorithm and private key operations.
2766 */
Raef Coles5127e852022-10-07 10:35:56 +01002767//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002768
2769/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002770 * \def MBEDTLS_NIST_KW_C
2771 *
2772 * Enable the Key Wrapping mode for 128-bit block ciphers,
2773 * as defined in NIST SP 800-38F. Only KW and KWP modes
2774 * are supported. At the moment, only AES is approved by NIST.
2775 *
2776 * Module: library/nist_kw.c
2777 *
2778 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2779 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002780#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002781
2782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002784 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002785 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002786 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002787 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2788 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002789 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002790 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002791 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002792 * Caller: library/constant_time.c
2793 * library/ecdsa.c
2794 * library/ecjpake.c
2795 * library/hkdf.c
2796 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002797 * library/pk.c
2798 * library/pkcs5.c
2799 * library/pkcs12.c
2800 * library/psa_crypto_ecp.c
2801 * library/psa_crypto_rsa.c
2802 * library/rsa.c
2803 * library/ssl_cookie.c
2804 * library/ssl_msg.c
2805 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002806 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002807 * library/x509_crt.c
2808 * library/x509write_crt.c
2809 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002810 *
2811 * Uncomment to enable generic message digest wrappers.
2812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002814
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002817 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002818 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002819 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002820 * Module: library/md5.c
2821 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002822 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002823 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002824 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002825 * This module is required for TLS 1.2 depending on the handshake parameters.
2826 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2827 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002828 *
2829 * \warning MD5 is considered a weak message digest and its use constitutes a
2830 * security risk. If possible, we recommend avoiding dependencies on
2831 * it, and considering stronger message digests instead.
2832 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002835
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002838 *
2839 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002840 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002841 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002842 *
2843 * Module: library/memory_buffer_alloc.c
2844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002846 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002847 *
2848 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002851
2852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002854 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002855 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2856 *
Simon Butcherd567a232016-03-09 20:19:21 +00002857 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2858 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002859 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002860 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002861 * \note See also our Knowledge Base article about porting to a new
2862 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002863 * 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 +00002864 *
Andres AG788aa4a2016-09-14 14:32:09 +01002865 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002866 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002867 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002870
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002873 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002874 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002875 *
2876 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002877 * Caller: library/asn1write.c
2878 * library/pkcs5.c
2879 * library/pkparse.c
2880 * library/pkwrite.c
2881 * library/rsa.c
2882 * library/x509.c
2883 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002884 * library/x509_crl.c
2885 * library/x509_crt.c
2886 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002887 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002888 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002889 *
2890 * This modules translates between OIDs and internal values.
2891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002893
2894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002896 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002897 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002898 *
2899 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002900 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002901 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002902 * library/x509_crl.c
2903 * library/x509_crt.c
2904 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002907 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2908 *
2909 * \warning When parsing password-protected files, if MD5 is provided only by
2910 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002911 *
Paul Bakkercff68422013-09-15 20:43:33 +02002912 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002913 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002915
2916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002918 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002919 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002920 *
2921 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002922 * Caller: library/pkwrite.c
2923 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002924 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002925 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002927 *
2928 * This modules adds support for encoding / writing PEM files.
2929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002931
2932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002934 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002935 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002936 *
2937 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002938 * Caller: library/psa_crypto_rsa.c
2939 * library/ssl_tls.c
2940 * library/ssl*_client.c
2941 * library/ssl*_server.c
2942 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002943 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002944 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002945 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002946 * Uncomment to enable generic public key wrappers.
2947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002949
2950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002952 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002953 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002954 *
2955 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002956 * Caller: library/x509_crt.c
2957 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002958 *
Yanray Wang072a0682023-12-05 10:53:04 +08002959 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002960 *
2961 * Uncomment to enable generic public key parse functions.
2962 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002964
2965/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002967 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002968 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002969 *
2970 * Module: library/pkwrite.c
2971 * Caller: library/x509write.c
2972 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002973 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002974 *
2975 * Uncomment to enable generic public key write functions.
2976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002978
2979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002981 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002982 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002983 *
2984 * Module: library/pkcs5.c
2985 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002986 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002987 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002988 * \warning If using a hash that is only provided by PSA drivers, you must
2989 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002990 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002991 * This module adds support for the PKCS#5 functions.
2992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002994
2995/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002996 * \def MBEDTLS_PKCS7_C
2997 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002998 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002999 * RFC Link - https://tools.ietf.org/html/rfc2315
3000 *
3001 * Module: library/pkcs7.c
3002 *
3003 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003004 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3005 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003006 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003007 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003008 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003009#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003010
3011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003013 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003014 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003015 * Adds algorithms for parsing PKCS#8 encrypted private keys
3016 *
3017 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003018 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003019 *
Valerio Settie98ad592023-12-28 10:42:12 +01003020 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3021 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003022 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003023 * \warning If using a hash that is only provided by PSA drivers, you must
3024 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003025 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003026 * This module enables PKCS#12 functions.
3027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003029
3030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003032 *
3033 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003034 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003035 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3037 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003038 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003039 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003040 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003041 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003042 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003043 * Module: library/platform.c
3044 * Caller: Most other .c files
3045 *
3046 * This module enables abstraction of common (libc) functions.
3047 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003048#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003049
3050/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003051 * \def MBEDTLS_POLY1305_C
3052 *
3053 * Enable the Poly1305 MAC algorithm.
3054 *
3055 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003056 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003057 */
3058#define MBEDTLS_POLY1305_C
3059
3060/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003061 * \def MBEDTLS_PSA_CRYPTO_C
3062 *
3063 * Enable the Platform Security Architecture cryptography API.
3064 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003065 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003066 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003067 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003068 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003069 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3070 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3071 * is enabled in PSA (unless it's fully accelerated, see
3072 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003073 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003074#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003075
3076/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003077 * \def MBEDTLS_PSA_CRYPTO_SE_C
3078 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003079 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003080 * cryptography API.
3081 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003082 * \deprecated This feature is deprecated. Please switch to the PSA driver
3083 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003084 *
Ryan Everett32a64582024-03-05 18:16:18 +00003085 * \warning This feature is not thread-safe, and should not be used in a
3086 * multi-threaded environment.
3087 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003088 * Module: library/psa_crypto_se.c
3089 *
3090 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3091 *
3092 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003093//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003094
3095/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003096 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3097 *
3098 * Enable the Platform Security Architecture persistent key storage.
3099 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003100 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003101 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003102 * Requires: MBEDTLS_PSA_CRYPTO_C,
3103 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3104 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003105 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003106#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003107
3108/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003109 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003110 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003111 * Enable the emulation of the Platform Security Architecture
3112 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003113 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003114 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003115 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003116 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003117 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003118#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003119
3120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003122 *
3123 * Enable the RIPEMD-160 hash algorithm.
3124 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003125 * Module: library/ripemd160.c
3126 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003127 *
3128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003130
3131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133 *
3134 * Enable the RSA public-key cryptosystem.
3135 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003136 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003137 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003138 * Caller: library/pk.c
3139 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003140 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003141 * library/ssl*_client.c
3142 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003143 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003144 * This module is used by the following key exchanges:
3145 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003146 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003150
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003153 *
3154 * Enable the SHA1 cryptographic hash algorithm.
3155 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003156 * Module: library/sha1.c
3157 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003158 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003159 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003160 * This module is required for TLS 1.2 depending on the handshake parameters,
3161 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003162 *
3163 * \warning SHA-1 is considered a weak message digest and its use constitutes
3164 * a security risk. If possible, we recommend avoiding dependencies
3165 * on it, and considering stronger message digests instead.
3166 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003169
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003170/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003171 * \def MBEDTLS_SHA224_C
3172 *
3173 * Enable the SHA-224 cryptographic hash algorithm.
3174 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003175 * Module: library/sha256.c
3176 * Caller: library/md.c
3177 * library/ssl_cookie.c
3178 *
3179 * This module adds support for SHA-224.
3180 */
3181#define MBEDTLS_SHA224_C
3182
3183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003185 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003186 * Enable the SHA-256 cryptographic hash algorithm.
3187 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003188 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003189 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003190 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003191 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003192 * library/ssl*_client.c
3193 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003194 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003195 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003196 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003199
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003200/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003201 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003202 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003203 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3204 * with the ARMv8 cryptographic extensions if they are available at runtime.
3205 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003206 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003207 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003208 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003209 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003210 * \note Minimum compiler versions for this feature are Clang 4.0,
3211 * armclang 6.6 or GCC 6.0.
3212 *
3213 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3214 * armclang <= 6.9
3215 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003216 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3217 * That name is deprecated, but may still be used as an alternative form for this
3218 * option.
3219 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003220 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3221 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003222 *
3223 * Requires: MBEDTLS_SHA256_C.
3224 *
3225 * Module: library/sha256.c
3226 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003227 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003228 * and use them if available.
3229 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003230//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003231
Dave Rodgmand85277c2023-10-13 09:22:54 +01003232/**
3233 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3234 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003235 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003236 * This name is now deprecated, but may still be used as an alternative form for
3237 * this option.
3238 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003239//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3240
3241/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003242 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003243 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003244 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3245 * with the ARMv8 cryptographic extensions, which must be available at runtime
3246 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003247 *
3248 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003249 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003250 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003251 * \note Minimum compiler versions for this feature are Clang 4.0,
3252 * armclang 6.6 or GCC 6.0.
3253 *
3254 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3255 * armclang <= 6.9
3256 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003257 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003258 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003259 * option.
3260 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003261 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3262 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003263 *
3264 * Requires: MBEDTLS_SHA256_C.
3265 *
3266 * Module: library/sha256.c
3267 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003268 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003269 * unconditionally.
3270 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003271//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003272
Dave Rodgmand85277c2023-10-13 09:22:54 +01003273/**
3274 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3275 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003276 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003277 * This name is now deprecated, but may still be used as an alternative form for
3278 * this option.
3279 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003280//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3281
3282/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003283 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003284 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003285 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003286 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003287 * Module: library/sha512.c
3288 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003289 * library/psa_crypto_hash.c
3290 * library/ssl_tls.c
3291 * library/ssl*_client.c
3292 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003293 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003294 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003295 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003296#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003297
3298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003300 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003301 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003302 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003303 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003304 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003305 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003306 * library/ssl_tls.c
3307 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003308 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003309 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003312
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003313/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003314 * \def MBEDTLS_SHA3_C
3315 *
3316 * Enable the SHA3 cryptographic hash algorithm.
3317 *
3318 * Module: library/sha3.c
3319 *
3320 * This module adds support for SHA3.
3321 */
3322#define MBEDTLS_SHA3_C
3323
3324/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003325 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3326 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003327 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3328 * with the ARMv8 cryptographic extensions if they are available at runtime.
3329 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003330 *
3331 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3332 * for a non-Aarch64 build it will be silently ignored.
3333 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003334 * \note Minimum compiler versions for this feature are Clang 7.0,
3335 * armclang 6.9 or GCC 8.0.
3336 *
3337 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3338 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003339 *
3340 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3341 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3342 *
3343 * Requires: MBEDTLS_SHA512_C.
3344 *
3345 * Module: library/sha512.c
3346 *
3347 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3348 * and use them if available.
3349 */
3350//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3351
3352/**
3353 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3354 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003355 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3356 * with the ARMv8 cryptographic extensions, which must be available at runtime
3357 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003358 *
3359 * \note This allows builds with a smaller code size than with
3360 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3361 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003362 * \note Minimum compiler versions for this feature are Clang 7.0,
3363 * armclang 6.9 or GCC 8.0.
3364 *
3365 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3366 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003367 *
3368 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3369 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3370 *
3371 * Requires: MBEDTLS_SHA512_C.
3372 *
3373 * Module: library/sha512.c
3374 *
3375 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3376 * unconditionally.
3377 */
3378//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3379
3380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003382 *
3383 * Enable simple SSL cache implementation.
3384 *
3385 * Module: library/ssl_cache.c
3386 * Caller:
3387 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003391
3392/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003394 *
3395 * Enable basic implementation of DTLS cookies for hello verification.
3396 *
3397 * Module: library/ssl_cookie.c
3398 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003401
3402/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003403 * \def MBEDTLS_SSL_TICKET_C
3404 *
3405 * Enable an implementation of TLS server-side callbacks for session tickets.
3406 *
3407 * Module: library/ssl_ticket.c
3408 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003409 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003410 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3411 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003412 */
3413#define MBEDTLS_SSL_TICKET_C
3414
3415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003417 *
3418 * Enable the SSL/TLS client code.
3419 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003420 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003421 * Caller:
3422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003424 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 * This module is required for SSL/TLS client support.
3426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003428
Paul Bakker9a736322012-11-14 12:39:52 +00003429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003431 *
3432 * Enable the SSL/TLS server code.
3433 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003434 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003435 * Caller:
3436 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003438 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003439 * This module is required for SSL/TLS server support.
3440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003442
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003445 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003446 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003448 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003449 * Caller: library/ssl*_client.c
3450 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003451 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3453 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003454 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003455 * This module is required for SSL/TLS.
3456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003458
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003461 *
3462 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003463 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003464 * contexts are not shared between threads. If you do intend to use contexts
3465 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003466 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003467 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003468 *
3469 * Module: library/threading.c
3470 *
3471 * This allows different threading implementations (self-implemented or
3472 * provided).
3473 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474 * You will have to enable either MBEDTLS_THREADING_ALT or
3475 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003476 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003477 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003480
3481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003483 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003484 * Enable the semi-portable timing interface.
3485 *
Simon Butcherd567a232016-03-09 20:19:21 +00003486 * \note The provided implementation only works on POSIX/Unix (including Linux,
3487 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003488 * module and provide your own implementations of the callbacks needed by
3489 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3490 * your own implementation of the whole module by setting
3491 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003492 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003493 * \note The timing module will include time.h on suitable platforms
3494 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3495 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3496 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003497 * \note See also our Knowledge Base article about porting to a new
3498 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003499 * 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 +00003500 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003501 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003504
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507 *
3508 * Enable run-time version information.
3509 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003510 * Module: library/version.c
3511 *
3512 * This module provides run-time version information.
3513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003515
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003518 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003519 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003520 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003521 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003522 * Caller: library/x509_crl.c
3523 * library/x509_crt.c
3524 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003525 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003526 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003527 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3528 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003529 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3530 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003531 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003532 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003535
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003538 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003540 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003541 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003542 * Caller: library/ssl_tls.c
3543 * library/ssl*_client.c
3544 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003545 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 *
3548 * This module is required for X.509 certificate parsing.
3549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003551
3552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554 *
3555 * Enable X.509 CRL parsing.
3556 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003557 * Module: library/x509_crl.c
3558 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003561 *
3562 * This module is required for X.509 CRL parsing.
3563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003564#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003565
3566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003568 *
3569 * Enable X.509 Certificate Signing Request (CSR) parsing.
3570 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003571 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003572 * Caller: library/x509_crt_write.c
3573 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003575 *
3576 * This module is used for reading X.509 certificate request.
3577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003579
3580/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003583 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584 *
3585 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003586 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003587 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003588 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3589 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003590 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3591 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003592 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003593 * This module is the basis for creating X.509 certificates and CSRs.
3594 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003596
3597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599 *
3600 * Enable creating X.509 certificates.
3601 *
3602 * Module: library/x509_crt_write.c
3603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 *
3606 * This module is required for X.509 certificate creation.
3607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003609
3610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003612 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003613 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003614 *
3615 * Module: library/x509_csr_write.c
3616 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003617 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003618 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003619 * This module is required for X.509 certificate request writing.
3620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003622
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003623/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003624
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003625/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003626 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003627 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003628 * This section contains Mbed TLS build settings that are not associated
3629 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003630 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003631 * \{
3632 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633
Gilles Peskinea02c1242022-03-16 17:03:19 +01003634/**
3635 * \def MBEDTLS_CONFIG_FILE
3636 *
3637 * If defined, this is a header which will be included instead of
3638 * `"mbedtls/mbedtls_config.h"`.
3639 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003640 * Unlike other configuration options, this one must be defined on the
3641 * compiler command line: a definition in `mbedtls_config.h` would have
3642 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003643 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003644 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003645 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003646 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003647 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003648 * The value of this symbol is typically a path in double quotes, either
3649 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003650 */
3651//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3652
3653/**
3654 * \def MBEDTLS_USER_CONFIG_FILE
3655 *
3656 * If defined, this is a header which will be included after
3657 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003658 * This allows you to modify the default configuration, including the ability
3659 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003660 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003661 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003662 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003663 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003664 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003665 * The value of this symbol is typically a path in double quotes, either
3666 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003667 */
3668//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3669
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003670/**
3671 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3672 *
3673 * If defined, this is a header which will be included instead of
3674 * `"psa/crypto_config.h"`.
3675 * This header file specifies which cryptographic mechanisms are available
3676 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3677 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3678 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003679 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003680 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003681 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003682 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003683 * The value of this symbol is typically a path in double quotes, either
3684 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003685 */
3686//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3687
3688/**
3689 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3690 *
3691 * If defined, this is a header which will be included after
3692 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003693 * This allows you to modify the default configuration, including the ability
3694 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003695 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003696 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003697 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003698 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003699 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003700 * The value of this symbol is typically a path in double quotes, either
3701 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003702 */
3703//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3704
Gilles Peskineb1176f22023-02-22 22:07:28 +01003705/**
3706 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3707 *
3708 * If defined, this is a header which will be included instead of
3709 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3710 * as the one in Mbed TLS, but with definitions adapted to the platform on
3711 * which the library code will run.
3712 *
3713 * \note The required content of this header can vary from one version of
3714 * Mbed TLS to the next. Integrators who provide an alternative file
3715 * should review the changes in the original file whenever they
3716 * upgrade Mbed TLS.
3717 *
3718 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3719 * non-standard feature of the C language, so this feature is only available
3720 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3721 *
3722 * The value of this symbol is typically a path in double quotes, either
3723 * absolute or relative to a directory on the include search path.
3724 */
3725//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3726
3727/**
3728 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3729 *
3730 * If defined, this is a header which will be included instead of
3731 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3732 * as the one in Mbed TLS, but with definitions adapted to the environment
3733 * in which the library code will run. The typical use for this feature
3734 * is to provide alternative type definitions on the client side in
3735 * client-server integrations of PSA crypto, where operation structures
3736 * contain handles instead of cryptographic data.
3737 *
3738 * \note The required content of this header can vary from one version of
3739 * Mbed TLS to the next. Integrators who provide an alternative file
3740 * should review the changes in the original file whenever they
3741 * upgrade Mbed TLS.
3742 *
3743 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3744 * non-standard feature of the C language, so this feature is only available
3745 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3746 *
3747 * The value of this symbol is typically a path in double quotes, either
3748 * absolute or relative to a directory on the include search path.
3749 */
3750//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3751
Gilles Peskineba4162a2022-04-11 17:04:38 +02003752/** \} name SECTION: General configuration options */
3753
3754/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003755 * \name SECTION: Module configuration options
3756 *
3757 * This section allows for the setting of module specific sizes and
3758 * configuration options. The default values are already present in the
3759 * relevant header files and should suffice for the regular use cases.
3760 *
3761 * Our advice is to enable options and change their values here
3762 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003763 * \{
3764 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003765/* The Doxygen documentation here is used when a user comments out a
3766 * setting and runs doxygen themselves. On the other hand, when we typeset
3767 * the full documentation including disabled settings, the documentation
3768 * in specific modules' header files is used if present. When editing this
3769 * file, make sure that each option is documented in exactly one place,
3770 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3771 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003772
Paul Bakker088c5c52014-04-25 11:11:10 +02003773/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003774//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003776
Paul Bakker088c5c52014-04-25 11:11:10 +02003777/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3779//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3780//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3781//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3782//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003783
Paul Bakker088c5c52014-04-25 11:11:10 +02003784/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003785//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3786//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3787//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3788//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003789
Paul Bakker088c5c52014-04-25 11:11:10 +02003790/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003791//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003792//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003793
Paul Bakker088c5c52014-04-25 11:11:10 +02003794/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003795//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3796//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003797//#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 +01003798
Paul Bakker088c5c52014-04-25 11:11:10 +02003799/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003801
Paul Bakker088c5c52014-04-25 11:11:10 +02003802/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003803//#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 -04003804
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003805/** \def MBEDTLS_PLATFORM_STD_CALLOC
3806 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003807 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003808 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003809 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003810 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003811 * 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 -04003812 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3813 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003814 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003815 */
3816//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003817
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003818/** \def MBEDTLS_PLATFORM_STD_FREE
3819 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003820 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003821 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003822 * 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 -04003823 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3824 * 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 -04003825 */
3826//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003827//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003828//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003829//#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 +02003830//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3831//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003832/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003833//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003834//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3835//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003836//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3837//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3838//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003839
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003840/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003841/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003842//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3843//#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 +02003844//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003845//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003846//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3847//#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 +02003848//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3849//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003850/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003851//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003852//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003853//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3854//#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 +08003855//#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 +08003856//#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 +02003857
Gilles Peskine3f106f72021-09-23 17:42:39 +02003858/** \def MBEDTLS_CHECK_RETURN
3859 *
3860 * This macro is used at the beginning of the declaration of a function
3861 * to indicate that its return value should be checked. It should
3862 * instruct the compiler to emit a warning or an error if the function
3863 * is called without checking its return value.
3864 *
3865 * There is a default implementation for popular compilers in platform_util.h.
3866 * You can override the default implementation by defining your own here.
3867 *
3868 * If the implementation here is empty, this will effectively disable the
3869 * checking of functions' return values.
3870 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003871//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003872
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003873/** \def MBEDTLS_IGNORE_RETURN
3874 *
3875 * This macro requires one argument, which should be a C function call.
3876 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3877 * warning is suppressed.
3878 */
3879//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3880
Gilles Peskineed038902020-11-13 21:33:21 +01003881/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003882/**
Gilles Peskineed038902020-11-13 21:33:21 +01003883 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3884 * PSA crypto subsystem.
3885 *
3886 * If this option is unset:
3887 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003888 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003889 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3890 * on unspecified heuristics.
3891 */
3892//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3893
Steven Cooreman863470a2021-02-15 14:03:19 +01003894/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003895 * Restrict the PSA library to supporting a maximum amount of simultaneously
3896 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3897 * volatile key, or a persistent key which is loaded temporarily by the
3898 * library as part of a crypto operation in flight.
3899 *
3900 * If this option is unset, the library will fall back to a default value of
3901 * 32 keys.
3902 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003903//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003904
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003905/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003906//#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 +00003907
Paul Bakker088c5c52014-04-25 11:11:10 +02003908/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3910//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003911
Paul Bakker088c5c52014-04-25 11:11:10 +02003912/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003913
Angus Grattond8213d02016-05-25 20:56:48 +10003914/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3915 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003916 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003917 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003918 * This determines the size of the incoming TLS I/O buffer in such a way
3919 * that it is capable of holding the specified amount of plaintext data,
3920 * regardless of the protection mechanism used.
3921 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003922 * \note When using a value less than the default of 16KB on the client, it is
3923 * recommended to use the Maximum Fragment Length (MFL) extension to
3924 * inform the server about this limitation. On the server, there
3925 * is no supported, standardized way of informing the client about
3926 * restriction on the maximum size of incoming messages, and unless
3927 * the limitation has been communicated by other means, it is recommended
3928 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3929 * while keeping the default value of 16KB for the incoming buffer.
3930 *
David Horstmann95d516f2021-05-04 18:36:56 +01003931 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003932 */
3933//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3934
Gilles Peskined3d02902020-03-04 21:35:27 +01003935/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3936 *
3937 * The maximum length of CIDs used for incoming DTLS messages.
3938 *
3939 */
3940//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3941
3942/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3943 *
3944 * The maximum length of CIDs used for outgoing DTLS messages.
3945 *
3946 */
3947//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3948
TRodziewicze8dd7092021-05-12 14:19:11 +02003949/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003950 *
3951 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003952 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003953 *
3954 * The padding will always be chosen so that the length of the
3955 * padded plaintext is a multiple of the value of this option.
3956 *
3957 * Note: A value of \c 1 means that no padding will be used
3958 * for outgoing records.
3959 *
3960 * Note: On systems lacking division instructions,
3961 * a power of two should be preferred.
3962 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003963//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003964
Angus Grattond8213d02016-05-25 20:56:48 +10003965/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3966 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003967 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003968 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003969 * This determines the size of the outgoing TLS I/O buffer in such a way
3970 * that it is capable of holding the specified amount of plaintext data,
3971 * regardless of the protection mechanism used.
3972 *
Angus Grattond8213d02016-05-25 20:56:48 +10003973 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3974 * the default inward 16384 byte buffer to conform to the TLS specification.
3975 *
3976 * The minimum required outward buffer size is determined by the handshake
3977 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3978 * The specific size requirement depends on the configured ciphers and any
3979 * certificate data which is sent during the handshake.
3980 *
David Horstmann95d516f2021-05-04 18:36:56 +01003981 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003982 */
3983//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3984
Hanno Beckere0b150f2018-08-21 15:51:03 +01003985/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3986 *
3987 * Maximum number of heap-allocated bytes for the purpose of
3988 * DTLS handshake message reassembly and future message buffering.
3989 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003990 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003991 * to account for a reassembled handshake message of maximum size,
3992 * together with its reassembly bitmap.
3993 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003994 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003995 * should be sufficient for all practical situations as it allows
3996 * to reassembly a large handshake message (such as a certificate)
3997 * while buffering multiple smaller handshake messages.
3998 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003999 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004000//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004001
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004002//#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 +02004003//#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 +02004004
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004005/**
4006 * Complete list of ciphersuites to use, in order of preference.
4007 *
4008 * \warning No dependency checking is done on that field! This option can only
4009 * be used to restrict the set of available ciphersuites. It is your
4010 * responsibility to make sure the needed modules are active.
4011 *
4012 * Use this to save a few hundred bytes of ROM (default ordering of all
4013 * available ciphersuites) and a few to a few hundred bytes of RAM.
4014 *
4015 * The value below is only an example, not the default.
4016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004017//#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 +02004018
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004019/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004020 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4021 *
4022 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004023 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004024 *
4025 * It must be positive and smaller than UINT32_MAX.
4026 *
4027 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4028 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004029 */
4030//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4031
4032/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004033 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4034 *
Jerry Yucf913512023-11-14 11:06:52 +08004035 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004036 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004037 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004038 * - The client ticket age is the time difference between the time when the
4039 * client proposes to the server to use the ticket and the time the client
4040 * received the ticket from the server.
4041 * - The server ticket age is the time difference between the time when the
4042 * server receives a proposition from the client to use the ticket and the
4043 * time when the ticket was created by the server.
4044 *
Jerry Yucf913512023-11-14 11:06:52 +08004045 * The ages might be different due to the client and server clocks not running
4046 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4047 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4048 * 6s, thus in the worst case clients and servers must sync up their system time
4049 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004050 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004051 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004052 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004053//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004054
4055/**
4056 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4057 *
4058 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4059 *
4060 * This must be less than 256.
4061 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004062//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004063
4064/**
4065 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4066 *
4067 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4068 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4069 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4070 *
4071 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004072//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004073
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004074/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004075//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004076//#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 +01004077
Gilles Peskine611179c2022-04-13 23:04:48 +02004078/** \} name SECTION: Module configuration options */