blob: a8bc45ea9b3c0fc7416933f849b947bdff55a5f1 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file config.h
3 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman7ff79652023-11-03 12:04:52 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020015#ifndef MBEDTLS_CONFIG_H
16#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000017
Paul Bakkercce9d772011-11-18 14:26:47 +000018#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000019#define _CRT_SECURE_NO_DEPRECATE 1
20#endif
21
Paul Bakkerf3b86c12011-01-27 15:24:17 +000022/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000023 * \name SECTION: System support
24 *
25 * This section sets system specific settings.
26 * \{
27 */
28
Paul Bakkerf3b86c12011-01-27 15:24:17 +000029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020032 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000033 *
34 * Requires support for asm() in compiler.
35 *
36 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010037 * library/aria.c
Paul Bakker68041ec2009-04-19 21:17:55 +000038 * library/timing.c
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039 * include/mbedtls/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000040 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010041 * Required by:
Gilles Peskinee5038c62023-03-16 17:49:44 +010042 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010043 * MBEDTLS_PADLOCK_C
44 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020045 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000048
Paul Bakkerf3b86c12011-01-27 15:24:17 +000049/**
Gilles Peskineed942f82017-06-08 15:19:20 +020050 * \def MBEDTLS_NO_UDBL_DIVISION
51 *
52 * The platform lacks support for double-width integer division (64-bit
53 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
54 *
55 * Used in:
56 * include/mbedtls/bignum.h
57 * library/bignum.c
58 *
59 * The bignum code uses double-width division to speed up some operations.
60 * Double-width division is often implemented in software that needs to
61 * be linked with the program. The presence of a double-width integer
62 * type is usually detected automatically through preprocessor macros,
63 * but the automatic detection cannot know whether the code needs to
64 * and can be linked with an implementation of division for that type.
65 * By default division is assumed to be usable if the type is present.
66 * Uncomment this option to prevent the use of double-width division.
67 *
68 * Note that division for the native integer type is always required.
69 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010070 * platform, but it need not support multiplication or division. In some
71 * cases it is also desirable to disable some double-width operations. For
72 * example, if double-width division is implemented in software, disabling
73 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020074 */
75//#define MBEDTLS_NO_UDBL_DIVISION
76
77/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020078 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
79 *
80 * The platform lacks support for 32x32 -> 64-bit multiplication.
81 *
82 * Used in:
83 * library/poly1305.c
84 *
85 * Some parts of the library may use multiplication of two unsigned 32-bit
86 * operands with a 64-bit result in order to speed up computations. On some
87 * platforms, this is not available in hardware and has to be implemented in
88 * software, usually in a library provided by the toolchain.
89 *
90 * Sometimes it is not desirable to have to link to that library. This option
91 * removes the dependency of that library on platforms that lack a hardware
92 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
93 *
94 * Note that depending on the compiler, this may decrease performance compared
95 * to using the library function provided by the toolchain.
96 */
97//#define MBEDTLS_NO_64BIT_MULTIPLICATION
98
99/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200100 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000101 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000102 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000103 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000104 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200107
108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200111 * System has time.h and time().
112 * The time does not need to be correct, only time differences are used,
113 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200114 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100115 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
116 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
117 * MBEDTLS_PLATFORM_STD_TIME.
118 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -0400119 * Comment if your system does not support time functions.
120 *
121 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
122 * interface - timing.c will include time.h on suitable platforms
123 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
124 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100127
128/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200129 * \def MBEDTLS_HAVE_TIME_DATE
130 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100131 * System has time.h, time(), and an implementation for
132 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100133 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200134 * the date should be correct). This is used to verify the validity period of
135 * X.509 certificates.
136 *
137 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100138 *
Hanno Becker6a739782018-09-05 15:06:19 +0100139 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100140 * behaves similarly to the gmtime_r() function from the C standard. Refer to
141 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100142 *
143 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100144 * mbedtls_platform_gmtime_r() at compile-time by using the macro
145 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 */
147#define MBEDTLS_HAVE_TIME_DATE
148
149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100151 *
152 * Enable the memory allocation layer.
153 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200154 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100155 * This allows different allocators (self-implemented or provided) to be
156 * provided to the platform abstraction layer.
157 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -0400158 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200159 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
160 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000161 * free() function pointer at runtime.
162 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -0400163 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200164 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000165 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100166 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -0400167 * An overview of how the value of mbedtls_calloc is determined:
168 *
169 * - if !MBEDTLS_PLATFORM_MEMORY
170 * - mbedtls_calloc = calloc
171 * - if MBEDTLS_PLATFORM_MEMORY
172 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
173 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
174 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
175 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
176 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
177 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
178 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
179 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
180 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
182 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
183 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
184 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
185 *
186 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
187 * - if !MBEDTLS_PLATFORM_STD_CALLOC
188 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
189 *
190 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
191 *
192 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
193 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
194 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
195 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
196 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
197 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
198 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100200 *
201 * Enable this layer to allow use of alternative memory allocators.
202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100204
205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200207 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200208 * Do not assign standard functions in the platform layer (e.g. calloc() to
209 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
211 * This makes sure there are no linking errors on platforms that do not support
212 * these functions. You will HAVE to provide alternatives, either at runtime
213 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
215 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200216 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200218 *
219 * Uncomment to prevent default assignment of standard functions in the
220 * platform layer.
221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200223
224/**
Janos Follathc351d182016-03-21 08:43:59 +0000225 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100226 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200227 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100228 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200230 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 * alternative printf function pointer.
233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200236 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
237 * it will be enabled automatically by check_config.h
238 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200239 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000241 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100242 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
243 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100244 * Uncomment a macro to enable alternate implementation of specific base
245 * platform function
246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100248//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249//#define MBEDTLS_PLATFORM_FPRINTF_ALT
250//#define MBEDTLS_PLATFORM_PRINTF_ALT
251//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200252//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100253//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100254//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255
256/**
Gilles Peskine937b91e2023-09-07 17:40:16 +0200257 * Uncomment the macro to let Mbed TLS use your alternate implementation of
258 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
259 * platform_util.c.
260 *
261 * gmtime() is not a thread-safe function as defined in the C standard. The
262 * library will try to use safer implementations of this function, such as
263 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
264 * system, the implementation of mbedtls_platform_gmtime_r() will default to
265 * using the standard gmtime(). In this case, calls from the library to
266 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
267 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
268 * library are also guarded with this mutex to avoid race conditions. However,
269 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
270 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
271 * supplied at compile time.
272 */
273//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
274
275/**
Gilles Peskinef08ca832023-09-12 19:21:54 +0200276 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Gilles Peskine937b91e2023-09-07 17:40:16 +0200277 * mbedtls_platform_zeroize(). This replaces the default implementation in
278 * platform_util.c.
279 *
280 * mbedtls_platform_zeroize() is a widely used function across the library to
281 * zero a block of memory. The implementation is expected to be secure in the
282 * sense that it has been written to prevent the compiler from removing calls
283 * to mbedtls_platform_zeroize() as part of redundant code elimination
284 * optimizations. However, it is difficult to guarantee that calls to
285 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
286 * versions of the C language standards do not provide a secure implementation
287 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
288 * configure their own implementation of mbedtls_platform_zeroize(), for
289 * example by using directives specific to their compiler, features from newer
290 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
291 * their system (e.g explicit_bzero() in BSD).
292 */
293//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
294
295/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100297 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000298 * Mark deprecated functions and features so that they generate a warning if
299 * used. Functionality deprecated in one version will usually be removed in the
300 * next version. You can enable this to help you prepare the transition to a
301 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100302 *
303 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100309
310/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100312 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000313 * Remove deprecated functions and features so that they generate an error if
314 * used. Functionality deprecated in one version will usually be removed in the
315 * next version. You can enable this to help you prepare the transition to a
316 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000318 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100321
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500322/**
323 * \def MBEDTLS_CHECK_PARAMS
324 *
325 * This configuration option controls whether the library validates more of
326 * the parameters passed to it.
327 *
328 * When this flag is not defined, the library only attempts to validate an
329 * input parameter if: (1) they may come from the outside world (such as the
330 * network, the filesystem, etc.) or (2) not validating them could result in
331 * internal memory errors such as overflowing a buffer controlled by the
332 * library. On the other hand, it doesn't attempt to validate parameters whose
333 * values are fully controlled by the application (such as pointers).
334 *
335 * When this flag is defined, the library additionally attempts to validate
336 * parameters that are fully controlled by the application, and should always
337 * be valid if the application code is fully correct and trusted.
338 *
339 * For example, when a function accepts as input a pointer to a buffer that may
340 * contain untrusted data, and its documentation mentions that this pointer
341 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200342 * - The pointer is checked to be non-NULL only if this option is enabled.
343 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500344 *
345 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200346 * is invalid:
347 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
348 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
349 * will immediately return. If the function returns an Mbed TLS error code,
350 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500351 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200352 * When defining this flag, you also need to arrange a definition for
353 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
354 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
355 * function mbedtls_param_failed(), but the library does not define this
356 * function. If you do not make any other arrangements, you must provide
357 * the function mbedtls_param_failed() in your application.
358 * See `platform_util.h` for its prototype.
359 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100360 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200361 * You can still supply an alternative definition of
362 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
363 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
364 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
365 * the library will call the macro that you defined and will not supply
366 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
367 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
368 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500369 *
370 * Uncomment to enable validation of application-controlled parameters.
371 */
372//#define MBEDTLS_CHECK_PARAMS
373
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200374/**
375 * \def MBEDTLS_CHECK_PARAMS_ASSERT
376 *
377 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
378 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
379 *
380 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
381 * calling a function mbedtls_param_failed(). See the documentation of
382 * #MBEDTLS_CHECK_PARAMS for details.
383 *
384 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
385 */
386//#define MBEDTLS_CHECK_PARAMS_ASSERT
387
Andrzej Kurek73afe272022-01-24 10:31:06 -0500388/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000389
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000390/**
Gilles Peskinef08ca832023-09-12 19:21:54 +0200391 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000392 *
393 * This section sets support for features that are or are not needed
394 * within the modules that are enabled.
395 * \{
396 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000397
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000398/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100400 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200402 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100403 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100405 *
406 * You will need to provide a header "timing_alt.h" and an implementation at
407 * compile time.
408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200409//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100410
411/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100412 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200413 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200414 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100415 * alternate core implementation of a symmetric crypto, an arithmetic or hash
416 * module (e.g. platform specific assembly optimized implementations). Keep
417 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200418 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200419 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200421 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200422 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000423 * provide the "struct mbedtls_aes_context" definition and omit the base
424 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200425 * "aes.h" to include the new function definitions.
426 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200427 * Uncomment a macro to enable alternate implementation of the corresponding
428 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100429 *
430 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
431 * use constitutes a security risk. If possible, we recommend
432 * avoiding dependencies on them, and considering stronger message
433 * digests and ciphers instead.
434 *
Paul Bakker90995b52013-06-24 19:20:35 +0200435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200436//#define MBEDTLS_AES_ALT
437//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000438//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439//#define MBEDTLS_BLOWFISH_ALT
440//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200441//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300442//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200443//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200444//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000446//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000447//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100448//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300449//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200450//#define MBEDTLS_MD2_ALT
451//#define MBEDTLS_MD4_ALT
452//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300453//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000455//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456//#define MBEDTLS_SHA1_ALT
457//#define MBEDTLS_SHA256_ALT
458//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000459//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000460
Janos Follathb0697532016-08-18 12:38:46 +0100461/*
Shaun Case0e7791f2021-12-20 21:14:10 -0800462 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100463 * implemented with two .c files:
464 * - ecp.c
465 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000466 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
467 * macros as described above. The only difference is that you have to make sure
468 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100469 */
470//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200471
472/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100473 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200474 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200475 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100476 * alternate core implementation of symmetric crypto or hash function. Keep in
477 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200478 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200479 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200481 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200482 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483 * no longer provide the mbedtls_sha1_process() function, but it will still provide
484 * the other function (using your mbedtls_sha1_process() function) and the definition
485 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200486 * with this definition.
487 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100488 * \note Because of a signature change, the core AES encryption and decryption routines are
489 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
490 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100491 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100492 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100493 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +0200494 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100495 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
496 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200497 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200498 * Uncomment a macro to enable alternate implementation of the corresponding
499 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100500 *
501 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
502 * constitutes a security risk. If possible, we recommend avoiding
503 * dependencies on them, and considering stronger message digests
504 * and ciphers instead.
505 *
Janos Follath1231d212019-01-07 15:01:32 +0000506 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
507 * enabled, then the deterministic ECDH signature functions pass the
508 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
509 * alternative implementations should use the RNG only for generating
510 * the ephemeral key and nothing else. If this is not possible, then
511 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
512 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
513 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
514 * desirable).
515 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200517//#define MBEDTLS_MD2_PROCESS_ALT
518//#define MBEDTLS_MD4_PROCESS_ALT
519//#define MBEDTLS_MD5_PROCESS_ALT
520//#define MBEDTLS_RIPEMD160_PROCESS_ALT
521//#define MBEDTLS_SHA1_PROCESS_ALT
522//#define MBEDTLS_SHA256_PROCESS_ALT
523//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200524//#define MBEDTLS_DES_SETKEY_ALT
525//#define MBEDTLS_DES_CRYPT_ECB_ALT
526//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200527//#define MBEDTLS_AES_SETKEY_ENC_ALT
528//#define MBEDTLS_AES_SETKEY_DEC_ALT
529//#define MBEDTLS_AES_ENCRYPT_ALT
530//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300531//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300532//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300533//#define MBEDTLS_ECDSA_VERIFY_ALT
534//#define MBEDTLS_ECDSA_SIGN_ALT
535//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200536
537/**
Janos Follathc44ab972016-11-18 16:38:23 +0000538 * \def MBEDTLS_ECP_INTERNAL_ALT
539 *
540 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100541 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200542 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100543 * alternative core implementation of elliptic curve arithmetic. Keep in mind
544 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100545 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200546 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100547 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
548 * is still present and it is used for group structures not supported by the
549 * alternative.
550 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100551 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100552 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100553 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
554 * able to fallback to curves not supported by the alternative implementation.
555 *
Janos Follathc44ab972016-11-18 16:38:23 +0000556 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
557 * and implementing the following functions:
558 * unsigned char mbedtls_internal_ecp_grp_capable(
559 * const mbedtls_ecp_group *grp )
560 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500561 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000562 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
563 * replacement functions implement arithmetic for the given group and 0
564 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500565 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000566 * called before and after each point operation and provide an opportunity to
567 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100568 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100569 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinef08ca832023-09-12 19:21:54 +0200570 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100571 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
572 * for the operation is supported by your implementation (i.e. your
573 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinef08ca832023-09-12 19:21:54 +0200574 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100575 * implementation of ecp_double_jac() is used instead, unless this fallback
576 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
577 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
578 *
579 * The function prototypes and the definition of mbedtls_ecp_group and
580 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
581 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
582 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100583 *
584 * Uncomment a macro to enable alternate implementation of the corresponding
585 * function.
586 */
587/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000588//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100589/* Turn off software fallback for curves not supported in hardware */
590//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100591/* Support for Weierstrass curves with Jacobi representation */
592//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
593//#define MBEDTLS_ECP_ADD_MIXED_ALT
594//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
595//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
596//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
597/* Support for curves with Montgomery arithmetic */
598//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
599//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
600//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
601
602/**
Simon Butcherab5df402016-06-11 02:31:21 +0100603 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100604 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200605 * Enables testing and use of Mbed TLS without any configured entropy sources.
Simon Butcherab5df402016-06-11 02:31:21 +0100606 * This permits use of the library on platforms before an entropy source has
607 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
608 * MBEDTLS_ENTROPY_NV_SEED switches).
609 *
610 * WARNING! This switch MUST be disabled in production builds, and is suitable
611 * only for development.
612 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100613 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100614 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
615 *
Janos Follath53de7842016-06-08 15:29:18 +0100616 */
Simon Butcherab5df402016-06-11 02:31:21 +0100617//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100618
619/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200620 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200621 *
Gilles Peskinef08ca832023-09-12 19:21:54 +0200622 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200623 * hardware entropy collector.
624 *
625 * Your function must be called \c mbedtls_hardware_poll(), have the same
626 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
627 *
628 * Uncomment to use your own hardware entropy collector.
629 */
630//#define MBEDTLS_ENTROPY_HARDWARE_ALT
631
632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000634 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100635 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000636 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100637 * Uncomment this macro to use precomputed AES tables stored in ROM.
638 * Comment this macro to generate AES tables in RAM at runtime.
639 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100640 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
641 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100642 * initialization time before the first AES operation can be performed.
643 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
644 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
645 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100646 *
647 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
648 *
Paul Bakker15566e42011-04-24 21:19:15 +0000649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000651
652/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100653 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200654 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100655 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200656 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100657 * Uncommenting this macro omits 75% of the AES tables from
658 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
659 * by computing their values on the fly during operations
660 * (the tables are entry-wise rotations of one another).
661 *
662 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100663 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100664 * runtime. Specifically, one has to compare 4 accesses within
665 * different tables to 4 accesses with additional arithmetic
666 * operations within the same table. The performance gain/loss
667 * depends on the system and memory details.
668 *
669 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
670 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200671 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100672//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200673
674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200676 *
677 * Use less ROM for the Camellia implementation (saves about 768 bytes).
678 *
679 * Uncomment this macro to use less memory for Camellia.
680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200682
683/**
Gilles Peskine8472a102021-09-23 18:07:36 +0200684 * \def MBEDTLS_CHECK_RETURN_WARNING
685 *
686 * If this macro is defined, emit a compile-time warning if application code
687 * calls a function without checking its return value, but the return value
688 * should generally be checked in portable applications.
689 *
690 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
691 * implemented. Otherwise this option has no effect.
692 *
693 * Uncomment to get warnings on using fallible functions without checking
694 * their return value.
695 *
696 * \note This feature is a work in progress.
697 * Warnings will be added to more functions in the future.
698 *
699 * \note A few functions are considered critical, and ignoring the return
700 * value of these functions will trigger a warning even if this
701 * macro is not defined. To completely disable return value check
702 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
703 */
704//#define MBEDTLS_CHECK_RETURN_WARNING
705
706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200708 *
709 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200712
713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000715 *
716 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000719
720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000722 *
723 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000726
727/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100728 * \def MBEDTLS_CIPHER_MODE_OFB
729 *
730 * Enable Output Feedback mode (OFB) for symmetric ciphers.
731 */
732#define MBEDTLS_CIPHER_MODE_OFB
733
734/**
735 * \def MBEDTLS_CIPHER_MODE_XTS
736 *
737 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
738 */
739#define MBEDTLS_CIPHER_MODE_XTS
740
741/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200742 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000743 *
744 * Enable NULL cipher.
745 * Warning: Only do so when you know what you are doing. This allows for
746 * encryption or channels without any security!
747 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000749 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
751 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
752 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
753 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
754 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
755 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
756 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
757 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
758 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
759 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
760 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
761 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
762 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
763 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
764 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
765 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
766 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
767 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
768 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000769 *
770 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000773
774/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100775 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200776 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100777 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
778 * specific padding modes in the cipher layer with cipher modes that support
779 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200780 *
781 * If you disable all padding modes, only full blocks can be used with CBC.
782 *
783 * Enable padding modes in the cipher layer.
784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#define MBEDTLS_CIPHER_PADDING_PKCS7
786#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
787#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
788#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200789
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200790/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
791 *
792 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
793 * By default, CTR_DRBG uses a 256-bit key.
794 */
795//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
796
Paul Bakker48e93c82013-08-14 12:21:18 +0200797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000799 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200800 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000801 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000802 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000803 *
804 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
806 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000807 *
808 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100809 *
810 * \warning DES is considered a weak cipher and its use constitutes a
811 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000814
815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200817 *
818 * Remove RC4 ciphersuites by default in SSL / TLS.
819 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200821 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200822 * explicitly.
823 *
824 * Uncomment this macro to remove RC4 ciphersuites by default.
825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200827
828/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000829 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
830 *
831 * Remove 3DES ciphersuites by default in SSL / TLS.
832 * This flag removes the ciphersuites based on 3DES from the default list as
833 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
834 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
835 * them explicitly.
836 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000837 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000838 * a TLS connection using a 3DES based cipher suite (see "On the Practical
839 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
840 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
841 * in your threat model or you are unsure, then you should keep this option
842 * enabled to remove 3DES based cipher suites.
843 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000844 * Comment this macro to keep 3DES in the default ciphersuite list.
845 */
846#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
847
848/**
Gilles Peskine937b91e2023-09-07 17:40:16 +0200849 * Enable the verified implementations of ECDH primitives from Project Everest
850 * (currently only Curve25519). This feature changes the layout of ECDH
851 * contexts and therefore is a compatibility break for applications that access
852 * fields of a mbedtls_ecdh_context structure directly. See also
853 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgmanfd0f4402023-11-08 11:36:00 +0000854 *
855 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
856 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskine937b91e2023-09-07 17:40:16 +0200857 */
858//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
859
860/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100861 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200862 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100863 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
864 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200865 *
866 * Comment macros to disable the curve and functions for it
867 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200868/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
870#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
871#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
872#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
873#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
874#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
875#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
876#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
877#define MBEDTLS_ECP_DP_BP256R1_ENABLED
878#define MBEDTLS_ECP_DP_BP384R1_ENABLED
879#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200880/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200881#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000882#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200883
884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200886 *
887 * Enable specific 'modulo p' routines for each NIST prime.
888 * Depending on the prime and architecture, makes operations 4 to 8 times
889 * faster on the corresponding curve.
890 *
891 * Comment this macro to disable NIST curves optimisation.
892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200894
895/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200896 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
897 *
898 * When this option is disabled, mbedtls_ecp_mul() will make use of an
899 * internal RNG when called with a NULL \c f_rng argument, in order to protect
900 * against some side-channel attacks.
901 *
902 * This protection introduces a dependency of the ECP module on one of the
903 * DRBG modules. For very constrained implementations that don't require this
904 * protection (for example, because you're only doing signature verification,
905 * so not manipulating any secret, or because local/physical side-channel
906 * attacks are outside your threat model), it might be desirable to get rid of
907 * that dependency.
908 *
909 * \warning Enabling this option makes some uses of ECP vulnerable to some
910 * side-channel attacks. Only enable it if you know that's not a problem for
911 * your use case.
912 *
913 * Uncomment this macro to disable some counter-measures in ECP.
914 */
915//#define MBEDTLS_ECP_NO_INTERNAL_RNG
916
917/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200918 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100919 *
920 * Enable "non-blocking" ECC operations that can return early and be resumed.
921 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200922 * This allows various functions to pause by returning
923 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
924 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
925 * order to further progress and eventually complete their operation. This is
926 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
927 * number of ECC operations a function may perform before pausing; see
928 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100929 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200930 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200931 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100932 *
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100933 * This option:
934 * - Adds xxx_restartable() variants of existing operations in the
935 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100936 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
937 * linear combination (muladd);
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100938 * - ECDSA: signature generation & verification;
939 * - PK: signature generation & verification;
940 * - X509: certificate chain verification.
941 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
942 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
943 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
944 * computations restartable:
Tom Cosgrove601e8392023-03-07 11:43:12 +0000945 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100946 * curves;
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100947 * - verification of the server's key exchange signature;
948 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100949 * - generation of the client's signature if client authentication is used,
950 * with an ECC key/certificate.
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100951 *
952 * \note In the cases above, the usual SSL/TLS functions, such as
953 * mbedtls_ssl_handshake(), can now return
954 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200955 *
Ron Eldor19779c42018-11-05 16:58:13 +0200956 * \note This option only works with the default software implementation of
957 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100958 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT,
959 * MBEDTLS_ECDH_LEGACY_CONTEXT, and MBEDTLS_USE_PSA_CRYPTO.
960 *
Manuel Pégourié-Gonnard3dc7f232022-12-06 13:20:06 +0100961 * Requires: MBEDTLS_ECP_C
962 *
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100963 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100964 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200965//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100966
967/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100968 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
969 *
970 * Use a backward compatible ECDH context.
971 *
972 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
973 * defined in `ecdh.h`). For most applications, the choice of format makes
974 * no difference, since all library functions can work with either format,
975 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
976
977 * The new format used when this option is disabled is smaller
978 * (56 bytes on a 32-bit platform). In future versions of the library, it
979 * will support alternative implementations of ECDH operations.
980 * The new format is incompatible with applications that access
981 * context fields directly and with restartable ECP operations.
982 *
983 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
984 * want to access ECDH context fields directly. Otherwise you should
985 * comment out this macro definition.
986 *
987 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
988 *
989 * \note This configuration option is experimental. Future versions of the
990 * library may modify the way the ECDH context layout is configured
991 * and may modify the layout of the new context type.
992 */
993#define MBEDTLS_ECDH_LEGACY_CONTEXT
994
995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100997 *
998 * Enable deterministic ECDSA (RFC 6979).
999 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
1000 * may result in a compromise of the long-term signing key. This is avoided by
1001 * the deterministic variant.
1002 *
John Durkop36a82e52020-10-26 09:39:05 -07001003 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +01001004 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +01001005 * Comment this macro to disable deterministic ECDSA.
1006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +01001008
1009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001011 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001012 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001013 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001014 * This enables the following ciphersuites (if other requisites are
1015 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
1017 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
1018 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
1019 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
1020 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
1021 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
1022 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
1023 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
1024 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
1025 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
1026 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
1027 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001030
1031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001034 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001035 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001037 *
1038 * This enables the following ciphersuites (if other requisites are
1039 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
1041 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
1042 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
1043 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
1044 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1045 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
1046 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
1047 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
1048 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
1049 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1050 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
1051 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001052 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001053 * \warning Using DHE constitutes a security risk as it
1054 * is not possible to validate custom DH parameters.
1055 * If possible, it is recommended users should consider
1056 * preferring other methods of key exchange.
1057 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001058 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001061
1062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001064 *
1065 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
1066 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001068 *
1069 * This enables the following ciphersuites (if other requisites are
1070 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1072 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1073 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1074 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1075 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1076 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1077 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
1078 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001081
1082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001084 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001085 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +02001086 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1088 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001089 *
1090 * This enables the following ciphersuites (if other requisites are
1091 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1093 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1094 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1095 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
1096 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
1097 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1098 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1099 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1100 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
1101 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
1102 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
1103 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001106
1107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001109 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001110 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001111 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1113 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001114 *
1115 * This enables the following ciphersuites (if other requisites are
1116 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1118 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1119 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1120 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
1121 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
1122 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
1123 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1124 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1125 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1126 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1127 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1128 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1129 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
1130 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
1131 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +02001132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001134
1135/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001137 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001138 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001139 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1141 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001142 *
1143 * This enables the following ciphersuites (if other requisites are
1144 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1146 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1147 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1148 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1149 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1150 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1151 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1152 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1153 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1154 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1155 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1156 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1157 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001158 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001159 * \warning Using DHE constitutes a security risk as it
1160 * is not possible to validate custom DH parameters.
1161 * If possible, it is recommended users should consider
1162 * preferring other methods of key exchange.
1163 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001164 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001167
1168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001170 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001171 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1174 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001175 *
1176 * This enables the following ciphersuites (if other requisites are
1177 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1179 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1180 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1181 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1182 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1183 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1184 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1185 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1186 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1187 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1188 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1189 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001192
1193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001195 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001196 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001197 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001199 *
1200 * This enables the following ciphersuites (if other requisites are
1201 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1203 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1204 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1205 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1206 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1207 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1208 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1209 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1210 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1211 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1212 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1213 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001216
1217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001219 *
1220 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1221 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001222 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001223 *
1224 * This enables the following ciphersuites (if other requisites are
1225 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1227 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1228 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1229 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1230 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1231 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1232 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1233 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1234 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1235 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1236 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1237 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001240
1241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001243 *
1244 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1245 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001246 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001247 *
1248 * This enables the following ciphersuites (if other requisites are
1249 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1251 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1252 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1253 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1254 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1255 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1256 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1257 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1258 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1259 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1260 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1261 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001264
1265/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001266 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1267 *
1268 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1269 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001270 * \warning This is currently experimental. EC J-PAKE support is based on the
1271 * Thread v1.0.0 specification; incompatible changes to the specification
1272 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001273 *
1274 * Requires: MBEDTLS_ECJPAKE_C
1275 * MBEDTLS_SHA256_C
1276 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1277 *
1278 * This enables the following ciphersuites (if other requisites are
1279 * enabled as well):
1280 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1281 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001282//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001283
1284/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001286 *
1287 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1288 * RFC 5915 and RFC 5480.
1289 *
1290 * Currently this means parsing the SpecifiedECDomain choice of EC
1291 * parameters (only known groups are supported, not arbitrary domains, to
1292 * avoid validation issues).
1293 *
1294 * Disable if you only need to support RFC 5915 + 5480 key formats.
1295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001297
1298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001300 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 * Enable a dummy error function to make use of mbedtls_strerror() in
1302 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1303 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001304 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1306 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001307 *
1308 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001312
1313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001315 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001316 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001317 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001321
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001324 *
1325 * Enable functions that use the filesystem.
1326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001328
1329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001331 *
1332 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001334 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001335 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001336 * application.
1337 *
1338 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001340//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001341
1342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001344 *
1345 * Do not use built-in platform entropy functions.
1346 * This is useful if your platform does not support
1347 * standards like the /dev/urandom or Windows CryptoAPI.
1348 *
1349 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001352
1353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001355 *
1356 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1357 * default SHA-512 based one (if both are available).
1358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001360 *
1361 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1362 * if you have performance concerns.
1363 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364 * This option is only useful if both MBEDTLS_SHA256_C and
1365 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001368
1369/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001370 * \def MBEDTLS_ENTROPY_NV_SEED
1371 *
1372 * Enable the non-volatile (NV) seed file-based entropy source.
1373 * (Also enables the NV seed read/write functions in the platform layer)
1374 *
1375 * This is crucial (if not required) on systems that do not have a
1376 * cryptographic entropy source (in hardware or kernel) available.
1377 *
1378 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1379 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001380 * \note The read/write functions that are used by the entropy source are
1381 * determined in the platform layer, and can be modified at runtime and/or
1382 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1383 *
1384 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001385 * with regular fopen(), please make sure you make a seedfile with the
1386 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1387 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001388 * and written to or you will get an entropy source error! The default
1389 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1390 * bytes from the file.
1391 *
1392 * \note The entropy collector will write to the seed file before entropy is
1393 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001394 */
1395//#define MBEDTLS_ENTROPY_NV_SEED
1396
Ronald Cron71016a92020-08-28 19:01:50 +02001397/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001398 *
Ronald Cron71016a92020-08-28 19:01:50 +02001399 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001400 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001401 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1402 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001403 *
1404 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001405 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001406 */
Ronald Cron71016a92020-08-28 19:01:50 +02001407//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001408
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001411 *
1412 * Enable debugging of buffer allocator memory issues. Automatically prints
1413 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1414 * function for 'debug output' of allocated memory.
1415 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001417 *
1418 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001421
1422/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001424 *
1425 * Include backtrace information with each allocated block.
1426 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrove5205c972022-07-28 06:12:08 +01001428 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001429 *
1430 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001433
1434/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001435 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001436 *
1437 * Support external private RSA keys (eg from a HSM) in the PK layer.
1438 *
1439 * Comment this macro to disable support for external private RSA keys.
1440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001441#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001442
1443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001445 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001446 * Enable support for PKCS#1 v1.5 encoding.
1447 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001449 *
Paul Bakker48377d92013-08-30 12:06:24 +02001450 * This enables support for PKCS#1 v1.5 operations.
1451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001453
1454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001456 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001457 * Enable support for PKCS#1 v2.1 encoding.
1458 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001460 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001461 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001464
Steven Cooreman6801f082021-02-19 17:21:22 +01001465/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1466 *
1467 * Enable support for platform built-in keys. If you enable this feature,
1468 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1469 * See the documentation of that function for more information.
1470 *
1471 * Built-in keys are typically derived from a hardware unique key or
1472 * stored in a secure element.
1473 *
1474 * Requires: MBEDTLS_PSA_CRYPTO_C.
1475 *
1476 * \warning This interface is experimental and may change or be removed
1477 * without notice.
1478 */
1479//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1480
Ronald Cron3768ac12021-01-26 16:58:00 +01001481/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1482 *
1483 * Enable support for PSA crypto client.
1484 *
1485 * \note This option allows to include the code necessary for a PSA
1486 * crypto client when the PSA crypto implementation is not included in
1487 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1488 * code to set and get PSA key attributes.
1489 * The development of PSA drivers partially relying on the library to
1490 * fulfill the hardware gaps is another possible usage of this option.
1491 *
1492 * \warning This interface is experimental and may change or be removed
1493 * without notice.
1494 */
1495//#define MBEDTLS_PSA_CRYPTO_CLIENT
1496
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001497/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1498 *
1499 * Enable support for the experimental PSA crypto driver interface.
1500 *
John Durkop185764f2020-10-12 21:32:12 -07001501 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001502 *
1503 * \warning This interface is experimental and may change or be removed
1504 * without notice.
1505 */
1506//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1507
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001508/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1509 *
1510 * Make the PSA Crypto module use an external random generator provided
1511 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1512 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001513 * \note This random generator must deliver random numbers with cryptographic
1514 * quality and high performance. It must supply unpredictable numbers
1515 * with a uniform distribution. The implementation of this function
1516 * is responsible for ensuring that the random generator is seeded
1517 * with sufficient entropy. If you have a hardware TRNG which is slow
1518 * or delivers non-uniform output, declare it as an entropy source
1519 * with mbedtls_entropy_add_source() instead of enabling this option.
1520 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001521 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001522 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1523 * and define a function called mbedtls_psa_external_get_random()
1524 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001525 * ```
1526 * psa_status_t mbedtls_psa_external_get_random(
1527 * mbedtls_psa_external_random_context_t *context,
1528 * uint8_t *output, size_t output_size, size_t *output_length);
1529 * );
1530 * ```
1531 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek96ce1b02023-07-14 05:22:42 -04001532 * The function must fill the \c output buffer with \c output_size bytes
1533 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001534 *
1535 * Requires: MBEDTLS_PSA_CRYPTO_C
1536 *
1537 * \warning If you enable this option, code that uses the PSA cryptography
1538 * interface will not use any of the entropy sources set up for
1539 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1540 * enables.
1541 *
1542 * \note This option is experimental and may be removed without notice.
1543 */
1544//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1545
Paul Bakker9dcc3222011-03-08 14:16:06 +00001546/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001547 * \def MBEDTLS_PSA_CRYPTO_SPM
1548 *
1549 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1550 * Partition Manager) integration which separates the code into two parts: a
1551 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1552 * Environment).
1553 *
1554 * Module: library/psa_crypto.c
1555 * Requires: MBEDTLS_PSA_CRYPTO_C
1556 *
1557 */
1558//#define MBEDTLS_PSA_CRYPTO_SPM
1559
1560/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001561 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001562 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001563 * Enable support for entropy injection at first boot. This feature is
1564 * required on systems that do not have a built-in entropy source (TRNG).
1565 * This feature is currently not supported on systems that have a built-in
1566 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001567 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001568 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001569 *
1570 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001571//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001572
1573/**
David Horstmannc0a2c302023-11-29 17:24:08 +00001574 * \def MBEDTLS_PSA_COPY_CALLER_BUFFERS
1575 *
1576 * Make local copies of buffers supplied by the callers of PSA functions.
1577 *
1578 * This should be enabled whenever caller-supplied buffers are owned by
1579 * an untrusted party, for example where arguments to PSA calls are passed
1580 * across a trust boundary.
1581 *
David Horstmann93b2dc72023-12-14 16:14:41 +00001582 * \note Enabling this option increases memory usage and code size.
1583 *
1584 * \note Enabling this option enables full support for overlap of input and
1585 * output buffers passed to PSA functions.
David Horstmannc0a2c302023-11-29 17:24:08 +00001586 */
1587#define MBEDTLS_PSA_COPY_CALLER_BUFFERS
1588
1589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001591 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001592 * Do not use the Chinese Remainder Theorem
1593 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001594 *
1595 * Uncomment this macro to disable the use of CRT in RSA.
1596 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001599
1600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001602 *
1603 * Enable the checkup functions (*_self_test).
1604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001606
1607/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001608 * \def MBEDTLS_SHA256_SMALLER
1609 *
1610 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1611 * lower performance.
1612 *
Adam Wolfef30d902019-09-10 09:53:08 -05001613 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001614 * performance and size. This version optimizes more aggressively for size at
1615 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1616 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1617 * 30%.
1618 *
1619 * Uncomment to enable the smaller implementation of SHA256.
1620 */
1621//#define MBEDTLS_SHA256_SMALLER
1622
1623/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001624 * \def MBEDTLS_SHA512_SMALLER
1625 *
1626 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1627 * lower performance.
1628 *
1629 * Uncomment to enable the smaller implementation of SHA512.
1630 */
1631//#define MBEDTLS_SHA512_SMALLER
1632
1633/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001634 * \def MBEDTLS_SHA512_NO_SHA384
1635 *
1636 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1637 * code size on devices that don't use SHA-384.
1638 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001639 * Requires: MBEDTLS_SHA512_C
1640 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001641 * Uncomment to disable SHA-384
1642 */
1643//#define MBEDTLS_SHA512_NO_SHA384
1644
1645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001647 *
1648 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinef08ca832023-09-12 19:21:54 +02001649 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001650 * with other servers, only debugging of failures is harder.
1651 *
1652 * The advantage of not sending alert messages, is that no information is given
1653 * about reasons for failures thus preventing adversaries of gaining intel.
1654 *
1655 * Enable sending of all alert messages
1656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001658
1659/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001660 * \def MBEDTLS_SSL_RECORD_CHECKING
1661 *
1662 * Enable the function mbedtls_ssl_check_record() which can be used to check
1663 * the validity and authenticity of an incoming record, to verify that it has
1664 * not been seen before. These checks are performed without modifying the
1665 * externally visible state of the SSL context.
1666 *
1667 * See mbedtls_ssl_check_record() for more information.
1668 *
1669 * Uncomment to enable support for record checking.
1670 */
1671#define MBEDTLS_SSL_RECORD_CHECKING
1672
1673/**
1674 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1675 *
1676 * Enable support for the DTLS Connection ID extension
1677 * (version draft-ietf-tls-dtls-connection-id-05,
1678 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1679 * which allows to identify DTLS connections across changes
1680 * in the underlying transport.
1681 *
1682 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1683 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1684 * See the corresponding documentation for more information.
1685 *
1686 * \warning The Connection ID extension is still in draft state.
1687 * We make no stability promises for the availability
1688 * or the shape of the API controlled by this option.
1689 *
1690 * The maximum lengths of outgoing and incoming CIDs can be configured
1691 * through the options
1692 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1693 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1694 *
1695 * Requires: MBEDTLS_SSL_PROTO_DTLS
1696 *
1697 * Uncomment to enable the Connection ID extension.
1698 */
1699//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1700
1701/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001702 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1703 *
1704 * Enable asynchronous external private key operations in SSL. This allows
1705 * you to configure an SSL connection to call an external cryptographic
1706 * module to perform private key operations instead of performing the
1707 * operation inside the library.
1708 *
1709 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001710//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001711
1712/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001713 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1714 *
1715 * Enable serialization of the TLS context structures, through use of the
1716 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1717 *
1718 * This pair of functions allows one side of a connection to serialize the
1719 * context associated with the connection, then free or re-use that context
1720 * while the serialized state is persisted elsewhere, and finally deserialize
1721 * that state to a live context for resuming read/write operations on the
1722 * connection. From a protocol perspective, the state of the connection is
1723 * unaffected, in particular this is entirely transparent to the peer.
1724 *
1725 * Note: this is distinct from TLS session resumption, which is part of the
1726 * protocol and fully visible by the peer. TLS session resumption enables
1727 * establishing new connections associated to a saved session with shorter,
1728 * lighter handshakes, while context serialization is a local optimization in
1729 * handling a single, potentially long-lived connection.
1730 *
1731 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1732 * saved after the handshake to allow for more efficient serialization, so if
1733 * you don't need this feature you'll save RAM by disabling it.
1734 *
Przemek Stekiel864b43d2022-10-05 11:47:29 +02001735 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1736 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001737 * Comment to disable the context serialization APIs.
1738 */
1739#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1740
1741/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001743 *
1744 * Enable the debug messages in SSL module for all issues.
1745 * Debug messages have been disabled in some places to prevent timing
1746 * attacks due to (unbalanced) debugging function calls.
1747 *
1748 * If you need all error reporting you should enable this during debugging,
1749 * but remove this for production servers that should log as well.
1750 *
1751 * Uncomment this macro to report all debug messages on errors introducing
1752 * a timing side-channel.
1753 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001758 *
1759 * Enable support for Encrypt-then-MAC, RFC 7366.
1760 *
1761 * This allows peers that both support it to use a more robust protection for
1762 * ciphersuites using CBC, providing deep resistance against timing attacks
1763 * on the padding or underlying cipher.
1764 *
1765 * This only affects CBC ciphersuites, and is useless if none is defined.
1766 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1768 * MBEDTLS_SSL_PROTO_TLS1_1 or
1769 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001770 *
1771 * Comment this macro to disable support for Encrypt-then-MAC
1772 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001776 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001777 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1778 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001779 *
Shaun Case0e7791f2021-12-20 21:14:10 -08001780 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001781 * attacks, but it is recommended to always use it (even if you disable
1782 * renegotiation), since it actually fixes a more fundamental issue in the
1783 * original SSL/TLS design, and has implications beyond Triple Handshake.
1784 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1786 * MBEDTLS_SSL_PROTO_TLS1_1 or
1787 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001788 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001789 * Comment this macro to disable support for Extended Master Secret.
1790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001792
Paul Bakkerd66f0702013-01-31 16:57:45 +01001793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001795 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001796 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1797 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001798 *
1799 * For servers, it is recommended to always enable this, unless you support
1800 * only one version of TLS, or know for sure that none of your clients
1801 * implements a fallback strategy.
1802 *
1803 * For clients, you only need this if you're using a fallback strategy, which
1804 * is not recommended in the first place, unless you absolutely need it to
1805 * interoperate with buggy (version-intolerant) servers.
1806 *
1807 * Comment this macro to disable support for FALLBACK_SCSV
1808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001810
1811/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001812 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1813 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001814 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001815 * giving access to the peer's certificate after completion of the handshake.
1816 *
1817 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1818 * recommended to disable this option for reduced RAM usage.
1819 *
1820 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1821 * defined, but always returns \c NULL.
1822 *
1823 * \note This option has no influence on the protection against the
1824 * triple handshake attack. Even if it is disabled, Mbed TLS will
1825 * still ensure that certificates do not change during renegotiation,
Shaun Case0e7791f2021-12-20 21:14:10 -08001826 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001827 *
1828 * Comment this macro to disable storing the peer's certificate
1829 * after the handshake.
1830 */
1831#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1832
1833/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001835 *
1836 * Enable hooking functions in SSL module for hardware acceleration of
1837 * individual records.
1838 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001839 * \deprecated This option is deprecated and will be removed in a future
1840 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001841 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001842 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001845
1846/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001848 *
1849 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1850 *
1851 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1852 * of interoperability issues compared to sending 0-length records.
1853 *
1854 * Comment this macro to disable 1/n-1 record splitting.
1855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001857
1858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001859 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001860 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001861 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001862 *
1863 * The two main uses of renegotiation are (1) refresh keys on long-lived
1864 * connections and (2) client authentication after the initial handshake.
1865 * If you don't need renegotiation, it's probably better to disable it, since
1866 * it has been associated with security issues in the past and is easy to
1867 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001868 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001869 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001870 *
1871 * \note Even if this option is disabled, both client and server are aware
1872 * of the Renegotiation Indication Extension (RFC 5746) used to
1873 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1874 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1875 * configuration of this extension).
1876 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001879
1880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001882 *
1883 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001885 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001886 * \deprecated This option is deprecated and will be removed in a future
1887 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001888 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001889 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001892
1893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001895 *
1896 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001898 *
1899 * Uncomment this macro to respect client's ciphersuite order
1900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001902
1903/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001905 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001906 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001907 *
1908 * Comment this macro to disable support for the max_fragment_length extension
1909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001911
1912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001914 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001915 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001916 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 * Requires: MBEDTLS_MD5_C
1918 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001919 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001920 * \deprecated This option is deprecated and will be removed in a future
1921 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001922 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001923 * Comment this macro to disable support for SSL 3.0
1924 */
Janos Follathe2681a42016-03-07 15:57:05 +00001925//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001926
1927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001929 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001930 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 * Requires: MBEDTLS_MD5_C
1933 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001934 *
1935 * Comment this macro to disable support for TLS 1.0
1936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001938
1939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001941 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001942 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001943 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 * Requires: MBEDTLS_MD5_C
1945 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001946 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001947 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001950
1951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001953 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001954 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001955 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001957 * (Depends on ciphersuites)
1958 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001959 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001962
1963/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001964 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1965 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001966 * This macro is used to selectively enable experimental parts
1967 * of the code that contribute to the ongoing development of
1968 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1969 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001970 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001971 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1972 * and no feature exposed through this macro is part of the
1973 * public API. In particular, features under the control
1974 * of this macro are experimental and don't come with any
1975 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001976 *
1977 * Uncomment this macro to enable experimental and partial
1978 * functionality specific to TLS 1.3.
1979 */
Hanno Beckere4160602020-05-07 15:11:45 +01001980//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001981
1982/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001984 *
1985 * Enable support for DTLS (all available versions).
1986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1988 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001989 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1991 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001992 *
1993 * Comment this macro to disable support for DTLS
1994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001996
1997/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001999 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01002000 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002001 *
Paul Bakker27e36d32014-04-08 12:33:37 +02002002 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002005
2006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02002008 *
2009 * Enable support for the anti-replay mechanism in DTLS.
2010 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011 * Requires: MBEDTLS_SSL_TLS_C
2012 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02002013 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002014 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002015 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002016 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02002017 * Comment this to disable anti-replay in DTLS.
2018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02002020
2021/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02002023 *
2024 * Enable support for HelloVerifyRequest on DTLS servers.
2025 *
2026 * This feature is highly recommended to prevent DTLS servers being used as
2027 * amplifiers in DoS attacks against other hosts. It should always be enabled
2028 * unless you know for sure amplification cannot be a problem in the
2029 * environment in which your server operates.
2030 *
Andrzej Kurek293e4522022-04-13 14:28:52 -04002031 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002032 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002033 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02002034 *
2035 * Comment this to disable support for HelloVerifyRequest.
2036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02002038
2039/**
Johan Pascalb62bb512015-12-03 21:56:45 +01002040 * \def MBEDTLS_SSL_DTLS_SRTP
2041 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02002042 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02002043 * through the use_srtp extension.
2044 *
2045 * \note This feature provides the minimum functionality required
2046 * to negotiate the use of DTLS-SRTP and to allow the derivation of
2047 * the associated SRTP packet protection key material.
2048 * In particular, the SRTP packet protection itself, as well as the
2049 * demultiplexing of RTP and DTLS packets at the datagram layer
2050 * (see Section 5 of RFC 5764), are not handled by this feature.
2051 * Instead, after successful completion of a handshake negotiating
2052 * the use of DTLS-SRTP, the extended key exporter API
2053 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
2054 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
2055 * (this is implemented in the SSL example programs).
2056 * The resulting key should then be passed to an SRTP stack.
2057 *
2058 * Setting this option enables the runtime API
2059 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
2060 * through which the supported DTLS-SRTP protection
2061 * profiles can be configured. You must call this API at
2062 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01002063 *
2064 * Requires: MBEDTLS_SSL_PROTO_DTLS
2065 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02002066 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01002067 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02002068//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01002069
2070/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02002071 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
2072 *
2073 * Enable server-side support for clients that reconnect from the same port.
2074 *
2075 * Some clients unexpectedly close the connection and try to reconnect using the
2076 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01002077 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02002078 * flag enables that support.
2079 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002080 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002081 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02002082 * Comment this to disable support for clients reusing the source port.
2083 */
2084#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
2085
2086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002088 *
2089 * Enable support for a limit of records with bad MAC.
2090 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002091 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002092 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002096
2097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002099 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002100 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01002101 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02002102 * session store remains the responsibility of the application, though).
2103 * Server-side, you also need to provide callbacks for writing and parsing
2104 * tickets, including authenticated encryption and key management. Example
2105 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02002106 *
2107 * Comment this macro to disable support for SSL session tickets
2108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002110
2111/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002112 * \def MBEDTLS_SSL_EXPORT_KEYS
2113 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002114 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002115 * This is required for certain users of TLS, e.g. EAP-TLS.
2116 *
2117 * Comment this macro to disable support for key export
2118 */
2119#define MBEDTLS_SSL_EXPORT_KEYS
2120
2121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002123 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002124 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02002125 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00002127 *
Paul Bakker0be444a2013-08-27 21:55:01 +02002128 * Comment this macro to disable support for server name indication in SSL
2129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002131
2132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002134 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002135 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02002136 *
2137 * Comment this macro to disable support for truncated HMAC in SSL
2138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002140
2141/**
Hanno Beckere89353a2017-11-20 16:36:41 +00002142 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2143 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002144 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
2145 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002146 * only meant for a transitory upgrade period and will be removed in a future
2147 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00002148 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002149 * \warning The old implementation is non-compliant and has a security weakness
2150 * (2^80 brute force attack on the HMAC key used for a single,
2151 * uninterrupted connection). This should only be enabled temporarily
2152 * when (1) the use of truncated HMAC is essential in order to save
2153 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
2154 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00002155 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002156 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00002157 * future version of Mbed TLS.
2158 *
Hanno Beckere89353a2017-11-20 16:36:41 +00002159 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
2160 *
2161 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
2162 */
2163//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2164
2165/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002166 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2167 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002168 * When this option is enabled, the SSL buffer will be resized automatically
2169 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002170 *
2171 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002172 */
2173//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2174
2175/**
Gilles Peskine937b91e2023-09-07 17:40:16 +02002176 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
2177 * signature and ciphersuite selection. Without this build-time option, SHA-1
2178 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
2179 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
2180 * default. At the time of writing, there is no practical attack on the use
2181 * of SHA-1 in handshake signatures, hence this option is turned on by default
2182 * to preserve compatibility with existing peers, but the general
2183 * warning applies nonetheless:
2184 *
2185 * \warning SHA-1 is considered a weak message digest and its use constitutes
2186 * a security risk. If possible, we recommend avoiding dependencies
2187 * on it, and considering stronger message digests instead.
2188 *
2189 */
2190//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
2191
2192/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002193 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2194 *
2195 * Enable testing of the constant-flow nature of some sensitive functions with
2196 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002197 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002198 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002199 * This setting requires compiling with clang -fsanitize=memory. The test
2200 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002201 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002202 * \warning This macro is only used for extended testing; it is not considered
2203 * part of the library's API, so it may change or disappear at any time.
2204 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002205 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002206 */
2207//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2208
2209/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002210 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2211 *
2212 * Enable testing of the constant-flow nature of some sensitive functions with
2213 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002214 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002215 *
2216 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002217 * testing if the tests suites are run with valgrind's memcheck. This can be
2218 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2219 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002220 *
2221 * \warning This macro is only used for extended testing; it is not considered
2222 * part of the library's API, so it may change or disappear at any time.
2223 *
2224 * Uncomment to enable testing of the constant-flow nature of selected code.
2225 */
2226//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2227
2228/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002229 * \def MBEDTLS_TEST_HOOKS
2230 *
2231 * Enable features for invasive testing such as introspection functions and
2232 * hooks for fault injection. This enables additional unit tests.
2233 *
2234 * Merely enabling this feature should not change the behavior of the product.
2235 * It only adds new code, and new branching points where the default behavior
2236 * is the same as when this feature is disabled.
2237 * However, this feature increases the attack surface: there is an added
2238 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2239 * Therefore this feature must never be enabled in production.
2240 *
2241 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2242 * information.
2243 *
2244 * Uncomment to enable invasive tests.
2245 */
2246//#define MBEDTLS_TEST_HOOKS
2247
2248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002250 *
2251 * Provide your own alternate threading implementation.
2252 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002254 *
2255 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002258
2259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002261 *
2262 * Enable the pthread wrapper layer for the threading layer.
2263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002265 *
2266 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002269
2270/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002271 * \def MBEDTLS_USE_PSA_CRYPTO
2272 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002273 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2274 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002275 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002276 * \note Development of this option is currently in progress, and parts of Mbed
2277 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002278 * will still continue to work as usual, so enabling this option should not
2279 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002280 *
Manuel Pégourié-Gonnard00b72fc2021-09-20 13:21:25 +02002281 * \note See docs/use-psa-crypto.md for a complete description of what this
2282 * option currently does, and of parts that are not affected by it so far.
2283 *
Manuel Pégourié-Gonnardb52b91d2021-09-21 11:30:52 +02002284 * \warning This option enables new Mbed TLS APIs which are currently
2285 * considered experimental and may change in incompatible ways at any time.
2286 * That is, the APIs enabled by this option are not covered by the usual
2287 * promises of API stability.
Hanno Becker51560b62018-11-19 09:46:26 +00002288 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002289 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002290 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002291 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002292 */
2293//#define MBEDTLS_USE_PSA_CRYPTO
2294
2295/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002296 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2297 *
John Durkop185764f2020-10-12 21:32:12 -07002298 * This setting allows support for cryptographic mechanisms through the PSA
2299 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002300 *
Gilles Peskine33665c42022-04-13 23:22:49 +02002301 * When this option is disabled, the PSA API exposes the cryptographic
2302 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2303 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine52834352022-03-16 17:03:55 +01002304 *
2305 * When this option is enabled, the PSA API exposes the cryptographic
2306 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2307 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2308 * automatically enabled if required (i.e. if no PSA driver provides the
2309 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
Gilles Peskine82909762022-04-26 18:10:11 +02002310 * in config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002311 *
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002312 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine8a557752022-04-14 12:44:01 +02002313 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002314 *
Gilles Peskine58858b72020-11-09 15:26:09 +01002315 * If you enable this option and write your own configuration file, you must
2316 * include mbedtls/config_psa.h in your configuration file. The default
2317 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002318 *
2319 * This feature is still experimental and is not ready for production since
2320 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002321 */
2322//#define MBEDTLS_PSA_CRYPTO_CONFIG
2323
2324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002326 *
2327 * Allow run-time checking of compile-time enabled features. Thus allowing users
2328 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002330 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002332 *
2333 * Comment this to disable run-time checking and save ROM space
2334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002336
2337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002338 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002339 *
2340 * If set, the X509 parser will not break-off when parsing an X509 certificate
2341 * and encountering an extension in a v1 or v2 certificate.
2342 *
2343 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002346
2347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002349 *
2350 * If set, the X509 parser will not break-off when parsing an X509 certificate
2351 * and encountering an unknown critical extension.
2352 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002353 * \warning Depending on your PKI use, enabling this can be a security risk!
2354 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002355 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002358
2359/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002360 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2361 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002362 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002363 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2364 * the set of trusted certificates through a callback instead of a linked
2365 * list.
2366 *
2367 * This is useful for example in environments where a large number of trusted
2368 * certificates is present and storing them in a linked list isn't efficient
2369 * enough, or when the set of trusted certificates changes frequently.
2370 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002371 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002372 * `mbedtls_ssl_conf_ca_cb()` for more information.
2373 *
2374 * Uncomment to enable trusted certificate callbacks.
2375 */
2376//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2377
2378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002380 *
2381 * Enable verification of the keyUsage extension (CA and leaf certificates).
2382 *
2383 * Disabling this avoids problems with mis-issued and/or misused
2384 * (intermediate) CA and leaf certificates.
2385 *
2386 * \warning Depending on your PKI use, disabling this can be a security risk!
2387 *
2388 * Comment to skip keyUsage checking for both CA and leaf certificates.
2389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002391
2392/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002394 *
2395 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2396 *
2397 * Disabling this avoids problems with mis-issued and/or misused certificates.
2398 *
2399 * \warning Depending on your PKI use, disabling this can be a security risk!
2400 *
2401 * Comment to skip extendedKeyUsage checking for certificates.
2402 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002404
2405/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002407 *
2408 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2409 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2410 *
2411 * Comment this macro to disallow using RSASSA-PSS in certificates.
2412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002414
2415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002417 *
2418 * If set, the SSL/TLS module uses ZLIB to support compression and
2419 * decompression of packet data.
2420 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002421 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2422 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002423 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002424 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002425 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002426 *
Hanno Beckere494e202018-03-08 13:26:12 +00002427 * \deprecated This feature is deprecated and will be removed
2428 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002429 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002430 * Used in: library/ssl_tls.c
2431 * library/ssl_cli.c
2432 * library/ssl_srv.c
2433 *
2434 * This feature requires zlib library and headers to be present.
2435 *
2436 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438//#define MBEDTLS_ZLIB_SUPPORT
Gilles Peskinef08ca832023-09-12 19:21:54 +02002439/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002440
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002441/**
Gilles Peskinef08ca832023-09-12 19:21:54 +02002442 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002443 *
Gilles Peskinef08ca832023-09-12 19:21:54 +02002444 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002445 * \{
2446 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002447
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002450 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002451 * Enable AES-NI support on x86-64 or x86-32.
2452 *
2453 * \note AESNI is only supported with certain compilers and target options:
2454 * - Visual Studio 2013: supported.
2455 * - GCC, x86-64, target not explicitly supporting AESNI:
2456 * requires MBEDTLS_HAVE_ASM.
2457 * - GCC, x86-32, target not explicitly supporting AESNI:
2458 * not supported.
2459 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2460 * For this assembly-less implementation, you must currently compile
2461 * `library/aesni.c` and `library/aes.c` with machine options to enable
2462 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2463 * `clang -maes -mpclmul`.
2464 * - Non-x86 targets: this option is silently ignored.
2465 * - Other compilers: this option is silently ignored.
2466 *
2467 * \note
2468 * Above, "GCC" includes compatible compilers such as Clang.
2469 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002470 *
2471 * Module: library/aesni.c
2472 * Caller: library/aes.c
2473 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002474 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002475 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002476 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002479
2480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002482 *
2483 * Enable the AES block cipher.
2484 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002485 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002486 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002487 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002488 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002489 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002490 * This module enables the following ciphersuites (if other requisites are
2491 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2493 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2494 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2495 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2496 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2497 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2498 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2499 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2500 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2501 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2502 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2503 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2504 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2505 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2506 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2507 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2508 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2509 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2510 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2511 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2512 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2513 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2514 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2515 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2516 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2517 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2518 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2519 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2520 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2521 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2522 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2523 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2524 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2525 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2526 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2527 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2528 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2529 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2530 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2531 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2532 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2533 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2534 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2535 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2536 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2537 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2538 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2539 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2540 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2541 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2542 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2543 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2544 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2545 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2546 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2547 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2548 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2549 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002550 *
Paul Bakkercff68422013-09-15 20:43:33 +02002551 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002554
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002557 *
2558 * Enable the ARCFOUR stream cipher.
2559 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002561 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002562 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002563 * This module enables the following ciphersuites (if other requisites are
2564 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2566 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2567 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2568 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2569 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2570 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2571 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2572 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2573 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2574 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002575 *
2576 * \warning ARC4 is considered a weak cipher and its use constitutes a
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00002577 * security risk. If possible, we recommend avoiding dependencies on
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002578 * it, and considering stronger ciphers instead.
2579 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002580 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002582
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002585 *
2586 * Enable the generic ASN1 parser.
2587 *
2588 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002589 * Caller: library/x509.c
2590 * library/dhm.c
2591 * library/pkcs12.c
2592 * library/pkcs5.c
2593 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002594 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002596
2597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002599 *
2600 * Enable the generic ASN1 writer.
2601 *
2602 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002603 * Caller: library/ecdsa.c
2604 * library/pkwrite.c
2605 * library/x509_create.c
2606 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002607 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002610
2611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002613 *
2614 * Enable the Base64 module.
2615 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002616 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002617 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002618 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002619 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002622
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002625 *
Paul Bakker9a736322012-11-14 12:39:52 +00002626 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002627 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002628 * Module: library/bignum.c
2629 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002630 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002631 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002632 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002633 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002634 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002635 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002636 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002639
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002640/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002642 *
2643 * Enable the Blowfish block cipher.
2644 *
2645 * Module: library/blowfish.c
2646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002648
2649/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002651 *
2652 * Enable the Camellia block cipher.
2653 *
Paul Bakker38119b12009-01-10 23:31:23 +00002654 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002655 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002656 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002657 * This module enables the following ciphersuites (if other requisites are
2658 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2660 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2661 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2662 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2663 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2664 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2665 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2666 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2667 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2668 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2669 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2670 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2671 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2672 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2673 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2674 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2675 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2676 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2677 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2678 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2679 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2680 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2681 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2682 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2683 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2684 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2685 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2686 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2687 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2688 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2689 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2690 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2691 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2692 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2693 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2694 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2695 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2696 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2697 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2698 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2699 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2700 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002703
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002704/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002705 * \def MBEDTLS_ARIA_C
2706 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002707 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002708 *
2709 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002710 * Caller: library/cipher.c
2711 *
2712 * This module enables the following ciphersuites (if other requisites are
2713 * enabled as well):
2714 *
2715 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2716 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2717 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2718 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2719 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2720 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2721 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2722 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2723 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2724 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2725 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2726 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2727 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2728 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2729 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2730 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2731 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2732 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2733 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2734 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2735 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2736 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2737 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2738 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2739 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2740 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2741 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2742 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2743 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2744 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2745 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2746 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2747 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2748 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2749 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2750 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2751 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2752 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002753 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002754//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002755
2756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002758 *
2759 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2760 *
2761 * Module: library/ccm.c
2762 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002764 *
2765 * This module enables the AES-CCM ciphersuites, if other requisites are
2766 * enabled as well.
2767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002769
2770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002772 *
2773 * Enable the test certificates.
2774 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002775 * Module: library/certs.c
2776 * Caller:
2777 *
2778 * This module is used for testing (ssl_client/server).
2779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002781
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002782/**
Daniel King34b822c2016-05-15 17:28:08 -03002783 * \def MBEDTLS_CHACHA20_C
2784 *
2785 * Enable the ChaCha20 stream cipher.
2786 *
2787 * Module: library/chacha20.c
2788 */
2789#define MBEDTLS_CHACHA20_C
2790
2791/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002792 * \def MBEDTLS_CHACHAPOLY_C
2793 *
2794 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2795 *
2796 * Module: library/chachapoly.c
2797 *
2798 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2799 */
2800#define MBEDTLS_CHACHAPOLY_C
2801
2802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002804 *
2805 * Enable the generic cipher layer.
2806 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002807 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002808 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002809 *
2810 * Uncomment to enable generic cipher wrappers.
2811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002813
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002814/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002815 * \def MBEDTLS_CMAC_C
2816 *
Simon Butcher327398a2016-10-05 14:09:11 +01002817 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2818 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002819 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002820 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2821 * implementation of the CMAC algorithm is provided by an alternate
2822 * implementation, that alternate implementation may opt to not support
2823 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2824 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002825 * Module: library/cmac.c
2826 *
Simon Butcher69283e52016-10-06 12:49:58 +01002827 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002828 *
2829 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002830//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002831
2832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002834 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002835 * Enable the CTR_DRBG AES-based random generator.
2836 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002837 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002838 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002839 * \note To achieve a 256-bit security strength with CTR_DRBG,
2840 * you must use AES-256 *and* use sufficient entropy.
2841 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002842 *
2843 * Module: library/ctr_drbg.c
2844 * Caller:
2845 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002847 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002848 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002851
2852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002854 *
2855 * Enable the debug functions.
2856 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002857 * Module: library/debug.c
2858 * Caller: library/ssl_cli.c
2859 * library/ssl_srv.c
2860 * library/ssl_tls.c
2861 *
2862 * This module provides debugging functions.
2863 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002865
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002866/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002868 *
2869 * Enable the DES block cipher.
2870 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002871 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002872 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002873 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002874 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002875 * This module enables the following ciphersuites (if other requisites are
2876 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2878 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2880 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2881 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2882 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2883 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2884 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2885 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2886 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002887 *
Paul Bakkercff68422013-09-15 20:43:33 +02002888 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002889 *
Dave Rodgmanb43d5e72023-02-02 10:47:58 +00002890 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002891 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002894
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002897 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002898 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002899 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002900 * Module: library/dhm.c
2901 * Caller: library/ssl_cli.c
2902 * library/ssl_srv.c
2903 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002904 * This module is used by the following key exchanges:
2905 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002906 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002907 * \warning Using DHE constitutes a security risk as it
2908 * is not possible to validate custom DH parameters.
2909 * If possible, it is recommended users should consider
2910 * preferring other methods of key exchange.
2911 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002912 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002913 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002915
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002918 *
2919 * Enable the elliptic curve Diffie-Hellman library.
2920 *
2921 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002922 * Caller: library/ssl_cli.c
2923 * library/ssl_srv.c
2924 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002925 * This module is used by the following key exchanges:
2926 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002927 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002931
2932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002934 *
2935 * Enable the elliptic curve DSA library.
2936 *
2937 * Module: library/ecdsa.c
2938 * Caller:
2939 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002940 * This module is used by the following key exchanges:
2941 * ECDHE-ECDSA
2942 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002943 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2944 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2945 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002948
2949/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002950 * \def MBEDTLS_ECJPAKE_C
2951 *
2952 * Enable the elliptic curve J-PAKE library.
2953 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002954 * \warning This is currently experimental. EC J-PAKE support is based on the
2955 * Thread v1.0.0 specification; incompatible changes to the specification
2956 * might still happen. For this reason, this is disabled by default.
2957 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002958 * Module: library/ecjpake.c
2959 * Caller:
2960 *
2961 * This module is used by the following key exchanges:
2962 * ECJPAKE
2963 *
2964 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2965 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002966//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002967
2968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002970 *
2971 * Enable the elliptic curve over GF(p) library.
2972 *
2973 * Module: library/ecp.c
2974 * Caller: library/ecdh.c
2975 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002976 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002979 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002981
2982/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002984 *
2985 * Enable the platform-specific entropy code.
2986 *
2987 * Module: library/entropy.c
2988 * Caller:
2989 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002991 *
2992 * This module provides a generic entropy pool
2993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002995
2996/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002998 *
2999 * Enable error code to error string conversion.
3000 *
3001 * Module: library/error.c
3002 * Caller:
3003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00003005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00003007
3008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00003010 *
Jaeden Amero7accf442019-04-10 18:13:57 +01003011 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00003012 *
3013 * Module: library/gcm.c
3014 *
Jaeden Amero651ae682019-04-10 18:19:16 +01003015 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00003016 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003017 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
3018 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00003019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00003021
3022/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003024 *
3025 * Enable the HAVEGE random generator.
3026 *
Paul Bakker2a844242013-06-24 13:01:53 +02003027 * Warning: the HAVEGE random generator is not suitable for virtualized
3028 * environments
3029 *
3030 * Warning: the HAVEGE random generator is dependent on timing and specific
3031 * processor traits. It is therefore not advised to use HAVEGE as
3032 * your applications primary random generator or primary entropy pool
3033 * input. As a secondary input to your entropy pool, it IS able add
3034 * the (limited) extra entropy it provides.
3035 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003036 * Module: library/havege.c
3037 * Caller:
3038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003040 *
Paul Bakker2a844242013-06-24 13:01:53 +02003041 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02003042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003044
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003045/**
Thomas Fossati656864b2016-07-17 08:51:22 +01003046 * \def MBEDTLS_HKDF_C
3047 *
3048 * Enable the HKDF algorithm (RFC 5869).
3049 *
3050 * Module: library/hkdf.c
3051 * Caller:
3052 *
3053 * Requires: MBEDTLS_MD_C
3054 *
3055 * This module adds support for the Hashed Message Authentication Code
3056 * (HMAC)-based key derivation function (HKDF).
3057 */
3058#define MBEDTLS_HKDF_C
3059
3060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01003062 *
3063 * Enable the HMAC_DRBG random generator.
3064 *
3065 * Module: library/hmac_drbg.c
3066 * Caller:
3067 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01003069 *
Tom Cosgrove2b150752022-05-26 11:55:43 +01003070 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01003071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01003073
3074/**
Ron Eldor466a57f2018-05-03 16:54:28 +03003075 * \def MBEDTLS_NIST_KW_C
3076 *
3077 * Enable the Key Wrapping mode for 128-bit block ciphers,
3078 * as defined in NIST SP 800-38F. Only KW and KWP modes
3079 * are supported. At the moment, only AES is approved by NIST.
3080 *
3081 * Module: library/nist_kw.c
3082 *
3083 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
3084 */
3085//#define MBEDTLS_NIST_KW_C
3086
3087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003089 *
3090 * Enable the generic message digest layer.
3091 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003092 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00003093 * Caller:
3094 *
3095 * Uncomment to enable generic message digest wrappers.
3096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00003098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003101 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003102 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003103 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003104 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003105 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00003106 *
3107 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003108 *
3109 * \warning MD2 is considered a weak message digest and its use constitutes a
3110 * security risk. If possible, we recommend avoiding dependencies on
3111 * it, and considering stronger message digests instead.
3112 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003115
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003118 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003119 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003120 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003121 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003122 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00003123 *
3124 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003125 *
3126 * \warning MD4 is considered a weak message digest and its use constitutes a
3127 * security risk. If possible, we recommend avoiding dependencies on
3128 * it, and considering stronger message digests instead.
3129 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003132
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003135 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003136 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003137 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003138 * Module: library/md5.c
3139 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003140 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01003141 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003143 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
3144 * depending on the handshake parameters. Further, it is used for checking
3145 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
3146 * encrypted keys.
3147 *
3148 * \warning MD5 is considered a weak message digest and its use constitutes a
3149 * security risk. If possible, we recommend avoiding dependencies on
3150 * it, and considering stronger message digests instead.
3151 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003154
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003157 *
3158 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003159 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003160 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02003161 *
3162 * Module: library/memory_buffer_alloc.c
3163 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinef08ca832023-09-12 19:21:54 +02003165 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02003166 *
3167 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02003168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02003170
3171/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003173 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003174 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
3175 *
Simon Butcherd567a232016-03-09 20:19:21 +00003176 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
3177 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003178 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003179 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003180 * \note See also our Knowledge Base article about porting to a new
3181 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003182 * 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 +00003183 *
Andres AG788aa4a2016-09-14 14:32:09 +01003184 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003186 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003189
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003192 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003193 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003194 *
3195 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003196 * Caller: library/asn1write.c
3197 * library/pkcs5.c
3198 * library/pkparse.c
3199 * library/pkwrite.c
3200 * library/rsa.c
3201 * library/x509.c
3202 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003203 * library/x509_crl.c
3204 * library/x509_crt.c
3205 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003206 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003207 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003208 *
3209 * This modules translates between OIDs and internal values.
3210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003212
3213/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003215 *
3216 * Enable VIA Padlock support on x86.
3217 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003218 * Module: library/padlock.c
3219 * Caller: library/aes.c
3220 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003222 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003223 * This modules adds support for the VIA PadLock on x86.
3224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003226
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003229 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003230 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003231 *
3232 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003233 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003234 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003235 * library/x509_crl.c
3236 * library/x509_crt.c
3237 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003238 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003240 *
Paul Bakkercff68422013-09-15 20:43:33 +02003241 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003244
3245/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003247 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003248 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003249 *
3250 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003251 * Caller: library/pkwrite.c
3252 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003253 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003254 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003256 *
3257 * This modules adds support for encoding / writing PEM files.
3258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003260
3261/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003263 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003264 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003265 *
3266 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003267 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003268 * library/ssl_cli.c
3269 * library/ssl_srv.c
3270 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003272 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003273 * Uncomment to enable generic public key wrappers.
3274 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003275#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003276
3277/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003278 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003279 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003280 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003281 *
3282 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003283 * Caller: library/x509_crt.c
3284 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003285 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003287 *
3288 * Uncomment to enable generic public key parse functions.
3289 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003290#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003291
3292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003294 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003295 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003296 *
3297 * Module: library/pkwrite.c
3298 * Caller: library/x509write.c
3299 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003301 *
3302 * Uncomment to enable generic public key write functions.
3303 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003305
3306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003308 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003309 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003310 *
3311 * Module: library/pkcs5.c
3312 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003314 *
3315 * This module adds support for the PKCS#5 functions.
3316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003318
3319/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003321 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003322 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003323 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003324 * \deprecated This option is deprecated and will be removed in a future
3325 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003326 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003327 * Module: library/pkcs11.c
3328 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003329 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003331 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003332 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003333 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003336
3337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003339 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003340 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003341 * Adds algorithms for parsing PKCS#8 encrypted private keys
3342 *
3343 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003344 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3347 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003348 *
3349 * This module enables PKCS#12 functions.
3350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003352
3353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003355 *
3356 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003357 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3360 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003361 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003362 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003363 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3364 * as other module rely on it for a fixed snprintf implementation.
3365 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003366 * Module: library/platform.c
3367 * Caller: Most other .c files
3368 *
3369 * This module enables abstraction of common (libc) functions.
3370 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003371#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003372
3373/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003374 * \def MBEDTLS_POLY1305_C
3375 *
3376 * Enable the Poly1305 MAC algorithm.
3377 *
3378 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003379 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003380 */
3381#define MBEDTLS_POLY1305_C
3382
3383/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003384 * \def MBEDTLS_PSA_CRYPTO_C
3385 *
3386 * Enable the Platform Security Architecture cryptography API.
3387 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003388 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003389 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003390 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003391 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003392 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003393 *
3394 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003395#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003396
3397/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003398 * \def MBEDTLS_PSA_CRYPTO_SE_C
3399 *
3400 * Enable secure element support in the Platform Security Architecture
3401 * cryptography API.
3402 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003403 * \warning This feature is not yet suitable for production. It is provided
3404 * for API evaluation and testing purposes only.
3405 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003406 * Module: library/psa_crypto_se.c
3407 *
3408 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3409 *
3410 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003411//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003412
3413/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003414 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3415 *
3416 * Enable the Platform Security Architecture persistent key storage.
3417 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003418 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003419 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003420 * Requires: MBEDTLS_PSA_CRYPTO_C,
3421 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3422 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003423 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003424#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003425
3426/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003427 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003428 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003429 * Enable the emulation of the Platform Security Architecture
3430 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003431 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003432 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003433 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003434 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003435 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003436#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003437
3438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003440 *
3441 * Enable the RIPEMD-160 hash algorithm.
3442 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003443 * Module: library/ripemd160.c
3444 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003445 *
3446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003448
3449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003451 *
3452 * Enable the RSA public-key cryptosystem.
3453 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003454 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003455 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003456 * Caller: library/ssl_cli.c
3457 * library/ssl_srv.c
3458 * library/ssl_tls.c
3459 * library/x509.c
3460 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003461 * This module is used by the following key exchanges:
3462 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003463 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003467
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003470 *
3471 * Enable the SHA1 cryptographic hash algorithm.
3472 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003473 * Module: library/sha1.c
3474 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003475 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003476 * library/ssl_srv.c
3477 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003478 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003479 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003480 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3481 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003482 *
3483 * \warning SHA-1 is considered a weak message digest and its use constitutes
3484 * a security risk. If possible, we recommend avoiding dependencies
3485 * on it, and considering stronger message digests instead.
3486 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003489
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003491 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003492 *
3493 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3494 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003495 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003496 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003497 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003498 * library/ssl_cli.c
3499 * library/ssl_srv.c
3500 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003501 *
3502 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003503 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003506
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003509 *
3510 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3511 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003512 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003513 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003514 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003515 * library/ssl_cli.c
3516 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003517 *
3518 * This module adds support for SHA-384 and SHA-512.
3519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003521
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003524 *
3525 * Enable simple SSL cache implementation.
3526 *
3527 * Module: library/ssl_cache.c
3528 * Caller:
3529 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003530 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003533
3534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003535 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003536 *
3537 * Enable basic implementation of DTLS cookies for hello verification.
3538 *
3539 * Module: library/ssl_cookie.c
3540 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003543
3544/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003545 * \def MBEDTLS_SSL_TICKET_C
3546 *
3547 * Enable an implementation of TLS server-side callbacks for session tickets.
3548 *
3549 * Module: library/ssl_ticket.c
3550 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003551 *
Przemek Stekiel97d57402022-10-10 14:08:51 +02003552 * Requires: MBEDTLS_CIPHER_C &&
3553 * ( MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C )
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003554 */
3555#define MBEDTLS_SSL_TICKET_C
3556
3557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003559 *
3560 * Enable the SSL/TLS client code.
3561 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 * Module: library/ssl_cli.c
3563 * Caller:
3564 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003566 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003567 * This module is required for SSL/TLS client support.
3568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003570
Paul Bakker9a736322012-11-14 12:39:52 +00003571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003573 *
3574 * Enable the SSL/TLS server code.
3575 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003576 * Module: library/ssl_srv.c
3577 * Caller:
3578 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003580 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003581 * This module is required for SSL/TLS server support.
3582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003584
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003587 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003588 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003589 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003590 * Module: library/ssl_tls.c
3591 * Caller: library/ssl_cli.c
3592 * library/ssl_srv.c
3593 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3595 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003596 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003597 * This module is required for SSL/TLS.
3598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003600
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003603 *
3604 * Enable the threading abstraction layer.
Gilles Peskinef08ca832023-09-12 19:21:54 +02003605 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003606 * contexts are not shared between threads. If you do intend to use contexts
3607 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003608 * conditions. See also our Knowledge Base article about threading:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003609 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003610 *
3611 * Module: library/threading.c
3612 *
3613 * This allows different threading implementations (self-implemented or
3614 * provided).
3615 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * You will have to enable either MBEDTLS_THREADING_ALT or
3617 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003618 *
Gilles Peskinef08ca832023-09-12 19:21:54 +02003619 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003622
3623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003625 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003626 * Enable the semi-portable timing interface.
3627 *
Simon Butcherd567a232016-03-09 20:19:21 +00003628 * \note The provided implementation only works on POSIX/Unix (including Linux,
3629 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003630 * module and provide your own implementations of the callbacks needed by
3631 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3632 * your own implementation of the whole module by setting
3633 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003634 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -04003635 * \note The timing module will include time.h on suitable platforms
3636 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3637 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3638 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003639 * \note See also our Knowledge Base article about porting to a new
3640 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003641 * 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 +00003642 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003643 * Module: library/timing.c
3644 * Caller: library/havege.c
3645 *
3646 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003648#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003649
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003652 *
3653 * Enable run-time version information.
3654 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003655 * Module: library/version.c
3656 *
3657 * This module provides run-time version information.
3658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003660
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003662 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003663 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003664 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003665 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003666 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003667 * Caller: library/x509_crl.c
3668 * library/x509_crt.c
3669 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003670 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3672 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003673 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003674 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003676#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003677
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003680 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003681 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003682 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003683 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003684 * Caller: library/ssl_cli.c
3685 * library/ssl_srv.c
3686 * library/ssl_tls.c
3687 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003688 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003689 *
3690 * This module is required for X.509 certificate parsing.
3691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003692#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003693
3694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003695 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003696 *
3697 * Enable X.509 CRL parsing.
3698 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003699 * Module: library/x509_crl.c
3700 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003701 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003702 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003703 *
3704 * This module is required for X.509 CRL parsing.
3705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003706#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003707
3708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003709 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003710 *
3711 * Enable X.509 Certificate Signing Request (CSR) parsing.
3712 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003713 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003714 * Caller: library/x509_crt_write.c
3715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003716 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003717 *
3718 * This module is used for reading X.509 certificate request.
3719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003720#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003721
3722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003723 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003724 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003725 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003726 *
3727 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003728 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003729 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003730 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003731 * This module is the basis for creating X.509 certificates and CSRs.
3732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003733#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003734
3735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003736 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003737 *
3738 * Enable creating X.509 certificates.
3739 *
3740 * Module: library/x509_crt_write.c
3741 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003743 *
3744 * This module is required for X.509 certificate creation.
3745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003746#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003747
3748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003749 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003750 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003751 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003752 *
3753 * Module: library/x509_csr_write.c
3754 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003755 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003756 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003757 * This module is required for X.509 certificate request writing.
3758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003759#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003760
3761/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003762 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003763 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003764 * Enable the XTEA block cipher.
3765 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003766 * Module: library/xtea.c
3767 * Caller:
3768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003769#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003770
Gilles Peskinef08ca832023-09-12 19:21:54 +02003771/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003772
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003773/**
Gilles Peskine86198d72022-04-11 17:04:38 +02003774 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003775 *
Gilles Peskine72665262022-04-13 23:05:10 +02003776 * This section contains Mbed TLS build settings that are not associated
3777 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003778 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003779 * \{
3780 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003781
Gilles Peskine781f7342022-03-16 17:03:19 +01003782/**
3783 * \def MBEDTLS_CONFIG_FILE
3784 *
3785 * If defined, this is a header which will be included instead of
Gilles Peskine82909762022-04-26 18:10:11 +02003786 * `"mbedtls/config.h"`.
Gilles Peskine781f7342022-03-16 17:03:19 +01003787 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskine238f9762022-04-26 18:13:01 +02003788 * Unlike other configuration options, this one must be defined on the
3789 * compiler command line: a definition in `config.h` would have no effect.
Gilles Peskine781f7342022-03-16 17:03:19 +01003790 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003791 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003792 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003793 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003794 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003795 * The value of this symbol is typically a path in double quotes, either
3796 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003797 */
Gilles Peskine82909762022-04-26 18:10:11 +02003798//#define MBEDTLS_CONFIG_FILE "mbedtls/config.h"
Gilles Peskine781f7342022-03-16 17:03:19 +01003799
3800/**
3801 * \def MBEDTLS_USER_CONFIG_FILE
3802 *
3803 * If defined, this is a header which will be included after
Gilles Peskine82909762022-04-26 18:10:11 +02003804 * `"mbedtls/config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003805 * This allows you to modify the default configuration, including the ability
3806 * to undefine options that are enabled by default.
Gilles Peskine781f7342022-03-16 17:03:19 +01003807 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003808 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003809 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003810 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003811 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003812 * The value of this symbol is typically a path in double quotes, either
3813 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003814 */
3815//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3816
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003817/**
3818 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3819 *
3820 * If defined, this is a header which will be included instead of
3821 * `"psa/crypto_config.h"`.
3822 * This header file specifies which cryptographic mechanisms are available
3823 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3824 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3825 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003826 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003827 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003828 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003829 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003830 * The value of this symbol is typically a path in double quotes, either
3831 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003832 */
3833//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3834
3835/**
3836 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3837 *
3838 * If defined, this is a header which will be included after
3839 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003840 * This allows you to modify the default configuration, including the ability
3841 * to undefine options that are enabled by default.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003842 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003843 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003844 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003845 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003846 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003847 * The value of this symbol is typically a path in double quotes, either
3848 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003849 */
3850//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3851
Gilles Peskine86198d72022-04-11 17:04:38 +02003852/** \} name SECTION: General configuration options */
3853
3854/**
3855 * \name SECTION: Module configuration options
3856 *
3857 * This section allows for the setting of module specific sizes and
3858 * configuration options. The default values are already present in the
3859 * relevant header files and should suffice for the regular use cases.
3860 *
3861 * Our advice is to enable options and change their values here
3862 * only if you have a good reason and know the consequences.
Gilles Peskine86198d72022-04-11 17:04:38 +02003863 * \{
3864 */
Gilles Peskine25496d02022-04-13 23:21:16 +02003865/* The Doxygen documentation here is used when a user comments out a
3866 * setting and runs doxygen themselves. On the other hand, when we typeset
3867 * the full documentation including disabled settings, the documentation
3868 * in specific modules' header files is used if present. When editing this
3869 * file, make sure that each option is documented in exactly one place,
3870 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3871 * comment in the specific module. */
Gilles Peskine86198d72022-04-11 17:04:38 +02003872
Paul Bakker088c5c52014-04-25 11:11:10 +02003873/* MPI / BIGNUM options */
Andrzej Kurek6e9385b2023-02-24 07:44:57 -05003874//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003875//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003876
Paul Bakker088c5c52014-04-25 11:11:10 +02003877/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3879//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3880//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3881//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3882//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003883
Paul Bakker088c5c52014-04-25 11:11:10 +02003884/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003885//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3886//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3887//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3888//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003889
Paul Bakker088c5c52014-04-25 11:11:10 +02003890/* ECP options */
Gilles Peskine33c92f02021-06-02 23:34:02 +02003891//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups. Normally determined automatically from the configured curves. */
Gilles Peskineb3ca90b2021-06-02 13:27:03 +02003892//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003893//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003894
Paul Bakker088c5c52014-04-25 11:11:10 +02003895/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003896//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3897//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003898//#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 +01003899
Paul Bakker088c5c52014-04-25 11:11:10 +02003900/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003901//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003902
Paul Bakker088c5c52014-04-25 11:11:10 +02003903/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003904//#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 Kurekc83d49e2023-07-14 09:58:17 -04003905
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003906/** \def MBEDTLS_PLATFORM_STD_CALLOC
3907 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -04003908 * Default allocator to use, can be undefined.
Andrzej Kurekba168592023-07-14 09:56:02 -04003909 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003910 * The size of the buffer is the product of the two parameters.
Andrzej Kurekba168592023-07-14 09:56:02 -04003911 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003912 * 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 Kurek3f87d632023-07-14 10:22:34 -04003913 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3914 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekba168592023-07-14 09:56:02 -04003915 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003916 */
3917//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek33b12222023-07-14 10:14:29 -04003918
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003919/** \def MBEDTLS_PLATFORM_STD_FREE
3920 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -04003921 * Default free to use, can be undefined.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003922 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekba168592023-07-14 09:56:02 -04003923 * A non-null parameter will always be a pointer previously returned by #MBEDTLS_PLATFORM_STD_CALLOC and not yet freed.
Andrzej Kurek3f87d632023-07-14 10:22:34 -04003924 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3925 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply).
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003926 */
3927//#define MBEDTLS_PLATFORM_STD_FREE free
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003928//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003929//#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 +02003930//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3931//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003932/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003933//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003934//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3935//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003936//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3937//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3938//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003939
Andrzej Kurekba168592023-07-14 09:56:02 -04003940/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003941/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003942//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3943//#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 +02003944//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003945//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3946//#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 +02003947//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3948//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003949/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003950//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003951//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003952//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3953//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003954
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003955/**
3956 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003957 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003958 * (see the documentation of that option for context).
3959 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003960 * When you leave this undefined here, the library provides
3961 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3962 * is defined, the default definition is `assert(cond)`,
3963 * otherwise the default definition calls a function
3964 * mbedtls_param_failed(). This function is declared in
3965 * `platform_util.h` for the benefit of the library, but
3966 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003967 *
3968 * When you define this here, this replaces the default
3969 * definition in platform_util.h (which no longer declares the
3970 * function mbedtls_param_failed()) and it is your responsibility
3971 * to make sure this macro expands to something suitable (in
3972 * particular, that all the necessary declarations are visible
3973 * from within the library - you can ensure that by providing
3974 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003975 * If you define this macro to call `assert`, also define
3976 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3977 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003978 *
3979 * Note that you may define this macro to expand to nothing, in
3980 * which case you don't have to worry about declarations or
3981 * definitions. However, you will then be notified about invalid
3982 * parameters only in non-void functions, and void function will
3983 * just silently return early on invalid parameters, which
3984 * partially negates the benefits of enabling
3985 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3986 *
3987 * \param cond The expression that should evaluate to true, but doesn't.
3988 */
3989//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3990
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003991/** \def MBEDTLS_CHECK_RETURN
3992 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003993 * This macro is used at the beginning of the declaration of a function
3994 * to indicate that its return value should be checked. It should
3995 * instruct the compiler to emit a warning or an error if the function
3996 * is called without checking its return value.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003997 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003998 * There is a default implementation for popular compilers in platform_util.h.
3999 * You can override the default implementation by defining your own here.
4000 *
4001 * If the implementation here is empty, this will effectively disable the
4002 * checking of functions' return values.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02004003 */
Gilles Peskine91108092021-09-30 18:53:36 +02004004//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02004005
Gilles Peskinec2779322021-09-30 18:56:17 +02004006/** \def MBEDTLS_IGNORE_RETURN
4007 *
4008 * This macro requires one argument, which should be a C function call.
4009 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
4010 * warning is suppressed.
4011 */
4012//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
4013
Gilles Peskineed038902020-11-13 21:33:21 +01004014/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01004015/**
Gilles Peskineed038902020-11-13 21:33:21 +01004016 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
4017 * PSA crypto subsystem.
4018 *
4019 * If this option is unset:
4020 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01004021 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01004022 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
4023 * on unspecified heuristics.
4024 */
4025//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
4026
Steven Cooreman863470a2021-02-15 14:03:19 +01004027/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004028 * Restrict the PSA library to supporting a maximum amount of simultaneously
4029 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
4030 * volatile key, or a persistent key which is loaded temporarily by the
4031 * library as part of a crypto operation in flight.
4032 *
4033 * If this option is unset, the library will fall back to a default value of
4034 * 32 keys.
4035 */
Steven Cooreman863470a2021-02-15 14:03:19 +01004036//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004037
Paul Bakker088c5c52014-04-25 11:11:10 +02004038/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004039//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
4040//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02004041
Paul Bakker088c5c52014-04-25 11:11:10 +02004042/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10004043
4044/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
4045 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004046 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004047 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004048 * This determines the size of both the incoming and outgoing TLS I/O buffers
4049 * in such a way that both are capable of holding the specified amount of
4050 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10004051 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004052 * To configure incoming and outgoing I/O buffers separately, use
4053 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
4054 * which overwrite the value set by this option.
4055 *
4056 * \note When using a value less than the default of 16KB on the client, it is
4057 * recommended to use the Maximum Fragment Length (MFL) extension to
4058 * inform the server about this limitation. On the server, there
4059 * is no supported, standardized way of informing the client about
4060 * restriction on the maximum size of incoming messages, and unless
4061 * the limitation has been communicated by other means, it is recommended
4062 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4063 * while keeping the default value of 16KB for the incoming buffer.
4064 *
4065 * Uncomment to set the maximum plaintext size of both
4066 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10004067 */
4068//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
4069
4070/** \def MBEDTLS_SSL_IN_CONTENT_LEN
4071 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004072 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004073 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004074 * This determines the size of the incoming TLS I/O buffer in such a way
4075 * that it is capable of holding the specified amount of plaintext data,
4076 * regardless of the protection mechanism used.
4077 *
4078 * If this option is undefined, it inherits its value from
4079 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
4080 *
4081 * \note When using a value less than the default of 16KB on the client, it is
4082 * recommended to use the Maximum Fragment Length (MFL) extension to
4083 * inform the server about this limitation. On the server, there
4084 * is no supported, standardized way of informing the client about
4085 * restriction on the maximum size of incoming messages, and unless
4086 * the limitation has been communicated by other means, it is recommended
4087 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4088 * while keeping the default value of 16KB for the incoming buffer.
4089 *
4090 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
4091 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004092 */
4093//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4094
Gilles Peskined3d02902020-03-04 21:35:27 +01004095/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4096 *
4097 * The maximum length of CIDs used for incoming DTLS messages.
4098 *
4099 */
4100//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4101
4102/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4103 *
4104 * The maximum length of CIDs used for outgoing DTLS messages.
4105 *
4106 */
4107//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4108
4109/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
4110 *
4111 * This option controls the use of record plaintext padding
4112 * when using the Connection ID extension in DTLS 1.2.
4113 *
4114 * The padding will always be chosen so that the length of the
4115 * padded plaintext is a multiple of the value of this option.
4116 *
4117 * Note: A value of \c 1 means that no padding will be used
4118 * for outgoing records.
4119 *
4120 * Note: On systems lacking division instructions,
4121 * a power of two should be preferred.
4122 *
4123 */
4124//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
4125
Hanno Beckerceef8482020-06-02 06:16:00 +01004126/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01004127 *
4128 * This option controls the use of record plaintext padding
4129 * in TLS 1.3.
4130 *
4131 * The padding will always be chosen so that the length of the
4132 * padded plaintext is a multiple of the value of this option.
4133 *
4134 * Note: A value of \c 1 means that no padding will be used
4135 * for outgoing records.
4136 *
4137 * Note: On systems lacking division instructions,
4138 * a power of two should be preferred.
4139 */
Hanno Beckerceef8482020-06-02 06:16:00 +01004140//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01004141
Angus Grattond8213d02016-05-25 20:56:48 +10004142/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4143 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004144 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004145 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004146 * This determines the size of the outgoing TLS I/O buffer in such a way
4147 * that it is capable of holding the specified amount of plaintext data,
4148 * regardless of the protection mechanism used.
4149 *
4150 * If this option undefined, it inherits its value from
4151 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10004152 *
4153 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4154 * the default inward 16384 byte buffer to conform to the TLS specification.
4155 *
4156 * The minimum required outward buffer size is determined by the handshake
4157 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4158 * The specific size requirement depends on the configured ciphers and any
4159 * certificate data which is sent during the handshake.
4160 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004161 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
4162 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004163 */
4164//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4165
Hanno Beckere0b150f2018-08-21 15:51:03 +01004166/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4167 *
4168 * Maximum number of heap-allocated bytes for the purpose of
4169 * DTLS handshake message reassembly and future message buffering.
4170 *
Yuto Takano5b4caf22021-08-10 11:26:15 +01004171 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004172 * to account for a reassembled handshake message of maximum size,
4173 * together with its reassembly bitmap.
4174 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004175 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004176 * should be sufficient for all practical situations as it allows
4177 * to reassembly a large handshake message (such as a certificate)
4178 * while buffering multiple smaller handshake messages.
4179 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004180 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004181//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004183//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
4184//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
4185//#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 +02004186
Gilles Peskine065a1c82021-04-24 13:35:41 +02004187/** \def MBEDTLS_TLS_EXT_CID
4188 *
4189 * At the time of writing, the CID extension has not been assigned its
4190 * final value. Set this configuration option to make Mbed TLS use a
4191 * different value.
4192 *
4193 * A future minor revision of Mbed TLS may change the default value of
4194 * this option to match evolving standards and usage.
4195 */
4196//#define MBEDTLS_TLS_EXT_CID 254
4197
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004198/**
4199 * Complete list of ciphersuites to use, in order of preference.
4200 *
4201 * \warning No dependency checking is done on that field! This option can only
4202 * be used to restrict the set of available ciphersuites. It is your
4203 * responsibility to make sure the needed modules are active.
4204 *
4205 * Use this to save a few hundred bytes of ROM (default ordering of all
4206 * available ciphersuites) and a few to a few hundred bytes of RAM.
4207 *
4208 * The value below is only an example, not the default.
4209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004210//#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 +02004211
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004212/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004213//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004214//#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 +01004215
Gilles Peskine1341e212022-04-13 23:04:48 +02004216/** \} name SECTION: Module configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02004217
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004218/* Target and application specific configurations
4219 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004220 * Allow user to override any previous default.
4221 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004222 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004223#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004224#include MBEDTLS_USER_CONFIG_FILE
4225#endif
4226
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004227#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07004228#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004229#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07004230
Jaeden Amero6609aef2019-07-04 20:01:14 +01004231#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01004232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004233#endif /* MBEDTLS_CONFIG_H */