blob: 6fa2e6aa40b670347007e76450e92ef6f79f383b [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
Paul Bakker90995b52013-06-24 19:20:35 +0200353/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200354 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200357 * hardware entropy collector.
358 *
359 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000360 * prototype as declared in library/entropy_poll.h, and accept NULL as first
361 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 *
363 * Uncomment to use your own hardware entropy collector.
364 */
365//#define MBEDTLS_ENTROPY_HARDWARE_ALT
366
367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000369 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100370 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000371 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100372 * Uncomment this macro to use precomputed AES tables stored in ROM.
373 * Comment this macro to generate AES tables in RAM at runtime.
374 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100375 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
376 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100377 * initialization time before the first AES operation can be performed.
378 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
379 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
380 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100381 *
382 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000385
386/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100387 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200388 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200390 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * Uncommenting this macro omits 75% of the AES tables from
392 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
393 * by computing their values on the fly during operations
394 * (the tables are entry-wise rotations of one another).
395 *
396 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100397 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * runtime. Specifically, one has to compare 4 accesses within
399 * different tables to 4 accesses with additional arithmetic
400 * operations within the same table. The performance gain/loss
401 * depends on the system and memory details.
402 *
403 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200404 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100405//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200406
407/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800408 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
409 *
410 * Use only 128-bit keys in AES operations to save ROM.
411 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800412 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800413 * or 256-bit keys.
414 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800415 * Uncommenting this macro reduces the size of AES code by ~300 bytes
416 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800418 * Module: library/aes.c
419 *
420 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 */
422//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
423
Gilles Peskinea8861e02023-09-05 20:20:51 +0200424/*
425 * Disable plain C implementation for AES.
426 *
427 * When the plain C implementation is enabled, and an implementation using a
428 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
429 * detection will be used to select between them.
430 *
431 * If only one implementation is present, runtime detection will not be used.
432 * This configuration will crash at runtime if running on a CPU without the
433 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
434 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
435 */
436//#define MBEDTLS_AES_USE_HARDWARE_ONLY
437
Arto Kinnunen732ca322023-04-14 14:26:10 +0800438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200440 *
441 * Use less ROM for the Camellia implementation (saves about 768 bytes).
442 *
443 * Uncomment this macro to use less memory for Camellia.
444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200446
447/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200448 * \def MBEDTLS_CHECK_RETURN_WARNING
449 *
450 * If this macro is defined, emit a compile-time warning if application code
451 * calls a function without checking its return value, but the return value
452 * should generally be checked in portable applications.
453 *
454 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
455 * implemented. Otherwise this option has no effect.
456 *
457 * Uncomment to get warnings on using fallible functions without checking
458 * their return value.
459 *
460 * \note This feature is a work in progress.
461 * Warnings will be added to more functions in the future.
462 *
463 * \note A few functions are considered critical, and ignoring the return
464 * value of these functions will trigger a warning even if this
465 * macro is not defined. To completely disable return value check
466 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
467 */
468//#define MBEDTLS_CHECK_RETURN_WARNING
469
470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200472 *
473 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000479 *
480 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000483
484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486 *
487 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490
491/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100492 * \def MBEDTLS_CIPHER_MODE_OFB
493 *
494 * Enable Output Feedback mode (OFB) for symmetric ciphers.
495 */
496#define MBEDTLS_CIPHER_MODE_OFB
497
498/**
499 * \def MBEDTLS_CIPHER_MODE_XTS
500 *
501 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
502 */
503#define MBEDTLS_CIPHER_MODE_XTS
504
505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000507 *
508 * Enable NULL cipher.
509 * Warning: Only do so when you know what you are doing. This allows for
510 * encryption or channels without any security!
511 *
Ronald Croncee42702021-04-26 11:34:44 +0200512 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
514 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
516 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
518 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
519 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
520 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
521 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
522 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
523 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
524 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
526 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
529 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
530 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
531 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000532 *
533 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000536
537/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100538 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200539 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100540 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
541 * specific padding modes in the cipher layer with cipher modes that support
542 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200543 *
544 * If you disable all padding modes, only full blocks can be used with CBC.
545 *
546 * Enable padding modes in the cipher layer.
547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548#define MBEDTLS_CIPHER_PADDING_PKCS7
549#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
550#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
551#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200552
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200553/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
554 *
555 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800556 * Without this, CTR_DRBG uses a 256-bit key
557 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200558 */
559//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
560
Paul Bakker48e93c82013-08-14 12:21:18 +0200561/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200562 * Enable the verified implementations of ECDH primitives from Project Everest
563 * (currently only Curve25519). This feature changes the layout of ECDH
564 * contexts and therefore is a compatibility break for applications that access
565 * fields of a mbedtls_ecdh_context structure directly. See also
566 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000567 *
568 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
569 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200570 */
571//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
572
573/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100574 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200575 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100576 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
577 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200578 *
579 * Comment macros to disable the curve and functions for it
580 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200581/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
583#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
584#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
585#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
586#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
587#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
588#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
589#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
590#define MBEDTLS_ECP_DP_BP256R1_ENABLED
591#define MBEDTLS_ECP_DP_BP384R1_ENABLED
592#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200593/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200594#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000595#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200596
597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200599 *
600 * Enable specific 'modulo p' routines for each NIST prime.
601 * Depending on the prime and architecture, makes operations 4 to 8 times
602 * faster on the corresponding curve.
603 *
604 * Comment this macro to disable NIST curves optimisation.
605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200607
608/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200609 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100610 *
611 * Enable "non-blocking" ECC operations that can return early and be resumed.
612 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200613 * This allows various functions to pause by returning
614 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
615 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
616 * order to further progress and eventually complete their operation. This is
617 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
618 * number of ECC operations a function may perform before pausing; see
619 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100620 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200621 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200622 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100623 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100624 * This option:
625 * - Adds xxx_restartable() variants of existing operations in the
626 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100627 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
628 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100629 * - ECDSA: signature generation & verification;
630 * - PK: signature generation & verification;
631 * - X509: certificate chain verification.
632 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
633 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
634 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
635 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000636 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100637 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100638 * - verification of the server's key exchange signature;
639 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100640 * - generation of the client's signature if client authentication is used,
641 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100642 *
643 * \note In the cases above, the usual SSL/TLS functions, such as
644 * mbedtls_ssl_handshake(), can now return
645 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200646 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100647 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
648 * restartable operations in PK, X.509 and TLS (see above) are not
649 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100650 * PSA, and are not restartable. These are temporary limitations that
651 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200652 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100653 * Requires: MBEDTLS_ECP_C
654 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100655 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100656 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200657//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100658
659/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200660 * Uncomment to enable using new bignum code in the ECC modules.
661 *
662 * \warning This is currently experimental, incomplete and therefore should not
663 * be used in production.
664 */
665//#define MBEDTLS_ECP_WITH_MPI_UINT
666
667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100669 *
670 * Enable deterministic ECDSA (RFC 6979).
671 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
672 * may result in a compromise of the long-term signing key. This is avoided by
673 * the deterministic variant.
674 *
John Durkop36a82e52020-10-26 09:39:05 -0700675 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100676 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100677 * Comment this macro to disable deterministic ECDSA.
678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100680
681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200683 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200684 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200685 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200686 * This enables the following ciphersuites (if other requisites are
687 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
689 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
690 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
691 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
692 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
693 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
694 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
695 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
696 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
697 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200700
701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200703 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200704 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200705 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200707 *
708 * This enables the following ciphersuites (if other requisites are
709 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
711 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
712 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
713 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
714 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
715 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
716 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
717 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
718 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
719 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100720 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100721 * \warning Using DHE constitutes a security risk as it
722 * is not possible to validate custom DH parameters.
723 * If possible, it is recommended users should consider
724 * preferring other methods of key exchange.
725 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100726 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200728#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200729
730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200731 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200732 *
733 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
734 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200735 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200736 *
737 * This enables the following ciphersuites (if other requisites are
738 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
740 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
741 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
742 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
743 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
744 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200747
748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200750 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200751 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200752 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
754 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200755 *
756 * This enables the following ciphersuites (if other requisites are
757 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
759 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
760 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
761 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
762 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
763 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
764 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
765 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
766 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
767 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
768 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
769 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772
773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200776 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
779 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200780 *
781 * This enables the following ciphersuites (if other requisites are
782 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
784 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
785 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
786 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
787 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
788 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
789 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
790 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
791 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
792 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
793 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
794 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100795 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100796 * \warning Using DHE constitutes a security risk as it
797 * is not possible to validate custom DH parameters.
798 * If possible, it is recommended users should consider
799 * preferring other methods of key exchange.
800 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100801 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804
805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200808 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200810 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
811 * MBEDTLS_RSA_C
812 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200814 *
815 * This enables the following ciphersuites (if other requisites are
816 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
818 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
819 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
820 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
821 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
822 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
823 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
824 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
825 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
826 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829
830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200833 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200834 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200835 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
836 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
837 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200838 *
839 * This enables the following ciphersuites (if other requisites are
840 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
842 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
843 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
844 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
845 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
846 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
847 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
848 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
849 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
850 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200853
854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100856 *
857 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
858 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200859 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
860 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
861 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100862 *
863 * This enables the following ciphersuites (if other requisites are
864 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
866 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
867 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
868 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
869 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
870 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
871 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
872 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
873 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
874 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100877
878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100880 *
881 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
882 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200883 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
884 * MBEDTLS_RSA_C
885 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100886 *
887 * This enables the following ciphersuites (if other requisites are
888 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
890 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
891 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
892 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
893 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
894 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
895 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
896 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
897 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
898 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100899 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100901
902/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200903 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
904 *
905 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
906 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200907 * \warning This is currently experimental. EC J-PAKE support is based on the
908 * Thread v1.0.0 specification; incompatible changes to the specification
909 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200910 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200911 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100912 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200913 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
914 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100915 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800916 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100917 * MBEDTLS_USE_PSA_CRYPTO is disabled).
918 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200919 * This enables the following ciphersuites (if other requisites are
920 * enabled as well):
921 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
922 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200923//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200924
925/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100927 *
928 * Enhance support for reading EC keys using variants of SEC1 not allowed by
929 * RFC 5915 and RFC 5480.
930 *
931 * Currently this means parsing the SpecifiedECDomain choice of EC
932 * parameters (only known groups are supported, not arbitrary domains, to
933 * avoid validation issues).
934 *
935 * Disable if you only need to support RFC 5915 + 5480 key formats.
936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100938
939/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200940 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
941 *
942 * Enable the support for parsing public keys of type Short Weierstrass
943 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200944 * compressed point format. This parsing is done through ECP module's functions.
945 *
946 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
947 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
948 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200949 */
950#define MBEDTLS_PK_PARSE_EC_COMPRESSED
951
952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100954 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * Enable a dummy error function to make use of mbedtls_strerror() in
956 * third party libraries easier when MBEDTLS_ERROR_C is disabled
957 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200958 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
960 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100961 *
962 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100966
967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000969 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200970 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200971 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000975
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000978 *
979 * Enable functions that use the filesystem.
980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000982
983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000985 *
TRodziewicz15a7b732021-06-16 11:22:53 +0200986 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +0000987 *
Shuo Chen95a0d112014-04-04 21:04:40 -0700988 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +0000989 * application.
990 *
991 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000994
995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000997 *
998 * Do not use built-in platform entropy functions.
999 * This is useful if your platform does not support
1000 * standards like the /dev/urandom or Windows CryptoAPI.
1001 *
1002 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001008 *
1009 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1010 * default SHA-512 based one (if both are available).
1011 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001013 *
1014 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1015 * if you have performance concerns.
1016 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 * This option is only useful if both MBEDTLS_SHA256_C and
1018 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001021
1022/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001023 * \def MBEDTLS_ENTROPY_NV_SEED
1024 *
1025 * Enable the non-volatile (NV) seed file-based entropy source.
1026 * (Also enables the NV seed read/write functions in the platform layer)
1027 *
1028 * This is crucial (if not required) on systems that do not have a
1029 * cryptographic entropy source (in hardware or kernel) available.
1030 *
1031 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1032 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001033 * \note The read/write functions that are used by the entropy source are
1034 * determined in the platform layer, and can be modified at runtime and/or
1035 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1036 *
1037 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001038 * with regular fopen(), please make sure you make a seedfile with the
1039 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1040 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001041 * and written to or you will get an entropy source error! The default
1042 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1043 * bytes from the file.
1044 *
1045 * \note The entropy collector will write to the seed file before entropy is
1046 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001047 */
1048//#define MBEDTLS_ENTROPY_NV_SEED
1049
Ronald Cron71016a92020-08-28 19:01:50 +02001050/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001051 *
Ronald Cron71016a92020-08-28 19:01:50 +02001052 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001053 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001054 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1055 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001056 *
1057 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001058 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001059 */
Ronald Cron71016a92020-08-28 19:01:50 +02001060//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001061
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001064 *
1065 * Enable debugging of buffer allocator memory issues. Automatically prints
1066 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1067 * function for 'debug output' of allocated memory.
1068 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001070 *
1071 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001074
1075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001077 *
1078 * Include backtrace information with each allocated block.
1079 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001081 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001082 *
1083 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001086
1087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001089 *
1090 * Support external private RSA keys (eg from a HSM) in the PK layer.
1091 *
1092 * Comment this macro to disable support for external private RSA keys.
1093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001095
1096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001098 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001099 * Enable support for PKCS#1 v1.5 encoding.
1100 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001101 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001102 *
Paul Bakker48377d92013-08-30 12:06:24 +02001103 * This enables support for PKCS#1 v1.5 operations.
1104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001106
1107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001109 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001110 * Enable support for PKCS#1 v2.1 encoding.
1111 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001112 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001113 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001114 * \warning If using a hash that is only provided by PSA drivers, you must
1115 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001116 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001117 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001120
Steven Cooreman6801f082021-02-19 17:21:22 +01001121/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1122 *
1123 * Enable support for platform built-in keys. If you enable this feature,
1124 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1125 * See the documentation of that function for more information.
1126 *
1127 * Built-in keys are typically derived from a hardware unique key or
1128 * stored in a secure element.
1129 *
1130 * Requires: MBEDTLS_PSA_CRYPTO_C.
1131 *
1132 * \warning This interface is experimental and may change or be removed
1133 * without notice.
1134 */
1135//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1136
Ronald Cron3768ac12021-01-26 16:58:00 +01001137/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1138 *
1139 * Enable support for PSA crypto client.
1140 *
1141 * \note This option allows to include the code necessary for a PSA
1142 * crypto client when the PSA crypto implementation is not included in
1143 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1144 * code to set and get PSA key attributes.
1145 * The development of PSA drivers partially relying on the library to
1146 * fulfill the hardware gaps is another possible usage of this option.
1147 *
1148 * \warning This interface is experimental and may change or be removed
1149 * without notice.
1150 */
1151//#define MBEDTLS_PSA_CRYPTO_CLIENT
1152
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001153/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1154 *
1155 * Make the PSA Crypto module use an external random generator provided
1156 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1157 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001158 * \note This random generator must deliver random numbers with cryptographic
1159 * quality and high performance. It must supply unpredictable numbers
1160 * with a uniform distribution. The implementation of this function
1161 * is responsible for ensuring that the random generator is seeded
1162 * with sufficient entropy. If you have a hardware TRNG which is slow
1163 * or delivers non-uniform output, declare it as an entropy source
1164 * with mbedtls_entropy_add_source() instead of enabling this option.
1165 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001166 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001167 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1168 * and define a function called mbedtls_psa_external_get_random()
1169 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001170 * ```
1171 * psa_status_t mbedtls_psa_external_get_random(
1172 * mbedtls_psa_external_random_context_t *context,
1173 * uint8_t *output, size_t output_size, size_t *output_length);
1174 * );
1175 * ```
1176 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001177 * The function must fill the \c output buffer with \c output_size bytes
1178 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001179 *
1180 * Requires: MBEDTLS_PSA_CRYPTO_C
1181 *
1182 * \warning If you enable this option, code that uses the PSA cryptography
1183 * interface will not use any of the entropy sources set up for
1184 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1185 * enables.
1186 *
1187 * \note This option is experimental and may be removed without notice.
1188 */
1189//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1190
Paul Bakker9dcc3222011-03-08 14:16:06 +00001191/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001192 * \def MBEDTLS_PSA_CRYPTO_SPM
1193 *
1194 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1195 * Partition Manager) integration which separates the code into two parts: a
1196 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1197 * Environment).
1198 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001199 * If you enable this option, your build environment must include a header
1200 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1201 * header files, or in another directory on the compiler's include search
1202 * path). Alternatively, your platform may customize the header
1203 * `psa/crypto_platform.h`, in which case it can skip or replace the
1204 * inclusion of `"crypto_spe.h"`.
1205 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001206 * Module: library/psa_crypto.c
1207 * Requires: MBEDTLS_PSA_CRYPTO_C
1208 *
1209 */
1210//#define MBEDTLS_PSA_CRYPTO_SPM
1211
1212/**
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02001213 * \def MBEDTLS_PSA_KEY_STORE_DYNAMIC
1214 *
1215 * Dynamically resize the PSA key store to accommodate any number of
1216 * volatile keys (until the heap memory is exhausted).
1217 *
1218 * If this option is disabled, the key store has a fixed size
1219 * #MBEDTLS_PSA_KEY_SLOT_COUNT for volatile keys and loaded persistent keys
1220 * together.
1221 *
1222 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
1223 *
1224 * Module: library/psa_crypto.c
1225 * Requires: MBEDTLS_PSA_CRYPTO_C
1226 */
1227#define MBEDTLS_PSA_KEY_STORE_DYNAMIC
1228
1229/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001230 * Uncomment to enable p256-m. This is an alternative implementation of
1231 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1232 * Compared to the default implementation:
1233 *
1234 * - p256-m has a much smaller code size and RAM footprint.
1235 * - p256-m is only available via the PSA API. This includes the pk module
1236 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1237 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1238 * over the core arithmetic, or deterministic derivation of keys.
1239 *
1240 * We recommend enabling this option if your application uses the PSA API
1241 * and the only elliptic curve support it needs is ECDH and ECDSA over
1242 * SECP256R1.
1243 *
1244 * If you enable this option, you do not need to enable any ECC-related
1245 * MBEDTLS_xxx option. You do need to separately request support for the
1246 * cryptographic mechanisms through the PSA API:
1247 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1248 * configuration;
1249 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1250 * - #PSA_WANT_ECC_SECP_R1_256;
1251 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1252 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1253 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1254 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1255 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001256 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001257 * \note To benefit from the smaller code size of p256-m, make sure that you
1258 * do not enable any ECC-related option not supported by p256-m: this
1259 * would cause the built-in ECC implementation to be built as well, in
1260 * order to provide the required option.
1261 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001262 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1263 * SECP256R1 are disabled as they are not supported by this driver.
1264 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1265 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001266 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001267 */
1268//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1269
1270/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001271 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001272 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001273 * Enable support for entropy injection at first boot. This feature is
1274 * required on systems that do not have a built-in entropy source (TRNG).
1275 * This feature is currently not supported on systems that have a built-in
1276 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001277 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001278 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001279 *
1280 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001281//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001282
1283/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001284 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001285 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001286 * Assume all buffers passed to PSA functions are owned exclusively by the
1287 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001288 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001289 * This option may be enabled if all buffers passed to any PSA function reside
1290 * in memory that is accessible only to the PSA function during its execution.
1291 *
1292 * This option MUST be disabled whenever buffer arguments are in memory shared
1293 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001294 * across a trust boundary.
1295 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001296 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001297 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001298 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001299 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001300 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001301//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001302
1303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001305 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001306 * Do not use the Chinese Remainder Theorem
1307 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001308 *
1309 * Uncomment this macro to disable the use of CRT in RSA.
1310 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001313
1314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001316 *
1317 * Enable the checkup functions (*_self_test).
1318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001320
1321/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001322 * \def MBEDTLS_SHA256_SMALLER
1323 *
1324 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1325 * lower performance.
1326 *
Adam Wolf039080f2019-09-10 09:53:08 -05001327 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001328 * performance and size. This version optimizes more aggressively for size at
1329 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1330 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1331 * 30%.
1332 *
1333 * Uncomment to enable the smaller implementation of SHA256.
1334 */
1335//#define MBEDTLS_SHA256_SMALLER
1336
1337/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001338 * \def MBEDTLS_SHA512_SMALLER
1339 *
1340 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1341 * lower performance.
1342 *
1343 * Uncomment to enable the smaller implementation of SHA512.
1344 */
1345//#define MBEDTLS_SHA512_SMALLER
1346
1347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001349 *
1350 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001351 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001352 * with other servers, only debugging of failures is harder.
1353 *
1354 * The advantage of not sending alert messages, is that no information is given
1355 * about reasons for failures thus preventing adversaries of gaining intel.
1356 *
1357 * Enable sending of all alert messages
1358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001360
1361/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001362 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1363 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001364 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001365 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001366 * in the underlying transport. The CID functionality is described
1367 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001368 *
1369 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001370 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1371 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1372 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001373 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001374 * The maximum lengths of outgoing and incoming CIDs can be configured
1375 * through the options
1376 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1377 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1378 *
1379 * Requires: MBEDTLS_SSL_PROTO_DTLS
1380 *
1381 * Uncomment to enable the Connection ID extension.
1382 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001383#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1384
1385
1386/**
1387 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1388 *
1389 * Defines whether RFC 9146 (default) or the legacy version
1390 * (version draft-ietf-tls-dtls-connection-id-05,
1391 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1392 * is used.
1393 *
1394 * Set the value to 0 for the standard version, and
1395 * 1 for the legacy draft version.
1396 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001397 * \deprecated Support for the legacy version of the DTLS
1398 * Connection ID feature is deprecated. Please
1399 * switch to the standardized version defined
1400 * in RFC 9146 enabled by utilizing
1401 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1402 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1403 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001404 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1405 */
1406#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001407
1408/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001409 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1410 *
1411 * Enable asynchronous external private key operations in SSL. This allows
1412 * you to configure an SSL connection to call an external cryptographic
1413 * module to perform private key operations instead of performing the
1414 * operation inside the library.
1415 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001416 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001417 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001418//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001419
1420/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001421 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1422 *
1423 * Enable serialization of the TLS context structures, through use of the
1424 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1425 *
1426 * This pair of functions allows one side of a connection to serialize the
1427 * context associated with the connection, then free or re-use that context
1428 * while the serialized state is persisted elsewhere, and finally deserialize
1429 * that state to a live context for resuming read/write operations on the
1430 * connection. From a protocol perspective, the state of the connection is
1431 * unaffected, in particular this is entirely transparent to the peer.
1432 *
1433 * Note: this is distinct from TLS session resumption, which is part of the
1434 * protocol and fully visible by the peer. TLS session resumption enables
1435 * establishing new connections associated to a saved session with shorter,
1436 * lighter handshakes, while context serialization is a local optimization in
1437 * handling a single, potentially long-lived connection.
1438 *
1439 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1440 * saved after the handshake to allow for more efficient serialization, so if
1441 * you don't need this feature you'll save RAM by disabling it.
1442 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001443 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1444 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001445 * Comment to disable the context serialization APIs.
1446 */
1447#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1448
1449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001451 *
1452 * Enable the debug messages in SSL module for all issues.
1453 * Debug messages have been disabled in some places to prevent timing
1454 * attacks due to (unbalanced) debugging function calls.
1455 *
1456 * If you need all error reporting you should enable this during debugging,
1457 * but remove this for production servers that should log as well.
1458 *
1459 * Uncomment this macro to report all debug messages on errors introducing
1460 * a timing side-channel.
1461 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001466 *
1467 * Enable support for Encrypt-then-MAC, RFC 7366.
1468 *
1469 * This allows peers that both support it to use a more robust protection for
1470 * ciphersuites using CBC, providing deep resistance against timing attacks
1471 * on the padding or underlying cipher.
1472 *
1473 * This only affects CBC ciphersuites, and is useless if none is defined.
1474 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001475 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001476 *
1477 * Comment this macro to disable support for Encrypt-then-MAC
1478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001482 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001483 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1484 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001485 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001486 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001487 * attacks, but it is recommended to always use it (even if you disable
1488 * renegotiation), since it actually fixes a more fundamental issue in the
1489 * original SSL/TLS design, and has implications beyond Triple Handshake.
1490 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001491 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001492 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001493 * Comment this macro to disable support for Extended Master Secret.
1494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001496
Paul Bakkerd66f0702013-01-31 16:57:45 +01001497/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001498 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1499 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001500 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001501 * giving access to the peer's certificate after completion of the handshake.
1502 *
1503 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1504 * recommended to disable this option for reduced RAM usage.
1505 *
1506 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1507 * defined, but always returns \c NULL.
1508 *
1509 * \note This option has no influence on the protection against the
1510 * triple handshake attack. Even if it is disabled, Mbed TLS will
1511 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001512 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001513 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001514 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001515 *
1516 * Comment this macro to disable storing the peer's certificate
1517 * after the handshake.
1518 */
1519#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1520
1521/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001523 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001524 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001525 *
1526 * The two main uses of renegotiation are (1) refresh keys on long-lived
1527 * connections and (2) client authentication after the initial handshake.
1528 * If you don't need renegotiation, it's probably better to disable it, since
1529 * it has been associated with security issues in the past and is easy to
1530 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001531 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001532 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1533 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001534 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001535 *
1536 * \note Even if this option is disabled, both client and server are aware
1537 * of the Renegotiation Indication Extension (RFC 5746) used to
1538 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1539 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1540 * configuration of this extension).
1541 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001544
1545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001547 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001548 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001549 *
1550 * Comment this macro to disable support for the max_fragment_length extension
1551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001553
1554/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001555 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1556 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001557 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001558 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001559 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1560 *
1561 * Uncomment this macro to enable support for the record_size_limit extension
1562 */
1563//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1564
1565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001567 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001568 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001569 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001570 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001571 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1572 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001573 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001574 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001575 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001576 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1577 * are only provided by PSA drivers, you must call psa_crypto_init() before
1578 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001579 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001580 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001583
1584/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001585 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001586 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001587 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001588 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001589 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001590 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001591 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001592 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001593 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001594 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001595 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1596 * directly performed by TLS 1.3 code. As a consequence, you must
1597 * call psa_crypto_init() before the first TLS 1.3 handshake.
1598 *
1599 * \note Cryptographic operations performed indirectly via another module
1600 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1601 * running handshake hash) only use PSA crypto if
1602 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001603 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001604 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001605 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001606#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001607
1608/**
Ronald Cronab65c522021-11-24 10:47:20 +01001609 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1610 *
1611 * Enable TLS 1.3 middlebox compatibility mode.
1612 *
1613 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1614 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1615 * expecting TLS 1.2 traffic.
1616 *
1617 * Turning on the compatibility mode comes at the cost of a few added bytes
1618 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1619 * that don't use it. Therefore, unless transmission bandwidth is critical and
1620 * you know that middlebox compatibility issues won't occur, it is therefore
1621 * recommended to set this option.
1622 *
1623 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001624 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1625 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001626 *
1627 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001628#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001629
1630/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001631 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1632 *
1633 * Enable TLS 1.3 PSK key exchange mode.
1634 *
1635 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1636 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1637 * effect on the build.
1638 *
1639 */
1640#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1641
1642/**
1643 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1644 *
1645 * Enable TLS 1.3 ephemeral key exchange mode.
1646 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001647 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001648 * MBEDTLS_X509_CRT_PARSE_C
1649 * and at least one of:
1650 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1651 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001652 *
1653 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1654 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1655 * effect on the build.
1656 *
1657 */
1658#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1659
1660/**
1661 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1662 *
1663 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1664 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001665 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001666 *
1667 * Comment to disable support for the PSK ephemeral key exchange mode in
1668 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1669 * have any effect on the build.
1670 *
1671 */
1672#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1673
1674/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 * \def MBEDTLS_SSL_EARLY_DATA
1676 *
1677 * Enable support for RFC 8446 TLS 1.3 early data.
1678 *
1679 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1680 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1681 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1682 *
1683 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1684 * is not enabled, this option does not have any effect on the build.
1685 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001686 * \note The maximum amount of early data can be set with
1687 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1688 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001690//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001691
1692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001694 *
1695 * Enable support for DTLS (all available versions).
1696 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001697 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001698 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001699 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001700 *
1701 * Comment this macro to disable support for DTLS
1702 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704
1705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001707 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001708 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001709 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001710 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001713
1714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001716 *
1717 * Enable support for the anti-replay mechanism in DTLS.
1718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * Requires: MBEDTLS_SSL_TLS_C
1720 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001721 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001722 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001723 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001724 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001725 * Comment this to disable anti-replay in DTLS.
1726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001728
1729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001731 *
1732 * Enable support for HelloVerifyRequest on DTLS servers.
1733 *
1734 * This feature is highly recommended to prevent DTLS servers being used as
1735 * amplifiers in DoS attacks against other hosts. It should always be enabled
1736 * unless you know for sure amplification cannot be a problem in the
1737 * environment in which your server operates.
1738 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001739 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001740 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001741 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001742 *
1743 * Comment this to disable support for HelloVerifyRequest.
1744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001746
1747/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001748 * \def MBEDTLS_SSL_DTLS_SRTP
1749 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001750 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001751 * through the use_srtp extension.
1752 *
1753 * \note This feature provides the minimum functionality required
1754 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1755 * the associated SRTP packet protection key material.
1756 * In particular, the SRTP packet protection itself, as well as the
1757 * demultiplexing of RTP and DTLS packets at the datagram layer
1758 * (see Section 5 of RFC 5764), are not handled by this feature.
1759 * Instead, after successful completion of a handshake negotiating
1760 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001761 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001762 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1763 * (this is implemented in the SSL example programs).
1764 * The resulting key should then be passed to an SRTP stack.
1765 *
1766 * Setting this option enables the runtime API
1767 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1768 * through which the supported DTLS-SRTP protection
1769 * profiles can be configured. You must call this API at
1770 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001771 *
1772 * Requires: MBEDTLS_SSL_PROTO_DTLS
1773 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001774 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001775 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001776//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001777
1778/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001779 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1780 *
1781 * Enable server-side support for clients that reconnect from the same port.
1782 *
1783 * Some clients unexpectedly close the connection and try to reconnect using the
1784 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001785 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001786 * flag enables that support.
1787 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001788 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001789 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001790 * Comment this to disable support for clients reusing the source port.
1791 */
1792#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1793
1794/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001796 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001797 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001798 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001799 * session store remains the responsibility of the application, though).
1800 * Server-side, you also need to provide callbacks for writing and parsing
1801 * tickets, including authenticated encryption and key management. Example
1802 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001803 *
1804 * Comment this macro to disable support for SSL session tickets
1805 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001807
1808/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001810 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001811 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001812 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001814 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001815 * Comment this macro to disable support for server name indication in SSL
1816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001818
1819/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001820 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1821 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001822 * When this option is enabled, the SSL buffer will be resized automatically
1823 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001824 *
1825 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001826 */
1827//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1828
1829/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001830 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1831 *
1832 * Enable testing of the constant-flow nature of some sensitive functions with
1833 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001834 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001835 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001836 * This setting requires compiling with clang -fsanitize=memory. The test
1837 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001838 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001839 * \warning This macro is only used for extended testing; it is not considered
1840 * part of the library's API, so it may change or disappear at any time.
1841 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001842 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001843 */
1844//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1845
1846/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001847 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1848 *
1849 * Enable testing of the constant-flow nature of some sensitive functions with
1850 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001852 *
1853 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001854 * testing if the tests suites are run with valgrind's memcheck. This can be
1855 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1856 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001857 *
1858 * \warning This macro is only used for extended testing; it is not considered
1859 * part of the library's API, so it may change or disappear at any time.
1860 *
1861 * Uncomment to enable testing of the constant-flow nature of selected code.
1862 */
1863//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1864
1865/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001866 * \def MBEDTLS_TEST_HOOKS
1867 *
1868 * Enable features for invasive testing such as introspection functions and
1869 * hooks for fault injection. This enables additional unit tests.
1870 *
1871 * Merely enabling this feature should not change the behavior of the product.
1872 * It only adds new code, and new branching points where the default behavior
1873 * is the same as when this feature is disabled.
1874 * However, this feature increases the attack surface: there is an added
1875 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1876 * Therefore this feature must never be enabled in production.
1877 *
1878 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1879 * information.
1880 *
1881 * Uncomment to enable invasive tests.
1882 */
1883//#define MBEDTLS_TEST_HOOKS
1884
1885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001887 *
1888 * Provide your own alternate threading implementation.
1889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001891 *
1892 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001895
1896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001898 *
1899 * Enable the pthread wrapper layer for the threading layer.
1900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001902 *
1903 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001906
1907/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001908 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1909 *
John Durkop185764f2020-10-12 21:32:12 -07001910 * This setting allows support for cryptographic mechanisms through the PSA
1911 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001912 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001913 * When this option is disabled, the PSA API exposes the cryptographic
1914 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1915 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001916 *
1917 * When this option is enabled, the PSA API exposes the cryptographic
1918 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1919 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1920 * automatically enabled if required (i.e. if no PSA driver provides the
1921 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1922 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001923 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001924 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001925 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001926 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001927 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1928 * symbols is not completely finalized yet, and the configuration
1929 * tooling is not ideally adapted to having two separate configuration
1930 * files.
1931 * Future minor releases of Mbed TLS may make minor changes to those
1932 * symbols, but we will endeavor to provide a transition path.
1933 * Nonetheless, this option is considered mature enough to use in
1934 * production, as long as you accept that you may need to make
1935 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001936 */
1937//#define MBEDTLS_PSA_CRYPTO_CONFIG
1938
1939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001941 *
1942 * Allow run-time checking of compile-time enabled features. Thus allowing users
1943 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001945 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001946 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001947 *
1948 * Comment this to disable run-time checking and save ROM space
1949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001951
1952/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001953 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1954 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001955 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001956 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1957 * the set of trusted certificates through a callback instead of a linked
1958 * list.
1959 *
1960 * This is useful for example in environments where a large number of trusted
1961 * certificates is present and storing them in a linked list isn't efficient
1962 * enough, or when the set of trusted certificates changes frequently.
1963 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001964 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001965 * `mbedtls_ssl_conf_ca_cb()` for more information.
1966 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01001967 * Requires: MBEDTLS_X509_CRT_PARSE_C
1968 *
Hanno Becker288dedc2019-03-27 11:00:53 +00001969 * Uncomment to enable trusted certificate callbacks.
1970 */
1971//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1972
1973/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001974 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001975 *
Chris Jones2c745862020-12-16 11:41:06 +00001976 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001977 *
Chris Jones2c745862020-12-16 11:41:06 +00001978 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001979 * and other functions/constants only used by these functions, thus reducing
1980 * the code footprint by several KB.
1981 */
Chris Jones2c745862020-12-16 11:41:06 +00001982//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001983
1984/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001986 *
1987 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1988 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1989 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03001990 * Requires: MBEDTLS_PKCS1_V21
1991 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001992 * Comment this macro to disallow using RSASSA-PSS in certificates.
1993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001995/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001996
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001997/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001998 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001999 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002000 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002001 * \{
2002 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002003
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002006 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002007 * Enable AES-NI support on x86-64 or x86-32.
2008 *
2009 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002010 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002011 * - GCC, x86-64, target not explicitly supporting AESNI:
2012 * requires MBEDTLS_HAVE_ASM.
2013 * - GCC, x86-32, target not explicitly supporting AESNI:
2014 * not supported.
2015 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2016 * For this assembly-less implementation, you must currently compile
2017 * `library/aesni.c` and `library/aes.c` with machine options to enable
2018 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2019 * `clang -maes -mpclmul`.
2020 * - Non-x86 targets: this option is silently ignored.
2021 * - Other compilers: this option is silently ignored.
2022 *
2023 * \note
2024 * Above, "GCC" includes compatible compilers such as Clang.
2025 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002026 *
2027 * Module: library/aesni.c
2028 * Caller: library/aes.c
2029 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002030 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002031 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002032 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002035
2036/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002037 * \def MBEDTLS_AESCE_C
2038 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002039 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002040 *
2041 * Module: library/aesce.c
2042 * Caller: library/aes.c
2043 *
Jerry Yuf015a932023-04-25 10:38:03 +08002044 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002045 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002046 * \warning Runtime detection only works on Linux. For non-Linux operating
2047 * system, Armv8-A Cryptographic Extensions must be supported by
2048 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002049 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002050 * \note Minimum compiler versions for this feature when targeting aarch64
2051 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2052 * Minimum compiler versions for this feature when targeting 32-bit
2053 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002054 *
2055 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2056 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002057 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002058 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002059 */
2060#define MBEDTLS_AESCE_C
2061
2062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002064 *
2065 * Enable the AES block cipher.
2066 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002067 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002068 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002069 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002070 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002071 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002072 * This module enables the following ciphersuites (if other requisites are
2073 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2075 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2076 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2077 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2078 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2079 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2080 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2081 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2082 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2083 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2084 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2085 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2086 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2087 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2088 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2089 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2090 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2091 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2092 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2093 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2094 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2095 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2096 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2097 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2098 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2099 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2100 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2101 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2102 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2103 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2104 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2105 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2106 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2107 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2108 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2109 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2110 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2111 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2112 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2113 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2114 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2115 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2116 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2117 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2118 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2119 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2120 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2121 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2122 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2123 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2124 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2125 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2126 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2127 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2128 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2129 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2130 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2131 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002132 *
Paul Bakkercff68422013-09-15 20:43:33 +02002133 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002136
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002137/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002139 *
2140 * Enable the generic ASN1 parser.
2141 *
2142 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002143 * Caller: library/x509.c
2144 * library/dhm.c
2145 * library/pkcs12.c
2146 * library/pkcs5.c
2147 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002150
2151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002153 *
2154 * Enable the generic ASN1 writer.
2155 *
2156 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002157 * Caller: library/ecdsa.c
2158 * library/pkwrite.c
2159 * library/x509_create.c
2160 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002161 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002162 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002164
2165/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002167 *
2168 * Enable the Base64 module.
2169 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002171 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002173 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002176
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002177/**
Yanray Wange367e472023-10-31 17:23:04 +08002178 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2179 *
2180 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2181 *
2182 * \note This feature is incompatible with insecure block cipher,
2183 * MBEDTLS_DES_C, and cipher modes which always require decryption
2184 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002185 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2186 * this feature is incompatible with following supported PSA equivalence,
2187 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2188 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002189 *
2190 * Module: library/aes.c
2191 * library/aesce.c
2192 * library/aesni.c
2193 * library/aria.c
2194 * library/camellia.c
2195 * library/cipher.c
2196 */
2197//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2198
2199/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002201 *
Paul Bakker9a736322012-11-14 12:39:52 +00002202 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002203 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002204 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002205 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002206 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002207 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002208 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002209 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002210 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002211 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002212 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002213 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002214 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002215 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002218
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002219/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002220 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002221 *
2222 * Enable the Camellia block cipher.
2223 *
Paul Bakker38119b12009-01-10 23:31:23 +00002224 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002225 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002226 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002227 * This module enables the following ciphersuites (if other requisites are
2228 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2230 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2231 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2232 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2233 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2234 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2235 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2236 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2237 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2238 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2239 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2240 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2241 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2242 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2243 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2244 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2245 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2246 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2247 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2248 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2249 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2250 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2251 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2252 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2253 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2254 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2255 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2256 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2257 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2258 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2259 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2260 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2262 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2263 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2264 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2265 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2266 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2267 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2268 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2269 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2270 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002271 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002273
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002274/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002275 * \def MBEDTLS_ARIA_C
2276 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002277 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002278 *
2279 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002280 * Caller: library/cipher.c
2281 *
2282 * This module enables the following ciphersuites (if other requisites are
2283 * enabled as well):
2284 *
2285 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2286 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2287 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2288 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2290 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2291 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2292 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2293 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2294 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2295 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2297 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2298 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2299 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2300 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2301 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2302 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2303 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2304 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2305 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2307 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2308 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2309 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2310 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2311 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2312 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2313 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2314 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2315 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2316 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2317 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2318 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2319 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2320 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2321 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2322 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002323 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002324#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002325
2326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002328 *
2329 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2330 *
2331 * Module: library/ccm.c
2332 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002333 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2334 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002335 *
2336 * This module enables the AES-CCM ciphersuites, if other requisites are
2337 * enabled as well.
2338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002340
2341/**
Daniel King34b822c2016-05-15 17:28:08 -03002342 * \def MBEDTLS_CHACHA20_C
2343 *
2344 * Enable the ChaCha20 stream cipher.
2345 *
2346 * Module: library/chacha20.c
2347 */
2348#define MBEDTLS_CHACHA20_C
2349
2350/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002351 * \def MBEDTLS_CHACHAPOLY_C
2352 *
2353 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2354 *
2355 * Module: library/chachapoly.c
2356 *
2357 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2358 */
2359#define MBEDTLS_CHACHAPOLY_C
2360
2361/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002363 *
2364 * Enable the generic cipher layer.
2365 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002366 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002367 * Caller: library/ccm.c
2368 * library/cmac.c
2369 * library/gcm.c
2370 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002371 * library/pkcs12.c
2372 * library/pkcs5.c
2373 * library/psa_crypto_aead.c
2374 * library/psa_crypto_mac.c
2375 * library/ssl_ciphersuites.c
2376 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002377 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002378 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2379 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002380 *
2381 * Uncomment to enable generic cipher wrappers.
2382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002384
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002385/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002386 * \def MBEDTLS_CMAC_C
2387 *
Simon Butcher327398a2016-10-05 14:09:11 +01002388 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2389 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002390 *
2391 * Module: library/cmac.c
2392 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002393 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002394 *
2395 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002396#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002397
2398/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002400 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002401 * Enable the CTR_DRBG AES-based random generator.
2402 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002403 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002404 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002405 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002406 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2407 * is used.
2408 *
2409 * \warning When using PSA, the user should call `psa_crypto_init()` before
2410 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2411 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002412 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2413 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002414 * \note To achieve a 256-bit security strength with CTR_DRBG,
2415 * you must use AES-256 *and* use sufficient entropy.
2416 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002417 *
2418 * Module: library/ctr_drbg.c
2419 * Caller:
2420 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002421 * Requires: MBEDTLS_AES_C or
2422 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2423 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002424 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002425 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002428
2429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002431 *
2432 * Enable the debug functions.
2433 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002434 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002435 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002436 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002437 * library/ssl_tls12_*.c
2438 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002439 *
2440 * This module provides debugging functions.
2441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002443
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002446 *
2447 * Enable the DES block cipher.
2448 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002449 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002450 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002451 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002452 *
Paul Bakkercff68422013-09-15 20:43:33 +02002453 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002454 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002455 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002456 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002459
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002462 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002463 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002464 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002465 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002466 * Caller: library/ssl_tls.c
2467 * library/ssl*_client.c
2468 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002469 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002470 * This module is used by the following key exchanges:
2471 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002472 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002473 * \warning Using DHE constitutes a security risk as it
2474 * is not possible to validate custom DH parameters.
2475 * If possible, it is recommended users should consider
2476 * preferring other methods of key exchange.
2477 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002478 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002481
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002484 *
2485 * Enable the elliptic curve Diffie-Hellman library.
2486 *
2487 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002488 * Caller: library/psa_crypto.c
2489 * library/ssl_tls.c
2490 * library/ssl*_client.c
2491 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002492 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002493 * This module is used by the following key exchanges:
2494 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002495 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002499
2500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002502 *
2503 * Enable the elliptic curve DSA library.
2504 *
2505 * Module: library/ecdsa.c
2506 * Caller:
2507 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002508 * This module is used by the following key exchanges:
2509 * ECDHE-ECDSA
2510 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002511 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2512 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2513 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002516
2517/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002518 * \def MBEDTLS_ECJPAKE_C
2519 *
2520 * Enable the elliptic curve J-PAKE library.
2521 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002522 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2523 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002524 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002525 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002526 * Module: library/ecjpake.c
2527 * Caller:
2528 *
2529 * This module is used by the following key exchanges:
2530 * ECJPAKE
2531 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002532 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002533 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002534 * \warning If using a hash that is only provided by PSA drivers, you must
2535 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002536 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002537#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002538
2539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541 *
2542 * Enable the elliptic curve over GF(p) library.
2543 *
2544 * Module: library/ecp.c
2545 * Caller: library/ecdh.c
2546 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002547 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002552
2553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002555 *
2556 * Enable the platform-specific entropy code.
2557 *
2558 * Module: library/entropy.c
2559 * Caller:
2560 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002562 *
2563 * This module provides a generic entropy pool
2564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002566
2567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002569 *
2570 * Enable error code to error string conversion.
2571 *
2572 * Module: library/error.c
2573 * Caller:
2574 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002578
2579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002581 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002582 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002583 *
2584 * Module: library/gcm.c
2585 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002586 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2587 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002588 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002589 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2590 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002593
2594/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002595 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002596 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002597 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002598 * Can significantly increase throughput on systems without GCM hardware
2599 * acceleration (e.g., AESNI, AESCE).
2600 *
Matthias Schulz78266782024-02-08 13:54:48 +01002601 * The mbedtls_gcm_context size will increase by 3840 bytes.
2602 * The code size will increase by roughly 344 bytes.
2603 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002604 * Module: library/gcm.c
2605 *
2606 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002607 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002608//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002609
2610/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002611 * \def MBEDTLS_HKDF_C
2612 *
2613 * Enable the HKDF algorithm (RFC 5869).
2614 *
2615 * Module: library/hkdf.c
2616 * Caller:
2617 *
2618 * Requires: MBEDTLS_MD_C
2619 *
2620 * This module adds support for the Hashed Message Authentication Code
2621 * (HMAC)-based key derivation function (HKDF).
2622 */
2623#define MBEDTLS_HKDF_C
2624
2625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002627 *
2628 * Enable the HMAC_DRBG random generator.
2629 *
2630 * Module: library/hmac_drbg.c
2631 * Caller:
2632 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002634 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002635 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002638
2639/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002640 * \def MBEDTLS_LMS_C
2641 *
2642 * Enable the LMS stateful-hash asymmetric signature algorithm.
2643 *
2644 * Module: library/lms.c
2645 * Caller:
2646 *
Raef Colesab4f8742022-09-01 12:24:31 +01002647 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002648 *
Raef Colesab4f8742022-09-01 12:24:31 +01002649 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002650 */
2651#define MBEDTLS_LMS_C
2652
2653/**
Raef Colesab4f8742022-09-01 12:24:31 +01002654 * \def MBEDTLS_LMS_PRIVATE
2655 *
2656 * Enable LMS private-key operations and signing code. Functions enabled by this
2657 * option are experimental, and should not be used in production.
2658 *
2659 * Requires: MBEDTLS_LMS_C
2660 *
2661 * Uncomment to enable the LMS signature algorithm and private key operations.
2662 */
Raef Coles5127e852022-10-07 10:35:56 +01002663//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002664
2665/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002666 * \def MBEDTLS_NIST_KW_C
2667 *
2668 * Enable the Key Wrapping mode for 128-bit block ciphers,
2669 * as defined in NIST SP 800-38F. Only KW and KWP modes
2670 * are supported. At the moment, only AES is approved by NIST.
2671 *
2672 * Module: library/nist_kw.c
2673 *
2674 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2675 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002676#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002677
2678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002680 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002681 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002682 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002683 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2684 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002685 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002686 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002687 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002688 * Caller: library/constant_time.c
2689 * library/ecdsa.c
2690 * library/ecjpake.c
2691 * library/hkdf.c
2692 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002693 * library/pk.c
2694 * library/pkcs5.c
2695 * library/pkcs12.c
2696 * library/psa_crypto_ecp.c
2697 * library/psa_crypto_rsa.c
2698 * library/rsa.c
2699 * library/ssl_cookie.c
2700 * library/ssl_msg.c
2701 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002702 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002703 * library/x509_crt.c
2704 * library/x509write_crt.c
2705 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002706 *
2707 * Uncomment to enable generic message digest wrappers.
2708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002710
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002713 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002714 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002715 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002716 * Module: library/md5.c
2717 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002718 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002719 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002720 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002721 * This module is required for TLS 1.2 depending on the handshake parameters.
2722 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2723 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002724 *
2725 * \warning MD5 is considered a weak message digest and its use constitutes a
2726 * security risk. If possible, we recommend avoiding dependencies on
2727 * it, and considering stronger message digests instead.
2728 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002731
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002734 *
2735 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002736 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002737 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002738 *
2739 * Module: library/memory_buffer_alloc.c
2740 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002742 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002743 *
2744 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002747
2748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002750 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002751 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2752 *
Simon Butcherd567a232016-03-09 20:19:21 +00002753 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2754 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002755 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002756 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002757 * \note See also our Knowledge Base article about porting to a new
2758 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002759 * 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 +00002760 *
Andres AG788aa4a2016-09-14 14:32:09 +01002761 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002762 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002763 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002766
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002770 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002771 *
2772 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002773 * Caller: library/asn1write.c
2774 * library/pkcs5.c
2775 * library/pkparse.c
2776 * library/pkwrite.c
2777 * library/rsa.c
2778 * library/x509.c
2779 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002780 * library/x509_crl.c
2781 * library/x509_crt.c
2782 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002783 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002784 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002785 *
2786 * This modules translates between OIDs and internal values.
2787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002789
2790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002792 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002793 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002794 *
2795 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002796 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002797 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002798 * library/x509_crl.c
2799 * library/x509_crt.c
2800 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002801 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002803 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2804 *
2805 * \warning When parsing password-protected files, if MD5 is provided only by
2806 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002807 *
Paul Bakkercff68422013-09-15 20:43:33 +02002808 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002811
2812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002814 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002815 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002816 *
2817 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002818 * Caller: library/pkwrite.c
2819 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002820 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002821 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002823 *
2824 * This modules adds support for encoding / writing PEM files.
2825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002827
2828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002830 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002831 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002832 *
2833 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002834 * Caller: library/psa_crypto_rsa.c
2835 * library/ssl_tls.c
2836 * library/ssl*_client.c
2837 * library/ssl*_server.c
2838 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002839 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002840 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002841 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002842 * Uncomment to enable generic public key wrappers.
2843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002845
2846/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002848 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002849 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002850 *
2851 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002852 * Caller: library/x509_crt.c
2853 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002854 *
Yanray Wang072a0682023-12-05 10:53:04 +08002855 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002856 *
2857 * Uncomment to enable generic public key parse functions.
2858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002860
2861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002863 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002864 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002865 *
2866 * Module: library/pkwrite.c
2867 * Caller: library/x509write.c
2868 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002869 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002870 *
2871 * Uncomment to enable generic public key write functions.
2872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002874
2875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002877 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002878 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002879 *
2880 * Module: library/pkcs5.c
2881 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002882 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002883 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002884 * \warning If using a hash that is only provided by PSA drivers, you must
2885 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002886 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002887 * This module adds support for the PKCS#5 functions.
2888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002890
2891/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002892 * \def MBEDTLS_PKCS7_C
2893 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002894 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002895 * RFC Link - https://tools.ietf.org/html/rfc2315
2896 *
2897 * Module: library/pkcs7.c
2898 *
2899 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002900 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2901 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002902 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002903 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002904 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002905#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002906
2907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002909 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002910 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002911 * Adds algorithms for parsing PKCS#8 encrypted private keys
2912 *
2913 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002914 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002915 *
Valerio Settie98ad592023-12-28 10:42:12 +01002916 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2917 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002918 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002919 * \warning If using a hash that is only provided by PSA drivers, you must
2920 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002921 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002922 * This module enables PKCS#12 functions.
2923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002925
2926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002928 *
2929 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002930 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2933 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002934 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002935 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002936 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002937 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002938 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002939 * Module: library/platform.c
2940 * Caller: Most other .c files
2941 *
2942 * This module enables abstraction of common (libc) functions.
2943 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002944#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002945
2946/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002947 * \def MBEDTLS_POLY1305_C
2948 *
2949 * Enable the Poly1305 MAC algorithm.
2950 *
2951 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002952 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002953 */
2954#define MBEDTLS_POLY1305_C
2955
2956/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002957 * \def MBEDTLS_PSA_CRYPTO_C
2958 *
2959 * Enable the Platform Security Architecture cryptography API.
2960 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002961 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002962 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002963 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002964 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01002965 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
2966 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
2967 * is enabled in PSA (unless it's fully accelerated, see
2968 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01002969 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002970#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002971
2972/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002973 * \def MBEDTLS_PSA_CRYPTO_SE_C
2974 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002975 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002976 * cryptography API.
2977 *
Ronald Crone6e6b752023-01-16 16:56:51 +01002978 * \deprecated This feature is deprecated. Please switch to the PSA driver
2979 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002980 *
Ryan Everett32a64582024-03-05 18:16:18 +00002981 * \warning This feature is not thread-safe, and should not be used in a
2982 * multi-threaded environment.
2983 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002984 * Module: library/psa_crypto_se.c
2985 *
2986 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2987 *
2988 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002989//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002990
2991/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002992 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2993 *
2994 * Enable the Platform Security Architecture persistent key storage.
2995 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002996 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002997 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002998 * Requires: MBEDTLS_PSA_CRYPTO_C,
2999 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3000 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003001 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003002#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003003
3004/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003005 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003006 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003007 * Enable the emulation of the Platform Security Architecture
3008 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003009 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003010 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003011 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003012 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003013 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003014#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003015
3016/**
Valerio Setti678e0fb2024-06-14 07:49:05 +02003017 * \def MBEDTLS_PSA_STATIC_KEY_SLOTS
3018 *
Valerio Setti933b7692024-08-13 11:08:26 +02003019 * Statically preallocate memory to store keys' material in PSA instead
3020 * of allocating it dynamically when required. This allows builds without a
3021 * heap, if none of the enabled cryptographic implementations or other features
3022 * require it.
3023 * This feature affects both volatile and persistent keys which means that
3024 * it's not possible to persistently store a key which is larger than
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003025 * #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE.
Valerio Setti678e0fb2024-06-14 07:49:05 +02003026 *
3027 * \note This feature comes with a (potentially) higher RAM usage since:
Valerio Setti83778d72024-10-04 13:46:37 +02003028 * - All the key slots are allocated no matter if they are used or not.
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003029 * - Each key buffer's length is #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE bytes.
Valerio Setti678e0fb2024-06-14 07:49:05 +02003030 *
3031 * Requires: MBEDTLS_PSA_CRYPTO_C
3032 *
3033 */
3034//#define MBEDTLS_PSA_STATIC_KEY_SLOTS
3035
3036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003038 *
3039 * Enable the RIPEMD-160 hash algorithm.
3040 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003041 * Module: library/ripemd160.c
3042 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003043 *
3044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003046
3047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003049 *
3050 * Enable the RSA public-key cryptosystem.
3051 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003052 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003053 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003054 * Caller: library/pk.c
3055 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003056 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003057 * library/ssl*_client.c
3058 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003059 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003060 * This module is used by the following key exchanges:
Gilles Peskineb3ec1252024-09-20 18:22:04 +02003061 * RSA, DHE-RSA, ECDHE-RSA
Paul Bakker5690efc2011-05-26 13:16:06 +00003062 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003066
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003069 *
3070 * Enable the SHA1 cryptographic hash algorithm.
3071 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003072 * Module: library/sha1.c
3073 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003074 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003075 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003076 * This module is required for TLS 1.2 depending on the handshake parameters,
3077 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003078 *
3079 * \warning SHA-1 is considered a weak message digest and its use constitutes
3080 * a security risk. If possible, we recommend avoiding dependencies
3081 * on it, and considering stronger message digests instead.
3082 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003085
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003086/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003087 * \def MBEDTLS_SHA224_C
3088 *
3089 * Enable the SHA-224 cryptographic hash algorithm.
3090 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003091 * Module: library/sha256.c
3092 * Caller: library/md.c
3093 * library/ssl_cookie.c
3094 *
3095 * This module adds support for SHA-224.
3096 */
3097#define MBEDTLS_SHA224_C
3098
3099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003101 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003102 * Enable the SHA-256 cryptographic hash algorithm.
3103 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003104 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003105 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003106 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003107 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003108 * library/ssl*_client.c
3109 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003110 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003111 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003112 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003115
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003116/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003117 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003118 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003119 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3120 * with the ARMv8 cryptographic extensions if they are available at runtime.
3121 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003122 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003123 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003124 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003125 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003126 * \note Minimum compiler versions for this feature are Clang 4.0,
3127 * armclang 6.6 or GCC 6.0.
3128 *
3129 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3130 * armclang <= 6.9
3131 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003132 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3133 * That name is deprecated, but may still be used as an alternative form for this
3134 * option.
3135 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003136 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3137 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003138 *
3139 * Requires: MBEDTLS_SHA256_C.
3140 *
3141 * Module: library/sha256.c
3142 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003143 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003144 * and use them if available.
3145 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003146//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003147
Dave Rodgmand85277c2023-10-13 09:22:54 +01003148/**
3149 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3150 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003151 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003152 * This name is now deprecated, but may still be used as an alternative form for
3153 * this option.
3154 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003155//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3156
3157/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003158 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003159 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003160 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3161 * with the ARMv8 cryptographic extensions, which must be available at runtime
3162 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003163 *
3164 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003165 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003166 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003167 * \note Minimum compiler versions for this feature are Clang 4.0,
3168 * armclang 6.6 or GCC 6.0.
3169 *
3170 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3171 * armclang <= 6.9
3172 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003173 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003174 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003175 * option.
3176 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003177 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3178 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003179 *
3180 * Requires: MBEDTLS_SHA256_C.
3181 *
3182 * Module: library/sha256.c
3183 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003184 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003185 * unconditionally.
3186 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003187//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003188
Dave Rodgmand85277c2023-10-13 09:22:54 +01003189/**
3190 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3191 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003192 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003193 * This name is now deprecated, but may still be used as an alternative form for
3194 * this option.
3195 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003196//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3197
3198/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003199 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003200 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003201 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003202 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003203 * Module: library/sha512.c
3204 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003205 * library/psa_crypto_hash.c
3206 * library/ssl_tls.c
3207 * library/ssl*_client.c
3208 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003209 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003210 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003211 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003212#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003213
3214/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003216 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003217 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003218 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003219 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003220 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003221 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003222 * library/ssl_tls.c
3223 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003224 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003225 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003227#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003228
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003229/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003230 * \def MBEDTLS_SHA3_C
3231 *
3232 * Enable the SHA3 cryptographic hash algorithm.
3233 *
3234 * Module: library/sha3.c
3235 *
3236 * This module adds support for SHA3.
3237 */
3238#define MBEDTLS_SHA3_C
3239
3240/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003241 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3242 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003243 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3244 * with the ARMv8 cryptographic extensions if they are available at runtime.
3245 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003246 *
3247 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3248 * for a non-Aarch64 build it will be silently ignored.
3249 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003250 * \note Minimum compiler versions for this feature are Clang 7.0,
3251 * armclang 6.9 or GCC 8.0.
3252 *
3253 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3254 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003255 *
3256 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3257 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3258 *
3259 * Requires: MBEDTLS_SHA512_C.
3260 *
3261 * Module: library/sha512.c
3262 *
3263 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3264 * and use them if available.
3265 */
3266//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3267
3268/**
3269 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3270 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003271 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3272 * with the ARMv8 cryptographic extensions, which must be available at runtime
3273 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003274 *
3275 * \note This allows builds with a smaller code size than with
3276 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3277 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003278 * \note Minimum compiler versions for this feature are Clang 7.0,
3279 * armclang 6.9 or GCC 8.0.
3280 *
3281 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3282 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003283 *
3284 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3285 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3286 *
3287 * Requires: MBEDTLS_SHA512_C.
3288 *
3289 * Module: library/sha512.c
3290 *
3291 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3292 * unconditionally.
3293 */
3294//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3295
3296/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003298 *
3299 * Enable simple SSL cache implementation.
3300 *
3301 * Module: library/ssl_cache.c
3302 * Caller:
3303 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003307
3308/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003310 *
3311 * Enable basic implementation of DTLS cookies for hello verification.
3312 *
3313 * Module: library/ssl_cookie.c
3314 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003317
3318/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003319 * \def MBEDTLS_SSL_TICKET_C
3320 *
3321 * Enable an implementation of TLS server-side callbacks for session tickets.
3322 *
3323 * Module: library/ssl_ticket.c
3324 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003325 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003326 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3327 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003328 */
3329#define MBEDTLS_SSL_TICKET_C
3330
3331/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003333 *
3334 * Enable the SSL/TLS client code.
3335 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003336 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003337 * Caller:
3338 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003340 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003341 * This module is required for SSL/TLS client support.
3342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003344
Paul Bakker9a736322012-11-14 12:39:52 +00003345/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003347 *
3348 * Enable the SSL/TLS server code.
3349 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003350 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003351 * Caller:
3352 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003354 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003355 * This module is required for SSL/TLS server support.
3356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003358
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003361 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003362 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003363 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003365 * Caller: library/ssl*_client.c
3366 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003367 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3369 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003370 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003371 * This module is required for SSL/TLS.
3372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003374
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003375/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003377 *
3378 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003379 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003380 * contexts are not shared between threads. If you do intend to use contexts
3381 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003382 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003383 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003384 *
3385 * Module: library/threading.c
3386 *
3387 * This allows different threading implementations (self-implemented or
3388 * provided).
3389 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 * You will have to enable either MBEDTLS_THREADING_ALT or
3391 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003392 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003393 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003396
3397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003399 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003400 * Enable the semi-portable timing interface.
3401 *
Simon Butcherd567a232016-03-09 20:19:21 +00003402 * \note The provided implementation only works on POSIX/Unix (including Linux,
3403 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003404 * module and provide your own implementations of the callbacks needed by
3405 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3406 * your own implementation of the whole module by setting
3407 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003408 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003409 * \note The timing module will include time.h on suitable platforms
3410 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3411 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3412 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003413 * \note See also our Knowledge Base article about porting to a new
3414 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003415 * 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 +00003416 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003417 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003420
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003423 *
3424 * Enable run-time version information.
3425 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003426 * Module: library/version.c
3427 *
3428 * This module provides run-time version information.
3429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003431
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003434 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003435 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003436 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003437 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003438 * Caller: library/x509_crl.c
3439 * library/x509_crt.c
3440 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003441 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003442 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003443 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3444 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003445 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3446 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003447 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003448 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003451
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003454 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003455 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003456 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003457 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003458 * Caller: library/ssl_tls.c
3459 * library/ssl*_client.c
3460 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003461 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003463 *
3464 * This module is required for X.509 certificate parsing.
3465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003467
3468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003470 *
3471 * Enable X.509 CRL parsing.
3472 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003473 * Module: library/x509_crl.c
3474 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003475 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003477 *
3478 * This module is required for X.509 CRL parsing.
3479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003481
3482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003484 *
3485 * Enable X.509 Certificate Signing Request (CSR) parsing.
3486 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003487 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003488 * Caller: library/x509_crt_write.c
3489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003491 *
3492 * This module is used for reading X.509 certificate request.
3493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495
3496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003498 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003499 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003500 *
3501 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003502 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003503 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003504 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3505 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003506 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3507 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003508 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003509 * This module is the basis for creating X.509 certificates and CSRs.
3510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003512
3513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003515 *
3516 * Enable creating X.509 certificates.
3517 *
3518 * Module: library/x509_crt_write.c
3519 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003521 *
3522 * This module is required for X.509 certificate creation.
3523 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003525
3526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003528 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003529 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003530 *
3531 * Module: library/x509_csr_write.c
3532 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003534 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003535 * This module is required for X.509 certificate request writing.
3536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003538
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003539/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003540
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003541/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003542 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003543 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003544 * This section contains Mbed TLS build settings that are not associated
3545 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003546 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003547 * \{
3548 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003549
Gilles Peskinea02c1242022-03-16 17:03:19 +01003550/**
3551 * \def MBEDTLS_CONFIG_FILE
3552 *
3553 * If defined, this is a header which will be included instead of
3554 * `"mbedtls/mbedtls_config.h"`.
3555 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003556 * Unlike other configuration options, this one must be defined on the
3557 * compiler command line: a definition in `mbedtls_config.h` would have
3558 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003559 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003560 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003561 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003562 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003563 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003564 * The value of this symbol is typically a path in double quotes, either
3565 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003566 */
3567//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3568
3569/**
3570 * \def MBEDTLS_USER_CONFIG_FILE
3571 *
3572 * If defined, this is a header which will be included after
3573 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003574 * This allows you to modify the default configuration, including the ability
3575 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003576 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003577 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003578 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003579 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003580 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003581 * The value of this symbol is typically a path in double quotes, either
3582 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003583 */
3584//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3585
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003586/**
3587 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3588 *
3589 * If defined, this is a header which will be included instead of
3590 * `"psa/crypto_config.h"`.
3591 * This header file specifies which cryptographic mechanisms are available
3592 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3593 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3594 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003595 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003596 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003597 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003598 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003599 * The value of this symbol is typically a path in double quotes, either
3600 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003601 */
3602//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3603
3604/**
3605 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3606 *
3607 * If defined, this is a header which will be included after
3608 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003609 * This allows you to modify the default configuration, including the ability
3610 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003611 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003612 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003613 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003614 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003615 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003616 * The value of this symbol is typically a path in double quotes, either
3617 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003618 */
3619//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3620
Gilles Peskineb1176f22023-02-22 22:07:28 +01003621/**
3622 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3623 *
3624 * If defined, this is a header which will be included instead of
3625 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3626 * as the one in Mbed TLS, but with definitions adapted to the platform on
3627 * which the library code will run.
3628 *
3629 * \note The required content of this header can vary from one version of
3630 * Mbed TLS to the next. Integrators who provide an alternative file
3631 * should review the changes in the original file whenever they
3632 * upgrade Mbed TLS.
3633 *
3634 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3635 * non-standard feature of the C language, so this feature is only available
3636 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3637 *
3638 * The value of this symbol is typically a path in double quotes, either
3639 * absolute or relative to a directory on the include search path.
3640 */
3641//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3642
3643/**
3644 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3645 *
3646 * If defined, this is a header which will be included instead of
3647 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3648 * as the one in Mbed TLS, but with definitions adapted to the environment
3649 * in which the library code will run. The typical use for this feature
3650 * is to provide alternative type definitions on the client side in
3651 * client-server integrations of PSA crypto, where operation structures
3652 * contain handles instead of cryptographic data.
3653 *
3654 * \note The required content of this header can vary from one version of
3655 * Mbed TLS to the next. Integrators who provide an alternative file
3656 * should review the changes in the original file whenever they
3657 * upgrade Mbed TLS.
3658 *
3659 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3660 * non-standard feature of the C language, so this feature is only available
3661 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3662 *
3663 * The value of this symbol is typically a path in double quotes, either
3664 * absolute or relative to a directory on the include search path.
3665 */
3666//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3667
Gilles Peskineba4162a2022-04-11 17:04:38 +02003668/** \} name SECTION: General configuration options */
3669
3670/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003671 * \name SECTION: Module configuration options
3672 *
3673 * This section allows for the setting of module specific sizes and
3674 * configuration options. The default values are already present in the
3675 * relevant header files and should suffice for the regular use cases.
3676 *
3677 * Our advice is to enable options and change their values here
3678 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003679 * \{
3680 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003681/* The Doxygen documentation here is used when a user comments out a
3682 * setting and runs doxygen themselves. On the other hand, when we typeset
3683 * the full documentation including disabled settings, the documentation
3684 * in specific modules' header files is used if present. When editing this
3685 * file, make sure that each option is documented in exactly one place,
3686 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3687 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003688
Paul Bakker088c5c52014-04-25 11:11:10 +02003689/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003690//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003691//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003692
Paul Bakker088c5c52014-04-25 11:11:10 +02003693/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3695//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3696//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3697//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3698//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003699
Paul Bakker088c5c52014-04-25 11:11:10 +02003700/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003701//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3702//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3703//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3704//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003705
Paul Bakker088c5c52014-04-25 11:11:10 +02003706/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003707//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003708//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003709
Paul Bakker088c5c52014-04-25 11:11:10 +02003710/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003711//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3712//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003713//#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 +01003714
Paul Bakker088c5c52014-04-25 11:11:10 +02003715/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003716//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003717
Paul Bakker088c5c52014-04-25 11:11:10 +02003718/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003719//#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 -04003720
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003721/** \def MBEDTLS_PLATFORM_STD_CALLOC
3722 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003723 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003724 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003725 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003726 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003727 * 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 -04003728 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3729 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003730 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003731 */
3732//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003733
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003734/** \def MBEDTLS_PLATFORM_STD_FREE
3735 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003736 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003737 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003738 * 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 -04003739 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3740 * 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 -04003741 */
3742//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003743//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003744//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003745//#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 +02003746//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3747//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003748/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003749//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003750//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3751//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003752//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3753//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3754//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003755
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003756/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003757/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003758//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3759//#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 +02003760//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003761//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003762//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3763//#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 +02003764//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3765//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003766/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003767//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003768//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003769//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3770//#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 +08003771//#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 +08003772//#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 +02003773
Gilles Peskine3f106f72021-09-23 17:42:39 +02003774/** \def MBEDTLS_CHECK_RETURN
3775 *
3776 * This macro is used at the beginning of the declaration of a function
3777 * to indicate that its return value should be checked. It should
3778 * instruct the compiler to emit a warning or an error if the function
3779 * is called without checking its return value.
3780 *
3781 * There is a default implementation for popular compilers in platform_util.h.
3782 * You can override the default implementation by defining your own here.
3783 *
3784 * If the implementation here is empty, this will effectively disable the
3785 * checking of functions' return values.
3786 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003787//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003788
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003789/** \def MBEDTLS_IGNORE_RETURN
3790 *
3791 * This macro requires one argument, which should be a C function call.
3792 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3793 * warning is suppressed.
3794 */
3795//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3796
Gilles Peskineed038902020-11-13 21:33:21 +01003797/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003798/**
Gilles Peskineed038902020-11-13 21:33:21 +01003799 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3800 * PSA crypto subsystem.
3801 *
Gilles Peskine868d2522024-07-01 21:14:45 +02003802 * If this option is unset, the library chooses a hash (currently between
3803 * #MBEDTLS_MD_SHA512 and #MBEDTLS_MD_SHA256) based on availability and
3804 * unspecified heuristics.
3805 *
3806 * \note The PSA crypto subsystem uses the first available mechanism amongst
3807 * the following:
3808 * - #MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG if enabled;
3809 * - Entropy from #MBEDTLS_ENTROPY_C plus CTR_DRBG with AES
3810 * if #MBEDTLS_CTR_DRBG_C is enabled;
3811 * - Entropy from #MBEDTLS_ENTROPY_C plus HMAC_DRBG.
3812 *
3813 * A future version may reevaluate the prioritization of DRBG mechanisms.
Gilles Peskineed038902020-11-13 21:33:21 +01003814 */
3815//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3816
Steven Cooreman863470a2021-02-15 14:03:19 +01003817/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003818 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003819 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is disabled,
3820 * the maximum amount of PSA keys simultaneously in memory. This counts all
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003821 * volatile keys, plus loaded persistent keys.
3822 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003823 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is enabled,
3824 * the maximum number of loaded persistent keys.
3825 *
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003826 * Currently, persistent keys do not need to be loaded all the time while
3827 * a multipart operation is in progress, only while the operation is being
3828 * set up. This may change in future versions of the library.
3829 *
3830 * Currently, the library traverses of the whole table on each access to a
3831 * persistent key. Therefore large values may cause poor performance.
3832 *
3833 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003834 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003835//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003836
Valerio Settia7ce5892024-08-13 10:44:02 +02003837/**
Valerio Setti933b7692024-08-13 11:08:26 +02003838 * \def MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
Valerio Settia7ce5892024-08-13 10:44:02 +02003839 *
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003840 * Define the size (in bytes) of each static key buffer when
3841 * #MBEDTLS_PSA_STATIC_KEY_SLOTS is set. If not
3842 * explicitly defined then it's automatically guessed from available PSA keys
3843 * enabled in the build through PSA_WANT_xxx symbols.
Valerio Settia7ce5892024-08-13 10:44:02 +02003844 * If required by the application this parameter can be set to higher values
3845 * in order to store larger objects (ex: raw keys), but please note that this
3846 * will increase RAM usage.
Valerio Settia7ce5892024-08-13 10:44:02 +02003847 */
3848//#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 256
3849
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003850/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003851//#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 +00003852
Paul Bakker088c5c52014-04-25 11:11:10 +02003853/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003854//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3855//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003856
Paul Bakker088c5c52014-04-25 11:11:10 +02003857/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003858
Angus Grattond8213d02016-05-25 20:56:48 +10003859/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3860 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003861 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003862 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003863 * This determines the size of the incoming TLS I/O buffer in such a way
3864 * that it is capable of holding the specified amount of plaintext data,
3865 * regardless of the protection mechanism used.
3866 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003867 * \note When using a value less than the default of 16KB on the client, it is
3868 * recommended to use the Maximum Fragment Length (MFL) extension to
3869 * inform the server about this limitation. On the server, there
3870 * is no supported, standardized way of informing the client about
3871 * restriction on the maximum size of incoming messages, and unless
3872 * the limitation has been communicated by other means, it is recommended
3873 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3874 * while keeping the default value of 16KB for the incoming buffer.
3875 *
David Horstmann95d516f2021-05-04 18:36:56 +01003876 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003877 */
3878//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3879
Gilles Peskined3d02902020-03-04 21:35:27 +01003880/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3881 *
3882 * The maximum length of CIDs used for incoming DTLS messages.
3883 *
3884 */
3885//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3886
3887/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3888 *
3889 * The maximum length of CIDs used for outgoing DTLS messages.
3890 *
3891 */
3892//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3893
TRodziewicze8dd7092021-05-12 14:19:11 +02003894/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003895 *
3896 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003897 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003898 *
3899 * The padding will always be chosen so that the length of the
3900 * padded plaintext is a multiple of the value of this option.
3901 *
3902 * Note: A value of \c 1 means that no padding will be used
3903 * for outgoing records.
3904 *
3905 * Note: On systems lacking division instructions,
3906 * a power of two should be preferred.
3907 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003908//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003909
Angus Grattond8213d02016-05-25 20:56:48 +10003910/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3911 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003912 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003913 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003914 * This determines the size of the outgoing TLS I/O buffer in such a way
3915 * that it is capable of holding the specified amount of plaintext data,
3916 * regardless of the protection mechanism used.
3917 *
Angus Grattond8213d02016-05-25 20:56:48 +10003918 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3919 * the default inward 16384 byte buffer to conform to the TLS specification.
3920 *
3921 * The minimum required outward buffer size is determined by the handshake
3922 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3923 * The specific size requirement depends on the configured ciphers and any
3924 * certificate data which is sent during the handshake.
3925 *
David Horstmann95d516f2021-05-04 18:36:56 +01003926 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003927 */
3928//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3929
Hanno Beckere0b150f2018-08-21 15:51:03 +01003930/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3931 *
3932 * Maximum number of heap-allocated bytes for the purpose of
3933 * DTLS handshake message reassembly and future message buffering.
3934 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003935 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003936 * to account for a reassembled handshake message of maximum size,
3937 * together with its reassembly bitmap.
3938 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003939 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003940 * should be sufficient for all practical situations as it allows
3941 * to reassembly a large handshake message (such as a certificate)
3942 * while buffering multiple smaller handshake messages.
3943 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003944 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003945//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003946
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003947//#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 +02003948//#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 +02003949
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003950/**
3951 * Complete list of ciphersuites to use, in order of preference.
3952 *
3953 * \warning No dependency checking is done on that field! This option can only
3954 * be used to restrict the set of available ciphersuites. It is your
3955 * responsibility to make sure the needed modules are active.
3956 *
3957 * Use this to save a few hundred bytes of ROM (default ordering of all
3958 * available ciphersuites) and a few to a few hundred bytes of RAM.
3959 *
3960 * The value below is only an example, not the default.
3961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003962//#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 +02003963
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003964/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003965 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3966 *
3967 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003968 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003969 *
3970 * It must be positive and smaller than UINT32_MAX.
3971 *
3972 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3973 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003974 */
3975//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3976
3977/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003978 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3979 *
Jerry Yucf913512023-11-14 11:06:52 +08003980 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003981 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003982 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003983 * - The client ticket age is the time difference between the time when the
3984 * client proposes to the server to use the ticket and the time the client
3985 * received the ticket from the server.
3986 * - The server ticket age is the time difference between the time when the
3987 * server receives a proposition from the client to use the ticket and the
3988 * time when the ticket was created by the server.
3989 *
Jerry Yucf913512023-11-14 11:06:52 +08003990 * The ages might be different due to the client and server clocks not running
3991 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3992 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3993 * 6s, thus in the worst case clients and servers must sync up their system time
3994 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003995 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003996 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003997 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003998//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003999
4000/**
4001 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4002 *
4003 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4004 *
4005 * This must be less than 256.
4006 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004007//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004008
4009/**
4010 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4011 *
4012 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4013 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4014 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4015 *
4016 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004017//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004018
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004019/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004020//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004021//#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 +01004022
Gilles Peskine611179c2022-04-13 23:04:48 +02004023/** \} name SECTION: Module configuration options */