blob: e9354da5a4a08c344aade1bf00a35358a83da5f0 [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000051 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010052 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000053 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000054 * library/constant_time.c
55 * library/padlock.h
Paul Bakker68041ec2009-04-19 21:17:55 +000056 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010057 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000058 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010059 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010060 * MBEDTLS_PADLOCK_C
61 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020062 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000065
Paul Bakkerf3b86c12011-01-27 15:24:17 +000066/**
Gilles Peskineed942f82017-06-08 15:19:20 +020067 * \def MBEDTLS_NO_UDBL_DIVISION
68 *
69 * The platform lacks support for double-width integer division (64-bit
70 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
71 *
72 * Used in:
73 * include/mbedtls/bignum.h
74 * library/bignum.c
75 *
76 * The bignum code uses double-width division to speed up some operations.
77 * Double-width division is often implemented in software that needs to
78 * be linked with the program. The presence of a double-width integer
79 * type is usually detected automatically through preprocessor macros,
80 * but the automatic detection cannot know whether the code needs to
81 * and can be linked with an implementation of division for that type.
82 * By default division is assumed to be usable if the type is present.
83 * Uncomment this option to prevent the use of double-width division.
84 *
85 * Note that division for the native integer type is always required.
86 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010087 * platform, but it need not support multiplication or division. In some
88 * cases it is also desirable to disable some double-width operations. For
89 * example, if double-width division is implemented in software, disabling
90 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020091 */
92//#define MBEDTLS_NO_UDBL_DIVISION
93
94/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020095 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
96 *
97 * The platform lacks support for 32x32 -> 64-bit multiplication.
98 *
99 * Used in:
100 * library/poly1305.c
101 *
102 * Some parts of the library may use multiplication of two unsigned 32-bit
103 * operands with a 64-bit result in order to speed up computations. On some
104 * platforms, this is not available in hardware and has to be implemented in
105 * software, usually in a library provided by the toolchain.
106 *
107 * Sometimes it is not desirable to have to link to that library. This option
108 * removes the dependency of that library on platforms that lack a hardware
109 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
110 *
111 * Note that depending on the compiler, this may decrease performance compared
112 * to using the library function provided by the toolchain.
113 */
114//#define MBEDTLS_NO_64BIT_MULTIPLICATION
115
116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000118 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000119 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000120 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200124
125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200128 * System has time.h and time().
129 * The time does not need to be correct, only time differences are used,
130 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100132 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
133 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
134 * MBEDTLS_PLATFORM_STD_TIME.
135 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400136 * Comment if your system does not support time functions.
137 *
138 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
139 * interface - timing.c will include time.h on suitable platforms
140 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
141 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100144
145/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * \def MBEDTLS_HAVE_TIME_DATE
147 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100148 * System has time.h, time(), and an implementation for
149 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100150 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200151 * the date should be correct). This is used to verify the validity period of
152 * X.509 certificates.
153 *
154 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100155 *
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100157 * behaves similarly to the gmtime_r() function from the C standard. Refer to
158 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100159 *
160 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100161 * mbedtls_platform_gmtime_r() at compile-time by using the macro
162 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200163 */
164#define MBEDTLS_HAVE_TIME_DATE
165
166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 *
169 * Enable the memory allocation layer.
170 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200171 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100172 * This allows different allocators (self-implemented or provided) to be
173 * provided to the platform abstraction layer.
174 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400175 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
177 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * free() function pointer at runtime.
179 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400180 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200181 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000182 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100183 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400184 * An overview of how the value of mbedtls_calloc is determined:
185 *
186 * - if !MBEDTLS_PLATFORM_MEMORY
187 * - mbedtls_calloc = calloc
188 * - if MBEDTLS_PLATFORM_MEMORY
189 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
190 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
191 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
192 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
193 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
194 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
195 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
196 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
197 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
198 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
199 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
200 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
201 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
202 *
203 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
204 * - if !MBEDTLS_PLATFORM_STD_CALLOC
205 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
206 *
207 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
208 *
209 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
210 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
211 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
212 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
213 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
214 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
215 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100217 *
218 * Enable this layer to allow use of alternative memory allocators.
219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100221
222/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200223 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200224 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200225 * Do not assign standard functions in the platform layer (e.g. calloc() to
226 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200227 *
228 * This makes sure there are no linking errors on platforms that do not support
229 * these functions. You will HAVE to provide alternatives, either at runtime
230 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
232 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200235 *
236 * Uncomment to prevent default assignment of standard functions in the
237 * platform layer.
238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200240
241/**
Janos Follathc351d182016-03-21 08:43:59 +0000242 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100243 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200244 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100245 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100246 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200247 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100249 * alternative printf function pointer.
250 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100252 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200253 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
254 * it will be enabled automatically by check_config.h
255 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200256 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000258 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100259 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
260 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100261 * Uncomment a macro to enable alternate implementation of specific base
262 * platform function
263 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200264//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100266//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267//#define MBEDTLS_PLATFORM_FPRINTF_ALT
268//#define MBEDTLS_PLATFORM_PRINTF_ALT
269//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200270//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100271//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100272//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800273//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100274
275/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200276 * Uncomment the macro to let Mbed TLS use your alternate implementation of
277 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
278 * platform_util.c.
279 *
280 * gmtime() is not a thread-safe function as defined in the C standard. The
281 * library will try to use safer implementations of this function, such as
282 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
283 * system, the implementation of mbedtls_platform_gmtime_r() will default to
284 * using the standard gmtime(). In this case, calls from the library to
285 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
286 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
287 * library are also guarded with this mutex to avoid race conditions. However,
288 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
289 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
290 * supplied at compile time.
291 */
292//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
293
294/**
Gilles Peskine86733832023-09-07 15:02:39 +0200295 * Uncomment the macro to let Mbed TLS use your alternate implementation of
296 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
297 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200298 *
Gilles Peskine86733832023-09-07 15:02:39 +0200299 * By default, the library uses a system function such as memset_s()
300 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
301 * SecureZeroMemory (Windows). If no such function is detected, the library
302 * falls back to a plain C implementation. Compilers are technically
303 * permitted to optimize this implementation out, meaning that the memory is
304 * not actually wiped. The library tries to prevent that, but the C language
305 * makes it impossible to guarantee that the memory will always be wiped.
306 *
307 * If your platform provides a guaranteed method to wipe memory which
308 * `platform_util.c` does not detect, define this macro to the name of
309 * a function that takes two arguments, a `void *` pointer and a length,
310 * and wipes that many bytes starting at the specified address. For example,
311 * if your platform has explicit_bzero() but `platform_util.c` does not
312 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
313 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200314 */
315//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
316
317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100319 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000320 * Mark deprecated functions and features so that they generate a warning if
321 * used. Functionality deprecated in one version will usually be removed in the
322 * next version. You can enable this to help you prepare the transition to a
323 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100324 *
325 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000328 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100331
332/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100334 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000335 * Remove deprecated functions and features so that they generate an error if
336 * used. Functionality deprecated in one version will usually be removed in the
337 * next version. You can enable this to help you prepare the transition to a
338 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100339 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000340 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100341 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200342//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100343
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100344/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000345
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000346/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200347 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000348 *
349 * This section sets support for features that are or are not needed
350 * within the modules that are enabled.
351 * \{
352 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000353
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100356 *
TRodziewiczd8540832021-06-10 15:16:50 +0200357 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200358 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100359 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100361 *
362 * You will need to provide a header "timing_alt.h" and an implementation at
363 * compile time.
364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200365//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100366
367/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100368 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200369 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200370 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100371 * alternate core implementation of a symmetric crypto, an arithmetic or hash
372 * module (e.g. platform specific assembly optimized implementations). Keep
373 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200374 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200375 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200377 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200378 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000379 * provide the "struct mbedtls_aes_context" definition and omit the base
380 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200381 * "aes.h" to include the new function definitions.
382 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200383 * Uncomment a macro to enable alternate implementation of the corresponding
384 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100385 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200386 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100387 * use constitutes a security risk. If possible, we recommend
388 * avoiding dependencies on them, and considering stronger message
389 * digests and ciphers instead.
390 *
Paul Bakker90995b52013-06-24 19:20:35 +0200391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000393//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200395//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300396//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200397//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200398//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000400//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000401//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100402//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300403//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300405//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200406//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000407//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408//#define MBEDTLS_SHA1_ALT
409//#define MBEDTLS_SHA256_ALT
410//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000411
Janos Follathb0697532016-08-18 12:38:46 +0100412/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800413 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100414 * implemented with two .c files:
415 * - ecp.c
416 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000417 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
418 * macros as described above. The only difference is that you have to make sure
419 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100420 */
421//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200422
423/**
TRodziewicz75628d52021-06-18 12:56:27 +0200424 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200425 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200426 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100427 * alternate core implementation of symmetric crypto or hash function. Keep in
428 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200429 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200430 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200432 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200433 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434 * no longer provide the mbedtls_sha1_process() function, but it will still provide
435 * the other function (using your mbedtls_sha1_process() function) and the definition
436 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200437 * with this definition.
438 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200439 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100440 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
441 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200442 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200443 * Uncomment a macro to enable alternate implementation of the corresponding
444 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100445 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200446 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100447 * constitutes a security risk. If possible, we recommend avoiding
448 * dependencies on them, and considering stronger message digests
449 * and ciphers instead.
450 *
Janos Follath1231d212019-01-07 15:01:32 +0000451 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
452 * enabled, then the deterministic ECDH signature functions pass the
453 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
454 * alternative implementations should use the RNG only for generating
455 * the ephemeral key and nothing else. If this is not possible, then
456 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200457 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000458 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200460//#define MBEDTLS_MD5_PROCESS_ALT
461//#define MBEDTLS_RIPEMD160_PROCESS_ALT
462//#define MBEDTLS_SHA1_PROCESS_ALT
463//#define MBEDTLS_SHA256_PROCESS_ALT
464//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200465//#define MBEDTLS_DES_SETKEY_ALT
466//#define MBEDTLS_DES_CRYPT_ECB_ALT
467//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200468//#define MBEDTLS_AES_SETKEY_ENC_ALT
469//#define MBEDTLS_AES_SETKEY_DEC_ALT
470//#define MBEDTLS_AES_ENCRYPT_ALT
471//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300472//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300473//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300474//#define MBEDTLS_ECDSA_VERIFY_ALT
475//#define MBEDTLS_ECDSA_SIGN_ALT
476//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200477
478/**
Janos Follathc44ab972016-11-18 16:38:23 +0000479 * \def MBEDTLS_ECP_INTERNAL_ALT
480 *
481 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100482 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200483 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100484 * alternative core implementation of elliptic curve arithmetic. Keep in mind
485 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100486 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200487 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100488 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
489 * is still present and it is used for group structures not supported by the
490 * alternative.
491 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100492 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100493 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100494 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
495 * able to fallback to curves not supported by the alternative implementation.
496 *
Janos Follathc44ab972016-11-18 16:38:23 +0000497 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
498 * and implementing the following functions:
499 * unsigned char mbedtls_internal_ecp_grp_capable(
500 * const mbedtls_ecp_group *grp )
501 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500502 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000503 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
504 * replacement functions implement arithmetic for the given group and 0
505 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500506 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000507 * called before and after each point operation and provide an opportunity to
508 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100509 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100510 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200511 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100512 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
513 * for the operation is supported by your implementation (i.e. your
514 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200515 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100516 * implementation of ecp_double_jac() is used instead, unless this fallback
517 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
518 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
519 *
520 * The function prototypes and the definition of mbedtls_ecp_group and
521 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
522 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
523 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100524 *
525 * Uncomment a macro to enable alternate implementation of the corresponding
526 * function.
527 */
528/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000529//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100530/* Turn off software fallback for curves not supported in hardware */
531//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100532/* Support for Weierstrass curves with Jacobi representation */
533//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
534//#define MBEDTLS_ECP_ADD_MIXED_ALT
535//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
536//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
537//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
538/* Support for curves with Montgomery arithmetic */
539//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
540//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
541//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
542
543/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200544 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200545 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200546 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200547 * hardware entropy collector.
548 *
549 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000550 * prototype as declared in library/entropy_poll.h, and accept NULL as first
551 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200552 *
553 * Uncomment to use your own hardware entropy collector.
554 */
555//#define MBEDTLS_ENTROPY_HARDWARE_ALT
556
557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000559 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100560 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000561 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 * Uncomment this macro to use precomputed AES tables stored in ROM.
563 * Comment this macro to generate AES tables in RAM at runtime.
564 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100565 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
566 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100567 * initialization time before the first AES operation can be performed.
568 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
569 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
570 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 *
572 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000575
576/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100577 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200578 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100579 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100581 * Uncommenting this macro omits 75% of the AES tables from
582 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
583 * by computing their values on the fly during operations
584 * (the tables are entry-wise rotations of one another).
585 *
586 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100587 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100588 * runtime. Specifically, one has to compare 4 accesses within
589 * different tables to 4 accesses with additional arithmetic
590 * operations within the same table. The performance gain/loss
591 * depends on the system and memory details.
592 *
593 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200594 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100595//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200596
597/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800598 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
599 *
600 * Use only 128-bit keys in AES operations to save ROM.
601 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800602 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800603 * or 256-bit keys.
604 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800605 * Uncommenting this macro reduces the size of AES code by ~300 bytes
606 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800607 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800608 * Module: library/aes.c
609 *
610 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800611 */
612//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
613
Gilles Peskinea8861e02023-09-05 20:20:51 +0200614/*
615 * Disable plain C implementation for AES.
616 *
617 * When the plain C implementation is enabled, and an implementation using a
618 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
619 * detection will be used to select between them.
620 *
621 * If only one implementation is present, runtime detection will not be used.
622 * This configuration will crash at runtime if running on a CPU without the
623 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
624 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
625 */
626//#define MBEDTLS_AES_USE_HARDWARE_ONLY
627
Arto Kinnunen732ca322023-04-14 14:26:10 +0800628/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200630 *
631 * Use less ROM for the Camellia implementation (saves about 768 bytes).
632 *
633 * Uncomment this macro to use less memory for Camellia.
634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200636
637/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200638 * \def MBEDTLS_CHECK_RETURN_WARNING
639 *
640 * If this macro is defined, emit a compile-time warning if application code
641 * calls a function without checking its return value, but the return value
642 * should generally be checked in portable applications.
643 *
644 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
645 * implemented. Otherwise this option has no effect.
646 *
647 * Uncomment to get warnings on using fallible functions without checking
648 * their return value.
649 *
650 * \note This feature is a work in progress.
651 * Warnings will be added to more functions in the future.
652 *
653 * \note A few functions are considered critical, and ignoring the return
654 * value of these functions will trigger a warning even if this
655 * macro is not defined. To completely disable return value check
656 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
657 */
658//#define MBEDTLS_CHECK_RETURN_WARNING
659
660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200662 *
663 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200666
667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000669 *
670 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000673
674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000676 *
677 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000680
681/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100682 * \def MBEDTLS_CIPHER_MODE_OFB
683 *
684 * Enable Output Feedback mode (OFB) for symmetric ciphers.
685 */
686#define MBEDTLS_CIPHER_MODE_OFB
687
688/**
689 * \def MBEDTLS_CIPHER_MODE_XTS
690 *
691 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
692 */
693#define MBEDTLS_CIPHER_MODE_XTS
694
695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000697 *
698 * Enable NULL cipher.
699 * Warning: Only do so when you know what you are doing. This allows for
700 * encryption or channels without any security!
701 *
Ronald Croncee42702021-04-26 11:34:44 +0200702 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
704 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
705 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
706 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
707 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
708 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
709 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
710 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
711 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
712 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
713 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
714 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
715 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
716 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
717 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
718 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
719 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
720 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
721 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000722 *
723 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000726
727/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100728 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200729 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100730 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
731 * specific padding modes in the cipher layer with cipher modes that support
732 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200733 *
734 * If you disable all padding modes, only full blocks can be used with CBC.
735 *
736 * Enable padding modes in the cipher layer.
737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#define MBEDTLS_CIPHER_PADDING_PKCS7
739#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
740#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
741#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200742
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200743/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
744 *
745 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800746 * Without this, CTR_DRBG uses a 256-bit key
747 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200748 */
749//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
750
Paul Bakker48e93c82013-08-14 12:21:18 +0200751/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200752 * Enable the verified implementations of ECDH primitives from Project Everest
753 * (currently only Curve25519). This feature changes the layout of ECDH
754 * contexts and therefore is a compatibility break for applications that access
755 * fields of a mbedtls_ecdh_context structure directly. See also
756 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
757 */
758//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
759
760/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100761 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200762 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100763 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
764 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200765 *
766 * Comment macros to disable the curve and functions for it
767 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200768/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
770#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
771#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
772#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
773#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
774#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
775#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
776#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
777#define MBEDTLS_ECP_DP_BP256R1_ENABLED
778#define MBEDTLS_ECP_DP_BP384R1_ENABLED
779#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200780/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200781#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000782#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200783
784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200786 *
787 * Enable specific 'modulo p' routines for each NIST prime.
788 * Depending on the prime and architecture, makes operations 4 to 8 times
789 * faster on the corresponding curve.
790 *
791 * Comment this macro to disable NIST curves optimisation.
792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200794
795/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200796 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100797 *
798 * Enable "non-blocking" ECC operations that can return early and be resumed.
799 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200800 * This allows various functions to pause by returning
801 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
802 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
803 * order to further progress and eventually complete their operation. This is
804 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
805 * number of ECC operations a function may perform before pausing; see
806 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100807 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200808 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200809 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100810 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100811 * This option:
812 * - Adds xxx_restartable() variants of existing operations in the
813 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100814 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
815 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100816 * - ECDSA: signature generation & verification;
817 * - PK: signature generation & verification;
818 * - X509: certificate chain verification.
819 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
820 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
821 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
822 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000823 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100824 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100825 * - verification of the server's key exchange signature;
826 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100827 * - generation of the client's signature if client authentication is used,
828 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100829 *
830 * \note In the cases above, the usual SSL/TLS functions, such as
831 * mbedtls_ssl_handshake(), can now return
832 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200833 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100834 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
835 * restartable operations in PK, X.509 and TLS (see above) are not
836 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100837 * PSA, and are not restartable. These are temporary limitations that
838 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200839 *
Ron Eldor19779c42018-11-05 16:58:13 +0200840 * \note This option only works with the default software implementation of
841 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100842 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100843 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100844 * Requires: MBEDTLS_ECP_C
845 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100846 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100847 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200848//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100849
850/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200851 * Uncomment to enable using new bignum code in the ECC modules.
852 *
853 * \warning This is currently experimental, incomplete and therefore should not
854 * be used in production.
855 */
856//#define MBEDTLS_ECP_WITH_MPI_UINT
857
858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100860 *
861 * Enable deterministic ECDSA (RFC 6979).
862 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
863 * may result in a compromise of the long-term signing key. This is avoided by
864 * the deterministic variant.
865 *
John Durkop36a82e52020-10-26 09:39:05 -0700866 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100867 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100868 * Comment this macro to disable deterministic ECDSA.
869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100871
872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200874 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200875 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200876 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200877 * This enables the following ciphersuites (if other requisites are
878 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
880 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
881 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
882 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
883 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
884 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
885 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
886 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
887 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
888 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200891
892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200895 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * Requires: MBEDTLS_DHM_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_DHE_PSK_WITH_AES_256_GCM_SHA384
902 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
903 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
904 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
905 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
906 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
907 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
908 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
909 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
910 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100911 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100912 * \warning Using DHE constitutes a security risk as it
913 * is not possible to validate custom DH parameters.
914 * If possible, it is recommended users should consider
915 * preferring other methods of key exchange.
916 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100917 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200920
921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200923 *
924 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
925 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200926 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200927 *
928 * This enables the following ciphersuites (if other requisites are
929 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
932 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
933 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
934 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
935 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200938
939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200941 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200942 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200943 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
945 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200946 *
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_RSA_PSK_WITH_AES_256_GCM_SHA384
950 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
951 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
952 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
953 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
954 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
955 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
956 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
957 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
958 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200961
962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200964 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200965 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200966 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
968 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200969 *
970 * This enables the following ciphersuites (if other requisites are
971 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
973 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
974 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
975 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
976 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
977 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
978 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
979 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
980 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
981 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
982 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
983 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200989 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200990 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200991 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
993 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200994 *
995 * This enables the following ciphersuites (if other requisites are
996 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
998 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
999 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1000 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1001 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1002 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1003 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1004 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1005 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1006 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1007 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1008 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001009 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001010 * \warning Using DHE constitutes a security risk as it
1011 * is not possible to validate custom DH parameters.
1012 * If possible, it is recommended users should consider
1013 * preferring other methods of key exchange.
1014 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001015 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001018
1019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001021 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001022 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001023 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001024 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1025 * MBEDTLS_RSA_C
1026 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001028 *
1029 * This enables the following ciphersuites (if other requisites are
1030 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1032 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1033 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1034 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1035 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1036 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1037 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1038 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1039 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1040 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001043
1044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001046 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001047 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001048 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001049 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1050 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1051 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001052 *
1053 * This enables the following ciphersuites (if other requisites are
1054 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1056 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1057 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1058 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1059 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1060 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1061 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1062 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1063 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1064 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001067
1068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001070 *
1071 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1072 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001073 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1074 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1075 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001076 *
1077 * This enables the following ciphersuites (if other requisites are
1078 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1080 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1081 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1082 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1083 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1084 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1085 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1086 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1087 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1088 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001091
1092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001094 *
1095 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1096 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001097 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1098 * MBEDTLS_RSA_C
1099 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001100 *
1101 * This enables the following ciphersuites (if other requisites are
1102 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1104 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1105 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1106 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1107 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1108 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1109 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1110 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1111 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1112 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001115
1116/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001117 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1118 *
1119 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1120 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001121 * \warning This is currently experimental. EC J-PAKE support is based on the
1122 * Thread v1.0.0 specification; incompatible changes to the specification
1123 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001124 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001125 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001126 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001127 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1128 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001129 * \warning If SHA-256 is provided only by a PSA driver, you must call
1130 * psa_crypto_init() before the first hanshake (even if
1131 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1132 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001133 * This enables the following ciphersuites (if other requisites are
1134 * enabled as well):
1135 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1136 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001137//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001138
1139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001141 *
1142 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1143 * RFC 5915 and RFC 5480.
1144 *
1145 * Currently this means parsing the SpecifiedECDomain choice of EC
1146 * parameters (only known groups are supported, not arbitrary domains, to
1147 * avoid validation issues).
1148 *
1149 * Disable if you only need to support RFC 5915 + 5480 key formats.
1150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001152
1153/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001154 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1155 *
1156 * Enable the support for parsing public keys of type Short Weierstrass
1157 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001158 * compressed point format. This parsing is done through ECP module's functions.
1159 *
1160 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1161 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1162 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001163 */
1164#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1165
1166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * Enable a dummy error function to make use of mbedtls_strerror() in
1170 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1171 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1174 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001175 *
1176 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001180
1181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001183 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001184 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001185 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001189
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001192 *
1193 * Enable functions that use the filesystem.
1194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001196
1197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001199 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001200 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001201 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001202 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001203 * application.
1204 *
1205 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001208
1209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001211 *
1212 * Do not use built-in platform entropy functions.
1213 * This is useful if your platform does not support
1214 * standards like the /dev/urandom or Windows CryptoAPI.
1215 *
1216 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001219
1220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001222 *
1223 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1224 * default SHA-512 based one (if both are available).
1225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001227 *
1228 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1229 * if you have performance concerns.
1230 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231 * This option is only useful if both MBEDTLS_SHA256_C and
1232 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001235
1236/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001237 * \def MBEDTLS_ENTROPY_NV_SEED
1238 *
1239 * Enable the non-volatile (NV) seed file-based entropy source.
1240 * (Also enables the NV seed read/write functions in the platform layer)
1241 *
1242 * This is crucial (if not required) on systems that do not have a
1243 * cryptographic entropy source (in hardware or kernel) available.
1244 *
1245 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1246 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001247 * \note The read/write functions that are used by the entropy source are
1248 * determined in the platform layer, and can be modified at runtime and/or
1249 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1250 *
1251 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001252 * with regular fopen(), please make sure you make a seedfile with the
1253 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1254 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001255 * and written to or you will get an entropy source error! The default
1256 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1257 * bytes from the file.
1258 *
1259 * \note The entropy collector will write to the seed file before entropy is
1260 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001261 */
1262//#define MBEDTLS_ENTROPY_NV_SEED
1263
Ronald Cron71016a92020-08-28 19:01:50 +02001264/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001265 *
Ronald Cron71016a92020-08-28 19:01:50 +02001266 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001267 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001268 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1269 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001270 *
1271 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001272 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001273 */
Ronald Cron71016a92020-08-28 19:01:50 +02001274//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001275
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001276/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001278 *
1279 * Enable debugging of buffer allocator memory issues. Automatically prints
1280 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1281 * function for 'debug output' of allocated memory.
1282 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001284 *
1285 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001288
1289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001291 *
1292 * Include backtrace information with each allocated block.
1293 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001295 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001296 *
1297 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001300
1301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001303 *
1304 * Support external private RSA keys (eg from a HSM) in the PK layer.
1305 *
1306 * Comment this macro to disable support for external private RSA keys.
1307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001309
1310/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001312 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001313 * Enable support for PKCS#1 v1.5 encoding.
1314 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001315 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001316 *
Paul Bakker48377d92013-08-30 12:06:24 +02001317 * This enables support for PKCS#1 v1.5 operations.
1318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001320
1321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001323 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001324 * Enable support for PKCS#1 v2.1 encoding.
1325 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001326 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001327 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001328 * \warning If using a hash that is only provided by PSA drivers, you must
1329 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001330 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001331 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001334
Steven Cooreman6801f082021-02-19 17:21:22 +01001335/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1336 *
1337 * Enable support for platform built-in keys. If you enable this feature,
1338 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1339 * See the documentation of that function for more information.
1340 *
1341 * Built-in keys are typically derived from a hardware unique key or
1342 * stored in a secure element.
1343 *
1344 * Requires: MBEDTLS_PSA_CRYPTO_C.
1345 *
1346 * \warning This interface is experimental and may change or be removed
1347 * without notice.
1348 */
1349//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1350
Ronald Cron3768ac12021-01-26 16:58:00 +01001351/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1352 *
1353 * Enable support for PSA crypto client.
1354 *
1355 * \note This option allows to include the code necessary for a PSA
1356 * crypto client when the PSA crypto implementation is not included in
1357 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1358 * code to set and get PSA key attributes.
1359 * The development of PSA drivers partially relying on the library to
1360 * fulfill the hardware gaps is another possible usage of this option.
1361 *
1362 * \warning This interface is experimental and may change or be removed
1363 * without notice.
1364 */
1365//#define MBEDTLS_PSA_CRYPTO_CLIENT
1366
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001367/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1368 *
1369 * Make the PSA Crypto module use an external random generator provided
1370 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1371 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001372 * \note This random generator must deliver random numbers with cryptographic
1373 * quality and high performance. It must supply unpredictable numbers
1374 * with a uniform distribution. The implementation of this function
1375 * is responsible for ensuring that the random generator is seeded
1376 * with sufficient entropy. If you have a hardware TRNG which is slow
1377 * or delivers non-uniform output, declare it as an entropy source
1378 * with mbedtls_entropy_add_source() instead of enabling this option.
1379 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001380 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001381 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1382 * and define a function called mbedtls_psa_external_get_random()
1383 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001384 * ```
1385 * psa_status_t mbedtls_psa_external_get_random(
1386 * mbedtls_psa_external_random_context_t *context,
1387 * uint8_t *output, size_t output_size, size_t *output_length);
1388 * );
1389 * ```
1390 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001391 * The function must fill the \c output buffer with \c output_size bytes
1392 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001393 *
1394 * Requires: MBEDTLS_PSA_CRYPTO_C
1395 *
1396 * \warning If you enable this option, code that uses the PSA cryptography
1397 * interface will not use any of the entropy sources set up for
1398 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1399 * enables.
1400 *
1401 * \note This option is experimental and may be removed without notice.
1402 */
1403//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1404
Paul Bakker9dcc3222011-03-08 14:16:06 +00001405/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001406 * \def MBEDTLS_PSA_CRYPTO_SPM
1407 *
1408 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1409 * Partition Manager) integration which separates the code into two parts: a
1410 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1411 * Environment).
1412 *
1413 * Module: library/psa_crypto.c
1414 * Requires: MBEDTLS_PSA_CRYPTO_C
1415 *
1416 */
1417//#define MBEDTLS_PSA_CRYPTO_SPM
1418
1419/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001420 * Uncomment to enable p256-m. This is an alternative implementation of
1421 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1422 * Compared to the default implementation:
1423 *
1424 * - p256-m has a much smaller code size and RAM footprint.
1425 * - p256-m is only available via the PSA API. This includes the pk module
1426 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1427 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1428 * over the core arithmetic, or deterministic derivation of keys.
1429 *
1430 * We recommend enabling this option if your application uses the PSA API
1431 * and the only elliptic curve support it needs is ECDH and ECDSA over
1432 * SECP256R1.
1433 *
1434 * If you enable this option, you do not need to enable any ECC-related
1435 * MBEDTLS_xxx option. You do need to separately request support for the
1436 * cryptographic mechanisms through the PSA API:
1437 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1438 * configuration;
1439 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1440 * - #PSA_WANT_ECC_SECP_R1_256;
1441 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1442 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1443 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1444 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1445 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001446 *
1447 * \note To genuinely benefit from the smaller code size of p256-m, make
1448 * sure that you do not enable any ECC-related option that requires
1449 * the built-in implementation of elliptic curve arithmetic. This
1450 * means enabling #MBEDTLS_PSA_CRYPTO_C, #MBEDTLS_PSA_CRYPTO_CONFIG,
1451 * #PSA_WANT_ECC_SECP_R1_256 and #MBEDTLS_PSA_P256M_DRIVER_ENABLED,
1452 * plus any of the `PSA_WANT_ALG_xxx` and `PSA_WANT_KEY_TYPE_xxx`
1453 * options listed above, and not enabling other ECC-related options
1454 * through `PSA_WANT_xxx` or `MBEDTLS_xxx` (in particular, not
1455 * enabling other curves or EC-JPAKE).
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001456 */
1457//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1458
1459/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001460 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001461 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001462 * Enable support for entropy injection at first boot. This feature is
1463 * required on systems that do not have a built-in entropy source (TRNG).
1464 * This feature is currently not supported on systems that have a built-in
1465 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001466 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001467 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001468 *
1469 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001470//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001471
1472/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001474 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001475 * Do not use the Chinese Remainder Theorem
1476 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001477 *
1478 * Uncomment this macro to disable the use of CRT in RSA.
1479 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001482
1483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001485 *
1486 * Enable the checkup functions (*_self_test).
1487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001489
1490/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001491 * \def MBEDTLS_SHA256_SMALLER
1492 *
1493 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1494 * lower performance.
1495 *
Adam Wolf039080f2019-09-10 09:53:08 -05001496 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001497 * performance and size. This version optimizes more aggressively for size at
1498 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1499 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1500 * 30%.
1501 *
1502 * Uncomment to enable the smaller implementation of SHA256.
1503 */
1504//#define MBEDTLS_SHA256_SMALLER
1505
1506/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001507 * \def MBEDTLS_SHA512_SMALLER
1508 *
1509 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1510 * lower performance.
1511 *
1512 * Uncomment to enable the smaller implementation of SHA512.
1513 */
1514//#define MBEDTLS_SHA512_SMALLER
1515
1516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001518 *
1519 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001520 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001521 * with other servers, only debugging of failures is harder.
1522 *
1523 * The advantage of not sending alert messages, is that no information is given
1524 * about reasons for failures thus preventing adversaries of gaining intel.
1525 *
1526 * Enable sending of all alert messages
1527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001529
1530/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001531 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1532 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001533 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001534 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001535 * in the underlying transport. The CID functionality is described
1536 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001537 *
1538 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001539 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1540 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1541 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001542 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001543 * The maximum lengths of outgoing and incoming CIDs can be configured
1544 * through the options
1545 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1546 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1547 *
1548 * Requires: MBEDTLS_SSL_PROTO_DTLS
1549 *
1550 * Uncomment to enable the Connection ID extension.
1551 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001552#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1553
1554
1555/**
1556 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1557 *
1558 * Defines whether RFC 9146 (default) or the legacy version
1559 * (version draft-ietf-tls-dtls-connection-id-05,
1560 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1561 * is used.
1562 *
1563 * Set the value to 0 for the standard version, and
1564 * 1 for the legacy draft version.
1565 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001566 * \deprecated Support for the legacy version of the DTLS
1567 * Connection ID feature is deprecated. Please
1568 * switch to the standardized version defined
1569 * in RFC 9146 enabled by utilizing
1570 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1571 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1572 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001573 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1574 */
1575#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001576
1577/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001578 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1579 *
1580 * Enable asynchronous external private key operations in SSL. This allows
1581 * you to configure an SSL connection to call an external cryptographic
1582 * module to perform private key operations instead of performing the
1583 * operation inside the library.
1584 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001585 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001586 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001587//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001588
1589/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001590 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1591 *
1592 * Enable serialization of the TLS context structures, through use of the
1593 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1594 *
1595 * This pair of functions allows one side of a connection to serialize the
1596 * context associated with the connection, then free or re-use that context
1597 * while the serialized state is persisted elsewhere, and finally deserialize
1598 * that state to a live context for resuming read/write operations on the
1599 * connection. From a protocol perspective, the state of the connection is
1600 * unaffected, in particular this is entirely transparent to the peer.
1601 *
1602 * Note: this is distinct from TLS session resumption, which is part of the
1603 * protocol and fully visible by the peer. TLS session resumption enables
1604 * establishing new connections associated to a saved session with shorter,
1605 * lighter handshakes, while context serialization is a local optimization in
1606 * handling a single, potentially long-lived connection.
1607 *
1608 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1609 * saved after the handshake to allow for more efficient serialization, so if
1610 * you don't need this feature you'll save RAM by disabling it.
1611 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001612 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1613 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001614 * Comment to disable the context serialization APIs.
1615 */
1616#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1617
1618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001620 *
1621 * Enable the debug messages in SSL module for all issues.
1622 * Debug messages have been disabled in some places to prevent timing
1623 * attacks due to (unbalanced) debugging function calls.
1624 *
1625 * If you need all error reporting you should enable this during debugging,
1626 * but remove this for production servers that should log as well.
1627 *
1628 * Uncomment this macro to report all debug messages on errors introducing
1629 * a timing side-channel.
1630 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001635 *
1636 * Enable support for Encrypt-then-MAC, RFC 7366.
1637 *
1638 * This allows peers that both support it to use a more robust protection for
1639 * ciphersuites using CBC, providing deep resistance against timing attacks
1640 * on the padding or underlying cipher.
1641 *
1642 * This only affects CBC ciphersuites, and is useless if none is defined.
1643 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001644 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001645 *
1646 * Comment this macro to disable support for Encrypt-then-MAC
1647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001651 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001652 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1653 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001654 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001655 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001656 * attacks, but it is recommended to always use it (even if you disable
1657 * renegotiation), since it actually fixes a more fundamental issue in the
1658 * original SSL/TLS design, and has implications beyond Triple Handshake.
1659 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001660 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001661 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001662 * Comment this macro to disable support for Extended Master Secret.
1663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001665
Paul Bakkerd66f0702013-01-31 16:57:45 +01001666/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001667 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1668 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001669 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001670 * giving access to the peer's certificate after completion of the handshake.
1671 *
1672 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1673 * recommended to disable this option for reduced RAM usage.
1674 *
1675 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1676 * defined, but always returns \c NULL.
1677 *
1678 * \note This option has no influence on the protection against the
1679 * triple handshake attack. Even if it is disabled, Mbed TLS will
1680 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001681 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001682 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001683 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001684 *
1685 * Comment this macro to disable storing the peer's certificate
1686 * after the handshake.
1687 */
1688#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1689
1690/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001691 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001692 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001693 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001694 *
1695 * The two main uses of renegotiation are (1) refresh keys on long-lived
1696 * connections and (2) client authentication after the initial handshake.
1697 * If you don't need renegotiation, it's probably better to disable it, since
1698 * it has been associated with security issues in the past and is easy to
1699 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001700 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001701 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1702 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001703 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001704 *
1705 * \note Even if this option is disabled, both client and server are aware
1706 * of the Renegotiation Indication Extension (RFC 5746) used to
1707 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1708 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1709 * configuration of this extension).
1710 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001713
1714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001716 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001717 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001718 *
1719 * Comment this macro to disable support for the max_fragment_length extension
1720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001722
1723/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001724 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1725 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001726 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001727 *
1728 * \warning This extension is currently in development and must NOT be used except
1729 * for testing purposes.
1730 *
1731 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1732 *
1733 * Uncomment this macro to enable support for the record_size_limit extension
1734 */
1735//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1736
1737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001739 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001740 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001741 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001742 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001743 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1744 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001745 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001746 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001747 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001748 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1749 * are only provided by PSA drivers, you must call psa_crypto_init() before
1750 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001751 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001752 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001755
1756/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001757 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001758 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001759 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001760 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001761 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001762 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001763 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001764 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001765 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001766 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001767 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1768 * directly performed by TLS 1.3 code. As a consequence, you must
1769 * call psa_crypto_init() before the first TLS 1.3 handshake.
1770 *
1771 * \note Cryptographic operations performed indirectly via another module
1772 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1773 * running handshake hash) only use PSA crypto if
1774 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001775 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001776 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001777 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001778//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001779
1780/**
Ronald Cronab65c522021-11-24 10:47:20 +01001781 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1782 *
1783 * Enable TLS 1.3 middlebox compatibility mode.
1784 *
1785 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1786 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1787 * expecting TLS 1.2 traffic.
1788 *
1789 * Turning on the compatibility mode comes at the cost of a few added bytes
1790 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1791 * that don't use it. Therefore, unless transmission bandwidth is critical and
1792 * you know that middlebox compatibility issues won't occur, it is therefore
1793 * recommended to set this option.
1794 *
1795 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001796 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1797 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001798 *
1799 */
1800//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1801
1802/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001803 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1804 *
1805 * Enable TLS 1.3 PSK key exchange mode.
1806 *
1807 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1808 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1809 * effect on the build.
1810 *
1811 */
1812#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1813
1814/**
1815 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1816 *
1817 * Enable TLS 1.3 ephemeral key exchange mode.
1818 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001819 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001820 * MBEDTLS_X509_CRT_PARSE_C
1821 * and at least one of:
1822 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1823 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001824 *
1825 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1826 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1827 * effect on the build.
1828 *
1829 */
1830#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1831
1832/**
1833 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1834 *
1835 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1836 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001837 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001838 *
1839 * Comment to disable support for the PSK ephemeral key exchange mode in
1840 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1841 * have any effect on the build.
1842 *
1843 */
1844#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1845
1846/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 * \def MBEDTLS_SSL_EARLY_DATA
1848 *
1849 * Enable support for RFC 8446 TLS 1.3 early data.
1850 *
1851 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1852 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1853 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1854 *
1855 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1856 * is not enabled, this option does not have any effect on the build.
1857 *
1858 * This feature is experimental, not completed and thus not ready for
1859 * production.
1860 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001861 * \note The maximum amount of early data can be set with
1862 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1863 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001865//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001866
1867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001869 *
1870 * Enable support for DTLS (all available versions).
1871 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001872 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001873 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001874 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001875 *
1876 * Comment this macro to disable support for DTLS
1877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001879
1880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001882 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001883 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001884 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001885 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001888
1889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001891 *
1892 * Enable support for the anti-replay mechanism in DTLS.
1893 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 * Requires: MBEDTLS_SSL_TLS_C
1895 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001896 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001897 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001898 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001899 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001900 * Comment this to disable anti-replay in DTLS.
1901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001903
1904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001906 *
1907 * Enable support for HelloVerifyRequest on DTLS servers.
1908 *
1909 * This feature is highly recommended to prevent DTLS servers being used as
1910 * amplifiers in DoS attacks against other hosts. It should always be enabled
1911 * unless you know for sure amplification cannot be a problem in the
1912 * environment in which your server operates.
1913 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001914 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001915 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001916 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001917 *
1918 * Comment this to disable support for HelloVerifyRequest.
1919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001921
1922/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001923 * \def MBEDTLS_SSL_DTLS_SRTP
1924 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001925 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001926 * through the use_srtp extension.
1927 *
1928 * \note This feature provides the minimum functionality required
1929 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1930 * the associated SRTP packet protection key material.
1931 * In particular, the SRTP packet protection itself, as well as the
1932 * demultiplexing of RTP and DTLS packets at the datagram layer
1933 * (see Section 5 of RFC 5764), are not handled by this feature.
1934 * Instead, after successful completion of a handshake negotiating
1935 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001936 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001937 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1938 * (this is implemented in the SSL example programs).
1939 * The resulting key should then be passed to an SRTP stack.
1940 *
1941 * Setting this option enables the runtime API
1942 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1943 * through which the supported DTLS-SRTP protection
1944 * profiles can be configured. You must call this API at
1945 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001946 *
1947 * Requires: MBEDTLS_SSL_PROTO_DTLS
1948 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001949 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001950 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001951//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001952
1953/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001954 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1955 *
1956 * Enable server-side support for clients that reconnect from the same port.
1957 *
1958 * Some clients unexpectedly close the connection and try to reconnect using the
1959 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001960 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001961 * flag enables that support.
1962 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001963 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001964 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001965 * Comment this to disable support for clients reusing the source port.
1966 */
1967#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1968
1969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001971 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001972 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001973 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001974 * session store remains the responsibility of the application, though).
1975 * Server-side, you also need to provide callbacks for writing and parsing
1976 * tickets, including authenticated encryption and key management. Example
1977 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001978 *
1979 * Comment this macro to disable support for SSL session tickets
1980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001982
1983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001985 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001986 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001987 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001989 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001990 * Comment this macro to disable support for server name indication in SSL
1991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001993
1994/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001995 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1996 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001997 * When this option is enabled, the SSL buffer will be resized automatically
1998 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001999 *
2000 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002001 */
2002//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2003
2004/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002005 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2006 *
2007 * Enable testing of the constant-flow nature of some sensitive functions with
2008 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002009 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002010 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002011 * This setting requires compiling with clang -fsanitize=memory. The test
2012 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002013 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002014 * \warning This macro is only used for extended testing; it is not considered
2015 * part of the library's API, so it may change or disappear at any time.
2016 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002017 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002018 */
2019//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2020
2021/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002022 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2023 *
2024 * Enable testing of the constant-flow nature of some sensitive functions with
2025 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002026 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002027 *
2028 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002029 * testing if the tests suites are run with valgrind's memcheck. This can be
2030 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2031 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002032 *
2033 * \warning This macro is only used for extended testing; it is not considered
2034 * part of the library's API, so it may change or disappear at any time.
2035 *
2036 * Uncomment to enable testing of the constant-flow nature of selected code.
2037 */
2038//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2039
2040/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002041 * \def MBEDTLS_TEST_HOOKS
2042 *
2043 * Enable features for invasive testing such as introspection functions and
2044 * hooks for fault injection. This enables additional unit tests.
2045 *
2046 * Merely enabling this feature should not change the behavior of the product.
2047 * It only adds new code, and new branching points where the default behavior
2048 * is the same as when this feature is disabled.
2049 * However, this feature increases the attack surface: there is an added
2050 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2051 * Therefore this feature must never be enabled in production.
2052 *
2053 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2054 * information.
2055 *
2056 * Uncomment to enable invasive tests.
2057 */
2058//#define MBEDTLS_TEST_HOOKS
2059
2060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002062 *
2063 * Provide your own alternate threading implementation.
2064 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002066 *
2067 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002070
2071/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002073 *
2074 * Enable the pthread wrapper layer for the threading layer.
2075 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002077 *
2078 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002081
2082/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002083 * \def MBEDTLS_USE_PSA_CRYPTO
2084 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002085 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2086 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002087 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002088 * \note Development of this option is currently in progress, and parts of Mbed
2089 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002090 * will still continue to work as usual, so enabling this option should not
2091 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002092 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002093 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002094 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2095 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002096 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002097 * \note An important and desirable effect of this option is that it allows
2098 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2099 * 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 +02002100 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002101 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2102 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002103 *
2104 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002105 *
2106 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002107 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002108 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002110//#define MBEDTLS_USE_PSA_CRYPTO
2111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002113 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2114 *
John Durkop185764f2020-10-12 21:32:12 -07002115 * This setting allows support for cryptographic mechanisms through the PSA
2116 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002117 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002118 * When this option is disabled, the PSA API exposes the cryptographic
2119 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2120 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002121 *
2122 * When this option is enabled, the PSA API exposes the cryptographic
2123 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2124 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2125 * automatically enabled if required (i.e. if no PSA driver provides the
2126 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2127 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002128 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002129 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002130 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002131 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002132 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2133 * symbols is not completely finalized yet, and the configuration
2134 * tooling is not ideally adapted to having two separate configuration
2135 * files.
2136 * Future minor releases of Mbed TLS may make minor changes to those
2137 * symbols, but we will endeavor to provide a transition path.
2138 * Nonetheless, this option is considered mature enough to use in
2139 * production, as long as you accept that you may need to make
2140 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002141 */
2142//#define MBEDTLS_PSA_CRYPTO_CONFIG
2143
2144/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002145 * \def MBEDTLS_VERSION_FEATURES
2146 *
2147 * Allow run-time checking of compile-time enabled features. Thus allowing users
2148 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002149 * support via mbedtls_version_check_feature().
2150 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002151 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002152 *
2153 * Comment this to disable run-time checking and save ROM space
2154 */
2155#define MBEDTLS_VERSION_FEATURES
2156
2157/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002158 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2159 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002160 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002161 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2162 * the set of trusted certificates through a callback instead of a linked
2163 * list.
2164 *
2165 * This is useful for example in environments where a large number of trusted
2166 * certificates is present and storing them in a linked list isn't efficient
2167 * enough, or when the set of trusted certificates changes frequently.
2168 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002169 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002170 * `mbedtls_ssl_conf_ca_cb()` for more information.
2171 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002172 * Requires: MBEDTLS_X509_CRT_PARSE_C
2173 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002174 * Uncomment to enable trusted certificate callbacks.
2175 */
2176//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2177
2178/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002179 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002180 *
Chris Jones2c745862020-12-16 11:41:06 +00002181 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002182 *
Chris Jones2c745862020-12-16 11:41:06 +00002183 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002184 * and other functions/constants only used by these functions, thus reducing
2185 * the code footprint by several KB.
2186 */
Chris Jones2c745862020-12-16 11:41:06 +00002187//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002188
2189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002191 *
2192 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2193 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2194 *
2195 * Comment this macro to disallow using RSASSA-PSS in certificates.
2196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002198/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002199
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002200/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002201 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002202 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002203 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002204 * \{
2205 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002209 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002210 * Enable AES-NI support on x86-64 or x86-32.
2211 *
2212 * \note AESNI is only supported with certain compilers and target options:
2213 * - Visual Studio 2013: supported.
2214 * - GCC, x86-64, target not explicitly supporting AESNI:
2215 * requires MBEDTLS_HAVE_ASM.
2216 * - GCC, x86-32, target not explicitly supporting AESNI:
2217 * not supported.
2218 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2219 * For this assembly-less implementation, you must currently compile
2220 * `library/aesni.c` and `library/aes.c` with machine options to enable
2221 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2222 * `clang -maes -mpclmul`.
2223 * - Non-x86 targets: this option is silently ignored.
2224 * - Other compilers: this option is silently ignored.
2225 *
2226 * \note
2227 * Above, "GCC" includes compatible compilers such as Clang.
2228 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002229 *
2230 * Module: library/aesni.c
2231 * Caller: library/aes.c
2232 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002233 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002234 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002235 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002238
2239/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002240 * \def MBEDTLS_AESCE_C
2241 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002242 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002243 *
2244 * Module: library/aesce.c
2245 * Caller: library/aes.c
2246 *
Jerry Yuf015a932023-04-25 10:38:03 +08002247 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002248 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002249 * \warning Runtime detection only works on Linux. For non-Linux operating
2250 * system, Armv8-A Cryptographic Extensions must be supported by
2251 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002252 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002253 * \note Minimum compiler versions for this feature are Clang 4.0,
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002254 * armclang 6.6, GCC 6.0 or MSVC 2019 version 16.11.2.
2255 *
2256 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2257 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002258 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002259 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002260 */
2261#define MBEDTLS_AESCE_C
2262
2263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002265 *
2266 * Enable the AES block cipher.
2267 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002268 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002269 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002270 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002271 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002272 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002273 * This module enables the following ciphersuites (if other requisites are
2274 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2276 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2277 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2278 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2280 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2281 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2282 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2283 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2284 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2285 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2286 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2289 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2290 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2291 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2292 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2293 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2294 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2295 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2296 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2297 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2298 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2299 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2300 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2301 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2302 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2303 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2304 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2305 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2306 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2307 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2308 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2309 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2310 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2311 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2312 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2313 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2314 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2315 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2316 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2317 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2318 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2319 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2320 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2321 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2322 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2323 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2324 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2325 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2326 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2327 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2328 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2329 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2330 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2331 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2332 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002333 *
Paul Bakkercff68422013-09-15 20:43:33 +02002334 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002337
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002338/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002340 *
2341 * Enable the generic ASN1 parser.
2342 *
2343 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002344 * Caller: library/x509.c
2345 * library/dhm.c
2346 * library/pkcs12.c
2347 * library/pkcs5.c
2348 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002351
2352/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002354 *
2355 * Enable the generic ASN1 writer.
2356 *
2357 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002358 * Caller: library/ecdsa.c
2359 * library/pkwrite.c
2360 * library/x509_create.c
2361 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002362 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002363 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002365
2366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002368 *
2369 * Enable the Base64 module.
2370 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002371 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002372 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002373 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002374 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002377
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002380 *
Paul Bakker9a736322012-11-14 12:39:52 +00002381 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002382 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002383 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002384 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002385 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002386 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002388 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002389 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002390 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002391 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002393 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002394 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002397
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002398/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002400 *
2401 * Enable the Camellia block cipher.
2402 *
Paul Bakker38119b12009-01-10 23:31:23 +00002403 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002404 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002405 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002406 * This module enables the following ciphersuites (if other requisites are
2407 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2409 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2410 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2411 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2412 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2413 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2415 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2416 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2417 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2418 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2419 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2420 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2421 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2422 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2423 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2424 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2425 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2426 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2427 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2428 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2429 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2430 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2431 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2432 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2433 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2434 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2435 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2436 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2437 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2438 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2439 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2440 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2441 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2442 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2443 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2444 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2445 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2446 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2447 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2448 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2449 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002452
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002453/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002454 * \def MBEDTLS_ARIA_C
2455 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002456 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002457 *
2458 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002459 * Caller: library/cipher.c
2460 *
2461 * This module enables the following ciphersuites (if other requisites are
2462 * enabled as well):
2463 *
2464 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2465 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2466 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2467 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2468 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2469 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2470 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2471 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2472 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2473 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2474 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2475 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2476 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2477 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2478 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2479 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2480 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2481 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2482 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2483 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2484 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2485 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2486 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2487 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2488 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2489 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2490 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2491 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2492 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2493 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2494 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2495 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2496 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2497 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2498 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2499 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2500 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2501 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002502 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002503#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002504
2505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002507 *
2508 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2509 *
2510 * Module: library/ccm.c
2511 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002512 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2513 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002514 *
2515 * This module enables the AES-CCM ciphersuites, if other requisites are
2516 * enabled as well.
2517 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002519
2520/**
Daniel King34b822c2016-05-15 17:28:08 -03002521 * \def MBEDTLS_CHACHA20_C
2522 *
2523 * Enable the ChaCha20 stream cipher.
2524 *
2525 * Module: library/chacha20.c
2526 */
2527#define MBEDTLS_CHACHA20_C
2528
2529/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002530 * \def MBEDTLS_CHACHAPOLY_C
2531 *
2532 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2533 *
2534 * Module: library/chachapoly.c
2535 *
2536 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2537 */
2538#define MBEDTLS_CHACHAPOLY_C
2539
2540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002542 *
2543 * Enable the generic cipher layer.
2544 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002545 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002546 * Caller: library/ccm.c
2547 * library/cmac.c
2548 * library/gcm.c
2549 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002550 * library/pkcs12.c
2551 * library/pkcs5.c
2552 * library/psa_crypto_aead.c
2553 * library/psa_crypto_mac.c
2554 * library/ssl_ciphersuites.c
2555 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002556 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002557 *
2558 * Uncomment to enable generic cipher wrappers.
2559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002561
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002562/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002563 * \def MBEDTLS_CMAC_C
2564 *
Simon Butcher327398a2016-10-05 14:09:11 +01002565 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2566 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002567 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002568 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2569 * implementation of the CMAC algorithm is provided by an alternate
2570 * implementation, that alternate implementation may opt to not support
2571 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2572 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002573 * Module: library/cmac.c
2574 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002575 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002576 *
2577 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002578#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002579
2580/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002582 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002583 * Enable the CTR_DRBG AES-based random generator.
2584 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002585 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002586 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002587 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2588 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002589 * \note To achieve a 256-bit security strength with CTR_DRBG,
2590 * you must use AES-256 *and* use sufficient entropy.
2591 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002592 *
2593 * Module: library/ctr_drbg.c
2594 * Caller:
2595 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002597 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002598 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002601
2602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002604 *
2605 * Enable the debug functions.
2606 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002607 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002608 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002609 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002610 * library/ssl_tls12_*.c
2611 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002612 *
2613 * This module provides debugging functions.
2614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002616
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002619 *
2620 * Enable the DES block cipher.
2621 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002622 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002623 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002624 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002625 *
Paul Bakkercff68422013-09-15 20:43:33 +02002626 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002627 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002628 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002629 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002632
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002635 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002636 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002637 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002638 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002639 * Caller: library/ssl_tls.c
2640 * library/ssl*_client.c
2641 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002642 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002643 * This module is used by the following key exchanges:
2644 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002645 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002646 * \warning Using DHE constitutes a security risk as it
2647 * is not possible to validate custom DH parameters.
2648 * If possible, it is recommended users should consider
2649 * preferring other methods of key exchange.
2650 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002651 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002654
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002655/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002657 *
2658 * Enable the elliptic curve Diffie-Hellman library.
2659 *
2660 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002661 * Caller: library/psa_crypto.c
2662 * library/ssl_tls.c
2663 * library/ssl*_client.c
2664 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002665 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002666 * This module is used by the following key exchanges:
2667 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002668 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002672
2673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002675 *
2676 * Enable the elliptic curve DSA library.
2677 *
2678 * Module: library/ecdsa.c
2679 * Caller:
2680 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002681 * This module is used by the following key exchanges:
2682 * ECDHE-ECDSA
2683 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002684 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2685 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2686 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002689
2690/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002691 * \def MBEDTLS_ECJPAKE_C
2692 *
2693 * Enable the elliptic curve J-PAKE library.
2694 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002695 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2696 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002697 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002698 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002699 * Module: library/ecjpake.c
2700 * Caller:
2701 *
2702 * This module is used by the following key exchanges:
2703 * ECJPAKE
2704 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002705 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002706 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002707 * \warning If using a hash that is only provided by PSA drivers, you must
2708 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002709 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002710#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002711
2712/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002714 *
2715 * Enable the elliptic curve over GF(p) library.
2716 *
2717 * Module: library/ecp.c
2718 * Caller: library/ecdh.c
2719 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002720 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002721 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002725
2726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002728 *
2729 * Enable the platform-specific entropy code.
2730 *
2731 * Module: library/entropy.c
2732 * Caller:
2733 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002735 *
2736 * This module provides a generic entropy pool
2737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002739
2740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002742 *
2743 * Enable error code to error string conversion.
2744 *
2745 * Module: library/error.c
2746 * Caller:
2747 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002751
2752/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002754 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002755 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002756 *
2757 * Module: library/gcm.c
2758 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002759 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2760 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002761 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002762 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2763 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002766
2767/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002768 * \def MBEDTLS_HKDF_C
2769 *
2770 * Enable the HKDF algorithm (RFC 5869).
2771 *
2772 * Module: library/hkdf.c
2773 * Caller:
2774 *
2775 * Requires: MBEDTLS_MD_C
2776 *
2777 * This module adds support for the Hashed Message Authentication Code
2778 * (HMAC)-based key derivation function (HKDF).
2779 */
2780#define MBEDTLS_HKDF_C
2781
2782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002784 *
2785 * Enable the HMAC_DRBG random generator.
2786 *
2787 * Module: library/hmac_drbg.c
2788 * Caller:
2789 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002791 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002792 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002795
2796/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002797 * \def MBEDTLS_LMS_C
2798 *
2799 * Enable the LMS stateful-hash asymmetric signature algorithm.
2800 *
2801 * Module: library/lms.c
2802 * Caller:
2803 *
Raef Colesab4f8742022-09-01 12:24:31 +01002804 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002805 *
Raef Colesab4f8742022-09-01 12:24:31 +01002806 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002807 */
2808#define MBEDTLS_LMS_C
2809
2810/**
Raef Colesab4f8742022-09-01 12:24:31 +01002811 * \def MBEDTLS_LMS_PRIVATE
2812 *
2813 * Enable LMS private-key operations and signing code. Functions enabled by this
2814 * option are experimental, and should not be used in production.
2815 *
2816 * Requires: MBEDTLS_LMS_C
2817 *
2818 * Uncomment to enable the LMS signature algorithm and private key operations.
2819 */
Raef Coles5127e852022-10-07 10:35:56 +01002820//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002821
2822/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002823 * \def MBEDTLS_NIST_KW_C
2824 *
2825 * Enable the Key Wrapping mode for 128-bit block ciphers,
2826 * as defined in NIST SP 800-38F. Only KW and KWP modes
2827 * are supported. At the moment, only AES is approved by NIST.
2828 *
2829 * Module: library/nist_kw.c
2830 *
2831 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2832 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002833#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002834
2835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002837 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002838 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002839 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002840 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2841 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002842 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002843 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002844 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002845 * Caller: library/constant_time.c
2846 * library/ecdsa.c
2847 * library/ecjpake.c
2848 * library/hkdf.c
2849 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002850 * library/pk.c
2851 * library/pkcs5.c
2852 * library/pkcs12.c
2853 * library/psa_crypto_ecp.c
2854 * library/psa_crypto_rsa.c
2855 * library/rsa.c
2856 * library/ssl_cookie.c
2857 * library/ssl_msg.c
2858 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002859 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002860 * library/x509_crt.c
2861 * library/x509write_crt.c
2862 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002863 *
2864 * Uncomment to enable generic message digest wrappers.
2865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002867
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002870 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002871 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002872 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002873 * Module: library/md5.c
2874 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002875 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002876 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002877 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002878 * This module is required for TLS 1.2 depending on the handshake parameters.
2879 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2880 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002881 *
2882 * \warning MD5 is considered a weak message digest and its use constitutes a
2883 * security risk. If possible, we recommend avoiding dependencies on
2884 * it, and considering stronger message digests instead.
2885 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002888
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002891 *
2892 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002893 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002894 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002895 *
2896 * Module: library/memory_buffer_alloc.c
2897 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002899 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002900 *
2901 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002904
2905/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002907 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002908 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2909 *
Simon Butcherd567a232016-03-09 20:19:21 +00002910 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2911 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002912 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002913 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002914 * \note See also our Knowledge Base article about porting to a new
2915 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002916 * 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 +00002917 *
Andres AG788aa4a2016-09-14 14:32:09 +01002918 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002919 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002920 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002923
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002926 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002927 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002928 *
2929 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002930 * Caller: library/asn1write.c
2931 * library/pkcs5.c
2932 * library/pkparse.c
2933 * library/pkwrite.c
2934 * library/rsa.c
2935 * library/x509.c
2936 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002937 * library/x509_crl.c
2938 * library/x509_crt.c
2939 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002940 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002941 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002942 *
2943 * This modules translates between OIDs and internal values.
2944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002945#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002946
2947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002949 *
2950 * Enable VIA Padlock support on x86.
2951 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002952 * Module: library/padlock.c
2953 * Caller: library/aes.c
2954 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002956 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002957 * This modules adds support for the VIA PadLock on x86.
2958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002960
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002963 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002964 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002965 *
2966 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002967 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002968 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002969 * library/x509_crl.c
2970 * library/x509_crt.c
2971 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002972 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002974 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2975 *
2976 * \warning When parsing password-protected files, if MD5 is provided only by
2977 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002978 *
Paul Bakkercff68422013-09-15 20:43:33 +02002979 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002982
2983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002985 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002986 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002987 *
2988 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002989 * Caller: library/pkwrite.c
2990 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002991 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002992 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002994 *
2995 * This modules adds support for encoding / writing PEM files.
2996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002998
2999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003001 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003002 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003003 *
3004 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003005 * Caller: library/psa_crypto_rsa.c
3006 * library/ssl_tls.c
3007 * library/ssl*_client.c
3008 * library/ssl*_server.c
3009 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003010 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02003011 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003012 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003013 * Uncomment to enable generic public key wrappers.
3014 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003016
3017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003019 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003020 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003021 *
3022 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003023 * Caller: library/x509_crt.c
3024 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003025 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003027 *
3028 * Uncomment to enable generic public key parse functions.
3029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003031
3032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003034 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003035 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003036 *
3037 * Module: library/pkwrite.c
3038 * Caller: library/x509write.c
3039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003041 *
3042 * Uncomment to enable generic public key write functions.
3043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003045
3046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003048 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003049 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003050 *
3051 * Module: library/pkcs5.c
3052 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003053 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003054 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003055 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003056 * \warning If using a hash that is only provided by PSA drivers, you must
3057 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003058 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003059 * This module adds support for the PKCS#5 functions.
3060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003062
3063/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003064 * \def MBEDTLS_PKCS7_C
3065 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003066 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003067 * RFC Link - https://tools.ietf.org/html/rfc2315
3068 *
3069 * Module: library/pkcs7.c
3070 *
3071 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003072 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3073 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003074 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003075 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003076 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003077#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003078
3079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003081 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003082 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003083 * Adds algorithms for parsing PKCS#8 encrypted private keys
3084 *
3085 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003086 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003087 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003088 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
3089 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
3090 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003091 * \warning If using a hash that is only provided by PSA drivers, you must
3092 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003093 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003094 * This module enables PKCS#12 functions.
3095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003097
3098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003100 *
3101 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003102 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003103 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3105 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003106 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003107 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003108 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003109 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003110 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003111 * Module: library/platform.c
3112 * Caller: Most other .c files
3113 *
3114 * This module enables abstraction of common (libc) functions.
3115 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003116#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003117
3118/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003119 * \def MBEDTLS_POLY1305_C
3120 *
3121 * Enable the Poly1305 MAC algorithm.
3122 *
3123 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003124 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003125 */
3126#define MBEDTLS_POLY1305_C
3127
3128/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003129 * \def MBEDTLS_PSA_CRYPTO_C
3130 *
3131 * Enable the Platform Security Architecture cryptography API.
3132 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003133 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003134 *
Przemek Stekielea805b42022-05-02 10:30:03 +02003135 * Requires: MBEDTLS_CIPHER_C,
3136 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003137 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003138 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003139 *
3140 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003141#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003142
3143/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003144 * \def MBEDTLS_PSA_CRYPTO_SE_C
3145 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003146 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003147 * cryptography API.
3148 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003149 * \deprecated This feature is deprecated. Please switch to the PSA driver
3150 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003151 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003152 * Module: library/psa_crypto_se.c
3153 *
3154 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3155 *
3156 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003157//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003158
3159/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003160 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3161 *
3162 * Enable the Platform Security Architecture persistent key storage.
3163 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003164 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003165 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003166 * Requires: MBEDTLS_PSA_CRYPTO_C,
3167 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3168 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003169 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003170#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003171
3172/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003173 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003174 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003175 * Enable the emulation of the Platform Security Architecture
3176 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003177 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003178 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003179 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003180 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003181 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003182#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003183
3184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003186 *
3187 * Enable the RIPEMD-160 hash algorithm.
3188 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003189 * Module: library/ripemd160.c
3190 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003191 *
3192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003194
3195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003197 *
3198 * Enable the RSA public-key cryptosystem.
3199 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003201 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003202 * Caller: library/pk.c
3203 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003204 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003205 * library/ssl*_client.c
3206 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003207 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003208 * This module is used by the following key exchanges:
3209 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003214
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003217 *
3218 * Enable the SHA1 cryptographic hash algorithm.
3219 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003220 * Module: library/sha1.c
3221 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003222 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003223 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003224 * This module is required for TLS 1.2 depending on the handshake parameters,
3225 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003226 *
3227 * \warning SHA-1 is considered a weak message digest and its use constitutes
3228 * a security risk. If possible, we recommend avoiding dependencies
3229 * on it, and considering stronger message digests instead.
3230 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003231 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003232#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003233
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003234/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003235 * \def MBEDTLS_SHA224_C
3236 *
3237 * Enable the SHA-224 cryptographic hash algorithm.
3238 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003239 * Module: library/sha256.c
3240 * Caller: library/md.c
3241 * library/ssl_cookie.c
3242 *
3243 * This module adds support for SHA-224.
3244 */
3245#define MBEDTLS_SHA224_C
3246
3247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003249 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003250 * Enable the SHA-256 cryptographic hash algorithm.
3251 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003252 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003253 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003254 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003255 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003256 * library/ssl*_client.c
3257 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003258 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003259 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003260 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003263
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003264/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003265 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3266 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003267 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3268 * with the ARMv8 cryptographic extensions if they are available at runtime.
3269 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003270 *
3271 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3272 * for a non-Aarch64 build it will be silently ignored.
3273 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003274 * \note Minimum compiler versions for this feature are Clang 4.0,
3275 * armclang 6.6 or GCC 6.0.
3276 *
3277 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3278 * armclang <= 6.9
3279 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003280 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3281 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3282 *
3283 * Requires: MBEDTLS_SHA256_C.
3284 *
3285 * Module: library/sha256.c
3286 *
3287 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3288 * and use them if available.
3289 */
3290//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3291
3292/**
3293 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3294 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003295 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3296 * with the ARMv8 cryptographic extensions, which must be available at runtime
3297 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003298 *
3299 * \note This allows builds with a smaller code size than with
3300 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3301 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003302 * \note Minimum compiler versions for this feature are Clang 4.0,
3303 * armclang 6.6 or GCC 6.0.
3304 *
3305 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3306 * armclang <= 6.9
3307 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003308 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3309 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3310 *
3311 * Requires: MBEDTLS_SHA256_C.
3312 *
3313 * Module: library/sha256.c
3314 *
3315 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3316 * unconditionally.
3317 */
3318//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3319
3320/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003321 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003322 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003323 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003324 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003325 * Module: library/sha512.c
3326 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003327 * library/psa_crypto_hash.c
3328 * library/ssl_tls.c
3329 * library/ssl*_client.c
3330 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003331 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003332 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003333 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003334#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003335
3336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003338 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003339 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003340 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003341 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003342 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003343 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003344 * library/ssl_tls.c
3345 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003346 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003347 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003350
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003351/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003352 * \def MBEDTLS_SHA3_C
3353 *
3354 * Enable the SHA3 cryptographic hash algorithm.
3355 *
3356 * Module: library/sha3.c
3357 *
3358 * This module adds support for SHA3.
3359 */
3360#define MBEDTLS_SHA3_C
3361
3362/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003363 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3364 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003365 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3366 * with the ARMv8 cryptographic extensions if they are available at runtime.
3367 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003368 *
3369 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3370 * for a non-Aarch64 build it will be silently ignored.
3371 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003372 * \note Minimum compiler versions for this feature are Clang 7.0,
3373 * armclang 6.9 or GCC 8.0.
3374 *
3375 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3376 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003377 *
3378 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3379 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3380 *
3381 * Requires: MBEDTLS_SHA512_C.
3382 *
3383 * Module: library/sha512.c
3384 *
3385 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3386 * and use them if available.
3387 */
3388//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3389
3390/**
3391 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3392 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003393 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3394 * with the ARMv8 cryptographic extensions, which must be available at runtime
3395 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003396 *
3397 * \note This allows builds with a smaller code size than with
3398 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3399 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003400 * \note Minimum compiler versions for this feature are Clang 7.0,
3401 * armclang 6.9 or GCC 8.0.
3402 *
3403 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3404 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003405 *
3406 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3407 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3408 *
3409 * Requires: MBEDTLS_SHA512_C.
3410 *
3411 * Module: library/sha512.c
3412 *
3413 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3414 * unconditionally.
3415 */
3416//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3417
3418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003420 *
3421 * Enable simple SSL cache implementation.
3422 *
3423 * Module: library/ssl_cache.c
3424 * Caller:
3425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003429
3430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003432 *
3433 * Enable basic implementation of DTLS cookies for hello verification.
3434 *
3435 * Module: library/ssl_cookie.c
3436 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003439
3440/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003441 * \def MBEDTLS_SSL_TICKET_C
3442 *
3443 * Enable an implementation of TLS server-side callbacks for session tickets.
3444 *
3445 * Module: library/ssl_ticket.c
3446 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003447 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003448 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3449 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003450 */
3451#define MBEDTLS_SSL_TICKET_C
3452
3453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003455 *
3456 * Enable the SSL/TLS client code.
3457 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003458 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003459 * Caller:
3460 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003462 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003463 * This module is required for SSL/TLS client support.
3464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003466
Paul Bakker9a736322012-11-14 12:39:52 +00003467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003469 *
3470 * Enable the SSL/TLS server code.
3471 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003472 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003473 * Caller:
3474 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003476 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003477 * This module is required for SSL/TLS server support.
3478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003480
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003483 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003484 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003485 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003486 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003487 * Caller: library/ssl*_client.c
3488 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3491 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003492 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003493 * This module is required for SSL/TLS.
3494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003496
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003499 *
3500 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003501 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003502 * contexts are not shared between threads. If you do intend to use contexts
3503 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003504 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003505 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003506 *
3507 * Module: library/threading.c
3508 *
3509 * This allows different threading implementations (self-implemented or
3510 * provided).
3511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * You will have to enable either MBEDTLS_THREADING_ALT or
3513 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003514 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003515 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003518
3519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003521 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003522 * Enable the semi-portable timing interface.
3523 *
Simon Butcherd567a232016-03-09 20:19:21 +00003524 * \note The provided implementation only works on POSIX/Unix (including Linux,
3525 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003526 * module and provide your own implementations of the callbacks needed by
3527 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3528 * your own implementation of the whole module by setting
3529 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003530 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003531 * \note The timing module will include time.h on suitable platforms
3532 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3533 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3534 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003535 * \note See also our Knowledge Base article about porting to a new
3536 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003537 * 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 +00003538 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003539 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003545 *
3546 * Enable run-time version information.
3547 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003548 * Module: library/version.c
3549 *
3550 * This module provides run-time version information.
3551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003553
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003556 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003557 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003558 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003560 * Caller: library/x509_crl.c
3561 * library/x509_crt.c
3562 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003563 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003564 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003565 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3566 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003567 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3568 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003569 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003573
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003576 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003578 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003579 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003580 * Caller: library/ssl_tls.c
3581 * library/ssl*_client.c
3582 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003585 *
3586 * This module is required for X.509 certificate parsing.
3587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589
3590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003592 *
3593 * Enable X.509 CRL parsing.
3594 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003595 * Module: library/x509_crl.c
3596 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599 *
3600 * This module is required for X.509 CRL parsing.
3601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603
3604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003606 *
3607 * Enable X.509 Certificate Signing Request (CSR) parsing.
3608 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003609 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003610 * Caller: library/x509_crt_write.c
3611 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003613 *
3614 * This module is used for reading X.509 certificate request.
3615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617
3618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003621 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 *
3623 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003624 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003625 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003626 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3627 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003628 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3629 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003630 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003631 * This module is the basis for creating X.509 certificates and CSRs.
3632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003634
3635/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003637 *
3638 * Enable creating X.509 certificates.
3639 *
3640 * Module: library/x509_crt_write.c
3641 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003642 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003643 *
3644 * This module is required for X.509 certificate creation.
3645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003646#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003647
3648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003649 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003650 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003651 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003652 *
3653 * Module: library/x509_csr_write.c
3654 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003656 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003657 * This module is required for X.509 certificate request writing.
3658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003660
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003661/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003662
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003663/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003664 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003665 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003666 * This section contains Mbed TLS build settings that are not associated
3667 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003668 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003669 * \{
3670 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003671
Gilles Peskinea02c1242022-03-16 17:03:19 +01003672/**
3673 * \def MBEDTLS_CONFIG_FILE
3674 *
3675 * If defined, this is a header which will be included instead of
3676 * `"mbedtls/mbedtls_config.h"`.
3677 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003678 * Unlike other configuration options, this one must be defined on the
3679 * compiler command line: a definition in `mbedtls_config.h` would have
3680 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003681 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003682 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003683 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003684 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003685 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003686 * The value of this symbol is typically a path in double quotes, either
3687 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003688 */
3689//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3690
3691/**
3692 * \def MBEDTLS_USER_CONFIG_FILE
3693 *
3694 * If defined, this is a header which will be included after
3695 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003696 * This allows you to modify the default configuration, including the ability
3697 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003698 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003699 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003700 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003701 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003702 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003703 * The value of this symbol is typically a path in double quotes, either
3704 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003705 */
3706//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3707
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003708/**
3709 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3710 *
3711 * If defined, this is a header which will be included instead of
3712 * `"psa/crypto_config.h"`.
3713 * This header file specifies which cryptographic mechanisms are available
3714 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3715 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3716 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003717 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003718 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003719 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003720 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003721 * The value of this symbol is typically a path in double quotes, either
3722 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003723 */
3724//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3725
3726/**
3727 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3728 *
3729 * If defined, this is a header which will be included after
3730 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003731 * This allows you to modify the default configuration, including the ability
3732 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003733 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003734 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003735 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003736 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003737 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003738 * The value of this symbol is typically a path in double quotes, either
3739 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003740 */
3741//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3742
Gilles Peskineb1176f22023-02-22 22:07:28 +01003743/**
3744 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3745 *
3746 * If defined, this is a header which will be included instead of
3747 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3748 * as the one in Mbed TLS, but with definitions adapted to the platform on
3749 * which the library code will run.
3750 *
3751 * \note The required content of this header can vary from one version of
3752 * Mbed TLS to the next. Integrators who provide an alternative file
3753 * should review the changes in the original file whenever they
3754 * upgrade Mbed TLS.
3755 *
3756 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3757 * non-standard feature of the C language, so this feature is only available
3758 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3759 *
3760 * The value of this symbol is typically a path in double quotes, either
3761 * absolute or relative to a directory on the include search path.
3762 */
3763//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3764
3765/**
3766 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3767 *
3768 * If defined, this is a header which will be included instead of
3769 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3770 * as the one in Mbed TLS, but with definitions adapted to the environment
3771 * in which the library code will run. The typical use for this feature
3772 * is to provide alternative type definitions on the client side in
3773 * client-server integrations of PSA crypto, where operation structures
3774 * contain handles instead of cryptographic data.
3775 *
3776 * \note The required content of this header can vary from one version of
3777 * Mbed TLS to the next. Integrators who provide an alternative file
3778 * should review the changes in the original file whenever they
3779 * upgrade Mbed TLS.
3780 *
3781 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3782 * non-standard feature of the C language, so this feature is only available
3783 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3784 *
3785 * The value of this symbol is typically a path in double quotes, either
3786 * absolute or relative to a directory on the include search path.
3787 */
3788//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3789
Gilles Peskineba4162a2022-04-11 17:04:38 +02003790/** \} name SECTION: General configuration options */
3791
3792/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003793 * \name SECTION: Module configuration options
3794 *
3795 * This section allows for the setting of module specific sizes and
3796 * configuration options. The default values are already present in the
3797 * relevant header files and should suffice for the regular use cases.
3798 *
3799 * Our advice is to enable options and change their values here
3800 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003801 * \{
3802 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003803/* The Doxygen documentation here is used when a user comments out a
3804 * setting and runs doxygen themselves. On the other hand, when we typeset
3805 * the full documentation including disabled settings, the documentation
3806 * in specific modules' header files is used if present. When editing this
3807 * file, make sure that each option is documented in exactly one place,
3808 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3809 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003810
Paul Bakker088c5c52014-04-25 11:11:10 +02003811/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003812//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003814
Paul Bakker088c5c52014-04-25 11:11:10 +02003815/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003816//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3817//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3818//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3819//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3820//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003821
Paul Bakker088c5c52014-04-25 11:11:10 +02003822/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003823//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3824//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3825//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3826//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003827
Paul Bakker088c5c52014-04-25 11:11:10 +02003828/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003829//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003830//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003831
Paul Bakker088c5c52014-04-25 11:11:10 +02003832/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003833//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3834//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003835//#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 +01003836
Paul Bakker088c5c52014-04-25 11:11:10 +02003837/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003839
Paul Bakker088c5c52014-04-25 11:11:10 +02003840/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003841//#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 -04003842
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003843/** \def MBEDTLS_PLATFORM_STD_CALLOC
3844 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003845 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003846 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003847 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003848 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003849 * 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 -04003850 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3851 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003852 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003853 */
3854//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003855
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003856/** \def MBEDTLS_PLATFORM_STD_FREE
3857 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003858 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003859 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003860 * 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 -04003861 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3862 * 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 -04003863 */
3864//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003865//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003867//#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 +02003868//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3869//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003870/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003871//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003872//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3873//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003874//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3875//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3876//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003877
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003878/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003879/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003880//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3881//#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 +02003882//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003883//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003884//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3885//#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 +02003886//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3887//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003888/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003890//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003891//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3892//#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 +08003893//#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 +08003894//#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 +02003895
Gilles Peskine3f106f72021-09-23 17:42:39 +02003896/** \def MBEDTLS_CHECK_RETURN
3897 *
3898 * This macro is used at the beginning of the declaration of a function
3899 * to indicate that its return value should be checked. It should
3900 * instruct the compiler to emit a warning or an error if the function
3901 * is called without checking its return value.
3902 *
3903 * There is a default implementation for popular compilers in platform_util.h.
3904 * You can override the default implementation by defining your own here.
3905 *
3906 * If the implementation here is empty, this will effectively disable the
3907 * checking of functions' return values.
3908 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003909//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003910
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003911/** \def MBEDTLS_IGNORE_RETURN
3912 *
3913 * This macro requires one argument, which should be a C function call.
3914 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3915 * warning is suppressed.
3916 */
3917//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3918
Gilles Peskineed038902020-11-13 21:33:21 +01003919/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003920/**
Gilles Peskineed038902020-11-13 21:33:21 +01003921 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3922 * PSA crypto subsystem.
3923 *
3924 * If this option is unset:
3925 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003926 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003927 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3928 * on unspecified heuristics.
3929 */
3930//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3931
Steven Cooreman863470a2021-02-15 14:03:19 +01003932/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003933 * Restrict the PSA library to supporting a maximum amount of simultaneously
3934 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3935 * volatile key, or a persistent key which is loaded temporarily by the
3936 * library as part of a crypto operation in flight.
3937 *
3938 * If this option is unset, the library will fall back to a default value of
3939 * 32 keys.
3940 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003941//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003942
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003943/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003944//#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 +00003945
Paul Bakker088c5c52014-04-25 11:11:10 +02003946/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3948//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003949
Paul Bakker088c5c52014-04-25 11:11:10 +02003950/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003951
Angus Grattond8213d02016-05-25 20:56:48 +10003952/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3953 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003954 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003955 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003956 * This determines the size of the incoming TLS I/O buffer in such a way
3957 * that it is capable of holding the specified amount of plaintext data,
3958 * regardless of the protection mechanism used.
3959 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003960 * \note When using a value less than the default of 16KB on the client, it is
3961 * recommended to use the Maximum Fragment Length (MFL) extension to
3962 * inform the server about this limitation. On the server, there
3963 * is no supported, standardized way of informing the client about
3964 * restriction on the maximum size of incoming messages, and unless
3965 * the limitation has been communicated by other means, it is recommended
3966 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3967 * while keeping the default value of 16KB for the incoming buffer.
3968 *
David Horstmann95d516f2021-05-04 18:36:56 +01003969 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003970 */
3971//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3972
Gilles Peskined3d02902020-03-04 21:35:27 +01003973/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3974 *
3975 * The maximum length of CIDs used for incoming DTLS messages.
3976 *
3977 */
3978//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3979
3980/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3981 *
3982 * The maximum length of CIDs used for outgoing DTLS messages.
3983 *
3984 */
3985//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3986
TRodziewicze8dd7092021-05-12 14:19:11 +02003987/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003988 *
3989 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003990 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003991 *
3992 * The padding will always be chosen so that the length of the
3993 * padded plaintext is a multiple of the value of this option.
3994 *
3995 * Note: A value of \c 1 means that no padding will be used
3996 * for outgoing records.
3997 *
3998 * Note: On systems lacking division instructions,
3999 * a power of two should be preferred.
4000 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004001//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004002
Angus Grattond8213d02016-05-25 20:56:48 +10004003/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4004 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004005 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004006 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004007 * This determines the size of the outgoing TLS I/O buffer in such a way
4008 * that it is capable of holding the specified amount of plaintext data,
4009 * regardless of the protection mechanism used.
4010 *
Angus Grattond8213d02016-05-25 20:56:48 +10004011 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4012 * the default inward 16384 byte buffer to conform to the TLS specification.
4013 *
4014 * The minimum required outward buffer size is determined by the handshake
4015 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4016 * The specific size requirement depends on the configured ciphers and any
4017 * certificate data which is sent during the handshake.
4018 *
David Horstmann95d516f2021-05-04 18:36:56 +01004019 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004020 */
4021//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4022
Hanno Beckere0b150f2018-08-21 15:51:03 +01004023/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4024 *
4025 * Maximum number of heap-allocated bytes for the purpose of
4026 * DTLS handshake message reassembly and future message buffering.
4027 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004028 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004029 * to account for a reassembled handshake message of maximum size,
4030 * together with its reassembly bitmap.
4031 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004032 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004033 * should be sufficient for all practical situations as it allows
4034 * to reassembly a large handshake message (such as a certificate)
4035 * while buffering multiple smaller handshake messages.
4036 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004037 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004038//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004039
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004040//#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 +02004041//#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 +02004042
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004043/**
4044 * Complete list of ciphersuites to use, in order of preference.
4045 *
4046 * \warning No dependency checking is done on that field! This option can only
4047 * be used to restrict the set of available ciphersuites. It is your
4048 * responsibility to make sure the needed modules are active.
4049 *
4050 * Use this to save a few hundred bytes of ROM (default ordering of all
4051 * available ciphersuites) and a few to a few hundred bytes of RAM.
4052 *
4053 * The value below is only an example, not the default.
4054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004055//#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 +02004056
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004057/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004058 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4059 *
4060 * The default maximum amount of 0-RTT data. See the documentation of
4061 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
4062 *
4063 * It must be positive and smaller than UINT32_MAX.
4064 *
4065 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4066 * have any impact on the build.
4067 *
4068 * This feature is experimental, not completed and thus not ready for
4069 * production.
4070 *
4071 */
4072//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4073
4074/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004075 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4076 *
4077 * Maximum time difference in milliseconds tolerated between the age of a
4078 * ticket from the server and client point of view.
4079 * From the client point of view, the age of a ticket is the time difference
4080 * between the time when the client proposes to the server to use the ticket
4081 * (time of writing of the Pre-Shared Key Extension including the ticket) and
4082 * the time the client received the ticket from the server.
4083 * From the server point of view, the age of a ticket is the time difference
4084 * between the time when the server receives a proposition from the client
4085 * to use the ticket and the time when the ticket was created by the server.
4086 * The server age is expected to be always greater than the client one and
4087 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
4088 * maximum difference tolerated for the server to accept the ticket.
4089 * This is not used in TLS 1.2.
4090 *
4091 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004092//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004093
4094/**
4095 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4096 *
4097 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4098 *
4099 * This must be less than 256.
4100 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004101//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004102
4103/**
4104 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4105 *
4106 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4107 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4108 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4109 *
4110 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004111//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004112
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004113/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004114//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004115//#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 +01004116
Gilles Peskine611179c2022-04-13 23:04:48 +02004117/** \} name SECTION: Module configuration options */