blob: 762ca8b6f4d2d7f7d474424b629c78b34e8281f8 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000354
Paul Bakker90995b52013-06-24 19:20:35 +0200355/**
TRodziewicz75628d52021-06-18 12:56:27 +0200356 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200358 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100359 * alternate core implementation of symmetric crypto or hash function. Keep in
360 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200362 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200365 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366 * no longer provide the mbedtls_sha1_process() function, but it will still provide
367 * the other function (using your mbedtls_sha1_process() function) and the definition
368 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * with this definition.
370 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200371 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100372 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
373 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200374 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200375 * Uncomment a macro to enable alternate implementation of the corresponding
376 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100377 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200378 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100379 * constitutes a security risk. If possible, we recommend avoiding
380 * dependencies on them, and considering stronger message digests
381 * and ciphers instead.
382 *
Janos Follath1231d212019-01-07 15:01:32 +0000383 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
384 * enabled, then the deterministic ECDH signature functions pass the
385 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
386 * alternative implementations should use the RNG only for generating
387 * the ephemeral key and nothing else. If this is not possible, then
388 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200389 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000390 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_MD5_PROCESS_ALT
393//#define MBEDTLS_RIPEMD160_PROCESS_ALT
394//#define MBEDTLS_SHA1_PROCESS_ALT
395//#define MBEDTLS_SHA256_PROCESS_ALT
396//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200397//#define MBEDTLS_DES_SETKEY_ALT
398//#define MBEDTLS_DES_CRYPT_ECB_ALT
399//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200400//#define MBEDTLS_AES_SETKEY_ENC_ALT
401//#define MBEDTLS_AES_SETKEY_DEC_ALT
402//#define MBEDTLS_AES_ENCRYPT_ALT
403//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300404//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300405//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300406//#define MBEDTLS_ECDSA_VERIFY_ALT
407//#define MBEDTLS_ECDSA_SIGN_ALT
408//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200409
410/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200411 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200412 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200413 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200414 * hardware entropy collector.
415 *
416 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000417 * prototype as declared in library/entropy_poll.h, and accept NULL as first
418 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200419 *
420 * Uncomment to use your own hardware entropy collector.
421 */
422//#define MBEDTLS_ENTROPY_HARDWARE_ALT
423
424/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000426 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100427 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000428 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100429 * Uncomment this macro to use precomputed AES tables stored in ROM.
430 * Comment this macro to generate AES tables in RAM at runtime.
431 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100432 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
433 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100434 * initialization time before the first AES operation can be performed.
435 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
436 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
437 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100438 *
439 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000442
443/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100444 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200445 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100446 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200447 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100448 * Uncommenting this macro omits 75% of the AES tables from
449 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
450 * by computing their values on the fly during operations
451 * (the tables are entry-wise rotations of one another).
452 *
453 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100454 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100455 * runtime. Specifically, one has to compare 4 accesses within
456 * different tables to 4 accesses with additional arithmetic
457 * operations within the same table. The performance gain/loss
458 * depends on the system and memory details.
459 *
460 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200461 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100462//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200463
464/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800465 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
466 *
467 * Use only 128-bit keys in AES operations to save ROM.
468 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800469 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800470 * or 256-bit keys.
471 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800472 * Uncommenting this macro reduces the size of AES code by ~300 bytes
473 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800474 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800475 * Module: library/aes.c
476 *
477 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800478 */
479//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
480
Gilles Peskinea8861e02023-09-05 20:20:51 +0200481/*
482 * Disable plain C implementation for AES.
483 *
484 * When the plain C implementation is enabled, and an implementation using a
485 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
486 * detection will be used to select between them.
487 *
488 * If only one implementation is present, runtime detection will not be used.
489 * This configuration will crash at runtime if running on a CPU without the
490 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
491 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
492 */
493//#define MBEDTLS_AES_USE_HARDWARE_ONLY
494
Arto Kinnunen732ca322023-04-14 14:26:10 +0800495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200497 *
498 * Use less ROM for the Camellia implementation (saves about 768 bytes).
499 *
500 * Uncomment this macro to use less memory for Camellia.
501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200503
504/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200505 * \def MBEDTLS_CHECK_RETURN_WARNING
506 *
507 * If this macro is defined, emit a compile-time warning if application code
508 * calls a function without checking its return value, but the return value
509 * should generally be checked in portable applications.
510 *
511 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
512 * implemented. Otherwise this option has no effect.
513 *
514 * Uncomment to get warnings on using fallible functions without checking
515 * their return value.
516 *
517 * \note This feature is a work in progress.
518 * Warnings will be added to more functions in the future.
519 *
520 * \note A few functions are considered critical, and ignoring the return
521 * value of these functions will trigger a warning even if this
522 * macro is not defined. To completely disable return value check
523 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
524 */
525//#define MBEDTLS_CHECK_RETURN_WARNING
526
527/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200529 *
530 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200533
534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000536 *
537 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200539#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000540
541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000543 *
544 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000547
548/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100549 * \def MBEDTLS_CIPHER_MODE_OFB
550 *
551 * Enable Output Feedback mode (OFB) for symmetric ciphers.
552 */
553#define MBEDTLS_CIPHER_MODE_OFB
554
555/**
556 * \def MBEDTLS_CIPHER_MODE_XTS
557 *
558 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
559 */
560#define MBEDTLS_CIPHER_MODE_XTS
561
562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000564 *
565 * Enable NULL cipher.
566 * Warning: Only do so when you know what you are doing. This allows for
567 * encryption or channels without any security!
568 *
Ronald Croncee42702021-04-26 11:34:44 +0200569 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
571 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
572 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
573 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
574 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
575 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
576 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
577 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
578 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
579 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
580 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
581 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
582 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
583 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
584 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
585 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
586 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
587 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
588 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000589 *
590 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200592//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000593
594/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100595 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200596 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100597 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
598 * specific padding modes in the cipher layer with cipher modes that support
599 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200600 *
601 * If you disable all padding modes, only full blocks can be used with CBC.
602 *
603 * Enable padding modes in the cipher layer.
604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605#define MBEDTLS_CIPHER_PADDING_PKCS7
606#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
607#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
608#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200609
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200610/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
611 *
612 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800613 * Without this, CTR_DRBG uses a 256-bit key
614 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200615 */
616//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
617
Paul Bakker48e93c82013-08-14 12:21:18 +0200618/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200619 * Enable the verified implementations of ECDH primitives from Project Everest
620 * (currently only Curve25519). This feature changes the layout of ECDH
621 * contexts and therefore is a compatibility break for applications that access
622 * fields of a mbedtls_ecdh_context structure directly. See also
623 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000624 *
625 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
626 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200627 */
628//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
629
630/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100631 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200632 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100633 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
634 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200635 *
636 * Comment macros to disable the curve and functions for it
637 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200638/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200639#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
640#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
641#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
642#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
643#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
644#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
645#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
646#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
647#define MBEDTLS_ECP_DP_BP256R1_ENABLED
648#define MBEDTLS_ECP_DP_BP384R1_ENABLED
649#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200650/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200651#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000652#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200653
654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200656 *
657 * Enable specific 'modulo p' routines for each NIST prime.
658 * Depending on the prime and architecture, makes operations 4 to 8 times
659 * faster on the corresponding curve.
660 *
661 * Comment this macro to disable NIST curves optimisation.
662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200664
665/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200666 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100667 *
668 * Enable "non-blocking" ECC operations that can return early and be resumed.
669 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200670 * This allows various functions to pause by returning
671 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
672 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
673 * order to further progress and eventually complete their operation. This is
674 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
675 * number of ECC operations a function may perform before pausing; see
676 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100677 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200678 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200679 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100680 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100681 * This option:
682 * - Adds xxx_restartable() variants of existing operations in the
683 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100684 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
685 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100686 * - ECDSA: signature generation & verification;
687 * - PK: signature generation & verification;
688 * - X509: certificate chain verification.
689 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
690 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
691 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
692 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000693 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100694 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100695 * - verification of the server's key exchange signature;
696 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100697 * - generation of the client's signature if client authentication is used,
698 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100699 *
700 * \note In the cases above, the usual SSL/TLS functions, such as
701 * mbedtls_ssl_handshake(), can now return
702 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200703 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100704 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
705 * restartable operations in PK, X.509 and TLS (see above) are not
706 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100707 * PSA, and are not restartable. These are temporary limitations that
708 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200709 *
Ron Eldor19779c42018-11-05 16:58:13 +0200710 * \note This option only works with the default software implementation of
711 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100712 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100713 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100714 * Requires: MBEDTLS_ECP_C
715 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100716 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100717 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200718//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100719
720/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200721 * Uncomment to enable using new bignum code in the ECC modules.
722 *
723 * \warning This is currently experimental, incomplete and therefore should not
724 * be used in production.
725 */
726//#define MBEDTLS_ECP_WITH_MPI_UINT
727
728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100730 *
731 * Enable deterministic ECDSA (RFC 6979).
732 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
733 * may result in a compromise of the long-term signing key. This is avoided by
734 * the deterministic variant.
735 *
John Durkop36a82e52020-10-26 09:39:05 -0700736 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100737 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100738 * Comment this macro to disable deterministic ECDSA.
739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100741
742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200743 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200744 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200745 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200746 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200747 * This enables the following ciphersuites (if other requisites are
748 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
750 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
751 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
752 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
753 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
754 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
755 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
756 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
757 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
758 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200761
762/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200763 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200764 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200765 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 *
769 * This enables the following ciphersuites (if other requisites are
770 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
772 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
774 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
775 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
776 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
777 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
779 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
780 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100781 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100782 * \warning Using DHE constitutes a security risk as it
783 * is not possible to validate custom DH parameters.
784 * If possible, it is recommended users should consider
785 * preferring other methods of key exchange.
786 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100787 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200790
791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200793 *
794 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
795 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200796 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200797 *
798 * This enables the following ciphersuites (if other requisites are
799 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
801 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
802 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
803 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
804 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
805 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200808
809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200812 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200813 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
815 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200816 *
817 * This enables the following ciphersuites (if other requisites are
818 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200819 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
820 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
822 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
823 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
824 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
825 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
827 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
828 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831
832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200835 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
838 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839 *
840 * This enables the following ciphersuites (if other requisites are
841 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
843 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
844 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
845 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
846 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
848 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
849 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
850 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
851 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
852 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856
857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200860 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
863 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 *
865 * This enables the following ciphersuites (if other requisites are
866 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
868 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
870 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
871 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
873 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
876 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
877 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100879 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100880 * \warning Using DHE constitutes a security risk as it
881 * is not possible to validate custom DH parameters.
882 * If possible, it is recommended users should consider
883 * preferring other methods of key exchange.
884 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100885 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888
889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200891 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200892 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200894 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
895 * MBEDTLS_RSA_C
896 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
899 * This enables the following ciphersuites (if other requisites are
900 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200913
914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200917 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200918 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200919 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
920 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
921 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200922 *
923 * This enables the following ciphersuites (if other requisites are
924 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200937
938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100940 *
941 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
942 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200943 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
944 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
945 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100946 *
947 * This enables the following ciphersuites (if other requisites are
948 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100961
962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100964 *
965 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
966 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200967 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
968 * MBEDTLS_RSA_C
969 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100970 *
971 * This enables the following ciphersuites (if other requisites are
972 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
976 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
977 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
978 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
979 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
980 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
981 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
982 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100985
986/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200987 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
988 *
989 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
990 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200991 * \warning This is currently experimental. EC J-PAKE support is based on the
992 * Thread v1.0.0 specification; incompatible changes to the specification
993 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200994 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200995 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100996 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200997 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
998 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100999 * \warning If SHA-256 is provided only by a PSA driver, you must call
1000 * psa_crypto_init() before the first hanshake (even if
1001 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1002 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001003 * This enables the following ciphersuites (if other requisites are
1004 * enabled as well):
1005 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1006 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001007//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001008
1009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001011 *
1012 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1013 * RFC 5915 and RFC 5480.
1014 *
1015 * Currently this means parsing the SpecifiedECDomain choice of EC
1016 * parameters (only known groups are supported, not arbitrary domains, to
1017 * avoid validation issues).
1018 *
1019 * Disable if you only need to support RFC 5915 + 5480 key formats.
1020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001022
1023/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001024 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1025 *
1026 * Enable the support for parsing public keys of type Short Weierstrass
1027 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001028 * compressed point format. This parsing is done through ECP module's functions.
1029 *
1030 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1031 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1032 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001033 */
1034#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1035
1036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * Enable a dummy error function to make use of mbedtls_strerror() in
1040 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1041 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1044 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001045 *
1046 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001048 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001050
1051/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001053 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001054 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001055 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001059
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001062 *
1063 * Enable functions that use the filesystem.
1064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001066
1067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001069 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001070 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001071 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001072 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001073 * application.
1074 *
1075 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001078
1079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001081 *
1082 * Do not use built-in platform entropy functions.
1083 * This is useful if your platform does not support
1084 * standards like the /dev/urandom or Windows CryptoAPI.
1085 *
1086 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001089
1090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001092 *
1093 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1094 * default SHA-512 based one (if both are available).
1095 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001097 *
1098 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1099 * if you have performance concerns.
1100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * This option is only useful if both MBEDTLS_SHA256_C and
1102 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001105
1106/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001107 * \def MBEDTLS_ENTROPY_NV_SEED
1108 *
1109 * Enable the non-volatile (NV) seed file-based entropy source.
1110 * (Also enables the NV seed read/write functions in the platform layer)
1111 *
1112 * This is crucial (if not required) on systems that do not have a
1113 * cryptographic entropy source (in hardware or kernel) available.
1114 *
1115 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1116 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001117 * \note The read/write functions that are used by the entropy source are
1118 * determined in the platform layer, and can be modified at runtime and/or
1119 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1120 *
1121 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001122 * with regular fopen(), please make sure you make a seedfile with the
1123 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1124 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001125 * and written to or you will get an entropy source error! The default
1126 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1127 * bytes from the file.
1128 *
1129 * \note The entropy collector will write to the seed file before entropy is
1130 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001131 */
1132//#define MBEDTLS_ENTROPY_NV_SEED
1133
Ronald Cron71016a92020-08-28 19:01:50 +02001134/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001135 *
Ronald Cron71016a92020-08-28 19:01:50 +02001136 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001137 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001138 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1139 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001140 *
1141 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001142 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001143 */
Ronald Cron71016a92020-08-28 19:01:50 +02001144//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001145
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001148 *
1149 * Enable debugging of buffer allocator memory issues. Automatically prints
1150 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1151 * function for 'debug output' of allocated memory.
1152 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001154 *
1155 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001158
1159/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001161 *
1162 * Include backtrace information with each allocated block.
1163 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001165 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001166 *
1167 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001170
1171/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001173 *
1174 * Support external private RSA keys (eg from a HSM) in the PK layer.
1175 *
1176 * Comment this macro to disable support for external private RSA keys.
1177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001179
1180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001182 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001183 * Enable support for PKCS#1 v1.5 encoding.
1184 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001185 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001186 *
Paul Bakker48377d92013-08-30 12:06:24 +02001187 * This enables support for PKCS#1 v1.5 operations.
1188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001190
1191/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001193 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001194 * Enable support for PKCS#1 v2.1 encoding.
1195 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001196 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001197 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001198 * \warning If using a hash that is only provided by PSA drivers, you must
1199 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001200 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001201 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001204
Steven Cooreman6801f082021-02-19 17:21:22 +01001205/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1206 *
1207 * Enable support for platform built-in keys. If you enable this feature,
1208 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1209 * See the documentation of that function for more information.
1210 *
1211 * Built-in keys are typically derived from a hardware unique key or
1212 * stored in a secure element.
1213 *
1214 * Requires: MBEDTLS_PSA_CRYPTO_C.
1215 *
1216 * \warning This interface is experimental and may change or be removed
1217 * without notice.
1218 */
1219//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1220
Ronald Cron3768ac12021-01-26 16:58:00 +01001221/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1222 *
1223 * Enable support for PSA crypto client.
1224 *
1225 * \note This option allows to include the code necessary for a PSA
1226 * crypto client when the PSA crypto implementation is not included in
1227 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1228 * code to set and get PSA key attributes.
1229 * The development of PSA drivers partially relying on the library to
1230 * fulfill the hardware gaps is another possible usage of this option.
1231 *
1232 * \warning This interface is experimental and may change or be removed
1233 * without notice.
1234 */
1235//#define MBEDTLS_PSA_CRYPTO_CLIENT
1236
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001237/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1238 *
1239 * Make the PSA Crypto module use an external random generator provided
1240 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1241 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001242 * \note This random generator must deliver random numbers with cryptographic
1243 * quality and high performance. It must supply unpredictable numbers
1244 * with a uniform distribution. The implementation of this function
1245 * is responsible for ensuring that the random generator is seeded
1246 * with sufficient entropy. If you have a hardware TRNG which is slow
1247 * or delivers non-uniform output, declare it as an entropy source
1248 * with mbedtls_entropy_add_source() instead of enabling this option.
1249 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001250 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001251 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1252 * and define a function called mbedtls_psa_external_get_random()
1253 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001254 * ```
1255 * psa_status_t mbedtls_psa_external_get_random(
1256 * mbedtls_psa_external_random_context_t *context,
1257 * uint8_t *output, size_t output_size, size_t *output_length);
1258 * );
1259 * ```
1260 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001261 * The function must fill the \c output buffer with \c output_size bytes
1262 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001263 *
1264 * Requires: MBEDTLS_PSA_CRYPTO_C
1265 *
1266 * \warning If you enable this option, code that uses the PSA cryptography
1267 * interface will not use any of the entropy sources set up for
1268 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1269 * enables.
1270 *
1271 * \note This option is experimental and may be removed without notice.
1272 */
1273//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1274
Paul Bakker9dcc3222011-03-08 14:16:06 +00001275/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001276 * \def MBEDTLS_PSA_CRYPTO_SPM
1277 *
1278 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1279 * Partition Manager) integration which separates the code into two parts: a
1280 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1281 * Environment).
1282 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001283 * If you enable this option, your build environment must include a header
1284 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1285 * header files, or in another directory on the compiler's include search
1286 * path). Alternatively, your platform may customize the header
1287 * `psa/crypto_platform.h`, in which case it can skip or replace the
1288 * inclusion of `"crypto_spe.h"`.
1289 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001290 * Module: library/psa_crypto.c
1291 * Requires: MBEDTLS_PSA_CRYPTO_C
1292 *
1293 */
1294//#define MBEDTLS_PSA_CRYPTO_SPM
1295
1296/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001297 * Uncomment to enable p256-m. This is an alternative implementation of
1298 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1299 * Compared to the default implementation:
1300 *
1301 * - p256-m has a much smaller code size and RAM footprint.
1302 * - p256-m is only available via the PSA API. This includes the pk module
1303 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1304 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1305 * over the core arithmetic, or deterministic derivation of keys.
1306 *
1307 * We recommend enabling this option if your application uses the PSA API
1308 * and the only elliptic curve support it needs is ECDH and ECDSA over
1309 * SECP256R1.
1310 *
1311 * If you enable this option, you do not need to enable any ECC-related
1312 * MBEDTLS_xxx option. You do need to separately request support for the
1313 * cryptographic mechanisms through the PSA API:
1314 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1315 * configuration;
1316 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1317 * - #PSA_WANT_ECC_SECP_R1_256;
1318 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1319 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1320 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1321 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1322 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001323 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001324 * \note To benefit from the smaller code size of p256-m, make sure that you
1325 * do not enable any ECC-related option not supported by p256-m: this
1326 * would cause the built-in ECC implementation to be built as well, in
1327 * order to provide the required option.
1328 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001329 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1330 * SECP256R1 are disabled as they are not supported by this driver.
1331 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1332 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001333 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001334 */
1335//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1336
1337/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001338 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001339 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001340 * Enable support for entropy injection at first boot. This feature is
1341 * required on systems that do not have a built-in entropy source (TRNG).
1342 * This feature is currently not supported on systems that have a built-in
1343 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001344 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001345 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001346 *
1347 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001348//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001349
1350/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001351 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001352 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001353 * Assume all buffers passed to PSA functions are owned exclusively by the
1354 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001355 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001356 * This option may be enabled if all buffers passed to any PSA function reside
1357 * in memory that is accessible only to the PSA function during its execution.
1358 *
1359 * This option MUST be disabled whenever buffer arguments are in memory shared
1360 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001361 * across a trust boundary.
1362 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001363 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001364 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001365 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001366 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001367 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001368//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001369
1370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001372 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001373 * Do not use the Chinese Remainder Theorem
1374 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001375 *
1376 * Uncomment this macro to disable the use of CRT in RSA.
1377 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001380
1381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001382 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001383 *
1384 * Enable the checkup functions (*_self_test).
1385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001387
1388/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001389 * \def MBEDTLS_SHA256_SMALLER
1390 *
1391 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1392 * lower performance.
1393 *
Adam Wolf039080f2019-09-10 09:53:08 -05001394 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001395 * performance and size. This version optimizes more aggressively for size at
1396 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1397 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1398 * 30%.
1399 *
1400 * Uncomment to enable the smaller implementation of SHA256.
1401 */
1402//#define MBEDTLS_SHA256_SMALLER
1403
1404/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001405 * \def MBEDTLS_SHA512_SMALLER
1406 *
1407 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1408 * lower performance.
1409 *
1410 * Uncomment to enable the smaller implementation of SHA512.
1411 */
1412//#define MBEDTLS_SHA512_SMALLER
1413
1414/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001415 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001416 *
1417 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001418 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001419 * with other servers, only debugging of failures is harder.
1420 *
1421 * The advantage of not sending alert messages, is that no information is given
1422 * about reasons for failures thus preventing adversaries of gaining intel.
1423 *
1424 * Enable sending of all alert messages
1425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001427
1428/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001429 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1430 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001431 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001432 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001433 * in the underlying transport. The CID functionality is described
1434 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001435 *
1436 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001437 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1438 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1439 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001440 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001441 * The maximum lengths of outgoing and incoming CIDs can be configured
1442 * through the options
1443 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1444 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1445 *
1446 * Requires: MBEDTLS_SSL_PROTO_DTLS
1447 *
1448 * Uncomment to enable the Connection ID extension.
1449 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001450#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1451
1452
1453/**
1454 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1455 *
1456 * Defines whether RFC 9146 (default) or the legacy version
1457 * (version draft-ietf-tls-dtls-connection-id-05,
1458 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1459 * is used.
1460 *
1461 * Set the value to 0 for the standard version, and
1462 * 1 for the legacy draft version.
1463 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001464 * \deprecated Support for the legacy version of the DTLS
1465 * Connection ID feature is deprecated. Please
1466 * switch to the standardized version defined
1467 * in RFC 9146 enabled by utilizing
1468 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1469 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1470 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001471 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1472 */
1473#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001474
1475/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001476 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1477 *
1478 * Enable asynchronous external private key operations in SSL. This allows
1479 * you to configure an SSL connection to call an external cryptographic
1480 * module to perform private key operations instead of performing the
1481 * operation inside the library.
1482 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001483 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001484 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001485//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001486
1487/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001488 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1489 *
1490 * Enable serialization of the TLS context structures, through use of the
1491 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1492 *
1493 * This pair of functions allows one side of a connection to serialize the
1494 * context associated with the connection, then free or re-use that context
1495 * while the serialized state is persisted elsewhere, and finally deserialize
1496 * that state to a live context for resuming read/write operations on the
1497 * connection. From a protocol perspective, the state of the connection is
1498 * unaffected, in particular this is entirely transparent to the peer.
1499 *
1500 * Note: this is distinct from TLS session resumption, which is part of the
1501 * protocol and fully visible by the peer. TLS session resumption enables
1502 * establishing new connections associated to a saved session with shorter,
1503 * lighter handshakes, while context serialization is a local optimization in
1504 * handling a single, potentially long-lived connection.
1505 *
1506 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1507 * saved after the handshake to allow for more efficient serialization, so if
1508 * you don't need this feature you'll save RAM by disabling it.
1509 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001510 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1511 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001512 * Comment to disable the context serialization APIs.
1513 */
1514#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1515
1516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001518 *
1519 * Enable the debug messages in SSL module for all issues.
1520 * Debug messages have been disabled in some places to prevent timing
1521 * attacks due to (unbalanced) debugging function calls.
1522 *
1523 * If you need all error reporting you should enable this during debugging,
1524 * but remove this for production servers that should log as well.
1525 *
1526 * Uncomment this macro to report all debug messages on errors introducing
1527 * a timing side-channel.
1528 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001533 *
1534 * Enable support for Encrypt-then-MAC, RFC 7366.
1535 *
1536 * This allows peers that both support it to use a more robust protection for
1537 * ciphersuites using CBC, providing deep resistance against timing attacks
1538 * on the padding or underlying cipher.
1539 *
1540 * This only affects CBC ciphersuites, and is useless if none is defined.
1541 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001542 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001543 *
1544 * Comment this macro to disable support for Encrypt-then-MAC
1545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001549 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001550 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1551 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001552 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001553 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001554 * attacks, but it is recommended to always use it (even if you disable
1555 * renegotiation), since it actually fixes a more fundamental issue in the
1556 * original SSL/TLS design, and has implications beyond Triple Handshake.
1557 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001558 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001559 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001560 * Comment this macro to disable support for Extended Master Secret.
1561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001563
Paul Bakkerd66f0702013-01-31 16:57:45 +01001564/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001565 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1566 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001567 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001568 * giving access to the peer's certificate after completion of the handshake.
1569 *
1570 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1571 * recommended to disable this option for reduced RAM usage.
1572 *
1573 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1574 * defined, but always returns \c NULL.
1575 *
1576 * \note This option has no influence on the protection against the
1577 * triple handshake attack. Even if it is disabled, Mbed TLS will
1578 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001579 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001580 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001581 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001582 *
1583 * Comment this macro to disable storing the peer's certificate
1584 * after the handshake.
1585 */
1586#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1587
1588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001590 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001591 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001592 *
1593 * The two main uses of renegotiation are (1) refresh keys on long-lived
1594 * connections and (2) client authentication after the initial handshake.
1595 * If you don't need renegotiation, it's probably better to disable it, since
1596 * it has been associated with security issues in the past and is easy to
1597 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001598 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001599 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1600 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001601 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001602 *
1603 * \note Even if this option is disabled, both client and server are aware
1604 * of the Renegotiation Indication Extension (RFC 5746) used to
1605 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1606 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1607 * configuration of this extension).
1608 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001610#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001611
1612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001614 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001615 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001616 *
1617 * Comment this macro to disable support for the max_fragment_length extension
1618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001620
1621/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001622 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1623 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001624 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001625 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001626 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1627 *
1628 * Uncomment this macro to enable support for the record_size_limit extension
1629 */
1630//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1631
1632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001634 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001635 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001636 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001637 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001638 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1639 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001640 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001641 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001642 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001643 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1644 * are only provided by PSA drivers, you must call psa_crypto_init() before
1645 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001646 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001647 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001650
1651/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001652 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001653 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001654 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001655 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001656 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001657 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001658 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001659 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001660 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001661 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001662 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1663 * directly performed by TLS 1.3 code. As a consequence, you must
1664 * call psa_crypto_init() before the first TLS 1.3 handshake.
1665 *
1666 * \note Cryptographic operations performed indirectly via another module
1667 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1668 * running handshake hash) only use PSA crypto if
1669 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001670 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001671 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001672 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001673#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001674
1675/**
Ronald Cronab65c522021-11-24 10:47:20 +01001676 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1677 *
1678 * Enable TLS 1.3 middlebox compatibility mode.
1679 *
1680 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1681 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1682 * expecting TLS 1.2 traffic.
1683 *
1684 * Turning on the compatibility mode comes at the cost of a few added bytes
1685 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1686 * that don't use it. Therefore, unless transmission bandwidth is critical and
1687 * you know that middlebox compatibility issues won't occur, it is therefore
1688 * recommended to set this option.
1689 *
1690 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001691 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1692 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001693 *
1694 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001695#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001696
1697/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001698 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1699 *
1700 * Enable TLS 1.3 PSK key exchange mode.
1701 *
1702 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1703 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1704 * effect on the build.
1705 *
1706 */
1707#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1708
1709/**
1710 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1711 *
1712 * Enable TLS 1.3 ephemeral key exchange mode.
1713 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001714 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001715 * MBEDTLS_X509_CRT_PARSE_C
1716 * and at least one of:
1717 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1718 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001719 *
1720 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1721 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1722 * effect on the build.
1723 *
1724 */
1725#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1726
1727/**
1728 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1729 *
1730 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1731 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001732 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001733 *
1734 * Comment to disable support for the PSK ephemeral key exchange mode in
1735 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1736 * have any effect on the build.
1737 *
1738 */
1739#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1740
1741/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 * \def MBEDTLS_SSL_EARLY_DATA
1743 *
1744 * Enable support for RFC 8446 TLS 1.3 early data.
1745 *
1746 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1747 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1748 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1749 *
1750 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1751 * is not enabled, this option does not have any effect on the build.
1752 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001753 * \note The maximum amount of early data can be set with
1754 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1755 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001757//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001758
1759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001761 *
1762 * Enable support for DTLS (all available versions).
1763 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001764 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001765 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001766 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001767 *
1768 * Comment this macro to disable support for DTLS
1769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001771
1772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001774 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001775 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001776 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001777 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001780
1781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001783 *
1784 * Enable support for the anti-replay mechanism in DTLS.
1785 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786 * Requires: MBEDTLS_SSL_TLS_C
1787 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001788 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001789 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001790 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001791 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001792 * Comment this to disable anti-replay in DTLS.
1793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001795
1796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001798 *
1799 * Enable support for HelloVerifyRequest on DTLS servers.
1800 *
1801 * This feature is highly recommended to prevent DTLS servers being used as
1802 * amplifiers in DoS attacks against other hosts. It should always be enabled
1803 * unless you know for sure amplification cannot be a problem in the
1804 * environment in which your server operates.
1805 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001806 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001807 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001808 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001809 *
1810 * Comment this to disable support for HelloVerifyRequest.
1811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001813
1814/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001815 * \def MBEDTLS_SSL_DTLS_SRTP
1816 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001817 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001818 * through the use_srtp extension.
1819 *
1820 * \note This feature provides the minimum functionality required
1821 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1822 * the associated SRTP packet protection key material.
1823 * In particular, the SRTP packet protection itself, as well as the
1824 * demultiplexing of RTP and DTLS packets at the datagram layer
1825 * (see Section 5 of RFC 5764), are not handled by this feature.
1826 * Instead, after successful completion of a handshake negotiating
1827 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001828 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001829 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1830 * (this is implemented in the SSL example programs).
1831 * The resulting key should then be passed to an SRTP stack.
1832 *
1833 * Setting this option enables the runtime API
1834 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1835 * through which the supported DTLS-SRTP protection
1836 * profiles can be configured. You must call this API at
1837 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001838 *
1839 * Requires: MBEDTLS_SSL_PROTO_DTLS
1840 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001841 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001842 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001843//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001844
1845/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001846 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1847 *
1848 * Enable server-side support for clients that reconnect from the same port.
1849 *
1850 * Some clients unexpectedly close the connection and try to reconnect using the
1851 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001852 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001853 * flag enables that support.
1854 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001855 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001856 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001857 * Comment this to disable support for clients reusing the source port.
1858 */
1859#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1860
1861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001864 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001865 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001866 * session store remains the responsibility of the application, though).
1867 * Server-side, you also need to provide callbacks for writing and parsing
1868 * tickets, including authenticated encryption and key management. Example
1869 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001870 *
1871 * Comment this macro to disable support for SSL session tickets
1872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001874
1875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001877 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001878 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001879 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001881 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001882 * Comment this macro to disable support for server name indication in SSL
1883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001885
1886/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001887 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1888 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001889 * When this option is enabled, the SSL buffer will be resized automatically
1890 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001891 *
1892 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001893 */
1894//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1895
1896/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001897 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1898 *
1899 * Enable testing of the constant-flow nature of some sensitive functions with
1900 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001901 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001902 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001903 * This setting requires compiling with clang -fsanitize=memory. The test
1904 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001905 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001906 * \warning This macro is only used for extended testing; it is not considered
1907 * part of the library's API, so it may change or disappear at any time.
1908 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001909 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001910 */
1911//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1912
1913/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001914 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1915 *
1916 * Enable testing of the constant-flow nature of some sensitive functions with
1917 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001918 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001919 *
1920 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001921 * testing if the tests suites are run with valgrind's memcheck. This can be
1922 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1923 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001924 *
1925 * \warning This macro is only used for extended testing; it is not considered
1926 * part of the library's API, so it may change or disappear at any time.
1927 *
1928 * Uncomment to enable testing of the constant-flow nature of selected code.
1929 */
1930//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1931
1932/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001933 * \def MBEDTLS_TEST_HOOKS
1934 *
1935 * Enable features for invasive testing such as introspection functions and
1936 * hooks for fault injection. This enables additional unit tests.
1937 *
1938 * Merely enabling this feature should not change the behavior of the product.
1939 * It only adds new code, and new branching points where the default behavior
1940 * is the same as when this feature is disabled.
1941 * However, this feature increases the attack surface: there is an added
1942 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1943 * Therefore this feature must never be enabled in production.
1944 *
1945 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1946 * information.
1947 *
1948 * Uncomment to enable invasive tests.
1949 */
1950//#define MBEDTLS_TEST_HOOKS
1951
1952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001954 *
1955 * Provide your own alternate threading implementation.
1956 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001958 *
1959 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001962
1963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001965 *
1966 * Enable the pthread wrapper layer for the threading layer.
1967 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001969 *
1970 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001971 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001973
1974/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001975 * \def MBEDTLS_USE_PSA_CRYPTO
1976 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001977 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1978 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001979 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001980 * \note Development of this option is currently in progress, and parts of Mbed
1981 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001982 * will still continue to work as usual, so enabling this option should not
1983 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001984 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001985 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001986 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1987 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001988 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001989 * \note An important and desirable effect of this option is that it allows
1990 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1991 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02001992 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001993 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1994 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001995 *
1996 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001997 *
1998 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001999 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002000 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002002//#define MBEDTLS_USE_PSA_CRYPTO
2003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002005 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2006 *
John Durkop185764f2020-10-12 21:32:12 -07002007 * This setting allows support for cryptographic mechanisms through the PSA
2008 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002009 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002010 * When this option is disabled, the PSA API exposes the cryptographic
2011 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2012 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002013 *
2014 * When this option is enabled, the PSA API exposes the cryptographic
2015 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2016 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2017 * automatically enabled if required (i.e. if no PSA driver provides the
2018 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2019 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002020 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002021 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002022 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002023 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002024 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2025 * symbols is not completely finalized yet, and the configuration
2026 * tooling is not ideally adapted to having two separate configuration
2027 * files.
2028 * Future minor releases of Mbed TLS may make minor changes to those
2029 * symbols, but we will endeavor to provide a transition path.
2030 * Nonetheless, this option is considered mature enough to use in
2031 * production, as long as you accept that you may need to make
2032 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002033 */
2034//#define MBEDTLS_PSA_CRYPTO_CONFIG
2035
2036/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002037 * \def MBEDTLS_VERSION_FEATURES
2038 *
2039 * Allow run-time checking of compile-time enabled features. Thus allowing users
2040 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002041 * support via mbedtls_version_check_feature().
2042 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002043 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002044 *
2045 * Comment this to disable run-time checking and save ROM space
2046 */
2047#define MBEDTLS_VERSION_FEATURES
2048
2049/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002050 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2051 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002052 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002053 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2054 * the set of trusted certificates through a callback instead of a linked
2055 * list.
2056 *
2057 * This is useful for example in environments where a large number of trusted
2058 * certificates is present and storing them in a linked list isn't efficient
2059 * enough, or when the set of trusted certificates changes frequently.
2060 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002061 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002062 * `mbedtls_ssl_conf_ca_cb()` for more information.
2063 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002064 * Requires: MBEDTLS_X509_CRT_PARSE_C
2065 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002066 * Uncomment to enable trusted certificate callbacks.
2067 */
2068//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2069
2070/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002071 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002072 *
Chris Jones2c745862020-12-16 11:41:06 +00002073 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002074 *
Chris Jones2c745862020-12-16 11:41:06 +00002075 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002076 * and other functions/constants only used by these functions, thus reducing
2077 * the code footprint by several KB.
2078 */
Chris Jones2c745862020-12-16 11:41:06 +00002079//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002080
2081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002083 *
2084 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2085 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2086 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002087 * Requires: MBEDTLS_PKCS1_V21
2088 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002089 * Comment this macro to disallow using RSASSA-PSS in certificates.
2090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002092/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002093
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002094/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002095 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002096 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002097 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002098 * \{
2099 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002100
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002101/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002103 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002104 * Enable AES-NI support on x86-64 or x86-32.
2105 *
2106 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002107 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002108 * - GCC, x86-64, target not explicitly supporting AESNI:
2109 * requires MBEDTLS_HAVE_ASM.
2110 * - GCC, x86-32, target not explicitly supporting AESNI:
2111 * not supported.
2112 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2113 * For this assembly-less implementation, you must currently compile
2114 * `library/aesni.c` and `library/aes.c` with machine options to enable
2115 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2116 * `clang -maes -mpclmul`.
2117 * - Non-x86 targets: this option is silently ignored.
2118 * - Other compilers: this option is silently ignored.
2119 *
2120 * \note
2121 * Above, "GCC" includes compatible compilers such as Clang.
2122 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002123 *
2124 * Module: library/aesni.c
2125 * Caller: library/aes.c
2126 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002127 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002128 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002129 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002132
2133/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002134 * \def MBEDTLS_AESCE_C
2135 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002136 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002137 *
2138 * Module: library/aesce.c
2139 * Caller: library/aes.c
2140 *
Jerry Yuf015a932023-04-25 10:38:03 +08002141 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002142 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002143 * \warning Runtime detection only works on Linux. For non-Linux operating
2144 * system, Armv8-A Cryptographic Extensions must be supported by
2145 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002146 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002147 * \note Minimum compiler versions for this feature when targeting aarch64
2148 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2149 * Minimum compiler versions for this feature when targeting 32-bit
2150 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002151 *
2152 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2153 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002154 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002155 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002156 */
2157#define MBEDTLS_AESCE_C
2158
2159/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002161 *
2162 * Enable the AES block cipher.
2163 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002164 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002165 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002166 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002167 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002168 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002169 * This module enables the following ciphersuites (if other requisites are
2170 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2172 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2173 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2174 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2175 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2177 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2179 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2180 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2183 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2184 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2185 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2186 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2187 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2188 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2189 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2190 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2191 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2192 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2193 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2194 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2195 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2196 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2197 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2198 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2199 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2200 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2201 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2202 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2203 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2204 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2205 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2206 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2207 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2208 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2209 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2211 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2212 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2213 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2214 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2215 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2216 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2217 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2218 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2219 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2220 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2221 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2222 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2223 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2224 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2225 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2226 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2227 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2228 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002229 *
Paul Bakkercff68422013-09-15 20:43:33 +02002230 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002231 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002233
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002234/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002236 *
2237 * Enable the generic ASN1 parser.
2238 *
2239 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002240 * Caller: library/x509.c
2241 * library/dhm.c
2242 * library/pkcs12.c
2243 * library/pkcs5.c
2244 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002245 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002246#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002247
2248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002250 *
2251 * Enable the generic ASN1 writer.
2252 *
2253 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002254 * Caller: library/ecdsa.c
2255 * library/pkwrite.c
2256 * library/x509_create.c
2257 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002258 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002259 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002261
2262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002264 *
2265 * Enable the Base64 module.
2266 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002267 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002268 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002269 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002270 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002271 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002273
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002274/**
Yanray Wange367e472023-10-31 17:23:04 +08002275 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2276 *
2277 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2278 *
2279 * \note This feature is incompatible with insecure block cipher,
2280 * MBEDTLS_DES_C, and cipher modes which always require decryption
2281 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002282 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2283 * this feature is incompatible with following supported PSA equivalence,
2284 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2285 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002286 *
2287 * Module: library/aes.c
2288 * library/aesce.c
2289 * library/aesni.c
2290 * library/aria.c
2291 * library/camellia.c
2292 * library/cipher.c
2293 */
2294//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2295
2296/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002298 *
Paul Bakker9a736322012-11-14 12:39:52 +00002299 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002300 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002301 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002302 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002303 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002304 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002305 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002306 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002307 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002309 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002312 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002315
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002318 *
2319 * Enable the Camellia block cipher.
2320 *
Paul Bakker38119b12009-01-10 23:31:23 +00002321 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002322 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002323 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002324 * This module enables the following ciphersuites (if other requisites are
2325 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2327 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2328 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2329 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2330 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2331 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2332 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2333 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2334 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2335 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2336 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2337 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2340 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2343 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2346 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2347 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2348 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2350 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2351 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2353 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2356 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2357 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2360 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2362 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2365 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2366 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002370
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002371/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002372 * \def MBEDTLS_ARIA_C
2373 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002374 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002375 *
2376 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002377 * Caller: library/cipher.c
2378 *
2379 * This module enables the following ciphersuites (if other requisites are
2380 * enabled as well):
2381 *
2382 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2383 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2384 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2386 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2387 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2389 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2392 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2394 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2395 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2396 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2397 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2398 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2399 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2400 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2406 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2407 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2408 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2409 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2410 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2411 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2412 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2413 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2415 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2416 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2417 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2418 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2419 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002420 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002421#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002422
2423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002425 *
2426 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2427 *
2428 * Module: library/ccm.c
2429 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002430 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2431 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002432 *
2433 * This module enables the AES-CCM ciphersuites, if other requisites are
2434 * enabled as well.
2435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002437
2438/**
Daniel King34b822c2016-05-15 17:28:08 -03002439 * \def MBEDTLS_CHACHA20_C
2440 *
2441 * Enable the ChaCha20 stream cipher.
2442 *
2443 * Module: library/chacha20.c
2444 */
2445#define MBEDTLS_CHACHA20_C
2446
2447/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002448 * \def MBEDTLS_CHACHAPOLY_C
2449 *
2450 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2451 *
2452 * Module: library/chachapoly.c
2453 *
2454 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2455 */
2456#define MBEDTLS_CHACHAPOLY_C
2457
2458/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002460 *
2461 * Enable the generic cipher layer.
2462 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002463 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002464 * Caller: library/ccm.c
2465 * library/cmac.c
2466 * library/gcm.c
2467 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002468 * library/pkcs12.c
2469 * library/pkcs5.c
2470 * library/psa_crypto_aead.c
2471 * library/psa_crypto_mac.c
2472 * library/ssl_ciphersuites.c
2473 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002474 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002475 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2476 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002477 *
2478 * Uncomment to enable generic cipher wrappers.
2479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002481
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002482/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002483 * \def MBEDTLS_CMAC_C
2484 *
Simon Butcher327398a2016-10-05 14:09:11 +01002485 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2486 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002487 *
Thomas Daubneyefc65e12024-06-05 12:56:46 +01002488 * \note When the underlying implementation of the CMAC algorithm is provided
2489 * by an alternate implementation, that alternate implementation may opt
2490 * to not support AES-192 or 3DES as underlying block ciphers for the CMAC
2491 * operation.
Steven Cooremanc338cef2021-04-26 11:24:44 +02002492 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002493 * Module: library/cmac.c
2494 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002495 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002496 *
2497 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002498#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002499
2500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002502 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002503 * Enable the CTR_DRBG AES-based random generator.
2504 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002505 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002506 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002507 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2508 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2509 * is used.
2510 *
2511 * \warning When using PSA, the user should call `psa_crypto_init()` before
2512 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2513 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002514 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2515 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002516 * \note To achieve a 256-bit security strength with CTR_DRBG,
2517 * you must use AES-256 *and* use sufficient entropy.
2518 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002519 *
2520 * Module: library/ctr_drbg.c
2521 * Caller:
2522 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002523 * Requires: MBEDTLS_AES_C or
2524 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2525 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002526 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002527 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002528 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002530
2531/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002533 *
2534 * Enable the debug functions.
2535 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002536 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002537 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002538 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002539 * library/ssl_tls12_*.c
2540 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002541 *
2542 * This module provides debugging functions.
2543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002545
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002548 *
2549 * Enable the DES block cipher.
2550 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002551 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002552 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002553 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002554 *
Paul Bakkercff68422013-09-15 20:43:33 +02002555 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002556 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002557 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002558 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002561
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002564 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002565 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002566 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002567 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002568 * Caller: library/ssl_tls.c
2569 * library/ssl*_client.c
2570 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002571 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002572 * This module is used by the following key exchanges:
2573 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002574 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002575 * \warning Using DHE constitutes a security risk as it
2576 * is not possible to validate custom DH parameters.
2577 * If possible, it is recommended users should consider
2578 * preferring other methods of key exchange.
2579 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002580 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002583
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002586 *
2587 * Enable the elliptic curve Diffie-Hellman library.
2588 *
2589 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002590 * Caller: library/psa_crypto.c
2591 * library/ssl_tls.c
2592 * library/ssl*_client.c
2593 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002594 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002595 * This module is used by the following key exchanges:
2596 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002597 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002601
2602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002604 *
2605 * Enable the elliptic curve DSA library.
2606 *
2607 * Module: library/ecdsa.c
2608 * Caller:
2609 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002610 * This module is used by the following key exchanges:
2611 * ECDHE-ECDSA
2612 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002613 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2614 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2615 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002618
2619/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002620 * \def MBEDTLS_ECJPAKE_C
2621 *
2622 * Enable the elliptic curve J-PAKE library.
2623 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002624 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2625 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002626 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002627 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002628 * Module: library/ecjpake.c
2629 * Caller:
2630 *
2631 * This module is used by the following key exchanges:
2632 * ECJPAKE
2633 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002634 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002635 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002636 * \warning If using a hash that is only provided by PSA drivers, you must
2637 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002638 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002639#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002640
2641/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002643 *
2644 * Enable the elliptic curve over GF(p) library.
2645 *
2646 * Module: library/ecp.c
2647 * Caller: library/ecdh.c
2648 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002649 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002650 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002654
2655/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002657 *
2658 * Enable the platform-specific entropy code.
2659 *
2660 * Module: library/entropy.c
2661 * Caller:
2662 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002664 *
2665 * This module provides a generic entropy pool
2666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002668
2669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002671 *
2672 * Enable error code to error string conversion.
2673 *
2674 * Module: library/error.c
2675 * Caller:
2676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002680
2681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002683 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002684 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002685 *
2686 * Module: library/gcm.c
2687 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002688 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2689 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002690 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002691 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2692 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002693 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002695
2696/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002697 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002698 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002699 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002700 * Can significantly increase throughput on systems without GCM hardware
2701 * acceleration (e.g., AESNI, AESCE).
2702 *
Matthias Schulz78266782024-02-08 13:54:48 +01002703 * The mbedtls_gcm_context size will increase by 3840 bytes.
2704 * The code size will increase by roughly 344 bytes.
2705 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002706 * Module: library/gcm.c
2707 *
2708 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002709 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002710//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002711
2712/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002713 * \def MBEDTLS_HKDF_C
2714 *
2715 * Enable the HKDF algorithm (RFC 5869).
2716 *
2717 * Module: library/hkdf.c
2718 * Caller:
2719 *
2720 * Requires: MBEDTLS_MD_C
2721 *
2722 * This module adds support for the Hashed Message Authentication Code
2723 * (HMAC)-based key derivation function (HKDF).
2724 */
2725#define MBEDTLS_HKDF_C
2726
2727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002729 *
2730 * Enable the HMAC_DRBG random generator.
2731 *
2732 * Module: library/hmac_drbg.c
2733 * Caller:
2734 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002736 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002737 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002740
2741/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002742 * \def MBEDTLS_LMS_C
2743 *
2744 * Enable the LMS stateful-hash asymmetric signature algorithm.
2745 *
2746 * Module: library/lms.c
2747 * Caller:
2748 *
Raef Colesab4f8742022-09-01 12:24:31 +01002749 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002750 *
Raef Colesab4f8742022-09-01 12:24:31 +01002751 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002752 */
2753#define MBEDTLS_LMS_C
2754
2755/**
Raef Colesab4f8742022-09-01 12:24:31 +01002756 * \def MBEDTLS_LMS_PRIVATE
2757 *
2758 * Enable LMS private-key operations and signing code. Functions enabled by this
2759 * option are experimental, and should not be used in production.
2760 *
2761 * Requires: MBEDTLS_LMS_C
2762 *
2763 * Uncomment to enable the LMS signature algorithm and private key operations.
2764 */
Raef Coles5127e852022-10-07 10:35:56 +01002765//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002766
2767/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002768 * \def MBEDTLS_NIST_KW_C
2769 *
2770 * Enable the Key Wrapping mode for 128-bit block ciphers,
2771 * as defined in NIST SP 800-38F. Only KW and KWP modes
2772 * are supported. At the moment, only AES is approved by NIST.
2773 *
2774 * Module: library/nist_kw.c
2775 *
2776 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2777 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002778#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002779
2780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002782 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002783 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002784 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002785 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2786 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002787 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002788 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002789 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002790 * Caller: library/constant_time.c
2791 * library/ecdsa.c
2792 * library/ecjpake.c
2793 * library/hkdf.c
2794 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002795 * library/pk.c
2796 * library/pkcs5.c
2797 * library/pkcs12.c
2798 * library/psa_crypto_ecp.c
2799 * library/psa_crypto_rsa.c
2800 * library/rsa.c
2801 * library/ssl_cookie.c
2802 * library/ssl_msg.c
2803 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002804 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002805 * library/x509_crt.c
2806 * library/x509write_crt.c
2807 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002808 *
2809 * Uncomment to enable generic message digest wrappers.
2810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002812
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002816 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002817 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002818 * Module: library/md5.c
2819 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002820 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002821 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002822 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002823 * This module is required for TLS 1.2 depending on the handshake parameters.
2824 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2825 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002826 *
2827 * \warning MD5 is considered a weak message digest and its use constitutes a
2828 * security risk. If possible, we recommend avoiding dependencies on
2829 * it, and considering stronger message digests instead.
2830 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002833
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002836 *
2837 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002838 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002839 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002840 *
2841 * Module: library/memory_buffer_alloc.c
2842 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002844 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002845 *
2846 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002849
2850/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002852 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002853 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2854 *
Simon Butcherd567a232016-03-09 20:19:21 +00002855 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2856 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002857 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002858 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002859 * \note See also our Knowledge Base article about porting to a new
2860 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002861 * 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 +00002862 *
Andres AG788aa4a2016-09-14 14:32:09 +01002863 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002864 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002865 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002866 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002868
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002871 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002872 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002873 *
2874 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002875 * Caller: library/asn1write.c
2876 * library/pkcs5.c
2877 * library/pkparse.c
2878 * library/pkwrite.c
2879 * library/rsa.c
2880 * library/x509.c
2881 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002882 * library/x509_crl.c
2883 * library/x509_crt.c
2884 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002885 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002886 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002887 *
2888 * This modules translates between OIDs and internal values.
2889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002891
2892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002894 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002895 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002896 *
2897 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002898 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002899 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002900 * library/x509_crl.c
2901 * library/x509_crt.c
2902 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002903 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002905 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2906 *
2907 * \warning When parsing password-protected files, if MD5 is provided only by
2908 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002909 *
Paul Bakkercff68422013-09-15 20:43:33 +02002910 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002913
2914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002917 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002918 *
2919 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002920 * Caller: library/pkwrite.c
2921 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002922 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002923 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002925 *
2926 * This modules adds support for encoding / writing PEM files.
2927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002929
2930/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002932 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002933 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002934 *
2935 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002936 * Caller: library/psa_crypto_rsa.c
2937 * library/ssl_tls.c
2938 * library/ssl*_client.c
2939 * library/ssl*_server.c
2940 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002941 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002942 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002943 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002944 * Uncomment to enable generic public key wrappers.
2945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002947
2948/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002950 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002951 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002952 *
2953 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002954 * Caller: library/x509_crt.c
2955 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002956 *
Yanray Wang072a0682023-12-05 10:53:04 +08002957 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002958 *
2959 * Uncomment to enable generic public key parse functions.
2960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002962
2963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002965 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002966 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002967 *
2968 * Module: library/pkwrite.c
2969 * Caller: library/x509write.c
2970 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002971 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002972 *
2973 * Uncomment to enable generic public key write functions.
2974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002976
2977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002979 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002980 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002981 *
2982 * Module: library/pkcs5.c
2983 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002984 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002985 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002986 * \warning If using a hash that is only provided by PSA drivers, you must
2987 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002988 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002989 * This module adds support for the PKCS#5 functions.
2990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002992
2993/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002994 * \def MBEDTLS_PKCS7_C
2995 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002996 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002997 * RFC Link - https://tools.ietf.org/html/rfc2315
2998 *
2999 * Module: library/pkcs7.c
3000 *
3001 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003002 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3003 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003004 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003005 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003006 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003007#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003008
3009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003011 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003012 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003013 * Adds algorithms for parsing PKCS#8 encrypted private keys
3014 *
3015 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003016 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003017 *
Valerio Settie98ad592023-12-28 10:42:12 +01003018 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3019 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003020 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003021 * \warning If using a hash that is only provided by PSA drivers, you must
3022 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003023 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003024 * This module enables PKCS#12 functions.
3025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003027
3028/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003030 *
3031 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003032 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3035 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003036 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003037 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003038 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003039 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003040 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003041 * Module: library/platform.c
3042 * Caller: Most other .c files
3043 *
3044 * This module enables abstraction of common (libc) functions.
3045 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003046#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003047
3048/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003049 * \def MBEDTLS_POLY1305_C
3050 *
3051 * Enable the Poly1305 MAC algorithm.
3052 *
3053 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003054 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003055 */
3056#define MBEDTLS_POLY1305_C
3057
3058/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003059 * \def MBEDTLS_PSA_CRYPTO_C
3060 *
3061 * Enable the Platform Security Architecture cryptography API.
3062 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003063 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003064 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003065 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003066 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003067 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3068 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3069 * is enabled in PSA (unless it's fully accelerated, see
3070 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003071 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003072#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003073
3074/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003075 * \def MBEDTLS_PSA_CRYPTO_SE_C
3076 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003077 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003078 * cryptography API.
3079 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003080 * \deprecated This feature is deprecated. Please switch to the PSA driver
3081 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003082 *
Ryan Everett32a64582024-03-05 18:16:18 +00003083 * \warning This feature is not thread-safe, and should not be used in a
3084 * multi-threaded environment.
3085 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003086 * Module: library/psa_crypto_se.c
3087 *
3088 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3089 *
3090 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003091//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003092
3093/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003094 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3095 *
3096 * Enable the Platform Security Architecture persistent key storage.
3097 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003098 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003099 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003100 * Requires: MBEDTLS_PSA_CRYPTO_C,
3101 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3102 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003103 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003104#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003105
3106/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003107 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003108 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003109 * Enable the emulation of the Platform Security Architecture
3110 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003111 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003112 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003113 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003114 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003115 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003116#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003117
3118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003120 *
3121 * Enable the RIPEMD-160 hash algorithm.
3122 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003123 * Module: library/ripemd160.c
3124 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003125 *
3126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003128
3129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003131 *
3132 * Enable the RSA public-key cryptosystem.
3133 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003134 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003135 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003136 * Caller: library/pk.c
3137 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003138 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003139 * library/ssl*_client.c
3140 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003141 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003142 * This module is used by the following key exchanges:
3143 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003144 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003148
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003151 *
3152 * Enable the SHA1 cryptographic hash algorithm.
3153 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003154 * Module: library/sha1.c
3155 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003156 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003157 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003158 * This module is required for TLS 1.2 depending on the handshake parameters,
3159 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003160 *
3161 * \warning SHA-1 is considered a weak message digest and its use constitutes
3162 * a security risk. If possible, we recommend avoiding dependencies
3163 * on it, and considering stronger message digests instead.
3164 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003167
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003168/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003169 * \def MBEDTLS_SHA224_C
3170 *
3171 * Enable the SHA-224 cryptographic hash algorithm.
3172 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003173 * Module: library/sha256.c
3174 * Caller: library/md.c
3175 * library/ssl_cookie.c
3176 *
3177 * This module adds support for SHA-224.
3178 */
3179#define MBEDTLS_SHA224_C
3180
3181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003183 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003184 * Enable the SHA-256 cryptographic hash algorithm.
3185 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003186 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003187 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003188 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003189 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003190 * library/ssl*_client.c
3191 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003192 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003193 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003194 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003197
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003198/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003199 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003200 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003201 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3202 * with the ARMv8 cryptographic extensions if they are available at runtime.
3203 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003204 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003205 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003206 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003207 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003208 * \note Minimum compiler versions for this feature are Clang 4.0,
3209 * armclang 6.6 or GCC 6.0.
3210 *
3211 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3212 * armclang <= 6.9
3213 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003214 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3215 * That name is deprecated, but may still be used as an alternative form for this
3216 * option.
3217 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003218 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3219 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003220 *
3221 * Requires: MBEDTLS_SHA256_C.
3222 *
3223 * Module: library/sha256.c
3224 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003225 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003226 * and use them if available.
3227 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003228//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003229
Dave Rodgmand85277c2023-10-13 09:22:54 +01003230/**
3231 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3232 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003233 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003234 * This name is now deprecated, but may still be used as an alternative form for
3235 * this option.
3236 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003237//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3238
3239/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003240 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003241 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003242 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3243 * with the ARMv8 cryptographic extensions, which must be available at runtime
3244 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003245 *
3246 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003247 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003248 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003249 * \note Minimum compiler versions for this feature are Clang 4.0,
3250 * armclang 6.6 or GCC 6.0.
3251 *
3252 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3253 * armclang <= 6.9
3254 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003255 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003256 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003257 * option.
3258 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003259 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3260 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003261 *
3262 * Requires: MBEDTLS_SHA256_C.
3263 *
3264 * Module: library/sha256.c
3265 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003266 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003267 * unconditionally.
3268 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003269//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003270
Dave Rodgmand85277c2023-10-13 09:22:54 +01003271/**
3272 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3273 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003274 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003275 * This name is now deprecated, but may still be used as an alternative form for
3276 * this option.
3277 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003278//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3279
3280/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003281 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003282 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003283 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003284 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003285 * Module: library/sha512.c
3286 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003287 * library/psa_crypto_hash.c
3288 * library/ssl_tls.c
3289 * library/ssl*_client.c
3290 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003291 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003292 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003293 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003294#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003295
3296/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003298 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003299 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003300 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003301 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003302 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003303 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003304 * library/ssl_tls.c
3305 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003306 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003307 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003310
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003311/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003312 * \def MBEDTLS_SHA3_C
3313 *
3314 * Enable the SHA3 cryptographic hash algorithm.
3315 *
3316 * Module: library/sha3.c
3317 *
3318 * This module adds support for SHA3.
3319 */
3320#define MBEDTLS_SHA3_C
3321
3322/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003323 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3324 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003325 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3326 * with the ARMv8 cryptographic extensions if they are available at runtime.
3327 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003328 *
3329 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3330 * for a non-Aarch64 build it will be silently ignored.
3331 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003332 * \note Minimum compiler versions for this feature are Clang 7.0,
3333 * armclang 6.9 or GCC 8.0.
3334 *
3335 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3336 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003337 *
3338 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3339 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3340 *
3341 * Requires: MBEDTLS_SHA512_C.
3342 *
3343 * Module: library/sha512.c
3344 *
3345 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3346 * and use them if available.
3347 */
3348//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3349
3350/**
3351 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3352 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003353 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3354 * with the ARMv8 cryptographic extensions, which must be available at runtime
3355 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003356 *
3357 * \note This allows builds with a smaller code size than with
3358 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3359 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003360 * \note Minimum compiler versions for this feature are Clang 7.0,
3361 * armclang 6.9 or GCC 8.0.
3362 *
3363 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3364 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003365 *
3366 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3367 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3368 *
3369 * Requires: MBEDTLS_SHA512_C.
3370 *
3371 * Module: library/sha512.c
3372 *
3373 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3374 * unconditionally.
3375 */
3376//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3377
3378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003380 *
3381 * Enable simple SSL cache implementation.
3382 *
3383 * Module: library/ssl_cache.c
3384 * Caller:
3385 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003389
3390/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003392 *
3393 * Enable basic implementation of DTLS cookies for hello verification.
3394 *
3395 * Module: library/ssl_cookie.c
3396 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003399
3400/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003401 * \def MBEDTLS_SSL_TICKET_C
3402 *
3403 * Enable an implementation of TLS server-side callbacks for session tickets.
3404 *
3405 * Module: library/ssl_ticket.c
3406 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003407 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003408 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3409 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003410 */
3411#define MBEDTLS_SSL_TICKET_C
3412
3413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003415 *
3416 * Enable the SSL/TLS client code.
3417 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003418 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003419 * Caller:
3420 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003422 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003423 * This module is required for SSL/TLS client support.
3424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003426
Paul Bakker9a736322012-11-14 12:39:52 +00003427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003429 *
3430 * Enable the SSL/TLS server code.
3431 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003432 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003433 * Caller:
3434 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003436 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003437 * This module is required for SSL/TLS server support.
3438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003440
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003441/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003443 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003444 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003445 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003446 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003447 * Caller: library/ssl*_client.c
3448 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003449 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3451 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003452 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003453 * This module is required for SSL/TLS.
3454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003456
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003457/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003459 *
3460 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003461 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003462 * contexts are not shared between threads. If you do intend to use contexts
3463 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003464 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003465 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003466 *
3467 * Module: library/threading.c
3468 *
3469 * This allows different threading implementations (self-implemented or
3470 * provided).
3471 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472 * You will have to enable either MBEDTLS_THREADING_ALT or
3473 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003474 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003475 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003478
3479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003482 * Enable the semi-portable timing interface.
3483 *
Simon Butcherd567a232016-03-09 20:19:21 +00003484 * \note The provided implementation only works on POSIX/Unix (including Linux,
3485 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003486 * module and provide your own implementations of the callbacks needed by
3487 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3488 * your own implementation of the whole module by setting
3489 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003490 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003491 * \note The timing module will include time.h on suitable platforms
3492 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3493 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3494 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003495 * \note See also our Knowledge Base article about porting to a new
3496 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003497 * 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 +00003498 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003499 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003502
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003503/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003505 *
3506 * Enable run-time version information.
3507 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003508 * Module: library/version.c
3509 *
3510 * This module provides run-time version information.
3511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003513
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003516 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003517 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003518 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003519 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003520 * Caller: library/x509_crl.c
3521 * library/x509_crt.c
3522 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003523 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003524 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003525 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3526 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003527 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3528 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003529 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003530 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003533
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003535 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003536 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003538 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003539 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003540 * Caller: library/ssl_tls.c
3541 * library/ssl*_client.c
3542 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003543 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003545 *
3546 * This module is required for X.509 certificate parsing.
3547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549
3550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552 *
3553 * Enable X.509 CRL parsing.
3554 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003555 * Module: library/x509_crl.c
3556 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 *
3560 * This module is required for X.509 CRL parsing.
3561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563
3564/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003566 *
3567 * Enable X.509 Certificate Signing Request (CSR) parsing.
3568 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003569 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 * Caller: library/x509_crt_write.c
3571 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003573 *
3574 * This module is used for reading X.509 certificate request.
3575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577
3578/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003580 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003581 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
3583 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003584 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003585 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003586 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3587 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003588 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3589 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003590 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003591 * This module is the basis for creating X.509 certificates and CSRs.
3592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003594
3595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597 *
3598 * Enable creating X.509 certificates.
3599 *
3600 * Module: library/x509_crt_write.c
3601 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603 *
3604 * This module is required for X.509 certificate creation.
3605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607
3608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003609 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003610 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003611 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003612 *
3613 * Module: library/x509_csr_write.c
3614 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003616 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003617 * This module is required for X.509 certificate request writing.
3618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003620
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003621/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003622
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003623/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003624 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003625 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003626 * This section contains Mbed TLS build settings that are not associated
3627 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003628 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003629 * \{
3630 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003631
Gilles Peskinea02c1242022-03-16 17:03:19 +01003632/**
3633 * \def MBEDTLS_CONFIG_FILE
3634 *
3635 * If defined, this is a header which will be included instead of
3636 * `"mbedtls/mbedtls_config.h"`.
3637 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003638 * Unlike other configuration options, this one must be defined on the
3639 * compiler command line: a definition in `mbedtls_config.h` would have
3640 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003641 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003642 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003643 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003644 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003645 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003646 * The value of this symbol is typically a path in double quotes, either
3647 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003648 */
3649//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3650
3651/**
3652 * \def MBEDTLS_USER_CONFIG_FILE
3653 *
3654 * If defined, this is a header which will be included after
3655 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003656 * This allows you to modify the default configuration, including the ability
3657 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003658 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003659 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003660 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003661 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003662 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003663 * 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.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003665 */
3666//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3667
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003668/**
3669 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3670 *
3671 * If defined, this is a header which will be included instead of
3672 * `"psa/crypto_config.h"`.
3673 * This header file specifies which cryptographic mechanisms are available
3674 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3675 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3676 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003677 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003678 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003679 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003680 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003681 * The value of this symbol is typically a path in double quotes, either
3682 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003683 */
3684//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3685
3686/**
3687 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3688 *
3689 * If defined, this is a header which will be included after
3690 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003691 * This allows you to modify the default configuration, including the ability
3692 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003693 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003694 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003695 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003696 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003697 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003698 * The value of this symbol is typically a path in double quotes, either
3699 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003700 */
3701//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3702
Gilles Peskineb1176f22023-02-22 22:07:28 +01003703/**
3704 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3705 *
3706 * If defined, this is a header which will be included instead of
3707 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3708 * as the one in Mbed TLS, but with definitions adapted to the platform on
3709 * which the library code will run.
3710 *
3711 * \note The required content of this header can vary from one version of
3712 * Mbed TLS to the next. Integrators who provide an alternative file
3713 * should review the changes in the original file whenever they
3714 * upgrade Mbed TLS.
3715 *
3716 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3717 * non-standard feature of the C language, so this feature is only available
3718 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3719 *
3720 * The value of this symbol is typically a path in double quotes, either
3721 * absolute or relative to a directory on the include search path.
3722 */
3723//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3724
3725/**
3726 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3727 *
3728 * If defined, this is a header which will be included instead of
3729 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3730 * as the one in Mbed TLS, but with definitions adapted to the environment
3731 * in which the library code will run. The typical use for this feature
3732 * is to provide alternative type definitions on the client side in
3733 * client-server integrations of PSA crypto, where operation structures
3734 * contain handles instead of cryptographic data.
3735 *
3736 * \note The required content of this header can vary from one version of
3737 * Mbed TLS to the next. Integrators who provide an alternative file
3738 * should review the changes in the original file whenever they
3739 * upgrade Mbed TLS.
3740 *
3741 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3742 * non-standard feature of the C language, so this feature is only available
3743 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3744 *
3745 * The value of this symbol is typically a path in double quotes, either
3746 * absolute or relative to a directory on the include search path.
3747 */
3748//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3749
Gilles Peskineba4162a2022-04-11 17:04:38 +02003750/** \} name SECTION: General configuration options */
3751
3752/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003753 * \name SECTION: Module configuration options
3754 *
3755 * This section allows for the setting of module specific sizes and
3756 * configuration options. The default values are already present in the
3757 * relevant header files and should suffice for the regular use cases.
3758 *
3759 * Our advice is to enable options and change their values here
3760 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003761 * \{
3762 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003763/* The Doxygen documentation here is used when a user comments out a
3764 * setting and runs doxygen themselves. On the other hand, when we typeset
3765 * the full documentation including disabled settings, the documentation
3766 * in specific modules' header files is used if present. When editing this
3767 * file, make sure that each option is documented in exactly one place,
3768 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3769 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003770
Paul Bakker088c5c52014-04-25 11:11:10 +02003771/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003772//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003774
Paul Bakker088c5c52014-04-25 11:11:10 +02003775/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3777//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3778//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3779//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3780//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003781
Paul Bakker088c5c52014-04-25 11:11:10 +02003782/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3784//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3785//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3786//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003787
Paul Bakker088c5c52014-04-25 11:11:10 +02003788/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003789//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003790//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003791
Paul Bakker088c5c52014-04-25 11:11:10 +02003792/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3794//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003795//#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 +01003796
Paul Bakker088c5c52014-04-25 11:11:10 +02003797/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003799
Paul Bakker088c5c52014-04-25 11:11:10 +02003800/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003801//#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 -04003802
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003803/** \def MBEDTLS_PLATFORM_STD_CALLOC
3804 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003805 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003806 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003807 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003808 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003809 * 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 -04003810 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3811 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003812 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003813 */
3814//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003815
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003816/** \def MBEDTLS_PLATFORM_STD_FREE
3817 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003818 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003819 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003820 * 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 -04003821 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3822 * 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 -04003823 */
3824//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003825//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003826//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003827//#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 +02003828//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3829//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003830/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003832//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3833//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003834//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3835//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3836//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003837
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003838/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003839/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003840//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3841//#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 +02003842//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003843//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003844//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3845//#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 +02003846//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3847//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003848/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003849//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003850//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003851//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3852//#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 +08003853//#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 +08003854//#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 +02003855
Gilles Peskine3f106f72021-09-23 17:42:39 +02003856/** \def MBEDTLS_CHECK_RETURN
3857 *
3858 * This macro is used at the beginning of the declaration of a function
3859 * to indicate that its return value should be checked. It should
3860 * instruct the compiler to emit a warning or an error if the function
3861 * is called without checking its return value.
3862 *
3863 * There is a default implementation for popular compilers in platform_util.h.
3864 * You can override the default implementation by defining your own here.
3865 *
3866 * If the implementation here is empty, this will effectively disable the
3867 * checking of functions' return values.
3868 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003869//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003870
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003871/** \def MBEDTLS_IGNORE_RETURN
3872 *
3873 * This macro requires one argument, which should be a C function call.
3874 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3875 * warning is suppressed.
3876 */
3877//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3878
Gilles Peskineed038902020-11-13 21:33:21 +01003879/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003880/**
Gilles Peskineed038902020-11-13 21:33:21 +01003881 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3882 * PSA crypto subsystem.
3883 *
3884 * If this option is unset:
3885 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003886 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003887 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3888 * on unspecified heuristics.
3889 */
3890//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3891
Steven Cooreman863470a2021-02-15 14:03:19 +01003892/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003893 * Restrict the PSA library to supporting a maximum amount of simultaneously
3894 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3895 * volatile key, or a persistent key which is loaded temporarily by the
3896 * library as part of a crypto operation in flight.
3897 *
3898 * If this option is unset, the library will fall back to a default value of
3899 * 32 keys.
3900 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003901//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003902
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003903/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003904//#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 +00003905
Paul Bakker088c5c52014-04-25 11:11:10 +02003906/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003907//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3908//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003909
Paul Bakker088c5c52014-04-25 11:11:10 +02003910/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003911
Angus Grattond8213d02016-05-25 20:56:48 +10003912/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3913 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003914 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003915 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003916 * This determines the size of the incoming TLS I/O buffer in such a way
3917 * that it is capable of holding the specified amount of plaintext data,
3918 * regardless of the protection mechanism used.
3919 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003920 * \note When using a value less than the default of 16KB on the client, it is
3921 * recommended to use the Maximum Fragment Length (MFL) extension to
3922 * inform the server about this limitation. On the server, there
3923 * is no supported, standardized way of informing the client about
3924 * restriction on the maximum size of incoming messages, and unless
3925 * the limitation has been communicated by other means, it is recommended
3926 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3927 * while keeping the default value of 16KB for the incoming buffer.
3928 *
David Horstmann95d516f2021-05-04 18:36:56 +01003929 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003930 */
3931//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3932
Gilles Peskined3d02902020-03-04 21:35:27 +01003933/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3934 *
3935 * The maximum length of CIDs used for incoming DTLS messages.
3936 *
3937 */
3938//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3939
3940/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3941 *
3942 * The maximum length of CIDs used for outgoing DTLS messages.
3943 *
3944 */
3945//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3946
TRodziewicze8dd7092021-05-12 14:19:11 +02003947/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003948 *
3949 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003950 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003951 *
3952 * The padding will always be chosen so that the length of the
3953 * padded plaintext is a multiple of the value of this option.
3954 *
3955 * Note: A value of \c 1 means that no padding will be used
3956 * for outgoing records.
3957 *
3958 * Note: On systems lacking division instructions,
3959 * a power of two should be preferred.
3960 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003961//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003962
Angus Grattond8213d02016-05-25 20:56:48 +10003963/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3964 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003965 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003966 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003967 * This determines the size of the outgoing TLS I/O buffer in such a way
3968 * that it is capable of holding the specified amount of plaintext data,
3969 * regardless of the protection mechanism used.
3970 *
Angus Grattond8213d02016-05-25 20:56:48 +10003971 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3972 * the default inward 16384 byte buffer to conform to the TLS specification.
3973 *
3974 * The minimum required outward buffer size is determined by the handshake
3975 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3976 * The specific size requirement depends on the configured ciphers and any
3977 * certificate data which is sent during the handshake.
3978 *
David Horstmann95d516f2021-05-04 18:36:56 +01003979 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003980 */
3981//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3982
Hanno Beckere0b150f2018-08-21 15:51:03 +01003983/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3984 *
3985 * Maximum number of heap-allocated bytes for the purpose of
3986 * DTLS handshake message reassembly and future message buffering.
3987 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003988 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003989 * to account for a reassembled handshake message of maximum size,
3990 * together with its reassembly bitmap.
3991 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003992 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003993 * should be sufficient for all practical situations as it allows
3994 * to reassembly a large handshake message (such as a certificate)
3995 * while buffering multiple smaller handshake messages.
3996 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003997 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003998//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003999
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004000//#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 +02004001//#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 +02004002
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004003/**
4004 * Complete list of ciphersuites to use, in order of preference.
4005 *
4006 * \warning No dependency checking is done on that field! This option can only
4007 * be used to restrict the set of available ciphersuites. It is your
4008 * responsibility to make sure the needed modules are active.
4009 *
4010 * Use this to save a few hundred bytes of ROM (default ordering of all
4011 * available ciphersuites) and a few to a few hundred bytes of RAM.
4012 *
4013 * The value below is only an example, not the default.
4014 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015//#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 +02004016
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004017/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004018 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4019 *
4020 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004021 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004022 *
4023 * It must be positive and smaller than UINT32_MAX.
4024 *
4025 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4026 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004027 */
4028//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4029
4030/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004031 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4032 *
Jerry Yucf913512023-11-14 11:06:52 +08004033 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004034 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004035 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004036 * - The client ticket age is the time difference between the time when the
4037 * client proposes to the server to use the ticket and the time the client
4038 * received the ticket from the server.
4039 * - The server ticket age is the time difference between the time when the
4040 * server receives a proposition from the client to use the ticket and the
4041 * time when the ticket was created by the server.
4042 *
Jerry Yucf913512023-11-14 11:06:52 +08004043 * The ages might be different due to the client and server clocks not running
4044 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4045 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4046 * 6s, thus in the worst case clients and servers must sync up their system time
4047 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004048 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004049 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004050 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004051//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004052
4053/**
4054 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4055 *
4056 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4057 *
4058 * This must be less than 256.
4059 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004060//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004061
4062/**
4063 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4064 *
4065 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4066 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4067 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4068 *
4069 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004070//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004071
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004072/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004073//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004074//#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 +01004075
Gilles Peskine611179c2022-04-13 23:04:48 +02004076/** \} name SECTION: Module configuration options */