blob: 4651e267c3198d725003aa8df39a282a2bed9a27 [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#ifndef MBEDTLS_CONFIG_H
28#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakkercce9d772011-11-18 14:26:47 +000030#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000031#define _CRT_SECURE_NO_DEPRECATE 1
32#endif
33
Paul Bakkerf3b86c12011-01-27 15:24:17 +000034/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000035 * \name SECTION: System support
36 *
37 * This section sets system specific settings.
38 * \{
39 */
40
Paul Bakkerf3b86c12011-01-27 15:24:17 +000041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020044 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000045 *
46 * Requires support for asm() in compiler.
47 *
48 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010049 * library/aria.c
Paul Bakker68041ec2009-04-19 21:17:55 +000050 * library/timing.c
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000051 * include/mbedtls/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000052 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010053 * Required by:
Gilles Peskinee5038c62023-03-16 17:49:44 +010054 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010055 * MBEDTLS_PADLOCK_C
56 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020057 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000060
Paul Bakkerf3b86c12011-01-27 15:24:17 +000061/**
Gilles Peskineed942f82017-06-08 15:19:20 +020062 * \def MBEDTLS_NO_UDBL_DIVISION
63 *
64 * The platform lacks support for double-width integer division (64-bit
65 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
66 *
67 * Used in:
68 * include/mbedtls/bignum.h
69 * library/bignum.c
70 *
71 * The bignum code uses double-width division to speed up some operations.
72 * Double-width division is often implemented in software that needs to
73 * be linked with the program. The presence of a double-width integer
74 * type is usually detected automatically through preprocessor macros,
75 * but the automatic detection cannot know whether the code needs to
76 * and can be linked with an implementation of division for that type.
77 * By default division is assumed to be usable if the type is present.
78 * Uncomment this option to prevent the use of double-width division.
79 *
80 * Note that division for the native integer type is always required.
81 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010082 * platform, but it need not support multiplication or division. In some
83 * cases it is also desirable to disable some double-width operations. For
84 * example, if double-width division is implemented in software, disabling
85 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020086 */
87//#define MBEDTLS_NO_UDBL_DIVISION
88
89/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020090 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
91 *
92 * The platform lacks support for 32x32 -> 64-bit multiplication.
93 *
94 * Used in:
95 * library/poly1305.c
96 *
97 * Some parts of the library may use multiplication of two unsigned 32-bit
98 * operands with a 64-bit result in order to speed up computations. On some
99 * platforms, this is not available in hardware and has to be implemented in
100 * software, usually in a library provided by the toolchain.
101 *
102 * Sometimes it is not desirable to have to link to that library. This option
103 * removes the dependency of that library on platforms that lack a hardware
104 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
105 *
106 * Note that depending on the compiler, this may decrease performance compared
107 * to using the library function provided by the toolchain.
108 */
109//#define MBEDTLS_NO_64BIT_MULTIPLICATION
110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000113 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000114 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000115 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000116 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200119
120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200122 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200123 * System has time.h and time().
124 * The time does not need to be correct, only time differences are used,
125 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200126 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100127 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
128 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
129 * MBEDTLS_PLATFORM_STD_TIME.
130 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -0400131 * Comment if your system does not support time functions.
132 *
133 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
134 * interface - timing.c will include time.h on suitable platforms
135 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
136 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100139
140/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200141 * \def MBEDTLS_HAVE_TIME_DATE
142 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100143 * System has time.h, time(), and an implementation for
144 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100145 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * the date should be correct). This is used to verify the validity period of
147 * X.509 certificates.
148 *
149 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100150 *
Hanno Becker6a739782018-09-05 15:06:19 +0100151 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100152 * behaves similarly to the gmtime_r() function from the C standard. Refer to
153 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100154 *
155 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * mbedtls_platform_gmtime_r() at compile-time by using the macro
157 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200158 */
159#define MBEDTLS_HAVE_TIME_DATE
160
161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100163 *
164 * Enable the memory allocation layer.
165 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200166 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100167 * This allows different allocators (self-implemented or provided) to be
168 * provided to the platform abstraction layer.
169 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -0400170 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
172 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000173 * free() function pointer at runtime.
174 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -0400175 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000177 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100178 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -0400179 * An overview of how the value of mbedtls_calloc is determined:
180 *
181 * - if !MBEDTLS_PLATFORM_MEMORY
182 * - mbedtls_calloc = calloc
183 * - if MBEDTLS_PLATFORM_MEMORY
184 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
185 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
186 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
187 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
188 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
189 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
190 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
191 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
192 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
193 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
194 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
195 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
196 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
197 *
198 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
199 * - if !MBEDTLS_PLATFORM_STD_CALLOC
200 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
201 *
202 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
203 *
204 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
205 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
206 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
207 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
208 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
209 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100212 *
213 * Enable this layer to allow use of alternative memory allocators.
214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100216
217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200220 * Do not assign standard functions in the platform layer (e.g. calloc() to
221 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200222 *
223 * This makes sure there are no linking errors on platforms that do not support
224 * these functions. You will HAVE to provide alternatives, either at runtime
225 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
227 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200228 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200230 *
231 * Uncomment to prevent default assignment of standard functions in the
232 * platform layer.
233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200235
236/**
Janos Follathc351d182016-03-21 08:43:59 +0000237 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100239 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
240 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100241 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
243 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100244 * alternative printf function pointer.
245 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200248 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
249 * it will be enabled automatically by check_config.h
250 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200251 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000253 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100254 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
255 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100256 * Uncomment a macro to enable alternate implementation of specific base
257 * platform function
258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100260//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261//#define MBEDTLS_PLATFORM_FPRINTF_ALT
262//#define MBEDTLS_PLATFORM_PRINTF_ALT
263//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200264//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100265//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100266//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100267
268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200269 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100270 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000271 * Mark deprecated functions and features so that they generate a warning if
272 * used. Functionality deprecated in one version will usually be removed in the
273 * next version. You can enable this to help you prepare the transition to a
274 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100275 *
276 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100278 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000279 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100280 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100282
283/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100285 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000286 * Remove deprecated functions and features so that they generate an error if
287 * used. Functionality deprecated in one version will usually be removed in the
288 * next version. You can enable this to help you prepare the transition to a
289 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100290 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000291 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100294
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500295/**
296 * \def MBEDTLS_CHECK_PARAMS
297 *
298 * This configuration option controls whether the library validates more of
299 * the parameters passed to it.
300 *
301 * When this flag is not defined, the library only attempts to validate an
302 * input parameter if: (1) they may come from the outside world (such as the
303 * network, the filesystem, etc.) or (2) not validating them could result in
304 * internal memory errors such as overflowing a buffer controlled by the
305 * library. On the other hand, it doesn't attempt to validate parameters whose
306 * values are fully controlled by the application (such as pointers).
307 *
308 * When this flag is defined, the library additionally attempts to validate
309 * parameters that are fully controlled by the application, and should always
310 * be valid if the application code is fully correct and trusted.
311 *
312 * For example, when a function accepts as input a pointer to a buffer that may
313 * contain untrusted data, and its documentation mentions that this pointer
314 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200315 * - The pointer is checked to be non-NULL only if this option is enabled.
316 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500317 *
318 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200319 * is invalid:
320 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
321 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
322 * will immediately return. If the function returns an Mbed TLS error code,
323 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500324 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200325 * When defining this flag, you also need to arrange a definition for
326 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
327 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
328 * function mbedtls_param_failed(), but the library does not define this
329 * function. If you do not make any other arrangements, you must provide
330 * the function mbedtls_param_failed() in your application.
331 * See `platform_util.h` for its prototype.
332 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100333 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200334 * You can still supply an alternative definition of
335 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
336 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
337 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
338 * the library will call the macro that you defined and will not supply
339 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
340 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
341 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500342 *
343 * Uncomment to enable validation of application-controlled parameters.
344 */
345//#define MBEDTLS_CHECK_PARAMS
346
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200347/**
348 * \def MBEDTLS_CHECK_PARAMS_ASSERT
349 *
350 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
351 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
352 *
353 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
354 * calling a function mbedtls_param_failed(). See the documentation of
355 * #MBEDTLS_CHECK_PARAMS for details.
356 *
357 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
358 */
359//#define MBEDTLS_CHECK_PARAMS_ASSERT
360
Andrzej Kurek73afe272022-01-24 10:31:06 -0500361/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000362
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000363/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000364 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000365 *
366 * This section sets support for features that are or are not needed
367 * within the modules that are enabled.
368 * \{
369 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000370
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100373 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200375 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100378 *
379 * You will need to provide a header "timing_alt.h" and an implementation at
380 * compile time.
381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100383
384/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100385 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200386 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100387 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100388 * alternate core implementation of a symmetric crypto, an arithmetic or hash
389 * module (e.g. platform specific assembly optimized implementations). Keep
390 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200391 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200392 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200394 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000396 * provide the "struct mbedtls_aes_context" definition and omit the base
397 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200398 * "aes.h" to include the new function definitions.
399 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200400 * Uncomment a macro to enable alternate implementation of the corresponding
401 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100402 *
403 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
404 * use constitutes a security risk. If possible, we recommend
405 * avoiding dependencies on them, and considering stronger message
406 * digests and ciphers instead.
407 *
Paul Bakker90995b52013-06-24 19:20:35 +0200408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200409//#define MBEDTLS_AES_ALT
410//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000411//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412//#define MBEDTLS_BLOWFISH_ALT
413//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200414//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300415//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200416//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200417//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000419//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000420//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100421//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300422//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423//#define MBEDTLS_MD2_ALT
424//#define MBEDTLS_MD4_ALT
425//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300426//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000428//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200429//#define MBEDTLS_SHA1_ALT
430//#define MBEDTLS_SHA256_ALT
431//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000432//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000433
Janos Follathb0697532016-08-18 12:38:46 +0100434/*
Shaun Case0e7791f2021-12-20 21:14:10 -0800435 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100436 * implemented with two .c files:
437 * - ecp.c
438 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000439 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
440 * macros as described above. The only difference is that you have to make sure
441 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100442 */
443//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200444
445/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100446 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200447 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100448 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
449 * alternate core implementation of symmetric crypto or hash function. Keep in
450 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200451 *
452 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200454 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200455 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
456 * no longer provide the mbedtls_sha1_process() function, but it will still provide
457 * the other function (using your mbedtls_sha1_process() function) and the definition
458 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200459 * with this definition.
460 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100461 * \note Because of a signature change, the core AES encryption and decryption routines are
462 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
463 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100464 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100465 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100466 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +0200467 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100468 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
469 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200470 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200471 * Uncomment a macro to enable alternate implementation of the corresponding
472 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100473 *
474 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
475 * constitutes a security risk. If possible, we recommend avoiding
476 * dependencies on them, and considering stronger message digests
477 * and ciphers instead.
478 *
Janos Follath1231d212019-01-07 15:01:32 +0000479 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
480 * enabled, then the deterministic ECDH signature functions pass the
481 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
482 * alternative implementations should use the RNG only for generating
483 * the ephemeral key and nothing else. If this is not possible, then
484 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
485 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
486 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
487 * desirable).
488 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200490//#define MBEDTLS_MD2_PROCESS_ALT
491//#define MBEDTLS_MD4_PROCESS_ALT
492//#define MBEDTLS_MD5_PROCESS_ALT
493//#define MBEDTLS_RIPEMD160_PROCESS_ALT
494//#define MBEDTLS_SHA1_PROCESS_ALT
495//#define MBEDTLS_SHA256_PROCESS_ALT
496//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200497//#define MBEDTLS_DES_SETKEY_ALT
498//#define MBEDTLS_DES_CRYPT_ECB_ALT
499//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200500//#define MBEDTLS_AES_SETKEY_ENC_ALT
501//#define MBEDTLS_AES_SETKEY_DEC_ALT
502//#define MBEDTLS_AES_ENCRYPT_ALT
503//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300504//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300505//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300506//#define MBEDTLS_ECDSA_VERIFY_ALT
507//#define MBEDTLS_ECDSA_SIGN_ALT
508//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200509
510/**
Janos Follathc44ab972016-11-18 16:38:23 +0000511 * \def MBEDTLS_ECP_INTERNAL_ALT
512 *
513 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100514 *
515 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100516 * alternative core implementation of elliptic curve arithmetic. Keep in mind
517 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100518 *
519 * This partially replaces one function. The header file from mbed TLS is still
520 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
521 * is still present and it is used for group structures not supported by the
522 * alternative.
523 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100524 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100525 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100526 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
527 * able to fallback to curves not supported by the alternative implementation.
528 *
Janos Follathc44ab972016-11-18 16:38:23 +0000529 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
530 * and implementing the following functions:
531 * unsigned char mbedtls_internal_ecp_grp_capable(
532 * const mbedtls_ecp_group *grp )
533 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500534 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000535 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
536 * replacement functions implement arithmetic for the given group and 0
537 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500538 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000539 * called before and after each point operation and provide an opportunity to
540 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100541 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100542 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
543 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
544 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
545 * for the operation is supported by your implementation (i.e. your
546 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
547 * group is not supported by your implementation, then the original mbed TLS
548 * implementation of ecp_double_jac() is used instead, unless this fallback
549 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
550 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
551 *
552 * The function prototypes and the definition of mbedtls_ecp_group and
553 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
554 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
555 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100556 *
557 * Uncomment a macro to enable alternate implementation of the corresponding
558 * function.
559 */
560/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000561//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100562/* Turn off software fallback for curves not supported in hardware */
563//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100564/* Support for Weierstrass curves with Jacobi representation */
565//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
566//#define MBEDTLS_ECP_ADD_MIXED_ALT
567//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
568//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
569//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
570/* Support for curves with Montgomery arithmetic */
571//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
572//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
573//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
574
575/**
Simon Butcherab5df402016-06-11 02:31:21 +0100576 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100577 *
Simon Butcherab5df402016-06-11 02:31:21 +0100578 * Enables testing and use of mbed TLS without any configured entropy sources.
579 * This permits use of the library on platforms before an entropy source has
580 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
581 * MBEDTLS_ENTROPY_NV_SEED switches).
582 *
583 * WARNING! This switch MUST be disabled in production builds, and is suitable
584 * only for development.
585 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100586 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100587 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
588 *
Janos Follath53de7842016-06-08 15:29:18 +0100589 */
Simon Butcherab5df402016-06-11 02:31:21 +0100590//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100591
592/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200593 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200594 *
595 * Uncomment this macro to let mbed TLS use your own implementation of a
596 * hardware entropy collector.
597 *
598 * Your function must be called \c mbedtls_hardware_poll(), have the same
599 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
600 *
601 * Uncomment to use your own hardware entropy collector.
602 */
603//#define MBEDTLS_ENTROPY_HARDWARE_ALT
604
605/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000607 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100608 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000609 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100610 * Uncomment this macro to use precomputed AES tables stored in ROM.
611 * Comment this macro to generate AES tables in RAM at runtime.
612 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100613 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
614 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100615 * initialization time before the first AES operation can be performed.
616 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
617 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
618 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100619 *
620 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
621 *
Paul Bakker15566e42011-04-24 21:19:15 +0000622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000624
625/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100626 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200627 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100628 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200629 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100630 * Uncommenting this macro omits 75% of the AES tables from
631 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
632 * by computing their values on the fly during operations
633 * (the tables are entry-wise rotations of one another).
634 *
635 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100636 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100637 * runtime. Specifically, one has to compare 4 accesses within
638 * different tables to 4 accesses with additional arithmetic
639 * operations within the same table. The performance gain/loss
640 * depends on the system and memory details.
641 *
642 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
643 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200644 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100645//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200646
647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200649 *
650 * Use less ROM for the Camellia implementation (saves about 768 bytes).
651 *
652 * Uncomment this macro to use less memory for Camellia.
653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200655
656/**
Gilles Peskine8472a102021-09-23 18:07:36 +0200657 * \def MBEDTLS_CHECK_RETURN_WARNING
658 *
659 * If this macro is defined, emit a compile-time warning if application code
660 * calls a function without checking its return value, but the return value
661 * should generally be checked in portable applications.
662 *
663 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
664 * implemented. Otherwise this option has no effect.
665 *
666 * Uncomment to get warnings on using fallible functions without checking
667 * their return value.
668 *
669 * \note This feature is a work in progress.
670 * Warnings will be added to more functions in the future.
671 *
672 * \note A few functions are considered critical, and ignoring the return
673 * value of these functions will trigger a warning even if this
674 * macro is not defined. To completely disable return value check
675 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
676 */
677//#define MBEDTLS_CHECK_RETURN_WARNING
678
679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200681 *
682 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200685
686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000688 *
689 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000692
693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000695 *
696 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000699
700/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100701 * \def MBEDTLS_CIPHER_MODE_OFB
702 *
703 * Enable Output Feedback mode (OFB) for symmetric ciphers.
704 */
705#define MBEDTLS_CIPHER_MODE_OFB
706
707/**
708 * \def MBEDTLS_CIPHER_MODE_XTS
709 *
710 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
711 */
712#define MBEDTLS_CIPHER_MODE_XTS
713
714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000716 *
717 * Enable NULL cipher.
718 * Warning: Only do so when you know what you are doing. This allows for
719 * encryption or channels without any security!
720 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000722 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200723 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
724 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
725 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
726 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
727 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
728 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
729 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
730 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
731 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
732 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
733 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
734 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
735 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
736 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
737 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
738 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
739 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
740 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
741 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000742 *
743 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000746
747/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100748 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200749 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100750 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
751 * specific padding modes in the cipher layer with cipher modes that support
752 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200753 *
754 * If you disable all padding modes, only full blocks can be used with CBC.
755 *
756 * Enable padding modes in the cipher layer.
757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758#define MBEDTLS_CIPHER_PADDING_PKCS7
759#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
760#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
761#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200762
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200763/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
764 *
765 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
766 * By default, CTR_DRBG uses a 256-bit key.
767 */
768//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
769
Paul Bakker48e93c82013-08-14 12:21:18 +0200770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000772 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200773 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000774 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000775 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000776 *
777 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
779 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000780 *
781 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100782 *
783 * \warning DES is considered a weak cipher and its use constitutes a
784 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000787
788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200790 *
791 * Remove RC4 ciphersuites by default in SSL / TLS.
792 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200794 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200795 * explicitly.
796 *
797 * Uncomment this macro to remove RC4 ciphersuites by default.
798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200800
801/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000802 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
803 *
804 * Remove 3DES ciphersuites by default in SSL / TLS.
805 * This flag removes the ciphersuites based on 3DES from the default list as
806 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
807 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
808 * them explicitly.
809 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000810 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000811 * a TLS connection using a 3DES based cipher suite (see "On the Practical
812 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
813 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
814 * in your threat model or you are unsure, then you should keep this option
815 * enabled to remove 3DES based cipher suites.
816 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000817 * Comment this macro to keep 3DES in the default ciphersuite list.
818 */
819#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
820
821/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100822 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200823 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100824 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
825 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200826 *
827 * Comment macros to disable the curve and functions for it
828 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200829/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
831#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
832#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
833#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
834#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
835#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
836#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
837#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
838#define MBEDTLS_ECP_DP_BP256R1_ENABLED
839#define MBEDTLS_ECP_DP_BP384R1_ENABLED
840#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200841/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200842#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000843#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200844
845/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200847 *
848 * Enable specific 'modulo p' routines for each NIST prime.
849 * Depending on the prime and architecture, makes operations 4 to 8 times
850 * faster on the corresponding curve.
851 *
852 * Comment this macro to disable NIST curves optimisation.
853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200855
856/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200857 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
858 *
859 * When this option is disabled, mbedtls_ecp_mul() will make use of an
860 * internal RNG when called with a NULL \c f_rng argument, in order to protect
861 * against some side-channel attacks.
862 *
863 * This protection introduces a dependency of the ECP module on one of the
864 * DRBG modules. For very constrained implementations that don't require this
865 * protection (for example, because you're only doing signature verification,
866 * so not manipulating any secret, or because local/physical side-channel
867 * attacks are outside your threat model), it might be desirable to get rid of
868 * that dependency.
869 *
870 * \warning Enabling this option makes some uses of ECP vulnerable to some
871 * side-channel attacks. Only enable it if you know that's not a problem for
872 * your use case.
873 *
874 * Uncomment this macro to disable some counter-measures in ECP.
875 */
876//#define MBEDTLS_ECP_NO_INTERNAL_RNG
877
878/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200879 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100880 *
881 * Enable "non-blocking" ECC operations that can return early and be resumed.
882 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200883 * This allows various functions to pause by returning
884 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
885 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
886 * order to further progress and eventually complete their operation. This is
887 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
888 * number of ECC operations a function may perform before pausing; see
889 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100890 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200891 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200892 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100893 *
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100894 * This option:
895 * - Adds xxx_restartable() variants of existing operations in the
896 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100897 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
898 * linear combination (muladd);
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100899 * - ECDSA: signature generation & verification;
900 * - PK: signature generation & verification;
901 * - X509: certificate chain verification.
902 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
903 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
904 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
905 * computations restartable:
Tom Cosgrove601e8392023-03-07 11:43:12 +0000906 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100907 * curves;
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100908 * - verification of the server's key exchange signature;
909 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100910 * - generation of the client's signature if client authentication is used,
911 * with an ECC key/certificate.
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100912 *
913 * \note In the cases above, the usual SSL/TLS functions, such as
914 * mbedtls_ssl_handshake(), can now return
915 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200916 *
Ron Eldor19779c42018-11-05 16:58:13 +0200917 * \note This option only works with the default software implementation of
918 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100919 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT,
920 * MBEDTLS_ECDH_LEGACY_CONTEXT, and MBEDTLS_USE_PSA_CRYPTO.
921 *
Manuel Pégourié-Gonnard3dc7f232022-12-06 13:20:06 +0100922 * Requires: MBEDTLS_ECP_C
923 *
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100924 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100925 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200926//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100927
928/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100929 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
930 *
931 * Use a backward compatible ECDH context.
932 *
933 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
934 * defined in `ecdh.h`). For most applications, the choice of format makes
935 * no difference, since all library functions can work with either format,
936 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
937
938 * The new format used when this option is disabled is smaller
939 * (56 bytes on a 32-bit platform). In future versions of the library, it
940 * will support alternative implementations of ECDH operations.
941 * The new format is incompatible with applications that access
942 * context fields directly and with restartable ECP operations.
943 *
944 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
945 * want to access ECDH context fields directly. Otherwise you should
946 * comment out this macro definition.
947 *
948 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
949 *
950 * \note This configuration option is experimental. Future versions of the
951 * library may modify the way the ECDH context layout is configured
952 * and may modify the layout of the new context type.
953 */
954#define MBEDTLS_ECDH_LEGACY_CONTEXT
955
956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100958 *
959 * Enable deterministic ECDSA (RFC 6979).
960 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
961 * may result in a compromise of the long-term signing key. This is avoided by
962 * the deterministic variant.
963 *
John Durkop36a82e52020-10-26 09:39:05 -0700964 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100965 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100966 * Comment this macro to disable deterministic ECDSA.
967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100969
970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200972 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200973 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200974 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200975 * This enables the following ciphersuites (if other requisites are
976 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
978 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
979 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
980 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
981 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
982 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
983 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
984 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
985 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
986 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
987 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
988 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200991
992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200994 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200995 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200996 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200998 *
999 * This enables the following ciphersuites (if other requisites are
1000 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
1002 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
1003 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
1004 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
1005 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1006 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
1007 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
1008 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
1009 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
1010 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1011 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
1012 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001013 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001014 * \warning Using DHE constitutes a security risk as it
1015 * is not possible to validate custom DH parameters.
1016 * If possible, it is recommended users should consider
1017 * preferring other methods of key exchange.
1018 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001019 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001022
1023/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001025 *
1026 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
1027 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001029 *
1030 * This enables the following ciphersuites (if other requisites are
1031 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1033 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1034 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1035 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1036 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1037 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1038 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
1039 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001042
1043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001046 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +02001047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1049 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001050 *
1051 * This enables the following ciphersuites (if other requisites are
1052 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1054 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1055 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1056 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
1057 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
1058 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1059 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1060 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1061 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
1062 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
1063 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
1064 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001067
1068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001070 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001071 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1074 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001075 *
1076 * This enables the following ciphersuites (if other requisites are
1077 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1079 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1080 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1081 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
1082 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
1083 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
1084 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1085 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1086 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1087 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1088 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1089 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1090 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
1091 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
1092 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +02001093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001095
1096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001098 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001099 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1102 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001103 *
1104 * This enables the following ciphersuites (if other requisites are
1105 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1107 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1108 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1109 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1110 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1111 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1112 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1113 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1114 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1115 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1116 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1117 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1118 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001119 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001120 * \warning Using DHE constitutes a security risk as it
1121 * is not possible to validate custom DH parameters.
1122 * If possible, it is recommended users should consider
1123 * preferring other methods of key exchange.
1124 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001125 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001128
1129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001131 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001132 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001133 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1135 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001136 *
1137 * This enables the following ciphersuites (if other requisites are
1138 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1141 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1142 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1143 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1144 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1145 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1146 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1147 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1148 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1149 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1150 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001153
1154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001156 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001157 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001158 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001160 *
1161 * This enables the following ciphersuites (if other requisites are
1162 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1164 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1165 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1166 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1167 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1168 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1169 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1170 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1171 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1172 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1173 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1174 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001177
1178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001180 *
1181 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1182 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001183 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001184 *
1185 * This enables the following ciphersuites (if other requisites are
1186 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1188 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1189 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1190 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1191 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1192 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1193 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1194 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1195 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1196 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1197 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1198 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001201
1202/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001204 *
1205 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1206 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001207 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001208 *
1209 * This enables the following ciphersuites (if other requisites are
1210 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1212 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1213 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1214 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1215 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1216 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1217 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1218 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1219 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1220 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1221 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1222 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001225
1226/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001227 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1228 *
1229 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1230 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001231 * \warning This is currently experimental. EC J-PAKE support is based on the
1232 * Thread v1.0.0 specification; incompatible changes to the specification
1233 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001234 *
1235 * Requires: MBEDTLS_ECJPAKE_C
1236 * MBEDTLS_SHA256_C
1237 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1238 *
1239 * This enables the following ciphersuites (if other requisites are
1240 * enabled as well):
1241 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1242 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001243//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001244
1245/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001247 *
1248 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1249 * RFC 5915 and RFC 5480.
1250 *
1251 * Currently this means parsing the SpecifiedECDomain choice of EC
1252 * parameters (only known groups are supported, not arbitrary domains, to
1253 * avoid validation issues).
1254 *
1255 * Disable if you only need to support RFC 5915 + 5480 key formats.
1256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001258
1259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001261 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262 * Enable a dummy error function to make use of mbedtls_strerror() in
1263 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1264 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001265 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1267 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001268 *
1269 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001271 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001273
1274/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001276 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001277 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001278 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001280 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001281#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001282
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001283/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001285 *
1286 * Enable functions that use the filesystem.
1287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001289
1290/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001292 *
1293 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001295 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001296 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001297 * application.
1298 *
1299 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001302
1303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001305 *
1306 * Do not use built-in platform entropy functions.
1307 * This is useful if your platform does not support
1308 * standards like the /dev/urandom or Windows CryptoAPI.
1309 *
1310 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001313
1314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001316 *
1317 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1318 * default SHA-512 based one (if both are available).
1319 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001321 *
1322 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1323 * if you have performance concerns.
1324 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325 * This option is only useful if both MBEDTLS_SHA256_C and
1326 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001329
1330/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001331 * \def MBEDTLS_ENTROPY_NV_SEED
1332 *
1333 * Enable the non-volatile (NV) seed file-based entropy source.
1334 * (Also enables the NV seed read/write functions in the platform layer)
1335 *
1336 * This is crucial (if not required) on systems that do not have a
1337 * cryptographic entropy source (in hardware or kernel) available.
1338 *
1339 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1340 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001341 * \note The read/write functions that are used by the entropy source are
1342 * determined in the platform layer, and can be modified at runtime and/or
1343 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1344 *
1345 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001346 * with regular fopen(), please make sure you make a seedfile with the
1347 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1348 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001349 * and written to or you will get an entropy source error! The default
1350 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1351 * bytes from the file.
1352 *
1353 * \note The entropy collector will write to the seed file before entropy is
1354 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001355 */
1356//#define MBEDTLS_ENTROPY_NV_SEED
1357
Ronald Cron71016a92020-08-28 19:01:50 +02001358/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001359 *
Ronald Cron71016a92020-08-28 19:01:50 +02001360 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001361 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001362 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1363 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001364 *
1365 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001366 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001367 */
Ronald Cron71016a92020-08-28 19:01:50 +02001368//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001369
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001372 *
1373 * Enable debugging of buffer allocator memory issues. Automatically prints
1374 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1375 * function for 'debug output' of allocated memory.
1376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001378 *
1379 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001382
1383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001385 *
1386 * Include backtrace information with each allocated block.
1387 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrove5205c972022-07-28 06:12:08 +01001389 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001390 *
1391 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001393//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001394
1395/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001396 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001397 *
1398 * Support external private RSA keys (eg from a HSM) in the PK layer.
1399 *
1400 * Comment this macro to disable support for external private RSA keys.
1401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001402#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001403
1404/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001405 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001406 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001407 * Enable support for PKCS#1 v1.5 encoding.
1408 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001409 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001410 *
Paul Bakker48377d92013-08-30 12:06:24 +02001411 * This enables support for PKCS#1 v1.5 operations.
1412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001414
1415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001417 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001418 * Enable support for PKCS#1 v2.1 encoding.
1419 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001421 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001422 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001425
Steven Cooreman6801f082021-02-19 17:21:22 +01001426/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1427 *
1428 * Enable support for platform built-in keys. If you enable this feature,
1429 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1430 * See the documentation of that function for more information.
1431 *
1432 * Built-in keys are typically derived from a hardware unique key or
1433 * stored in a secure element.
1434 *
1435 * Requires: MBEDTLS_PSA_CRYPTO_C.
1436 *
1437 * \warning This interface is experimental and may change or be removed
1438 * without notice.
1439 */
1440//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1441
Ronald Cron3768ac12021-01-26 16:58:00 +01001442/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1443 *
1444 * Enable support for PSA crypto client.
1445 *
1446 * \note This option allows to include the code necessary for a PSA
1447 * crypto client when the PSA crypto implementation is not included in
1448 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1449 * code to set and get PSA key attributes.
1450 * The development of PSA drivers partially relying on the library to
1451 * fulfill the hardware gaps is another possible usage of this option.
1452 *
1453 * \warning This interface is experimental and may change or be removed
1454 * without notice.
1455 */
1456//#define MBEDTLS_PSA_CRYPTO_CLIENT
1457
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001458/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1459 *
1460 * Enable support for the experimental PSA crypto driver interface.
1461 *
John Durkop185764f2020-10-12 21:32:12 -07001462 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001463 *
1464 * \warning This interface is experimental and may change or be removed
1465 * without notice.
1466 */
1467//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1468
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001469/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1470 *
1471 * Make the PSA Crypto module use an external random generator provided
1472 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1473 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001474 * \note This random generator must deliver random numbers with cryptographic
1475 * quality and high performance. It must supply unpredictable numbers
1476 * with a uniform distribution. The implementation of this function
1477 * is responsible for ensuring that the random generator is seeded
1478 * with sufficient entropy. If you have a hardware TRNG which is slow
1479 * or delivers non-uniform output, declare it as an entropy source
1480 * with mbedtls_entropy_add_source() instead of enabling this option.
1481 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001482 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001483 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1484 * and define a function called mbedtls_psa_external_get_random()
1485 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001486 * ```
1487 * psa_status_t mbedtls_psa_external_get_random(
1488 * mbedtls_psa_external_random_context_t *context,
1489 * uint8_t *output, size_t output_size, size_t *output_length);
1490 * );
1491 * ```
1492 * The \c context value is initialized to 0 before the first call.
1493 * The function must fill the \c output buffer with \p output_size bytes
1494 * of random data and set \c *output_length to \p output_size.
1495 *
1496 * Requires: MBEDTLS_PSA_CRYPTO_C
1497 *
1498 * \warning If you enable this option, code that uses the PSA cryptography
1499 * interface will not use any of the entropy sources set up for
1500 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1501 * enables.
1502 *
1503 * \note This option is experimental and may be removed without notice.
1504 */
1505//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1506
Paul Bakker9dcc3222011-03-08 14:16:06 +00001507/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001508 * \def MBEDTLS_PSA_CRYPTO_SPM
1509 *
1510 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1511 * Partition Manager) integration which separates the code into two parts: a
1512 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1513 * Environment).
1514 *
1515 * Module: library/psa_crypto.c
1516 * Requires: MBEDTLS_PSA_CRYPTO_C
1517 *
1518 */
1519//#define MBEDTLS_PSA_CRYPTO_SPM
1520
1521/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001522 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001523 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001524 * Enable support for entropy injection at first boot. This feature is
1525 * required on systems that do not have a built-in entropy source (TRNG).
1526 * This feature is currently not supported on systems that have a built-in
1527 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001528 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001529 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001530 *
1531 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001532//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001533
1534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001536 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001537 * Do not use the Chinese Remainder Theorem
1538 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001539 *
1540 * Uncomment this macro to disable the use of CRT in RSA.
1541 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001544
1545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001547 *
1548 * Enable the checkup functions (*_self_test).
1549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001551
1552/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001553 * \def MBEDTLS_SHA256_SMALLER
1554 *
1555 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1556 * lower performance.
1557 *
Adam Wolfef30d902019-09-10 09:53:08 -05001558 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001559 * performance and size. This version optimizes more aggressively for size at
1560 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1561 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1562 * 30%.
1563 *
1564 * Uncomment to enable the smaller implementation of SHA256.
1565 */
1566//#define MBEDTLS_SHA256_SMALLER
1567
1568/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001569 * \def MBEDTLS_SHA512_SMALLER
1570 *
1571 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1572 * lower performance.
1573 *
1574 * Uncomment to enable the smaller implementation of SHA512.
1575 */
1576//#define MBEDTLS_SHA512_SMALLER
1577
1578/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001579 * \def MBEDTLS_SHA512_NO_SHA384
1580 *
1581 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1582 * code size on devices that don't use SHA-384.
1583 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001584 * Requires: MBEDTLS_SHA512_C
1585 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001586 * Uncomment to disable SHA-384
1587 */
1588//#define MBEDTLS_SHA512_NO_SHA384
1589
1590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001592 *
1593 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001594 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001595 * with other servers, only debugging of failures is harder.
1596 *
1597 * The advantage of not sending alert messages, is that no information is given
1598 * about reasons for failures thus preventing adversaries of gaining intel.
1599 *
1600 * Enable sending of all alert messages
1601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001602#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001603
1604/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001605 * \def MBEDTLS_SSL_RECORD_CHECKING
1606 *
1607 * Enable the function mbedtls_ssl_check_record() which can be used to check
1608 * the validity and authenticity of an incoming record, to verify that it has
1609 * not been seen before. These checks are performed without modifying the
1610 * externally visible state of the SSL context.
1611 *
1612 * See mbedtls_ssl_check_record() for more information.
1613 *
1614 * Uncomment to enable support for record checking.
1615 */
1616#define MBEDTLS_SSL_RECORD_CHECKING
1617
1618/**
1619 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1620 *
1621 * Enable support for the DTLS Connection ID extension
1622 * (version draft-ietf-tls-dtls-connection-id-05,
1623 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1624 * which allows to identify DTLS connections across changes
1625 * in the underlying transport.
1626 *
1627 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1628 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1629 * See the corresponding documentation for more information.
1630 *
1631 * \warning The Connection ID extension is still in draft state.
1632 * We make no stability promises for the availability
1633 * or the shape of the API controlled by this option.
1634 *
1635 * The maximum lengths of outgoing and incoming CIDs can be configured
1636 * through the options
1637 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1638 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1639 *
1640 * Requires: MBEDTLS_SSL_PROTO_DTLS
1641 *
1642 * Uncomment to enable the Connection ID extension.
1643 */
1644//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1645
1646/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001647 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1648 *
1649 * Enable asynchronous external private key operations in SSL. This allows
1650 * you to configure an SSL connection to call an external cryptographic
1651 * module to perform private key operations instead of performing the
1652 * operation inside the library.
1653 *
1654 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001655//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001656
1657/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001658 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1659 *
1660 * Enable serialization of the TLS context structures, through use of the
1661 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1662 *
1663 * This pair of functions allows one side of a connection to serialize the
1664 * context associated with the connection, then free or re-use that context
1665 * while the serialized state is persisted elsewhere, and finally deserialize
1666 * that state to a live context for resuming read/write operations on the
1667 * connection. From a protocol perspective, the state of the connection is
1668 * unaffected, in particular this is entirely transparent to the peer.
1669 *
1670 * Note: this is distinct from TLS session resumption, which is part of the
1671 * protocol and fully visible by the peer. TLS session resumption enables
1672 * establishing new connections associated to a saved session with shorter,
1673 * lighter handshakes, while context serialization is a local optimization in
1674 * handling a single, potentially long-lived connection.
1675 *
1676 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1677 * saved after the handshake to allow for more efficient serialization, so if
1678 * you don't need this feature you'll save RAM by disabling it.
1679 *
Przemek Stekiel864b43d2022-10-05 11:47:29 +02001680 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1681 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001682 * Comment to disable the context serialization APIs.
1683 */
1684#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1685
1686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001688 *
1689 * Enable the debug messages in SSL module for all issues.
1690 * Debug messages have been disabled in some places to prevent timing
1691 * attacks due to (unbalanced) debugging function calls.
1692 *
1693 * If you need all error reporting you should enable this during debugging,
1694 * but remove this for production servers that should log as well.
1695 *
1696 * Uncomment this macro to report all debug messages on errors introducing
1697 * a timing side-channel.
1698 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001703 *
1704 * Enable support for Encrypt-then-MAC, RFC 7366.
1705 *
1706 * This allows peers that both support it to use a more robust protection for
1707 * ciphersuites using CBC, providing deep resistance against timing attacks
1708 * on the padding or underlying cipher.
1709 *
1710 * This only affects CBC ciphersuites, and is useless if none is defined.
1711 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1713 * MBEDTLS_SSL_PROTO_TLS1_1 or
1714 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001715 *
1716 * Comment this macro to disable support for Encrypt-then-MAC
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001721 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001722 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1723 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001724 *
Shaun Case0e7791f2021-12-20 21:14:10 -08001725 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001726 * attacks, but it is recommended to always use it (even if you disable
1727 * renegotiation), since it actually fixes a more fundamental issue in the
1728 * original SSL/TLS design, and has implications beyond Triple Handshake.
1729 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1731 * MBEDTLS_SSL_PROTO_TLS1_1 or
1732 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001733 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001734 * Comment this macro to disable support for Extended Master Secret.
1735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001737
Paul Bakkerd66f0702013-01-31 16:57:45 +01001738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001740 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001741 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1742 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001743 *
1744 * For servers, it is recommended to always enable this, unless you support
1745 * only one version of TLS, or know for sure that none of your clients
1746 * implements a fallback strategy.
1747 *
1748 * For clients, you only need this if you're using a fallback strategy, which
1749 * is not recommended in the first place, unless you absolutely need it to
1750 * interoperate with buggy (version-intolerant) servers.
1751 *
1752 * Comment this macro to disable support for FALLBACK_SCSV
1753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001755
1756/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001757 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1758 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001759 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001760 * giving access to the peer's certificate after completion of the handshake.
1761 *
1762 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1763 * recommended to disable this option for reduced RAM usage.
1764 *
1765 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1766 * defined, but always returns \c NULL.
1767 *
1768 * \note This option has no influence on the protection against the
1769 * triple handshake attack. Even if it is disabled, Mbed TLS will
1770 * still ensure that certificates do not change during renegotiation,
Shaun Case0e7791f2021-12-20 21:14:10 -08001771 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001772 *
1773 * Comment this macro to disable storing the peer's certificate
1774 * after the handshake.
1775 */
1776#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1777
1778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001780 *
1781 * Enable hooking functions in SSL module for hardware acceleration of
1782 * individual records.
1783 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001784 * \deprecated This option is deprecated and will be removed in a future
1785 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001786 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001787 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001790
1791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001793 *
1794 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1795 *
1796 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1797 * of interoperability issues compared to sending 0-length records.
1798 *
1799 * Comment this macro to disable 1/n-1 record splitting.
1800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001802
1803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001805 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001806 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001807 *
1808 * The two main uses of renegotiation are (1) refresh keys on long-lived
1809 * connections and (2) client authentication after the initial handshake.
1810 * If you don't need renegotiation, it's probably better to disable it, since
1811 * it has been associated with security issues in the past and is easy to
1812 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001813 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001814 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001815 *
1816 * \note Even if this option is disabled, both client and server are aware
1817 * of the Renegotiation Indication Extension (RFC 5746) used to
1818 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1819 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1820 * configuration of this extension).
1821 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001824
1825/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001827 *
1828 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001830 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001831 * \deprecated This option is deprecated and will be removed in a future
1832 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001833 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001834 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001837
1838/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001840 *
1841 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001842 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001843 *
1844 * Uncomment this macro to respect client's ciphersuite order
1845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001847
1848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001850 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001851 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001852 *
1853 * Comment this macro to disable support for the max_fragment_length extension
1854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001855#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001856
1857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001860 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 * Requires: MBEDTLS_MD5_C
1863 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001864 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001865 * \deprecated This option is deprecated and will be removed in a future
1866 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001867 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001868 * Comment this macro to disable support for SSL 3.0
1869 */
Janos Follathe2681a42016-03-07 15:57:05 +00001870//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001871
1872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001874 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001875 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001876 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * Requires: MBEDTLS_MD5_C
1878 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001879 *
1880 * Comment this macro to disable support for TLS 1.0
1881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001883
1884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001886 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001887 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001888 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889 * Requires: MBEDTLS_MD5_C
1890 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001891 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001892 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001895
1896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001898 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001899 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001902 * (Depends on ciphersuites)
1903 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001904 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001907
1908/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001909 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1910 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001911 * This macro is used to selectively enable experimental parts
1912 * of the code that contribute to the ongoing development of
1913 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1914 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001915 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001916 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1917 * and no feature exposed through this macro is part of the
1918 * public API. In particular, features under the control
1919 * of this macro are experimental and don't come with any
1920 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001921 *
1922 * Uncomment this macro to enable experimental and partial
1923 * functionality specific to TLS 1.3.
1924 */
Hanno Beckere4160602020-05-07 15:11:45 +01001925//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001926
1927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001929 *
1930 * Enable support for DTLS (all available versions).
1931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1933 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001934 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1936 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001937 *
1938 * Comment this macro to disable support for DTLS
1939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001941
1942/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001944 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001945 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001946 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001947 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001950
1951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001953 *
1954 * Enable support for the anti-replay mechanism in DTLS.
1955 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 * Requires: MBEDTLS_SSL_TLS_C
1957 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001958 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001959 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001960 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001961 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001962 * Comment this to disable anti-replay in DTLS.
1963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001965
1966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001968 *
1969 * Enable support for HelloVerifyRequest on DTLS servers.
1970 *
1971 * This feature is highly recommended to prevent DTLS servers being used as
1972 * amplifiers in DoS attacks against other hosts. It should always be enabled
1973 * unless you know for sure amplification cannot be a problem in the
1974 * environment in which your server operates.
1975 *
Andrzej Kurek293e4522022-04-13 14:28:52 -04001976 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001977 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001978 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001979 *
1980 * Comment this to disable support for HelloVerifyRequest.
1981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001983
1984/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001985 * \def MBEDTLS_SSL_DTLS_SRTP
1986 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02001987 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001988 * through the use_srtp extension.
1989 *
1990 * \note This feature provides the minimum functionality required
1991 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1992 * the associated SRTP packet protection key material.
1993 * In particular, the SRTP packet protection itself, as well as the
1994 * demultiplexing of RTP and DTLS packets at the datagram layer
1995 * (see Section 5 of RFC 5764), are not handled by this feature.
1996 * Instead, after successful completion of a handshake negotiating
1997 * the use of DTLS-SRTP, the extended key exporter API
1998 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1999 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
2000 * (this is implemented in the SSL example programs).
2001 * The resulting key should then be passed to an SRTP stack.
2002 *
2003 * Setting this option enables the runtime API
2004 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
2005 * through which the supported DTLS-SRTP protection
2006 * profiles can be configured. You must call this API at
2007 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01002008 *
2009 * Requires: MBEDTLS_SSL_PROTO_DTLS
2010 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02002011 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01002012 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02002013//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01002014
2015/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02002016 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
2017 *
2018 * Enable server-side support for clients that reconnect from the same port.
2019 *
2020 * Some clients unexpectedly close the connection and try to reconnect using the
2021 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01002022 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02002023 * flag enables that support.
2024 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002025 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002026 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02002027 * Comment this to disable support for clients reusing the source port.
2028 */
2029#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
2030
2031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002033 *
2034 * Enable support for a limit of records with bad MAC.
2035 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002036 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002041
2042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002044 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002045 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01002046 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02002047 * session store remains the responsibility of the application, though).
2048 * Server-side, you also need to provide callbacks for writing and parsing
2049 * tickets, including authenticated encryption and key management. Example
2050 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02002051 *
2052 * Comment this macro to disable support for SSL session tickets
2053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002055
2056/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002057 * \def MBEDTLS_SSL_EXPORT_KEYS
2058 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002059 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002060 * This is required for certain users of TLS, e.g. EAP-TLS.
2061 *
2062 * Comment this macro to disable support for key export
2063 */
2064#define MBEDTLS_SSL_EXPORT_KEYS
2065
2066/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002067 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002068 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002069 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02002070 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00002072 *
Paul Bakker0be444a2013-08-27 21:55:01 +02002073 * Comment this macro to disable support for server name indication in SSL
2074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002076
2077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002079 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002080 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02002081 *
2082 * Comment this macro to disable support for truncated HMAC in SSL
2083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002085
2086/**
Hanno Beckere89353a2017-11-20 16:36:41 +00002087 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2088 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002089 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
2090 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002091 * only meant for a transitory upgrade period and will be removed in a future
2092 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00002093 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002094 * \warning The old implementation is non-compliant and has a security weakness
2095 * (2^80 brute force attack on the HMAC key used for a single,
2096 * uninterrupted connection). This should only be enabled temporarily
2097 * when (1) the use of truncated HMAC is essential in order to save
2098 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
2099 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00002100 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002101 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00002102 * future version of Mbed TLS.
2103 *
Hanno Beckere89353a2017-11-20 16:36:41 +00002104 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
2105 *
2106 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
2107 */
2108//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2109
2110/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002111 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2112 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002113 * When this option is enabled, the SSL buffer will be resized automatically
2114 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002115 *
2116 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002117 */
2118//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2119
2120/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002121 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2122 *
2123 * Enable testing of the constant-flow nature of some sensitive functions with
2124 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002125 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002126 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002127 * This setting requires compiling with clang -fsanitize=memory. The test
2128 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002129 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002130 * \warning This macro is only used for extended testing; it is not considered
2131 * part of the library's API, so it may change or disappear at any time.
2132 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002133 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002134 */
2135//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2136
2137/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002138 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2139 *
2140 * Enable testing of the constant-flow nature of some sensitive functions with
2141 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002142 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002143 *
2144 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002145 * testing if the tests suites are run with valgrind's memcheck. This can be
2146 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2147 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002148 *
2149 * \warning This macro is only used for extended testing; it is not considered
2150 * part of the library's API, so it may change or disappear at any time.
2151 *
2152 * Uncomment to enable testing of the constant-flow nature of selected code.
2153 */
2154//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2155
2156/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002157 * \def MBEDTLS_TEST_HOOKS
2158 *
2159 * Enable features for invasive testing such as introspection functions and
2160 * hooks for fault injection. This enables additional unit tests.
2161 *
2162 * Merely enabling this feature should not change the behavior of the product.
2163 * It only adds new code, and new branching points where the default behavior
2164 * is the same as when this feature is disabled.
2165 * However, this feature increases the attack surface: there is an added
2166 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2167 * Therefore this feature must never be enabled in production.
2168 *
2169 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2170 * information.
2171 *
2172 * Uncomment to enable invasive tests.
2173 */
2174//#define MBEDTLS_TEST_HOOKS
2175
2176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002178 *
2179 * Provide your own alternate threading implementation.
2180 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002182 *
2183 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002186
2187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002189 *
2190 * Enable the pthread wrapper layer for the threading layer.
2191 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002192 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002193 *
2194 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002197
2198/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002199 * \def MBEDTLS_USE_PSA_CRYPTO
2200 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002201 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2202 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002203 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002204 * \note Development of this option is currently in progress, and parts of Mbed
2205 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002206 * will still continue to work as usual, so enabling this option should not
2207 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002208 *
Manuel Pégourié-Gonnard00b72fc2021-09-20 13:21:25 +02002209 * \note See docs/use-psa-crypto.md for a complete description of what this
2210 * option currently does, and of parts that are not affected by it so far.
2211 *
Manuel Pégourié-Gonnardb52b91d2021-09-21 11:30:52 +02002212 * \warning This option enables new Mbed TLS APIs which are currently
2213 * considered experimental and may change in incompatible ways at any time.
2214 * That is, the APIs enabled by this option are not covered by the usual
2215 * promises of API stability.
Hanno Becker51560b62018-11-19 09:46:26 +00002216 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002217 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002218 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002219 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002220 */
2221//#define MBEDTLS_USE_PSA_CRYPTO
2222
2223/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002224 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2225 *
John Durkop185764f2020-10-12 21:32:12 -07002226 * This setting allows support for cryptographic mechanisms through the PSA
2227 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002228 *
Gilles Peskine33665c42022-04-13 23:22:49 +02002229 * When this option is disabled, the PSA API exposes the cryptographic
2230 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2231 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine52834352022-03-16 17:03:55 +01002232 *
2233 * When this option is enabled, the PSA API exposes the cryptographic
2234 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2235 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2236 * automatically enabled if required (i.e. if no PSA driver provides the
2237 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
Gilles Peskine82909762022-04-26 18:10:11 +02002238 * in config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002239 *
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002240 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine8a557752022-04-14 12:44:01 +02002241 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002242 *
Gilles Peskine58858b72020-11-09 15:26:09 +01002243 * If you enable this option and write your own configuration file, you must
2244 * include mbedtls/config_psa.h in your configuration file. The default
2245 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002246 *
2247 * This feature is still experimental and is not ready for production since
2248 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002249 */
2250//#define MBEDTLS_PSA_CRYPTO_CONFIG
2251
2252/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002254 *
2255 * Allow run-time checking of compile-time enabled features. Thus allowing users
2256 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002258 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002260 *
2261 * Comment this to disable run-time checking and save ROM space
2262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002264
2265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002267 *
2268 * If set, the X509 parser will not break-off when parsing an X509 certificate
2269 * and encountering an extension in a v1 or v2 certificate.
2270 *
2271 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002274
2275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002277 *
2278 * If set, the X509 parser will not break-off when parsing an X509 certificate
2279 * and encountering an unknown critical extension.
2280 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002281 * \warning Depending on your PKI use, enabling this can be a security risk!
2282 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002283 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002286
2287/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002288 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2289 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002290 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002291 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2292 * the set of trusted certificates through a callback instead of a linked
2293 * list.
2294 *
2295 * This is useful for example in environments where a large number of trusted
2296 * certificates is present and storing them in a linked list isn't efficient
2297 * enough, or when the set of trusted certificates changes frequently.
2298 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002299 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002300 * `mbedtls_ssl_conf_ca_cb()` for more information.
2301 *
2302 * Uncomment to enable trusted certificate callbacks.
2303 */
2304//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2305
2306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002308 *
2309 * Enable verification of the keyUsage extension (CA and leaf certificates).
2310 *
2311 * Disabling this avoids problems with mis-issued and/or misused
2312 * (intermediate) CA and leaf certificates.
2313 *
2314 * \warning Depending on your PKI use, disabling this can be a security risk!
2315 *
2316 * Comment to skip keyUsage checking for both CA and leaf certificates.
2317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002319
2320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002322 *
2323 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2324 *
2325 * Disabling this avoids problems with mis-issued and/or misused certificates.
2326 *
2327 * \warning Depending on your PKI use, disabling this can be a security risk!
2328 *
2329 * Comment to skip extendedKeyUsage checking for certificates.
2330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002332
2333/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002335 *
2336 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2337 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2338 *
2339 * Comment this macro to disallow using RSASSA-PSS in certificates.
2340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002342
2343/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002345 *
2346 * If set, the SSL/TLS module uses ZLIB to support compression and
2347 * decompression of packet data.
2348 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002349 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2350 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002351 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002352 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002353 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002354 *
Hanno Beckere494e202018-03-08 13:26:12 +00002355 * \deprecated This feature is deprecated and will be removed
2356 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002357 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002358 * Used in: library/ssl_tls.c
2359 * library/ssl_cli.c
2360 * library/ssl_srv.c
2361 *
2362 * This feature requires zlib library and headers to be present.
2363 *
2364 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366//#define MBEDTLS_ZLIB_SUPPORT
Andrzej Kurek73afe272022-01-24 10:31:06 -05002367/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002368
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002369/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002370 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002371 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002372 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002373 * \{
2374 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002375
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002378 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002379 * Enable AES-NI support on x86-64 or x86-32.
2380 *
2381 * \note AESNI is only supported with certain compilers and target options:
2382 * - Visual Studio 2013: supported.
2383 * - GCC, x86-64, target not explicitly supporting AESNI:
2384 * requires MBEDTLS_HAVE_ASM.
2385 * - GCC, x86-32, target not explicitly supporting AESNI:
2386 * not supported.
2387 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2388 * For this assembly-less implementation, you must currently compile
2389 * `library/aesni.c` and `library/aes.c` with machine options to enable
2390 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2391 * `clang -maes -mpclmul`.
2392 * - Non-x86 targets: this option is silently ignored.
2393 * - Other compilers: this option is silently ignored.
2394 *
2395 * \note
2396 * Above, "GCC" includes compatible compilers such as Clang.
2397 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002398 *
2399 * Module: library/aesni.c
2400 * Caller: library/aes.c
2401 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002402 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002403 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002404 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002407
2408/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002410 *
2411 * Enable the AES block cipher.
2412 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002413 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002414 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002415 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002416 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002417 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002418 * This module enables the following ciphersuites (if other requisites are
2419 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2421 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2422 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2423 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2424 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2425 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2426 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2427 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2428 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2429 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2430 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2431 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2432 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2433 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2434 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2435 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2436 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2437 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2438 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2439 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2440 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2441 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2442 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2443 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2444 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2445 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2446 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2447 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2448 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2449 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2450 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2451 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2452 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2453 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2454 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2455 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2456 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2457 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2458 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2459 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2460 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2461 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2462 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2463 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2464 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2465 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2466 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2467 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2468 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2469 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2470 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2471 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2472 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2473 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2474 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2475 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2476 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2477 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002478 *
Paul Bakkercff68422013-09-15 20:43:33 +02002479 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002482
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002485 *
2486 * Enable the ARCFOUR stream cipher.
2487 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002488 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002489 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002490 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002491 * This module enables the following ciphersuites (if other requisites are
2492 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2494 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2495 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2496 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2497 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2498 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2499 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2500 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2501 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2502 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002503 *
2504 * \warning ARC4 is considered a weak cipher and its use constitutes a
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00002505 * security risk. If possible, we recommend avoiding dependencies on
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002506 * it, and considering stronger ciphers instead.
2507 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002510
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002513 *
2514 * Enable the generic ASN1 parser.
2515 *
2516 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002517 * Caller: library/x509.c
2518 * library/dhm.c
2519 * library/pkcs12.c
2520 * library/pkcs5.c
2521 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002524
2525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002527 *
2528 * Enable the generic ASN1 writer.
2529 *
2530 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002531 * Caller: library/ecdsa.c
2532 * library/pkwrite.c
2533 * library/x509_create.c
2534 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002535 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002538
2539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002541 *
2542 * Enable the Base64 module.
2543 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002545 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002547 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002550
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002553 *
Paul Bakker9a736322012-11-14 12:39:52 +00002554 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002555 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002556 * Module: library/bignum.c
2557 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002558 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002559 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002561 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002562 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002563 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002564 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002567
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002570 *
2571 * Enable the Blowfish block cipher.
2572 *
2573 * Module: library/blowfish.c
2574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002576
2577/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002579 *
2580 * Enable the Camellia block cipher.
2581 *
Paul Bakker38119b12009-01-10 23:31:23 +00002582 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002583 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002584 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002585 * This module enables the following ciphersuites (if other requisites are
2586 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2588 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2589 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2590 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2591 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2592 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2593 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2594 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2595 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2596 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2597 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2598 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2599 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2600 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2601 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2602 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2603 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2604 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2605 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2606 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2607 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2608 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2609 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2610 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2611 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2612 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2613 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2614 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2615 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2616 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2617 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2618 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2619 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2620 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2621 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2622 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2623 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2624 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2625 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2626 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2627 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2628 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002631
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002632/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002633 * \def MBEDTLS_ARIA_C
2634 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002635 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002636 *
2637 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002638 * Caller: library/cipher.c
2639 *
2640 * This module enables the following ciphersuites (if other requisites are
2641 * enabled as well):
2642 *
2643 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2644 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2645 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2646 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2647 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2648 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2649 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2650 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2651 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2652 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2653 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2654 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2655 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2656 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2657 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2658 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2659 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2660 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2661 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2662 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2663 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2664 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2665 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2666 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2667 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2668 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2669 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2670 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2671 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2672 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2673 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2674 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2675 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2676 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2677 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2678 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2679 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2680 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002681 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002682//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002683
2684/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002686 *
2687 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2688 *
2689 * Module: library/ccm.c
2690 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002692 *
2693 * This module enables the AES-CCM ciphersuites, if other requisites are
2694 * enabled as well.
2695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002697
2698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002700 *
2701 * Enable the test certificates.
2702 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002703 * Module: library/certs.c
2704 * Caller:
2705 *
2706 * This module is used for testing (ssl_client/server).
2707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002709
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002710/**
Daniel King34b822c2016-05-15 17:28:08 -03002711 * \def MBEDTLS_CHACHA20_C
2712 *
2713 * Enable the ChaCha20 stream cipher.
2714 *
2715 * Module: library/chacha20.c
2716 */
2717#define MBEDTLS_CHACHA20_C
2718
2719/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002720 * \def MBEDTLS_CHACHAPOLY_C
2721 *
2722 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2723 *
2724 * Module: library/chachapoly.c
2725 *
2726 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2727 */
2728#define MBEDTLS_CHACHAPOLY_C
2729
2730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002732 *
2733 * Enable the generic cipher layer.
2734 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002735 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002736 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002737 *
2738 * Uncomment to enable generic cipher wrappers.
2739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002741
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002742/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002743 * \def MBEDTLS_CMAC_C
2744 *
Simon Butcher327398a2016-10-05 14:09:11 +01002745 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2746 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002747 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002748 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2749 * implementation of the CMAC algorithm is provided by an alternate
2750 * implementation, that alternate implementation may opt to not support
2751 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2752 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002753 * Module: library/cmac.c
2754 *
Simon Butcher69283e52016-10-06 12:49:58 +01002755 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002756 *
2757 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002758//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002759
2760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002762 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002763 * Enable the CTR_DRBG AES-based random generator.
2764 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002765 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002766 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002767 * \note To achieve a 256-bit security strength with CTR_DRBG,
2768 * you must use AES-256 *and* use sufficient entropy.
2769 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002770 *
2771 * Module: library/ctr_drbg.c
2772 * Caller:
2773 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002775 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002776 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002779
2780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002782 *
2783 * Enable the debug functions.
2784 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002785 * Module: library/debug.c
2786 * Caller: library/ssl_cli.c
2787 * library/ssl_srv.c
2788 * library/ssl_tls.c
2789 *
2790 * This module provides debugging functions.
2791 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002793
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002794/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002796 *
2797 * Enable the DES block cipher.
2798 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002799 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002800 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002801 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002802 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002803 * This module enables the following ciphersuites (if other requisites are
2804 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2806 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2807 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2808 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2809 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2810 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2811 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2812 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2813 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2814 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002815 *
Paul Bakkercff68422013-09-15 20:43:33 +02002816 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002817 *
Dave Rodgmanb43d5e72023-02-02 10:47:58 +00002818 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002819 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002822
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002823/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002825 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002826 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002827 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002828 * Module: library/dhm.c
2829 * Caller: library/ssl_cli.c
2830 * library/ssl_srv.c
2831 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002832 * This module is used by the following key exchanges:
2833 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002834 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002835 * \warning Using DHE constitutes a security risk as it
2836 * is not possible to validate custom DH parameters.
2837 * If possible, it is recommended users should consider
2838 * preferring other methods of key exchange.
2839 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002840 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002843
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002846 *
2847 * Enable the elliptic curve Diffie-Hellman library.
2848 *
2849 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002850 * Caller: library/ssl_cli.c
2851 * library/ssl_srv.c
2852 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002853 * This module is used by the following key exchanges:
2854 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002855 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002859
2860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002862 *
2863 * Enable the elliptic curve DSA library.
2864 *
2865 * Module: library/ecdsa.c
2866 * Caller:
2867 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002868 * This module is used by the following key exchanges:
2869 * ECDHE-ECDSA
2870 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002871 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2872 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2873 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002874 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002876
2877/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002878 * \def MBEDTLS_ECJPAKE_C
2879 *
2880 * Enable the elliptic curve J-PAKE library.
2881 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002882 * \warning This is currently experimental. EC J-PAKE support is based on the
2883 * Thread v1.0.0 specification; incompatible changes to the specification
2884 * might still happen. For this reason, this is disabled by default.
2885 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002886 * Module: library/ecjpake.c
2887 * Caller:
2888 *
2889 * This module is used by the following key exchanges:
2890 * ECJPAKE
2891 *
2892 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2893 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002894//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002895
2896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002898 *
2899 * Enable the elliptic curve over GF(p) library.
2900 *
2901 * Module: library/ecp.c
2902 * Caller: library/ecdh.c
2903 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002904 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002909
2910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002912 *
2913 * Enable the platform-specific entropy code.
2914 *
2915 * Module: library/entropy.c
2916 * Caller:
2917 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002919 *
2920 * This module provides a generic entropy pool
2921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002923
2924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002926 *
2927 * Enable error code to error string conversion.
2928 *
2929 * Module: library/error.c
2930 * Caller:
2931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002935
2936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002938 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002939 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002940 *
2941 * Module: library/gcm.c
2942 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002943 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002944 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002945 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2946 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002949
2950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002952 *
2953 * Enable the HAVEGE random generator.
2954 *
Paul Bakker2a844242013-06-24 13:01:53 +02002955 * Warning: the HAVEGE random generator is not suitable for virtualized
2956 * environments
2957 *
2958 * Warning: the HAVEGE random generator is dependent on timing and specific
2959 * processor traits. It is therefore not advised to use HAVEGE as
2960 * your applications primary random generator or primary entropy pool
2961 * input. As a secondary input to your entropy pool, it IS able add
2962 * the (limited) extra entropy it provides.
2963 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002964 * Module: library/havege.c
2965 * Caller:
2966 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002968 *
Paul Bakker2a844242013-06-24 13:01:53 +02002969 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002972
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002973/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002974 * \def MBEDTLS_HKDF_C
2975 *
2976 * Enable the HKDF algorithm (RFC 5869).
2977 *
2978 * Module: library/hkdf.c
2979 * Caller:
2980 *
2981 * Requires: MBEDTLS_MD_C
2982 *
2983 * This module adds support for the Hashed Message Authentication Code
2984 * (HMAC)-based key derivation function (HKDF).
2985 */
2986#define MBEDTLS_HKDF_C
2987
2988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002990 *
2991 * Enable the HMAC_DRBG random generator.
2992 *
2993 * Module: library/hmac_drbg.c
2994 * Caller:
2995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002997 *
Tom Cosgrove2b150752022-05-26 11:55:43 +01002998 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01003001
3002/**
Ron Eldor466a57f2018-05-03 16:54:28 +03003003 * \def MBEDTLS_NIST_KW_C
3004 *
3005 * Enable the Key Wrapping mode for 128-bit block ciphers,
3006 * as defined in NIST SP 800-38F. Only KW and KWP modes
3007 * are supported. At the moment, only AES is approved by NIST.
3008 *
3009 * Module: library/nist_kw.c
3010 *
3011 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
3012 */
3013//#define MBEDTLS_NIST_KW_C
3014
3015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003017 *
3018 * Enable the generic message digest layer.
3019 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003020 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00003021 * Caller:
3022 *
3023 * Uncomment to enable generic message digest wrappers.
3024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00003026
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003029 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003030 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003031 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003032 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003033 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00003034 *
3035 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003036 *
3037 * \warning MD2 is considered a weak message digest and its use constitutes a
3038 * security risk. If possible, we recommend avoiding dependencies on
3039 * it, and considering stronger message digests instead.
3040 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003043
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003046 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003047 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003048 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003049 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003050 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00003051 *
3052 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003053 *
3054 * \warning MD4 is considered a weak message digest and its use constitutes a
3055 * security risk. If possible, we recommend avoiding dependencies on
3056 * it, and considering stronger message digests instead.
3057 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003060
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003063 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003064 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003065 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003066 * Module: library/md5.c
3067 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003068 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01003069 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003070 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003071 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
3072 * depending on the handshake parameters. Further, it is used for checking
3073 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
3074 * encrypted keys.
3075 *
3076 * \warning MD5 is considered a weak message digest and its use constitutes a
3077 * security risk. If possible, we recommend avoiding dependencies on
3078 * it, and considering stronger message digests instead.
3079 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003082
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003085 *
3086 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003087 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003088 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02003089 *
3090 * Module: library/memory_buffer_alloc.c
3091 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092 * Requires: MBEDTLS_PLATFORM_C
3093 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02003094 *
3095 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02003096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02003098
3099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003101 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003102 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
3103 *
Simon Butcherd567a232016-03-09 20:19:21 +00003104 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
3105 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003106 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003107 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003108 * \note See also our Knowledge Base article about porting to a new
3109 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003110 * 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 +00003111 *
Andres AG788aa4a2016-09-14 14:32:09 +01003112 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003113 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003114 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003117
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003120 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003121 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003122 *
3123 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003124 * Caller: library/asn1write.c
3125 * library/pkcs5.c
3126 * library/pkparse.c
3127 * library/pkwrite.c
3128 * library/rsa.c
3129 * library/x509.c
3130 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003131 * library/x509_crl.c
3132 * library/x509_crt.c
3133 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003134 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003135 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003136 *
3137 * This modules translates between OIDs and internal values.
3138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003140
3141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003143 *
3144 * Enable VIA Padlock support on x86.
3145 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003146 * Module: library/padlock.c
3147 * Caller: library/aes.c
3148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003150 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 * This modules adds support for the VIA PadLock on x86.
3152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#define MBEDTLS_PADLOCK_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_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003157 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003158 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003159 *
3160 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003161 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003162 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003163 * library/x509_crl.c
3164 * library/x509_crt.c
3165 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003166 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003168 *
Paul Bakkercff68422013-09-15 20:43:33 +02003169 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003172
3173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003175 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003176 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003177 *
3178 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003179 * Caller: library/pkwrite.c
3180 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003181 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003182 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003184 *
3185 * This modules adds support for encoding / writing PEM files.
3186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003188
3189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003191 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003192 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003193 *
3194 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003195 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003196 * library/ssl_cli.c
3197 * library/ssl_srv.c
3198 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003200 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003201 * Uncomment to enable generic public key wrappers.
3202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003204
3205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003207 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003208 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003209 *
3210 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003211 * Caller: library/x509_crt.c
3212 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003213 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003215 *
3216 * Uncomment to enable generic public key parse functions.
3217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003219
3220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003222 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003223 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003224 *
3225 * Module: library/pkwrite.c
3226 * Caller: library/x509write.c
3227 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003229 *
3230 * Uncomment to enable generic public key write functions.
3231 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003232#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003233
3234/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003236 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003237 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003238 *
3239 * Module: library/pkcs5.c
3240 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003242 *
3243 * This module adds support for the PKCS#5 functions.
3244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003246
3247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003249 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003250 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003251 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003252 * \deprecated This option is deprecated and will be removed in a future
3253 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003254 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003255 * Module: library/pkcs11.c
3256 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003257 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003259 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003260 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003261 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003264
3265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003267 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003268 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003269 * Adds algorithms for parsing PKCS#8 encrypted private keys
3270 *
3271 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003272 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003273 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003274 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3275 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003276 *
3277 * This module enables PKCS#12 functions.
3278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003279#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003280
3281/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003283 *
3284 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003285 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003286 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3288 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003289 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003290 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003291 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3292 * as other module rely on it for a fixed snprintf implementation.
3293 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003294 * Module: library/platform.c
3295 * Caller: Most other .c files
3296 *
3297 * This module enables abstraction of common (libc) functions.
3298 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003299#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003300
3301/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003302 * \def MBEDTLS_POLY1305_C
3303 *
3304 * Enable the Poly1305 MAC algorithm.
3305 *
3306 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003307 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003308 */
3309#define MBEDTLS_POLY1305_C
3310
3311/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003312 * \def MBEDTLS_PSA_CRYPTO_C
3313 *
3314 * Enable the Platform Security Architecture cryptography API.
3315 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003316 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003317 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003318 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003319 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003320 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003321 *
3322 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003323#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003324
3325/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003326 * \def MBEDTLS_PSA_CRYPTO_SE_C
3327 *
3328 * Enable secure element support in the Platform Security Architecture
3329 * cryptography API.
3330 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003331 * \warning This feature is not yet suitable for production. It is provided
3332 * for API evaluation and testing purposes only.
3333 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003334 * Module: library/psa_crypto_se.c
3335 *
3336 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3337 *
3338 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003339//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003340
3341/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003342 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3343 *
3344 * Enable the Platform Security Architecture persistent key storage.
3345 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003346 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003347 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003348 * Requires: MBEDTLS_PSA_CRYPTO_C,
3349 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3350 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003351 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003352#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003353
3354/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003355 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003356 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003357 * Enable the emulation of the Platform Security Architecture
3358 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003359 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003360 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003361 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003362 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003363 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003364#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003365
3366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003368 *
3369 * Enable the RIPEMD-160 hash algorithm.
3370 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003371 * Module: library/ripemd160.c
3372 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003373 *
3374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003376
3377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003379 *
3380 * Enable the RSA public-key cryptosystem.
3381 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003382 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003383 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003384 * Caller: library/ssl_cli.c
3385 * library/ssl_srv.c
3386 * library/ssl_tls.c
3387 * library/x509.c
3388 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003389 * This module is used by the following key exchanges:
3390 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003391 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003395
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003396/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003398 *
3399 * Enable the SHA1 cryptographic hash algorithm.
3400 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003401 * Module: library/sha1.c
3402 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003403 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003404 * library/ssl_srv.c
3405 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003406 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003407 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003408 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3409 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003410 *
3411 * \warning SHA-1 is considered a weak message digest and its use constitutes
3412 * a security risk. If possible, we recommend avoiding dependencies
3413 * on it, and considering stronger message digests instead.
3414 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003417
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003420 *
3421 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3422 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003423 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003424 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003425 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003426 * library/ssl_cli.c
3427 * library/ssl_srv.c
3428 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 *
3430 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003431 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003434
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003437 *
3438 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3439 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003440 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003441 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003442 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003443 * library/ssl_cli.c
3444 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003445 *
3446 * This module adds support for SHA-384 and SHA-512.
3447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003449
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003452 *
3453 * Enable simple SSL cache implementation.
3454 *
3455 * Module: library/ssl_cache.c
3456 * Caller:
3457 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003461
3462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003464 *
3465 * Enable basic implementation of DTLS cookies for hello verification.
3466 *
3467 * Module: library/ssl_cookie.c
3468 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003471
3472/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003473 * \def MBEDTLS_SSL_TICKET_C
3474 *
3475 * Enable an implementation of TLS server-side callbacks for session tickets.
3476 *
3477 * Module: library/ssl_ticket.c
3478 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003479 *
Przemek Stekiel97d57402022-10-10 14:08:51 +02003480 * Requires: MBEDTLS_CIPHER_C &&
3481 * ( MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C )
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003482 */
3483#define MBEDTLS_SSL_TICKET_C
3484
3485/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003486 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003487 *
3488 * Enable the SSL/TLS client code.
3489 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003490 * Module: library/ssl_cli.c
3491 * Caller:
3492 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003494 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003495 * This module is required for SSL/TLS client support.
3496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003498
Paul Bakker9a736322012-11-14 12:39:52 +00003499/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003500 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003501 *
3502 * Enable the SSL/TLS server code.
3503 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003504 * Module: library/ssl_srv.c
3505 * Caller:
3506 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003508 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003509 * This module is required for SSL/TLS server support.
3510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003512
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003515 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003516 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003517 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003518 * Module: library/ssl_tls.c
3519 * Caller: library/ssl_cli.c
3520 * library/ssl_srv.c
3521 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3523 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003524 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003525 * This module is required for SSL/TLS.
3526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003528
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003530 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003531 *
3532 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003533 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003534 * contexts are not shared between threads. If you do intend to use contexts
3535 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003536 * conditions. See also our Knowledge Base article about threading:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003537 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003538 *
3539 * Module: library/threading.c
3540 *
3541 * This allows different threading implementations (self-implemented or
3542 * provided).
3543 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * You will have to enable either MBEDTLS_THREADING_ALT or
3545 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003546 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003547 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003550
3551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003553 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003554 * Enable the semi-portable timing interface.
3555 *
Simon Butcherd567a232016-03-09 20:19:21 +00003556 * \note The provided implementation only works on POSIX/Unix (including Linux,
3557 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003558 * module and provide your own implementations of the callbacks needed by
3559 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3560 * your own implementation of the whole module by setting
3561 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003562 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -04003563 * \note The timing module will include time.h on suitable platforms
3564 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3565 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3566 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003567 * \note See also our Knowledge Base article about porting to a new
3568 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003569 * 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 +00003570 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003571 * Module: library/timing.c
3572 * Caller: library/havege.c
3573 *
3574 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003577
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003578/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003580 *
3581 * Enable run-time version information.
3582 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003583 * Module: library/version.c
3584 *
3585 * This module provides run-time version information.
3586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003588
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003591 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003592 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003593 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003594 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003595 * Caller: library/x509_crl.c
3596 * library/x509_crt.c
3597 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003598 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3600 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003601 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003605
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003608 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003609 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003610 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003611 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003612 * Caller: library/ssl_cli.c
3613 * library/ssl_srv.c
3614 * library/ssl_tls.c
3615 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617 *
3618 * This module is required for X.509 certificate parsing.
3619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003621
3622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003623 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003624 *
3625 * Enable X.509 CRL parsing.
3626 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003627 * Module: library/x509_crl.c
3628 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003629 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003631 *
3632 * This module is required for X.509 CRL parsing.
3633 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003635
3636/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003637 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003638 *
3639 * Enable X.509 Certificate Signing Request (CSR) parsing.
3640 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003641 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003642 * Caller: library/x509_crt_write.c
3643 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003644 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003645 *
3646 * This module is used for reading X.509 certificate request.
3647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003648#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003649
3650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003652 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003653 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003654 *
3655 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003656 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003657 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003658 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003659 * This module is the basis for creating X.509 certificates and CSRs.
3660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003661#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003662
3663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003664 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003665 *
3666 * Enable creating X.509 certificates.
3667 *
3668 * Module: library/x509_crt_write.c
3669 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003670 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003671 *
3672 * This module is required for X.509 certificate creation.
3673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003675
3676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003677 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003678 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003679 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003680 *
3681 * Module: library/x509_csr_write.c
3682 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003683 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003684 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003685 * This module is required for X.509 certificate request writing.
3686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003687#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003688
3689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003690 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003691 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003692 * Enable the XTEA block cipher.
3693 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003694 * Module: library/xtea.c
3695 * Caller:
3696 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003697#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003698
Andrzej Kurek73afe272022-01-24 10:31:06 -05003699/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003700
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003701/**
Gilles Peskine86198d72022-04-11 17:04:38 +02003702 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003703 *
Gilles Peskine72665262022-04-13 23:05:10 +02003704 * This section contains Mbed TLS build settings that are not associated
3705 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003706 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003707 * \{
3708 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003709
Gilles Peskine781f7342022-03-16 17:03:19 +01003710/**
3711 * \def MBEDTLS_CONFIG_FILE
3712 *
3713 * If defined, this is a header which will be included instead of
Gilles Peskine82909762022-04-26 18:10:11 +02003714 * `"mbedtls/config.h"`.
Gilles Peskine781f7342022-03-16 17:03:19 +01003715 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskine238f9762022-04-26 18:13:01 +02003716 * Unlike other configuration options, this one must be defined on the
3717 * compiler command line: a definition in `config.h` would have no effect.
Gilles Peskine781f7342022-03-16 17:03:19 +01003718 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003719 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003720 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003721 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003722 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003723 * The value of this symbol is typically a path in double quotes, either
3724 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003725 */
Gilles Peskine82909762022-04-26 18:10:11 +02003726//#define MBEDTLS_CONFIG_FILE "mbedtls/config.h"
Gilles Peskine781f7342022-03-16 17:03:19 +01003727
3728/**
3729 * \def MBEDTLS_USER_CONFIG_FILE
3730 *
3731 * If defined, this is a header which will be included after
Gilles Peskine82909762022-04-26 18:10:11 +02003732 * `"mbedtls/config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003733 * This allows you to modify the default configuration, including the ability
3734 * to undefine options that are enabled by default.
Gilles Peskine781f7342022-03-16 17:03:19 +01003735 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003736 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003737 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003738 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003739 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003740 * The value of this symbol is typically a path in double quotes, either
3741 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003742 */
3743//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3744
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003745/**
3746 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3747 *
3748 * If defined, this is a header which will be included instead of
3749 * `"psa/crypto_config.h"`.
3750 * This header file specifies which cryptographic mechanisms are available
3751 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3752 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3753 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003754 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003755 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003756 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003757 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003758 * The value of this symbol is typically a path in double quotes, either
3759 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003760 */
3761//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3762
3763/**
3764 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3765 *
3766 * If defined, this is a header which will be included after
3767 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003768 * This allows you to modify the default configuration, including the ability
3769 * to undefine options that are enabled by default.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003770 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003771 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003772 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003773 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003774 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003775 * The value of this symbol is typically a path in double quotes, either
3776 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003777 */
3778//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3779
Gilles Peskine86198d72022-04-11 17:04:38 +02003780/** \} name SECTION: General configuration options */
3781
3782/**
3783 * \name SECTION: Module configuration options
3784 *
3785 * This section allows for the setting of module specific sizes and
3786 * configuration options. The default values are already present in the
3787 * relevant header files and should suffice for the regular use cases.
3788 *
3789 * Our advice is to enable options and change their values here
3790 * only if you have a good reason and know the consequences.
Gilles Peskine86198d72022-04-11 17:04:38 +02003791 * \{
3792 */
Gilles Peskine25496d02022-04-13 23:21:16 +02003793/* The Doxygen documentation here is used when a user comments out a
3794 * setting and runs doxygen themselves. On the other hand, when we typeset
3795 * the full documentation including disabled settings, the documentation
3796 * in specific modules' header files is used if present. When editing this
3797 * file, make sure that each option is documented in exactly one place,
3798 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3799 * comment in the specific module. */
Gilles Peskine86198d72022-04-11 17:04:38 +02003800
Paul Bakker088c5c52014-04-25 11:11:10 +02003801/* MPI / BIGNUM options */
Andrzej Kurek6e9385b2023-02-24 07:44:57 -05003802//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003803//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003804
Paul Bakker088c5c52014-04-25 11:11:10 +02003805/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3807//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3808//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3809//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3810//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003811
Paul Bakker088c5c52014-04-25 11:11:10 +02003812/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3814//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3815//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3816//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003817
Paul Bakker088c5c52014-04-25 11:11:10 +02003818/* ECP options */
Gilles Peskine33c92f02021-06-02 23:34:02 +02003819//#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 +02003820//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003821//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003822
Paul Bakker088c5c52014-04-25 11:11:10 +02003823/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003824//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3825//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003826//#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 +01003827
Paul Bakker088c5c52014-04-25 11:11:10 +02003828/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003830
Paul Bakker088c5c52014-04-25 11:11:10 +02003831/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003832//#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 -04003833
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003834/** \def MBEDTLS_PLATFORM_STD_CALLOC
3835 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -04003836 * Default allocator to use, can be undefined.
Andrzej Kurekba168592023-07-14 09:56:02 -04003837 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003838 * The size of the buffer is the product of the two parameters.
Andrzej Kurekba168592023-07-14 09:56:02 -04003839 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003840 * 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 -04003841 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3842 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekba168592023-07-14 09:56:02 -04003843 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003844 */
3845//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek33b12222023-07-14 10:14:29 -04003846
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003847/** \def MBEDTLS_PLATFORM_STD_FREE
3848 *
Andrzej Kurek3f87d632023-07-14 10:22:34 -04003849 * Default free to use, can be undefined.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003850 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekba168592023-07-14 09:56:02 -04003851 * 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 -04003852 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3853 * 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 -04003854 */
3855//#define MBEDTLS_PLATFORM_STD_FREE free
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003856//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003857//#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 +02003858//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3859//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003860/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003861//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003862//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3863//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003864//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3865//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3866//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003867
Andrzej Kurekba168592023-07-14 09:56:02 -04003868/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003869/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003870//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3871//#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 +02003872//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003873//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3874//#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 +02003875//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3876//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003877/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003879//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003880//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3881//#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 +02003882
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003883/**
3884 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003885 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003886 * (see the documentation of that option for context).
3887 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003888 * When you leave this undefined here, the library provides
3889 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3890 * is defined, the default definition is `assert(cond)`,
3891 * otherwise the default definition calls a function
3892 * mbedtls_param_failed(). This function is declared in
3893 * `platform_util.h` for the benefit of the library, but
3894 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003895 *
3896 * When you define this here, this replaces the default
3897 * definition in platform_util.h (which no longer declares the
3898 * function mbedtls_param_failed()) and it is your responsibility
3899 * to make sure this macro expands to something suitable (in
3900 * particular, that all the necessary declarations are visible
3901 * from within the library - you can ensure that by providing
3902 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003903 * If you define this macro to call `assert`, also define
3904 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3905 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003906 *
3907 * Note that you may define this macro to expand to nothing, in
3908 * which case you don't have to worry about declarations or
3909 * definitions. However, you will then be notified about invalid
3910 * parameters only in non-void functions, and void function will
3911 * just silently return early on invalid parameters, which
3912 * partially negates the benefits of enabling
3913 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3914 *
3915 * \param cond The expression that should evaluate to true, but doesn't.
3916 */
3917//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3918
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003919/** \def MBEDTLS_CHECK_RETURN
3920 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003921 * This macro is used at the beginning of the declaration of a function
3922 * to indicate that its return value should be checked. It should
3923 * instruct the compiler to emit a warning or an error if the function
3924 * is called without checking its return value.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003925 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003926 * There is a default implementation for popular compilers in platform_util.h.
3927 * You can override the default implementation by defining your own here.
3928 *
3929 * If the implementation here is empty, this will effectively disable the
3930 * checking of functions' return values.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003931 */
Gilles Peskine91108092021-09-30 18:53:36 +02003932//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003933
Gilles Peskinec2779322021-09-30 18:56:17 +02003934/** \def MBEDTLS_IGNORE_RETURN
3935 *
3936 * This macro requires one argument, which should be a C function call.
3937 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3938 * warning is suppressed.
3939 */
3940//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3941
Gilles Peskineed038902020-11-13 21:33:21 +01003942/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003943/**
Gilles Peskineed038902020-11-13 21:33:21 +01003944 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3945 * PSA crypto subsystem.
3946 *
3947 * If this option is unset:
3948 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003949 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003950 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3951 * on unspecified heuristics.
3952 */
3953//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3954
Steven Cooreman863470a2021-02-15 14:03:19 +01003955/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003956 * Restrict the PSA library to supporting a maximum amount of simultaneously
3957 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3958 * volatile key, or a persistent key which is loaded temporarily by the
3959 * library as part of a crypto operation in flight.
3960 *
3961 * If this option is unset, the library will fall back to a default value of
3962 * 32 keys.
3963 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003964//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003965
Paul Bakker088c5c52014-04-25 11:11:10 +02003966/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003967//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3968//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003969
Paul Bakker088c5c52014-04-25 11:11:10 +02003970/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003971
3972/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3973 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003974 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003975 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003976 * This determines the size of both the incoming and outgoing TLS I/O buffers
3977 * in such a way that both are capable of holding the specified amount of
3978 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003979 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003980 * To configure incoming and outgoing I/O buffers separately, use
3981 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3982 * which overwrite the value set by this option.
3983 *
3984 * \note When using a value less than the default of 16KB on the client, it is
3985 * recommended to use the Maximum Fragment Length (MFL) extension to
3986 * inform the server about this limitation. On the server, there
3987 * is no supported, standardized way of informing the client about
3988 * restriction on the maximum size of incoming messages, and unless
3989 * the limitation has been communicated by other means, it is recommended
3990 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3991 * while keeping the default value of 16KB for the incoming buffer.
3992 *
3993 * Uncomment to set the maximum plaintext size of both
3994 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003995 */
3996//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3997
3998/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3999 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004000 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004001 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004002 * This determines the size of the incoming TLS I/O buffer in such a way
4003 * that it is capable of holding the specified amount of plaintext data,
4004 * regardless of the protection mechanism used.
4005 *
4006 * If this option is undefined, it inherits its value from
4007 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
4008 *
4009 * \note When using a value less than the default of 16KB on the client, it is
4010 * recommended to use the Maximum Fragment Length (MFL) extension to
4011 * inform the server about this limitation. On the server, there
4012 * is no supported, standardized way of informing the client about
4013 * restriction on the maximum size of incoming messages, and unless
4014 * the limitation has been communicated by other means, it is recommended
4015 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4016 * while keeping the default value of 16KB for the incoming buffer.
4017 *
4018 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
4019 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004020 */
4021//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4022
Gilles Peskined3d02902020-03-04 21:35:27 +01004023/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4024 *
4025 * The maximum length of CIDs used for incoming DTLS messages.
4026 *
4027 */
4028//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4029
4030/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4031 *
4032 * The maximum length of CIDs used for outgoing DTLS messages.
4033 *
4034 */
4035//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4036
4037/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
4038 *
4039 * This option controls the use of record plaintext padding
4040 * when using the Connection ID extension in DTLS 1.2.
4041 *
4042 * The padding will always be chosen so that the length of the
4043 * padded plaintext is a multiple of the value of this option.
4044 *
4045 * Note: A value of \c 1 means that no padding will be used
4046 * for outgoing records.
4047 *
4048 * Note: On systems lacking division instructions,
4049 * a power of two should be preferred.
4050 *
4051 */
4052//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
4053
Hanno Beckerceef8482020-06-02 06:16:00 +01004054/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01004055 *
4056 * This option controls the use of record plaintext padding
4057 * in TLS 1.3.
4058 *
4059 * The padding will always be chosen so that the length of the
4060 * padded plaintext is a multiple of the value of this option.
4061 *
4062 * Note: A value of \c 1 means that no padding will be used
4063 * for outgoing records.
4064 *
4065 * Note: On systems lacking division instructions,
4066 * a power of two should be preferred.
4067 */
Hanno Beckerceef8482020-06-02 06:16:00 +01004068//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01004069
Angus Grattond8213d02016-05-25 20:56:48 +10004070/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4071 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004072 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004073 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004074 * This determines the size of the outgoing 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 undefined, it inherits its value from
4079 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10004080 *
4081 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4082 * the default inward 16384 byte buffer to conform to the TLS specification.
4083 *
4084 * The minimum required outward buffer size is determined by the handshake
4085 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4086 * The specific size requirement depends on the configured ciphers and any
4087 * certificate data which is sent during the handshake.
4088 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004089 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
4090 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004091 */
4092//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4093
Hanno Beckere0b150f2018-08-21 15:51:03 +01004094/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4095 *
4096 * Maximum number of heap-allocated bytes for the purpose of
4097 * DTLS handshake message reassembly and future message buffering.
4098 *
Yuto Takano5b4caf22021-08-10 11:26:15 +01004099 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004100 * to account for a reassembled handshake message of maximum size,
4101 * together with its reassembly bitmap.
4102 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004103 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004104 * should be sufficient for all practical situations as it allows
4105 * to reassembly a large handshake message (such as a certificate)
4106 * while buffering multiple smaller handshake messages.
4107 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004108 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004109//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004111//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
4112//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
4113//#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 +02004114
Gilles Peskine065a1c82021-04-24 13:35:41 +02004115/** \def MBEDTLS_TLS_EXT_CID
4116 *
4117 * At the time of writing, the CID extension has not been assigned its
4118 * final value. Set this configuration option to make Mbed TLS use a
4119 * different value.
4120 *
4121 * A future minor revision of Mbed TLS may change the default value of
4122 * this option to match evolving standards and usage.
4123 */
4124//#define MBEDTLS_TLS_EXT_CID 254
4125
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004126/**
4127 * Complete list of ciphersuites to use, in order of preference.
4128 *
4129 * \warning No dependency checking is done on that field! This option can only
4130 * be used to restrict the set of available ciphersuites. It is your
4131 * responsibility to make sure the needed modules are active.
4132 *
4133 * Use this to save a few hundred bytes of ROM (default ordering of all
4134 * available ciphersuites) and a few to a few hundred bytes of RAM.
4135 *
4136 * The value below is only an example, not the default.
4137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004138//#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 +02004139
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004140/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004141//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004142//#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 +01004143
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004144/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004145 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
4146 * signature and ciphersuite selection. Without this build-time option, SHA-1
4147 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
4148 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
4149 * default. At the time of writing, there is no practical attack on the use
4150 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01004151 * to preserve compatibility with existing peers, but the general
4152 * warning applies nonetheless:
4153 *
4154 * \warning SHA-1 is considered a weak message digest and its use constitutes
4155 * a security risk. If possible, we recommend avoiding dependencies
4156 * on it, and considering stronger message digests instead.
4157 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004158 */
Mateusz Starzyk7d135392021-08-27 15:36:47 +02004159//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004160
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004161/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004162 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004163 * mbedtls_platform_zeroize(). This replaces the default implementation in
4164 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00004165 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004166 * mbedtls_platform_zeroize() is a widely used function across the library to
4167 * zero a block of memory. The implementation is expected to be secure in the
4168 * sense that it has been written to prevent the compiler from removing calls
4169 * to mbedtls_platform_zeroize() as part of redundant code elimination
4170 * optimizations. However, it is difficult to guarantee that calls to
4171 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
4172 * versions of the C language standards do not provide a secure implementation
4173 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
4174 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05004175 * example by using directives specific to their compiler, features from newer
4176 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004177 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004178 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004179//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004180
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004181/**
4182 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01004183 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004184 * platform_util.c.
4185 *
Hanno Becker921b76d2018-09-05 16:21:36 +01004186 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004187 * library will try to use safer implementations of this function, such as
4188 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01004189 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004190 * using the standard gmtime(). In this case, calls from the library to
4191 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01004192 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004193 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01004194 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
4195 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
4196 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004197 */
Hanno Becker6a739782018-09-05 15:06:19 +01004198//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004199
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00004200/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00004201 * Enable the verified implementations of ECDH primitives from Project Everest
4202 * (currently only Curve25519). This feature changes the layout of ECDH
4203 * contexts and therefore is a compatibility break for applications that access
4204 * fields of a mbedtls_ecdh_context structure directly. See also
4205 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004206 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00004207//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004208
Gilles Peskine1341e212022-04-13 23:04:48 +02004209/** \} name SECTION: Module configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02004210
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004211/* Target and application specific configurations
4212 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004213 * Allow user to override any previous default.
4214 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004215 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004216#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004217#include MBEDTLS_USER_CONFIG_FILE
4218#endif
4219
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004220#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07004221#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004222#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07004223
Jaeden Amero6609aef2019-07-04 20:01:14 +01004224#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01004225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004226#endif /* MBEDTLS_CONFIG_H */