blob: 6714db33fcc452e131799ab34b4cd9049a7f15db [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
Chris Jones4c5819c2021-03-03 17:45:34 +000051 * library/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000052 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010053 * Required by:
54 * MBEDTLS_AESNI_C
55 * 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 *
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 * Comment if your system does not support time functions
132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100134
135/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200136 * \def MBEDTLS_HAVE_TIME_DATE
137 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100138 * System has time.h, time(), and an implementation for
139 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100140 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200141 * the date should be correct). This is used to verify the validity period of
142 * X.509 certificates.
143 *
144 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100145 *
Hanno Becker6a739782018-09-05 15:06:19 +0100146 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100147 * behaves similarly to the gmtime_r() function from the C standard. Refer to
148 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100149 *
150 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100151 * mbedtls_platform_gmtime_r() at compile-time by using the macro
152 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200153 */
154#define MBEDTLS_HAVE_TIME_DATE
155
156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 *
159 * Enable the memory allocation layer.
160 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200161 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100162 * This allows different allocators (self-implemented or provided) to be
163 * provided to the platform abstraction layer.
164 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200166 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
167 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * free() function pointer at runtime.
169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000172 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100175 *
176 * Enable this layer to allow use of alternative memory allocators.
177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179
180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200182 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200183 * Do not assign standard functions in the platform layer (e.g. calloc() to
184 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200185 *
186 * This makes sure there are no linking errors on platforms that do not support
187 * these functions. You will HAVE to provide alternatives, either at runtime
188 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
190 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200193 *
194 * Uncomment to prevent default assignment of standard functions in the
195 * platform layer.
196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200198
199/**
Janos Follathc351d182016-03-21 08:43:59 +0000200 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100201 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100202 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
203 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100204 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
206 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 * alternative printf function pointer.
208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200211 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
212 * it will be enabled automatically by check_config.h
213 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200214 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000216 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100217 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
218 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100219 * Uncomment a macro to enable alternate implementation of specific base
220 * platform function
221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100223//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224//#define MBEDTLS_PLATFORM_FPRINTF_ALT
225//#define MBEDTLS_PLATFORM_PRINTF_ALT
226//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200227//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100228//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100229//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100230
231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100233 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000234 * Mark deprecated functions and features so that they generate a warning if
235 * used. Functionality deprecated in one version will usually be removed in the
236 * next version. You can enable this to help you prepare the transition to a
237 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100238 *
239 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100241 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000242 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245
246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000249 * Remove deprecated functions and features so that they generate an error if
250 * used. Functionality deprecated in one version will usually be removed in the
251 * next version. You can enable this to help you prepare the transition to a
252 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100257
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500258/**
259 * \def MBEDTLS_CHECK_PARAMS
260 *
261 * This configuration option controls whether the library validates more of
262 * the parameters passed to it.
263 *
264 * When this flag is not defined, the library only attempts to validate an
265 * input parameter if: (1) they may come from the outside world (such as the
266 * network, the filesystem, etc.) or (2) not validating them could result in
267 * internal memory errors such as overflowing a buffer controlled by the
268 * library. On the other hand, it doesn't attempt to validate parameters whose
269 * values are fully controlled by the application (such as pointers).
270 *
271 * When this flag is defined, the library additionally attempts to validate
272 * parameters that are fully controlled by the application, and should always
273 * be valid if the application code is fully correct and trusted.
274 *
275 * For example, when a function accepts as input a pointer to a buffer that may
276 * contain untrusted data, and its documentation mentions that this pointer
277 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200278 * - The pointer is checked to be non-NULL only if this option is enabled.
279 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500280 *
281 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200282 * is invalid:
283 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
284 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
285 * will immediately return. If the function returns an Mbed TLS error code,
286 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500287 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200288 * When defining this flag, you also need to arrange a definition for
289 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
290 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
291 * function mbedtls_param_failed(), but the library does not define this
292 * function. If you do not make any other arrangements, you must provide
293 * the function mbedtls_param_failed() in your application.
294 * See `platform_util.h` for its prototype.
295 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100296 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200297 * You can still supply an alternative definition of
298 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
299 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
300 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
301 * the library will call the macro that you defined and will not supply
302 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
303 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
304 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500305 *
306 * Uncomment to enable validation of application-controlled parameters.
307 */
308//#define MBEDTLS_CHECK_PARAMS
309
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200310/**
311 * \def MBEDTLS_CHECK_PARAMS_ASSERT
312 *
313 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
314 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
315 *
316 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
317 * calling a function mbedtls_param_failed(). See the documentation of
318 * #MBEDTLS_CHECK_PARAMS for details.
319 *
320 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
321 */
322//#define MBEDTLS_CHECK_PARAMS_ASSERT
323
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200324/* \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000325
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000326/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000327 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000328 *
329 * This section sets support for features that are or are not needed
330 * within the modules that are enabled.
331 * \{
332 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000333
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200335 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100336 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200338 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100339 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100341 *
342 * You will need to provide a header "timing_alt.h" and an implementation at
343 * compile time.
344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100346
347/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100348 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200349 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100350 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100351 * alternate core implementation of a symmetric crypto, an arithmetic or hash
352 * module (e.g. platform specific assembly optimized implementations). Keep
353 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200354 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200355 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000359 * provide the "struct mbedtls_aes_context" definition and omit the base
360 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200361 * "aes.h" to include the new function definitions.
362 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 * Uncomment a macro to enable alternate implementation of the corresponding
364 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100365 *
366 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
367 * use constitutes a security risk. If possible, we recommend
368 * avoiding dependencies on them, and considering stronger message
369 * digests and ciphers instead.
370 *
Paul Bakker90995b52013-06-24 19:20:35 +0200371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372//#define MBEDTLS_AES_ALT
373//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000374//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375//#define MBEDTLS_BLOWFISH_ALT
376//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200377//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300378//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200379//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200380//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000382//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000383//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100384//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300385//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_MD2_ALT
387//#define MBEDTLS_MD4_ALT
388//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300389//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000391//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_SHA1_ALT
393//#define MBEDTLS_SHA256_ALT
394//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000395//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000396
Janos Follathb0697532016-08-18 12:38:46 +0100397/*
398 * When replacing the elliptic curve module, pleace consider, that it is
399 * implemented with two .c files:
400 * - ecp.c
401 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000402 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
403 * macros as described above. The only difference is that you have to make sure
404 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100405 */
406//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200407
408/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100409 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200410 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100411 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
412 * alternate core implementation of symmetric crypto or hash function. Keep in
413 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200414 *
415 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200417 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
419 * no longer provide the mbedtls_sha1_process() function, but it will still provide
420 * the other function (using your mbedtls_sha1_process() function) and the definition
421 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200422 * with this definition.
423 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100424 * \note If you use the AES_xxx_ALT macros, then is is recommended to also set
425 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
426 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200427 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200428 * Uncomment a macro to enable alternate implementation of the corresponding
429 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100430 *
431 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
432 * constitutes a security risk. If possible, we recommend avoiding
433 * dependencies on them, and considering stronger message digests
434 * and ciphers instead.
435 *
Janos Follath1231d212019-01-07 15:01:32 +0000436 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
437 * enabled, then the deterministic ECDH signature functions pass the
438 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
439 * alternative implementations should use the RNG only for generating
440 * the ephemeral key and nothing else. If this is not possible, then
441 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200442 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000443 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_MD2_PROCESS_ALT
446//#define MBEDTLS_MD4_PROCESS_ALT
447//#define MBEDTLS_MD5_PROCESS_ALT
448//#define MBEDTLS_RIPEMD160_PROCESS_ALT
449//#define MBEDTLS_SHA1_PROCESS_ALT
450//#define MBEDTLS_SHA256_PROCESS_ALT
451//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200452//#define MBEDTLS_DES_SETKEY_ALT
453//#define MBEDTLS_DES_CRYPT_ECB_ALT
454//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200455//#define MBEDTLS_AES_SETKEY_ENC_ALT
456//#define MBEDTLS_AES_SETKEY_DEC_ALT
457//#define MBEDTLS_AES_ENCRYPT_ALT
458//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300459//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300460//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300461//#define MBEDTLS_ECDSA_VERIFY_ALT
462//#define MBEDTLS_ECDSA_SIGN_ALT
463//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200464
465/**
Janos Follathc44ab972016-11-18 16:38:23 +0000466 * \def MBEDTLS_ECP_INTERNAL_ALT
467 *
468 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100469 *
470 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100471 * alternative core implementation of elliptic curve arithmetic. Keep in mind
472 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100473 *
474 * This partially replaces one function. The header file from mbed TLS is still
475 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
476 * is still present and it is used for group structures not supported by the
477 * alternative.
478 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100479 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100480 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100481 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
482 * able to fallback to curves not supported by the alternative implementation.
483 *
Janos Follathc44ab972016-11-18 16:38:23 +0000484 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
485 * and implementing the following functions:
486 * unsigned char mbedtls_internal_ecp_grp_capable(
487 * const mbedtls_ecp_group *grp )
488 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500489 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000490 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
491 * replacement functions implement arithmetic for the given group and 0
492 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500493 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000494 * called before and after each point operation and provide an opportunity to
495 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100496 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100497 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
498 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
499 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
500 * for the operation is supported by your implementation (i.e. your
501 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
502 * group is not supported by your implementation, then the original mbed TLS
503 * implementation of ecp_double_jac() is used instead, unless this fallback
504 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
505 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
506 *
507 * The function prototypes and the definition of mbedtls_ecp_group and
508 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
509 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
510 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100511 *
512 * Uncomment a macro to enable alternate implementation of the corresponding
513 * function.
514 */
515/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000516//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100517/* Turn off software fallback for curves not supported in hardware */
518//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100519/* Support for Weierstrass curves with Jacobi representation */
520//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
521//#define MBEDTLS_ECP_ADD_MIXED_ALT
522//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
523//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
524//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
525/* Support for curves with Montgomery arithmetic */
526//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
527//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
528//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
529
530/**
Simon Butcherab5df402016-06-11 02:31:21 +0100531 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100532 *
Simon Butcherab5df402016-06-11 02:31:21 +0100533 * Enables testing and use of mbed TLS without any configured entropy sources.
534 * This permits use of the library on platforms before an entropy source has
535 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
536 * MBEDTLS_ENTROPY_NV_SEED switches).
537 *
538 * WARNING! This switch MUST be disabled in production builds, and is suitable
539 * only for development.
540 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100541 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100542 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
543 *
Janos Follath53de7842016-06-08 15:29:18 +0100544 */
Simon Butcherab5df402016-06-11 02:31:21 +0100545//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100546
547/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200548 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200549 *
550 * Uncomment this macro to let mbed TLS use your own implementation of a
551 * hardware entropy collector.
552 *
553 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000554 * prototype as declared in library/entropy_poll.h, and accept NULL as first
555 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200556 *
557 * Uncomment to use your own hardware entropy collector.
558 */
559//#define MBEDTLS_ENTROPY_HARDWARE_ALT
560
561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200562 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000563 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100564 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000565 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100566 * Uncomment this macro to use precomputed AES tables stored in ROM.
567 * Comment this macro to generate AES tables in RAM at runtime.
568 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100569 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
570 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100571 * initialization time before the first AES operation can be performed.
572 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
573 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
574 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100575 *
576 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
577 *
Paul Bakker15566e42011-04-24 21:19:15 +0000578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000580
581/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100582 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200583 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100584 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200585 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100586 * Uncommenting this macro omits 75% of the AES tables from
587 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
588 * by computing their values on the fly during operations
589 * (the tables are entry-wise rotations of one another).
590 *
591 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100592 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100593 * runtime. Specifically, one has to compare 4 accesses within
594 * different tables to 4 accesses with additional arithmetic
595 * operations within the same table. The performance gain/loss
596 * depends on the system and memory details.
597 *
598 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
599 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200600 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100601//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200602
603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200605 *
606 * Use less ROM for the Camellia implementation (saves about 768 bytes).
607 *
608 * Uncomment this macro to use less memory for Camellia.
609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200611
612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200614 *
615 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200618
619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000621 *
622 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000625
626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000628 *
629 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000632
633/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100634 * \def MBEDTLS_CIPHER_MODE_OFB
635 *
636 * Enable Output Feedback mode (OFB) for symmetric ciphers.
637 */
638#define MBEDTLS_CIPHER_MODE_OFB
639
640/**
641 * \def MBEDTLS_CIPHER_MODE_XTS
642 *
643 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
644 */
645#define MBEDTLS_CIPHER_MODE_XTS
646
647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000649 *
650 * Enable NULL cipher.
651 * Warning: Only do so when you know what you are doing. This allows for
652 * encryption or channels without any security!
653 *
Ronald Croncee42702021-04-26 11:34:44 +0200654 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
656 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
657 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
658 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
659 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
660 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
661 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
662 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
663 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
664 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
665 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
666 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
667 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
668 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
669 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
670 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
671 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
672 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
673 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000674 *
675 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000678
679/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100680 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200681 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100682 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
683 * specific padding modes in the cipher layer with cipher modes that support
684 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200685 *
686 * If you disable all padding modes, only full blocks can be used with CBC.
687 *
688 * Enable padding modes in the cipher layer.
689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200690#define MBEDTLS_CIPHER_PADDING_PKCS7
691#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
692#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
693#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200694
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200695/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
696 *
697 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
698 * By default, CTR_DRBG uses a 256-bit key.
699 */
700//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
701
Paul Bakker48e93c82013-08-14 12:21:18 +0200702/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000703 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
704 *
705 * Remove 3DES ciphersuites by default in SSL / TLS.
706 * This flag removes the ciphersuites based on 3DES from the default list as
707 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
708 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
709 * them explicitly.
710 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000711 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000712 * a TLS connection using a 3DES based cipher suite (see "On the Practical
713 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
714 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
715 * in your threat model or you are unsure, then you should keep this option
716 * enabled to remove 3DES based cipher suites.
717 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000718 * Comment this macro to keep 3DES in the default ciphersuite list.
719 */
720#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
721
722/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100723 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200724 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100725 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
726 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200727 *
728 * Comment macros to disable the curve and functions for it
729 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200730/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200731#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
732#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
733#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
734#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
735#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
736#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
737#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
738#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
739#define MBEDTLS_ECP_DP_BP256R1_ENABLED
740#define MBEDTLS_ECP_DP_BP384R1_ENABLED
741#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200742/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200743#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000744#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200745
746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200748 *
749 * Enable specific 'modulo p' routines for each NIST prime.
750 * Depending on the prime and architecture, makes operations 4 to 8 times
751 * faster on the corresponding curve.
752 *
753 * Comment this macro to disable NIST curves optimisation.
754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200756
757/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200758 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
759 *
760 * When this option is disabled, mbedtls_ecp_mul() will make use of an
761 * internal RNG when called with a NULL \c f_rng argument, in order to protect
762 * against some side-channel attacks.
763 *
764 * This protection introduces a dependency of the ECP module on one of the
765 * DRBG modules. For very constrained implementations that don't require this
766 * protection (for example, because you're only doing signature verification,
767 * so not manipulating any secret, or because local/physical side-channel
768 * attacks are outside your threat model), it might be desirable to get rid of
769 * that dependency.
770 *
771 * \warning Enabling this option makes some uses of ECP vulnerable to some
772 * side-channel attacks. Only enable it if you know that's not a problem for
773 * your use case.
774 *
775 * Uncomment this macro to disable some counter-measures in ECP.
776 */
777//#define MBEDTLS_ECP_NO_INTERNAL_RNG
778
779/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200780 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100781 *
782 * Enable "non-blocking" ECC operations that can return early and be resumed.
783 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200784 * This allows various functions to pause by returning
785 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
786 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
787 * order to further progress and eventually complete their operation. This is
788 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
789 * number of ECC operations a function may perform before pausing; see
790 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100791 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200792 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200793 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100794 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200795 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200796 *
Ron Eldor19779c42018-11-05 16:58:13 +0200797 * \note This option only works with the default software implementation of
798 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100799 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
800 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100801 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200802//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100803
804/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100805 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
806 *
807 * Use a backward compatible ECDH context.
808 *
809 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
810 * defined in `ecdh.h`). For most applications, the choice of format makes
811 * no difference, since all library functions can work with either format,
812 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
813
814 * The new format used when this option is disabled is smaller
815 * (56 bytes on a 32-bit platform). In future versions of the library, it
816 * will support alternative implementations of ECDH operations.
817 * The new format is incompatible with applications that access
818 * context fields directly and with restartable ECP operations.
819 *
820 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
821 * want to access ECDH context fields directly. Otherwise you should
822 * comment out this macro definition.
823 *
824 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
825 *
826 * \note This configuration option is experimental. Future versions of the
827 * library may modify the way the ECDH context layout is configured
828 * and may modify the layout of the new context type.
829 */
830#define MBEDTLS_ECDH_LEGACY_CONTEXT
831
832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100834 *
835 * Enable deterministic ECDSA (RFC 6979).
836 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
837 * may result in a compromise of the long-term signing key. This is avoided by
838 * the deterministic variant.
839 *
John Durkop36a82e52020-10-26 09:39:05 -0700840 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100841 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100842 * Comment this macro to disable deterministic ECDSA.
843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100845
846/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200848 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200849 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200850 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200851 * This enables the following ciphersuites (if other requisites are
852 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
854 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
855 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
856 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
857 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
858 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
859 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
860 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
861 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
862 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
863 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200864 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200866
867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200870 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200873 *
874 * This enables the following ciphersuites (if other requisites are
875 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
877 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
878 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
879 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
880 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
881 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
882 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
883 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
884 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
885 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
886 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100887 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100888 * \warning Using DHE constitutes a security risk as it
889 * is not possible to validate custom DH parameters.
890 * If possible, it is recommended users should consider
891 * preferring other methods of key exchange.
892 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100893 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896
897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200899 *
900 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
901 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200903 *
904 * This enables the following ciphersuites (if other requisites are
905 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
907 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
908 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
909 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
910 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
911 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
912 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200913 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200915
916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200919 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200920 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
922 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200923 *
924 * This enables the following ciphersuites (if other requisites are
925 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
927 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
928 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
929 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
930 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
931 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
932 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
933 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
934 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
935 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
936 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200939
940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200942 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200943 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200944 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
946 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200947 *
948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
951 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
952 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
953 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
954 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
955 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
956 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
957 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
958 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
959 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
960 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
961 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
962 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200965
966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200968 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200969 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200970 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
972 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200973 *
974 * This enables the following ciphersuites (if other requisites are
975 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
977 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
978 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
979 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
980 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
981 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
982 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
983 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
984 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
985 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
986 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
987 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
988 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100989 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100990 * \warning Using DHE constitutes a security risk as it
991 * is not possible to validate custom DH parameters.
992 * If possible, it is recommended users should consider
993 * preferring other methods of key exchange.
994 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100995 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001001 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001002 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1005 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001006 *
1007 * This enables the following ciphersuites (if other requisites are
1008 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1010 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1011 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1012 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1013 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1014 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1015 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1016 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1017 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1018 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1019 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_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_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001025 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001026 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001027 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +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_ECDSA_WITH_AES_256_GCM_SHA384
1033 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1034 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1035 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1036 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1037 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1038 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1039 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1040 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1041 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1042 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001048 *
1049 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1050 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001051 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001052 *
1053 * This enables the following ciphersuites (if other requisites are
1054 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1056 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1057 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1058 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1059 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1060 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1061 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1062 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1063 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1064 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1065 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001068
1069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001071 *
1072 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1073 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001074 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001075 *
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_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1079 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1080 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1081 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1082 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1083 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1084 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1085 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1086 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1087 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1088 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001091
1092/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001093 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1094 *
1095 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1096 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001097 * \warning This is currently experimental. EC J-PAKE support is based on the
1098 * Thread v1.0.0 specification; incompatible changes to the specification
1099 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001100 *
1101 * Requires: MBEDTLS_ECJPAKE_C
1102 * MBEDTLS_SHA256_C
1103 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1104 *
1105 * This enables the following ciphersuites (if other requisites are
1106 * enabled as well):
1107 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1108 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001109//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001110
1111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001113 *
1114 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1115 * RFC 5915 and RFC 5480.
1116 *
1117 * Currently this means parsing the SpecifiedECDomain choice of EC
1118 * parameters (only known groups are supported, not arbitrary domains, to
1119 * avoid validation issues).
1120 *
1121 * Disable if you only need to support RFC 5915 + 5480 key formats.
1122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001124
1125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001127 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * Enable a dummy error function to make use of mbedtls_strerror() in
1129 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1130 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001131 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1133 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001134 *
1135 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001139
1140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001142 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001143 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001144 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001148
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001151 *
1152 * Enable functions that use the filesystem.
1153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001155
1156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001158 *
Mateusz Starzyk0fdcc8e2021-01-29 16:46:31 +01001159 * Do not add default entropy sources. These are the platform specific
1160 * or mbedtls_timing_hardclock poll function.
Paul Bakker43655f42011-12-15 20:11:16 +00001161 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001162 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001163 * application.
1164 *
1165 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001168
1169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001171 *
1172 * Do not use built-in platform entropy functions.
1173 * This is useful if your platform does not support
1174 * standards like the /dev/urandom or Windows CryptoAPI.
1175 *
1176 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001179
1180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001182 *
1183 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1184 * default SHA-512 based one (if both are available).
1185 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001187 *
1188 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1189 * if you have performance concerns.
1190 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 * This option is only useful if both MBEDTLS_SHA256_C and
1192 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001195
1196/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001197 * \def MBEDTLS_ENTROPY_NV_SEED
1198 *
1199 * Enable the non-volatile (NV) seed file-based entropy source.
1200 * (Also enables the NV seed read/write functions in the platform layer)
1201 *
1202 * This is crucial (if not required) on systems that do not have a
1203 * cryptographic entropy source (in hardware or kernel) available.
1204 *
1205 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1206 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001207 * \note The read/write functions that are used by the entropy source are
1208 * determined in the platform layer, and can be modified at runtime and/or
1209 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1210 *
1211 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001212 * with regular fopen(), please make sure you make a seedfile with the
1213 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1214 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001215 * and written to or you will get an entropy source error! The default
1216 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1217 * bytes from the file.
1218 *
1219 * \note The entropy collector will write to the seed file before entropy is
1220 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001221 */
1222//#define MBEDTLS_ENTROPY_NV_SEED
1223
Ronald Cron71016a92020-08-28 19:01:50 +02001224/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001225 *
Ronald Cron71016a92020-08-28 19:01:50 +02001226 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001227 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001228 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1229 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001230 *
1231 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001232 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001233 */
Ronald Cron71016a92020-08-28 19:01:50 +02001234//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001235
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001238 *
1239 * Enable debugging of buffer allocator memory issues. Automatically prints
1240 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1241 * function for 'debug output' of allocated memory.
1242 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001244 *
1245 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001248
1249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001251 *
1252 * Include backtrace information with each allocated block.
1253 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001255 * GLIBC-compatible backtrace() an backtrace_symbols() support
1256 *
1257 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001260
1261/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001263 *
1264 * Support external private RSA keys (eg from a HSM) in the PK layer.
1265 *
1266 * Comment this macro to disable support for external private RSA keys.
1267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001269
1270/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001272 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001273 * Enable support for PKCS#1 v1.5 encoding.
1274 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001276 *
Paul Bakker48377d92013-08-30 12:06:24 +02001277 * This enables support for PKCS#1 v1.5 operations.
1278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001280
1281/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001282 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001283 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001284 * Enable support for PKCS#1 v2.1 encoding.
1285 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001287 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001288 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1289 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001291
Steven Cooreman6801f082021-02-19 17:21:22 +01001292/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1293 *
1294 * Enable support for platform built-in keys. If you enable this feature,
1295 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1296 * See the documentation of that function for more information.
1297 *
1298 * Built-in keys are typically derived from a hardware unique key or
1299 * stored in a secure element.
1300 *
1301 * Requires: MBEDTLS_PSA_CRYPTO_C.
1302 *
1303 * \warning This interface is experimental and may change or be removed
1304 * without notice.
1305 */
1306//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1307
Ronald Cron3768ac12021-01-26 16:58:00 +01001308/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1309 *
1310 * Enable support for PSA crypto client.
1311 *
1312 * \note This option allows to include the code necessary for a PSA
1313 * crypto client when the PSA crypto implementation is not included in
1314 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1315 * code to set and get PSA key attributes.
1316 * The development of PSA drivers partially relying on the library to
1317 * fulfill the hardware gaps is another possible usage of this option.
1318 *
1319 * \warning This interface is experimental and may change or be removed
1320 * without notice.
1321 */
1322//#define MBEDTLS_PSA_CRYPTO_CLIENT
1323
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001324/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1325 *
1326 * Enable support for the experimental PSA crypto driver interface.
1327 *
John Durkop185764f2020-10-12 21:32:12 -07001328 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001329 *
1330 * \warning This interface is experimental and may change or be removed
1331 * without notice.
1332 */
1333//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1334
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001335/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1336 *
1337 * Make the PSA Crypto module use an external random generator provided
1338 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1339 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001340 * \note This random generator must deliver random numbers with cryptographic
1341 * quality and high performance. It must supply unpredictable numbers
1342 * with a uniform distribution. The implementation of this function
1343 * is responsible for ensuring that the random generator is seeded
1344 * with sufficient entropy. If you have a hardware TRNG which is slow
1345 * or delivers non-uniform output, declare it as an entropy source
1346 * with mbedtls_entropy_add_source() instead of enabling this option.
1347 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001348 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001349 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1350 * and define a function called mbedtls_psa_external_get_random()
1351 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001352 * ```
1353 * psa_status_t mbedtls_psa_external_get_random(
1354 * mbedtls_psa_external_random_context_t *context,
1355 * uint8_t *output, size_t output_size, size_t *output_length);
1356 * );
1357 * ```
1358 * The \c context value is initialized to 0 before the first call.
1359 * The function must fill the \c output buffer with \p output_size bytes
1360 * of random data and set \c *output_length to \p output_size.
1361 *
1362 * Requires: MBEDTLS_PSA_CRYPTO_C
1363 *
1364 * \warning If you enable this option, code that uses the PSA cryptography
1365 * interface will not use any of the entropy sources set up for
1366 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1367 * enables.
1368 *
1369 * \note This option is experimental and may be removed without notice.
1370 */
1371//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1372
Paul Bakker9dcc3222011-03-08 14:16:06 +00001373/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001374 * \def MBEDTLS_PSA_CRYPTO_SPM
1375 *
1376 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1377 * Partition Manager) integration which separates the code into two parts: a
1378 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1379 * Environment).
1380 *
1381 * Module: library/psa_crypto.c
1382 * Requires: MBEDTLS_PSA_CRYPTO_C
1383 *
1384 */
1385//#define MBEDTLS_PSA_CRYPTO_SPM
1386
1387/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001388 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001389 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001390 * Enable support for entropy injection at first boot. This feature is
1391 * required on systems that do not have a built-in entropy source (TRNG).
1392 * This feature is currently not supported on systems that have a built-in
1393 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001394 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001395 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001396 *
1397 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001398//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001399
1400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001402 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001403 * Do not use the Chinese Remainder Theorem
1404 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001405 *
1406 * Uncomment this macro to disable the use of CRT in RSA.
1407 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001409//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001410
1411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001413 *
1414 * Enable the checkup functions (*_self_test).
1415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001417
1418/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001419 * \def MBEDTLS_SHA256_SMALLER
1420 *
1421 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1422 * lower performance.
1423 *
1424 * The default implementation is meant to be a reasonnable compromise between
1425 * performance and size. This version optimizes more aggressively for size at
1426 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1427 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1428 * 30%.
1429 *
1430 * Uncomment to enable the smaller implementation of SHA256.
1431 */
1432//#define MBEDTLS_SHA256_SMALLER
1433
1434/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001435 * \def MBEDTLS_SHA512_SMALLER
1436 *
1437 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1438 * lower performance.
1439 *
1440 * Uncomment to enable the smaller implementation of SHA512.
1441 */
1442//#define MBEDTLS_SHA512_SMALLER
1443
1444/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001445 * \def MBEDTLS_SHA512_NO_SHA384
1446 *
1447 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1448 * code size on devices that don't use SHA-384.
1449 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001450 * Requires: MBEDTLS_SHA512_C
1451 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001452 * Uncomment to disable SHA-384
1453 */
1454//#define MBEDTLS_SHA512_NO_SHA384
1455
1456/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001458 *
1459 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001460 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001461 * with other servers, only debugging of failures is harder.
1462 *
1463 * The advantage of not sending alert messages, is that no information is given
1464 * about reasons for failures thus preventing adversaries of gaining intel.
1465 *
1466 * Enable sending of all alert messages
1467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001469
1470/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001471 * \def MBEDTLS_SSL_RECORD_CHECKING
1472 *
1473 * Enable the function mbedtls_ssl_check_record() which can be used to check
1474 * the validity and authenticity of an incoming record, to verify that it has
1475 * not been seen before. These checks are performed without modifying the
1476 * externally visible state of the SSL context.
1477 *
1478 * See mbedtls_ssl_check_record() for more information.
1479 *
1480 * Uncomment to enable support for record checking.
1481 */
1482#define MBEDTLS_SSL_RECORD_CHECKING
1483
1484/**
1485 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1486 *
1487 * Enable support for the DTLS Connection ID extension
1488 * (version draft-ietf-tls-dtls-connection-id-05,
1489 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1490 * which allows to identify DTLS connections across changes
1491 * in the underlying transport.
1492 *
1493 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1494 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1495 * See the corresponding documentation for more information.
1496 *
1497 * \warning The Connection ID extension is still in draft state.
1498 * We make no stability promises for the availability
1499 * or the shape of the API controlled by this option.
1500 *
1501 * The maximum lengths of outgoing and incoming CIDs can be configured
1502 * through the options
1503 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1504 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1505 *
1506 * Requires: MBEDTLS_SSL_PROTO_DTLS
1507 *
1508 * Uncomment to enable the Connection ID extension.
1509 */
1510//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1511
1512/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001513 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1514 *
1515 * Enable asynchronous external private key operations in SSL. This allows
1516 * you to configure an SSL connection to call an external cryptographic
1517 * module to perform private key operations instead of performing the
1518 * operation inside the library.
1519 *
1520 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001521//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001522
1523/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001524 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1525 *
1526 * Enable serialization of the TLS context structures, through use of the
1527 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1528 *
1529 * This pair of functions allows one side of a connection to serialize the
1530 * context associated with the connection, then free or re-use that context
1531 * while the serialized state is persisted elsewhere, and finally deserialize
1532 * that state to a live context for resuming read/write operations on the
1533 * connection. From a protocol perspective, the state of the connection is
1534 * unaffected, in particular this is entirely transparent to the peer.
1535 *
1536 * Note: this is distinct from TLS session resumption, which is part of the
1537 * protocol and fully visible by the peer. TLS session resumption enables
1538 * establishing new connections associated to a saved session with shorter,
1539 * lighter handshakes, while context serialization is a local optimization in
1540 * handling a single, potentially long-lived connection.
1541 *
1542 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1543 * saved after the handshake to allow for more efficient serialization, so if
1544 * you don't need this feature you'll save RAM by disabling it.
1545 *
1546 * Comment to disable the context serialization APIs.
1547 */
1548#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1549
1550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001552 *
1553 * Enable the debug messages in SSL module for all issues.
1554 * Debug messages have been disabled in some places to prevent timing
1555 * attacks due to (unbalanced) debugging function calls.
1556 *
1557 * If you need all error reporting you should enable this during debugging,
1558 * but remove this for production servers that should log as well.
1559 *
1560 * Uncomment this macro to report all debug messages on errors introducing
1561 * a timing side-channel.
1562 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001567 *
1568 * Enable support for Encrypt-then-MAC, RFC 7366.
1569 *
1570 * This allows peers that both support it to use a more robust protection for
1571 * ciphersuites using CBC, providing deep resistance against timing attacks
1572 * on the padding or underlying cipher.
1573 *
1574 * This only affects CBC ciphersuites, and is useless if none is defined.
1575 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1577 * MBEDTLS_SSL_PROTO_TLS1_1 or
1578 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001579 *
1580 * Comment this macro to disable support for Encrypt-then-MAC
1581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001585 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001586 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1587 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001588 *
1589 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1590 * attacks, but it is recommended to always use it (even if you disable
1591 * renegotiation), since it actually fixes a more fundamental issue in the
1592 * original SSL/TLS design, and has implications beyond Triple Handshake.
1593 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1595 * MBEDTLS_SSL_PROTO_TLS1_1 or
1596 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001597 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001598 * Comment this macro to disable support for Extended Master Secret.
1599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001601
Paul Bakkerd66f0702013-01-31 16:57:45 +01001602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001603 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001604 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001605 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1606 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001607 *
1608 * For servers, it is recommended to always enable this, unless you support
1609 * only one version of TLS, or know for sure that none of your clients
1610 * implements a fallback strategy.
1611 *
1612 * For clients, you only need this if you're using a fallback strategy, which
1613 * is not recommended in the first place, unless you absolutely need it to
1614 * interoperate with buggy (version-intolerant) servers.
1615 *
1616 * Comment this macro to disable support for FALLBACK_SCSV
1617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001619
1620/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001621 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1622 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001623 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001624 * giving access to the peer's certificate after completion of the handshake.
1625 *
1626 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1627 * recommended to disable this option for reduced RAM usage.
1628 *
1629 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1630 * defined, but always returns \c NULL.
1631 *
1632 * \note This option has no influence on the protection against the
1633 * triple handshake attack. Even if it is disabled, Mbed TLS will
1634 * still ensure that certificates do not change during renegotiation,
1635 * for exaple by keeping a hash of the peer's certificate.
1636 *
1637 * Comment this macro to disable storing the peer's certificate
1638 * after the handshake.
1639 */
1640#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1641
1642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001644 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001645 * Enable 1/n-1 record splitting for CBC mode in TLS 1.0.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001646 *
1647 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1648 * of interoperability issues compared to sending 0-length records.
1649 *
1650 * Comment this macro to disable 1/n-1 record splitting.
1651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001653
1654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001656 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001657 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001658 *
1659 * The two main uses of renegotiation are (1) refresh keys on long-lived
1660 * connections and (2) client authentication after the initial handshake.
1661 * If you don't need renegotiation, it's probably better to disable it, since
1662 * it has been associated with security issues in the past and is easy to
1663 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001664 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001665 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001666 *
1667 * \note Even if this option is disabled, both client and server are aware
1668 * of the Renegotiation Indication Extension (RFC 5746) used to
1669 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1670 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1671 * configuration of this extension).
1672 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001674#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001675
1676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001678 *
1679 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001681 *
1682 * Uncomment this macro to respect client's ciphersuite order
1683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001685
1686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001688 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001689 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001690 *
1691 * Comment this macro to disable support for the max_fragment_length extension
1692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001694
1695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001697 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001698 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001699 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700 * Requires: MBEDTLS_MD5_C
1701 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001702 *
1703 * Comment this macro to disable support for TLS 1.0
1704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001709 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001711 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * Requires: MBEDTLS_MD5_C
1713 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001714 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001715 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001718
1719/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001721 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001722 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001723 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001725 * (Depends on ciphersuites)
1726 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001727 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001730
1731/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001732 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1733 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001734 * This macro is used to selectively enable experimental parts
1735 * of the code that contribute to the ongoing development of
1736 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1737 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001738 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001739 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1740 * and no feature exposed through this macro is part of the
1741 * public API. In particular, features under the control
1742 * of this macro are experimental and don't come with any
1743 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001744 *
1745 * Uncomment this macro to enable experimental and partial
1746 * functionality specific to TLS 1.3.
1747 */
Hanno Beckere4160602020-05-07 15:11:45 +01001748//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001749
1750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001752 *
1753 * Enable support for DTLS (all available versions).
1754 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1756 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001757 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1759 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001760 *
1761 * Comment this macro to disable support for DTLS
1762 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001764
1765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001767 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001768 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001769 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001770 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001772#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001773
1774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001776 *
1777 * Enable support for the anti-replay mechanism in DTLS.
1778 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779 * Requires: MBEDTLS_SSL_TLS_C
1780 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001781 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001782 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001783 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001784 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001785 * Comment this to disable anti-replay in DTLS.
1786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001788
1789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001791 *
1792 * Enable support for HelloVerifyRequest on DTLS servers.
1793 *
1794 * This feature is highly recommended to prevent DTLS servers being used as
1795 * amplifiers in DoS attacks against other hosts. It should always be enabled
1796 * unless you know for sure amplification cannot be a problem in the
1797 * environment in which your server operates.
1798 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001799 * \warning Disabling this can ba a security risk! (see above)
1800 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001801 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001802 *
1803 * Comment this to disable support for HelloVerifyRequest.
1804 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001806
1807/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001808 * \def MBEDTLS_SSL_DTLS_SRTP
1809 *
Johan Pascal842d6712020-09-23 13:34:40 +02001810 * Enable support for negotation of DTLS-SRTP (RFC 5764)
1811 * through the use_srtp extension.
1812 *
1813 * \note This feature provides the minimum functionality required
1814 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1815 * the associated SRTP packet protection key material.
1816 * In particular, the SRTP packet protection itself, as well as the
1817 * demultiplexing of RTP and DTLS packets at the datagram layer
1818 * (see Section 5 of RFC 5764), are not handled by this feature.
1819 * Instead, after successful completion of a handshake negotiating
1820 * the use of DTLS-SRTP, the extended key exporter API
1821 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1822 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1823 * (this is implemented in the SSL example programs).
1824 * The resulting key should then be passed to an SRTP stack.
1825 *
1826 * Setting this option enables the runtime API
1827 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1828 * through which the supported DTLS-SRTP protection
1829 * profiles can be configured. You must call this API at
1830 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001831 *
1832 * Requires: MBEDTLS_SSL_PROTO_DTLS
1833 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001834 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001835 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001836//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001837
1838/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001839 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1840 *
1841 * Enable server-side support for clients that reconnect from the same port.
1842 *
1843 * Some clients unexpectedly close the connection and try to reconnect using the
1844 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001845 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001846 * flag enables that support.
1847 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001848 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001849 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001850 * Comment this to disable support for clients reusing the source port.
1851 */
1852#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1853
1854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001855 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001856 *
1857 * Enable support for a limit of records with bad MAC.
1858 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001859 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001860 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001862 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001864
1865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001867 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001868 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001869 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001870 * session store remains the responsibility of the application, though).
1871 * Server-side, you also need to provide callbacks for writing and parsing
1872 * tickets, including authenticated encryption and key management. Example
1873 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001874 *
1875 * Comment this macro to disable support for SSL session tickets
1876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001878
1879/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001880 * \def MBEDTLS_SSL_EXPORT_KEYS
1881 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001882 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001883 * This is required for certain users of TLS, e.g. EAP-TLS.
1884 *
1885 * Comment this macro to disable support for key export
1886 */
1887#define MBEDTLS_SSL_EXPORT_KEYS
1888
1889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001891 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001892 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001893 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001895 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001896 * Comment this macro to disable support for server name indication in SSL
1897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001902 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001903 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001904 *
1905 * Comment this macro to disable support for truncated HMAC in SSL
1906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001908
1909/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001910 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1911 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001912 * When this option is enabled, the SSL buffer will be resized automatically
1913 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001914 *
1915 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001916 */
1917//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1918
1919/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001920 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1921 *
1922 * Enable testing of the constant-flow nature of some sensitive functions with
1923 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001924 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001925 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001926 * This setting requires compiling with clang -fsanitize=memory. The test
1927 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001928 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001929 * \warning This macro is only used for extended testing; it is not considered
1930 * part of the library's API, so it may change or disappear at any time.
1931 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001932 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001933 */
1934//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1935
1936/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001937 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1938 *
1939 * Enable testing of the constant-flow nature of some sensitive functions with
1940 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001941 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001942 *
1943 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001944 * testing if the tests suites are run with valgrind's memcheck. This can be
1945 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1946 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001947 *
1948 * \warning This macro is only used for extended testing; it is not considered
1949 * part of the library's API, so it may change or disappear at any time.
1950 *
1951 * Uncomment to enable testing of the constant-flow nature of selected code.
1952 */
1953//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1954
1955/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001956 * \def MBEDTLS_TEST_HOOKS
1957 *
1958 * Enable features for invasive testing such as introspection functions and
1959 * hooks for fault injection. This enables additional unit tests.
1960 *
1961 * Merely enabling this feature should not change the behavior of the product.
1962 * It only adds new code, and new branching points where the default behavior
1963 * is the same as when this feature is disabled.
1964 * However, this feature increases the attack surface: there is an added
1965 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1966 * Therefore this feature must never be enabled in production.
1967 *
1968 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1969 * information.
1970 *
1971 * Uncomment to enable invasive tests.
1972 */
1973//#define MBEDTLS_TEST_HOOKS
1974
1975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001977 *
1978 * Provide your own alternate threading implementation.
1979 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001981 *
1982 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001985
1986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001988 *
1989 * Enable the pthread wrapper layer for the threading layer.
1990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001992 *
1993 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001996
1997/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001998 * \def MBEDTLS_USE_PSA_CRYPTO
1999 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002000 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2001 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002002 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002003 * \note Development of this option is currently in progress, and parts of Mbed
2004 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002005 * will still continue to work as usual, so enabling this option should not
2006 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002007 *
Gilles Peskined3d02902020-03-04 21:35:27 +01002008 * \warning The PSA Crypto API is in beta stage. While you're welcome to
2009 * experiment using it, incompatible API changes are still possible, and some
2010 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002011 *
2012 * \warning This option enables new Mbed TLS APIs that are dependent on the
2013 * PSA Crypto API, so can't come with the same stability guarantees as the
2014 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002015 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002016 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00002017 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002018 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002019 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002020 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002021 */
2022//#define MBEDTLS_USE_PSA_CRYPTO
2023
2024/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002025 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2026 *
John Durkop185764f2020-10-12 21:32:12 -07002027 * This setting allows support for cryptographic mechanisms through the PSA
2028 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002029 *
John Durkop185764f2020-10-12 21:32:12 -07002030 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01002031 * can be found in include/psa/crypto_config.h.
2032 *
2033 * If you enable this option and write your own configuration file, you must
2034 * include mbedtls/config_psa.h in your configuration file. The default
2035 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002036 *
2037 * This feature is still experimental and is not ready for production since
2038 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002039 */
2040//#define MBEDTLS_PSA_CRYPTO_CONFIG
2041
2042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002044 *
2045 * Allow run-time checking of compile-time enabled features. Thus allowing users
2046 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002050 *
2051 * Comment this to disable run-time checking and save ROM space
2052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002053#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002054
2055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002057 *
2058 * If set, the X509 parser will not break-off when parsing an X509 certificate
2059 * and encountering an extension in a v1 or v2 certificate.
2060 *
2061 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002064
2065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002067 *
2068 * If set, the X509 parser will not break-off when parsing an X509 certificate
2069 * and encountering an unknown critical extension.
2070 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002071 * \warning Depending on your PKI use, enabling this can be a security risk!
2072 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002073 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002076
2077/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002078 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2079 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002080 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002081 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2082 * the set of trusted certificates through a callback instead of a linked
2083 * list.
2084 *
2085 * This is useful for example in environments where a large number of trusted
2086 * certificates is present and storing them in a linked list isn't efficient
2087 * enough, or when the set of trusted certificates changes frequently.
2088 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002089 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002090 * `mbedtls_ssl_conf_ca_cb()` for more information.
2091 *
2092 * Uncomment to enable trusted certificate callbacks.
2093 */
2094//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2095
2096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002098 *
2099 * Enable verification of the keyUsage extension (CA and leaf certificates).
2100 *
2101 * Disabling this avoids problems with mis-issued and/or misused
2102 * (intermediate) CA and leaf certificates.
2103 *
2104 * \warning Depending on your PKI use, disabling this can be a security risk!
2105 *
2106 * Comment to skip keyUsage checking for both CA and leaf certificates.
2107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002109
2110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002112 *
2113 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2114 *
2115 * Disabling this avoids problems with mis-issued and/or misused certificates.
2116 *
2117 * \warning Depending on your PKI use, disabling this can be a security risk!
2118 *
2119 * Comment to skip extendedKeyUsage checking for certificates.
2120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002122
2123/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002124 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002125 *
Chris Jones2c745862020-12-16 11:41:06 +00002126 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002127 *
Chris Jones2c745862020-12-16 11:41:06 +00002128 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002129 * and other functions/constants only used by these functions, thus reducing
2130 * the code footprint by several KB.
2131 */
Chris Jones2c745862020-12-16 11:41:06 +00002132//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002133
2134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002136 *
2137 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2138 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2139 *
2140 * Comment this macro to disallow using RSASSA-PSS in certificates.
2141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002143/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002144
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002145/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002146 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002147 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002148 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002149 * \{
2150 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002151
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002154 *
2155 * Enable AES-NI support on x86-64.
2156 *
2157 * Module: library/aesni.c
2158 * Caller: library/aes.c
2159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002161 *
2162 * This modules adds support for the AES-NI instructions on x86-64
2163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002164#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002165
2166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002168 *
2169 * Enable the AES block cipher.
2170 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002171 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002172 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002173 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002174 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002175 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002176 * This module enables the following ciphersuites (if other requisites are
2177 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2179 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2180 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2182 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2183 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2184 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2185 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2186 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2187 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2189 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2198 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2199 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2200 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2201 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2202 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2203 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2204 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2205 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2206 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2207 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2208 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2209 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2211 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2212 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2213 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2214 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2215 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2216 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2217 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2218 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2219 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2220 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2221 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2222 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2224 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2225 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2228 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2229 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2230 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2231 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2232 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2233 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2234 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2235 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002236 *
Paul Bakkercff68422013-09-15 20:43:33 +02002237 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002240
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002243 *
2244 * Enable the ARCFOUR stream cipher.
2245 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002246 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002247 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002248 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002249 * This module enables the following ciphersuites (if other requisites are
2250 * enabled as well):
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002251 *
2252 * \warning ARC4 is considered a weak cipher and its use constitutes a
2253 * security risk. If possible, we recommend avoidng dependencies on
2254 * it, and considering stronger ciphers instead.
2255 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002258
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002261 *
2262 * Enable the generic ASN1 parser.
2263 *
2264 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002265 * Caller: library/x509.c
2266 * library/dhm.c
2267 * library/pkcs12.c
2268 * library/pkcs5.c
2269 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002272
2273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002275 *
2276 * Enable the generic ASN1 writer.
2277 *
2278 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002279 * Caller: library/ecdsa.c
2280 * library/pkwrite.c
2281 * library/x509_create.c
2282 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002283 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002286
2287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002289 *
2290 * Enable the Base64 module.
2291 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002292 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002293 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002294 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002295 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002298
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002301 *
Paul Bakker9a736322012-11-14 12:39:52 +00002302 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002303 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002304 * Module: library/bignum.c
2305 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002306 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002307 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002309 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002312 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002315
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002318 *
2319 * Enable the Blowfish block cipher.
2320 *
2321 * Module: library/blowfish.c
2322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002324
2325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002327 *
2328 * Enable the Camellia block cipher.
2329 *
Paul Bakker38119b12009-01-10 23:31:23 +00002330 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002331 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002332 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002333 * This module enables the following ciphersuites (if other requisites are
2334 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2348 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2349 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2350 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2357 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2358 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2361 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2365 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2366 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2368 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2369 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2370 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2371 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2372 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2373 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2374 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2375 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2376 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002379
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002380/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002381 * \def MBEDTLS_ARIA_C
2382 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002383 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002384 *
2385 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002386 * Caller: library/cipher.c
2387 *
2388 * This module enables the following ciphersuites (if other requisites are
2389 * enabled as well):
2390 *
2391 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2393 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2395 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2396 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2398 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2399 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2400 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2401 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2402 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2403 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2404 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2405 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2406 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2407 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2408 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2409 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2411 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2412 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2413 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2414 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2415 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2416 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2417 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2418 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2419 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2420 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2421 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2422 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2423 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2424 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2425 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2426 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2427 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2428 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002429 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002430#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002431
2432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002434 *
2435 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2436 *
2437 * Module: library/ccm.c
2438 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002440 *
2441 * This module enables the AES-CCM ciphersuites, if other requisites are
2442 * enabled as well.
2443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002445
2446/**
Daniel King34b822c2016-05-15 17:28:08 -03002447 * \def MBEDTLS_CHACHA20_C
2448 *
2449 * Enable the ChaCha20 stream cipher.
2450 *
2451 * Module: library/chacha20.c
2452 */
2453#define MBEDTLS_CHACHA20_C
2454
2455/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002456 * \def MBEDTLS_CHACHAPOLY_C
2457 *
2458 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2459 *
2460 * Module: library/chachapoly.c
2461 *
2462 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2463 */
2464#define MBEDTLS_CHACHAPOLY_C
2465
2466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002468 *
2469 * Enable the generic cipher layer.
2470 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002471 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002472 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002473 *
2474 * Uncomment to enable generic cipher wrappers.
2475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002477
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002478/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002479 * \def MBEDTLS_CMAC_C
2480 *
Simon Butcher327398a2016-10-05 14:09:11 +01002481 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2482 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002483 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002484 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2485 * implementation of the CMAC algorithm is provided by an alternate
2486 * implementation, that alternate implementation may opt to not support
2487 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2488 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002489 * Module: library/cmac.c
2490 *
Simon Butcher69283e52016-10-06 12:49:58 +01002491 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002492 *
2493 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002494#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002495
2496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002498 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002499 * Enable the CTR_DRBG AES-based random generator.
2500 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002501 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002502 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002503 * \note To achieve a 256-bit security strength with CTR_DRBG,
2504 * you must use AES-256 *and* use sufficient entropy.
2505 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002506 *
2507 * Module: library/ctr_drbg.c
2508 * Caller:
2509 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002511 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002512 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002515
2516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002518 *
2519 * Enable the debug functions.
2520 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002521 * Module: library/debug.c
2522 * Caller: library/ssl_cli.c
2523 * library/ssl_srv.c
2524 * library/ssl_tls.c
2525 *
2526 * This module provides debugging functions.
2527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002529
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002532 *
2533 * Enable the DES block cipher.
2534 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002535 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002536 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002537 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002538 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002539 * This module enables the following ciphersuites (if other requisites are
2540 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2542 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2543 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2544 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2545 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2546 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2547 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2548 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2549 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2550 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002551 *
Paul Bakkercff68422013-09-15 20:43:33 +02002552 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002553 *
2554 * \warning DES is considered a weak cipher and its use constitutes a
2555 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002558
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002561 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002562 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002563 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002564 * Module: library/dhm.c
2565 * Caller: library/ssl_cli.c
2566 * library/ssl_srv.c
2567 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002568 * This module is used by the following key exchanges:
2569 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002570 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002571 * \warning Using DHE constitutes a security risk as it
2572 * is not possible to validate custom DH parameters.
2573 * If possible, it is recommended users should consider
2574 * preferring other methods of key exchange.
2575 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002576 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002579
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002580/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002582 *
2583 * Enable the elliptic curve Diffie-Hellman library.
2584 *
2585 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002586 * Caller: library/ssl_cli.c
2587 * library/ssl_srv.c
2588 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002589 * This module is used by the following key exchanges:
2590 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002591 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595
2596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002598 *
2599 * Enable the elliptic curve DSA library.
2600 *
2601 * Module: library/ecdsa.c
2602 * Caller:
2603 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002604 * This module is used by the following key exchanges:
2605 * ECDHE-ECDSA
2606 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002607 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2608 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2609 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002612
2613/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002614 * \def MBEDTLS_ECJPAKE_C
2615 *
2616 * Enable the elliptic curve J-PAKE library.
2617 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002618 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2619 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002620 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002621 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002622 * Module: library/ecjpake.c
2623 * Caller:
2624 *
2625 * This module is used by the following key exchanges:
2626 * ECJPAKE
2627 *
2628 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2629 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002630#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002631
2632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002634 *
2635 * Enable the elliptic curve over GF(p) library.
2636 *
2637 * Module: library/ecp.c
2638 * Caller: library/ecdh.c
2639 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002640 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002641 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002645
2646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002648 *
2649 * Enable the platform-specific entropy code.
2650 *
2651 * Module: library/entropy.c
2652 * Caller:
2653 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002655 *
2656 * This module provides a generic entropy pool
2657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002659
2660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002662 *
2663 * Enable error code to error string conversion.
2664 *
2665 * Module: library/error.c
2666 * Caller:
2667 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002669 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002671
2672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002674 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002675 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002676 *
2677 * Module: library/gcm.c
2678 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002679 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002680 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002681 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2682 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002685
2686/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002687 * \def MBEDTLS_HKDF_C
2688 *
2689 * Enable the HKDF algorithm (RFC 5869).
2690 *
2691 * Module: library/hkdf.c
2692 * Caller:
2693 *
2694 * Requires: MBEDTLS_MD_C
2695 *
2696 * This module adds support for the Hashed Message Authentication Code
2697 * (HMAC)-based key derivation function (HKDF).
2698 */
2699#define MBEDTLS_HKDF_C
2700
2701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002703 *
2704 * Enable the HMAC_DRBG random generator.
2705 *
2706 * Module: library/hmac_drbg.c
2707 * Caller:
2708 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002710 *
2711 * Uncomment to enable the HMAC_DRBG random number geerator.
2712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002714
2715/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002716 * \def MBEDTLS_NIST_KW_C
2717 *
2718 * Enable the Key Wrapping mode for 128-bit block ciphers,
2719 * as defined in NIST SP 800-38F. Only KW and KWP modes
2720 * are supported. At the moment, only AES is approved by NIST.
2721 *
2722 * Module: library/nist_kw.c
2723 *
2724 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2725 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002726#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002727
2728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002730 *
2731 * Enable the generic message digest layer.
2732 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002733 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002734 * Caller:
2735 *
2736 * Uncomment to enable generic message digest wrappers.
2737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002739
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002742 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002743 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002744 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002745 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002746 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002747 *
2748 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002749 *
2750 * \warning MD2 is considered a weak message digest and its use constitutes a
2751 * security risk. If possible, we recommend avoiding dependencies on
2752 * it, and considering stronger message digests instead.
2753 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002756
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002760 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002761 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002762 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002763 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002764 *
2765 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002766 *
2767 * \warning MD4 is considered a weak message digest and its use constitutes a
2768 * security risk. If possible, we recommend avoiding dependencies on
2769 * it, and considering stronger message digests instead.
2770 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002773
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002776 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002777 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002778 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002779 * Module: library/md5.c
2780 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002781 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002782 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002783 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002784 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2785 * depending on the handshake parameters. Further, it is used for checking
2786 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2787 * encrypted keys.
2788 *
2789 * \warning MD5 is considered a weak message digest and its use constitutes a
2790 * security risk. If possible, we recommend avoiding dependencies on
2791 * it, and considering stronger message digests instead.
2792 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002795
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002798 *
2799 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002800 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002801 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002802 *
2803 * Module: library/memory_buffer_alloc.c
2804 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * Requires: MBEDTLS_PLATFORM_C
2806 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002807 *
2808 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002811
2812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002814 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002815 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2816 *
Simon Butcherd567a232016-03-09 20:19:21 +00002817 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2818 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002819 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002820 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002821 * \note See also our Knowledge Base article about porting to a new
2822 * environment:
2823 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2824 *
Andres AG788aa4a2016-09-14 14:32:09 +01002825 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002826 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002827 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002830
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002831/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002833 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002834 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002835 *
2836 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002837 * Caller: library/asn1write.c
2838 * library/pkcs5.c
2839 * library/pkparse.c
2840 * library/pkwrite.c
2841 * library/rsa.c
2842 * library/x509.c
2843 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002844 * library/x509_crl.c
2845 * library/x509_crt.c
2846 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002847 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002848 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002849 *
2850 * This modules translates between OIDs and internal values.
2851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002853
2854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002856 *
2857 * Enable VIA Padlock support on x86.
2858 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002859 * Module: library/padlock.c
2860 * Caller: library/aes.c
2861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002863 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002864 * This modules adds support for the VIA PadLock on x86.
2865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002867
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002870 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002871 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002872 *
2873 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002874 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002875 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002876 * library/x509_crl.c
2877 * library/x509_crt.c
2878 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002879 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002881 *
Paul Bakkercff68422013-09-15 20:43:33 +02002882 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002885
2886/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002888 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002889 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002890 *
2891 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002892 * Caller: library/pkwrite.c
2893 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002894 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002897 *
2898 * This modules adds support for encoding / writing PEM files.
2899 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002901
2902/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002904 *
2905 * Enable the generic public (asymetric) key layer.
2906 *
2907 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002908 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002909 * library/ssl_cli.c
2910 * library/ssl_srv.c
2911 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002913 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002914 * Uncomment to enable generic public key wrappers.
2915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002917
2918/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002920 *
2921 * Enable the generic public (asymetric) key parser.
2922 *
2923 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002924 * Caller: library/x509_crt.c
2925 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002926 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002928 *
2929 * Uncomment to enable generic public key parse functions.
2930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002932
2933/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002935 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002936 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002937 *
2938 * Module: library/pkwrite.c
2939 * Caller: library/x509write.c
2940 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002942 *
2943 * Uncomment to enable generic public key write functions.
2944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002945#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002946
2947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002949 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002950 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002951 *
2952 * Module: library/pkcs5.c
2953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002955 *
2956 * This module adds support for the PKCS#5 functions.
2957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002959
2960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002962 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002963 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002964 * Adds algorithms for parsing PKCS#8 encrypted private keys
2965 *
2966 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002967 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002968 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2970 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002971 *
2972 * This module enables PKCS#12 functions.
2973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002975
2976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002978 *
2979 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002980 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002981 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2983 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002984 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002985 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002986 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2987 * as other module rely on it for a fixed snprintf implementation.
2988 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002989 * Module: library/platform.c
2990 * Caller: Most other .c files
2991 *
2992 * This module enables abstraction of common (libc) functions.
2993 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002994#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002995
2996/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002997 * \def MBEDTLS_POLY1305_C
2998 *
2999 * Enable the Poly1305 MAC algorithm.
3000 *
3001 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003002 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003003 */
3004#define MBEDTLS_POLY1305_C
3005
3006/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003007 * \def MBEDTLS_PSA_CRYPTO_C
3008 *
3009 * Enable the Platform Security Architecture cryptography API.
3010 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003011 * \warning The PSA Crypto API is still beta status. While you're welcome to
3012 * experiment using it, incompatible API changes are still possible, and some
3013 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01003014 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003015 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003016 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003017 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003018 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003019 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003020 *
3021 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003022#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003023
3024/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003025 * \def MBEDTLS_PSA_CRYPTO_SE_C
3026 *
3027 * Enable secure element support in the Platform Security Architecture
3028 * cryptography API.
3029 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003030 * \warning This feature is not yet suitable for production. It is provided
3031 * for API evaluation and testing purposes only.
3032 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003033 * Module: library/psa_crypto_se.c
3034 *
3035 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3036 *
3037 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003038//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003039
3040/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003041 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3042 *
3043 * Enable the Platform Security Architecture persistent key storage.
3044 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003045 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003046 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003047 * Requires: MBEDTLS_PSA_CRYPTO_C,
3048 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3049 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003050 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003051#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003052
3053/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003054 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003056 * Enable the emulation of the Platform Security Architecture
3057 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003058 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003059 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003060 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003061 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003062 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003063#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003064
3065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003067 *
3068 * Enable the RIPEMD-160 hash algorithm.
3069 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003070 * Module: library/ripemd160.c
3071 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003072 *
3073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003075
3076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003078 *
3079 * Enable the RSA public-key cryptosystem.
3080 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003081 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003082 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 * Caller: library/ssl_cli.c
3084 * library/ssl_srv.c
3085 * library/ssl_tls.c
3086 * library/x509.c
3087 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003088 * This module is used by the following key exchanges:
3089 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003090 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003094
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003097 *
3098 * Enable the SHA1 cryptographic hash algorithm.
3099 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003100 * Module: library/sha1.c
3101 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003102 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003103 * library/ssl_srv.c
3104 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003105 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003106 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003107 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3108 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003109 *
3110 * \warning SHA-1 is considered a weak message digest and its use constitutes
3111 * a security risk. If possible, we recommend avoiding dependencies
3112 * on it, and considering stronger message digests instead.
3113 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003114 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003115#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003116
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003119 *
3120 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3121 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003122 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003123 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003124 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003125 * library/ssl_cli.c
3126 * library/ssl_srv.c
3127 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003128 *
3129 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003130 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003133
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003136 *
3137 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3138 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003139 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003140 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003141 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003142 * library/ssl_cli.c
3143 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003144 *
3145 * This module adds support for SHA-384 and SHA-512.
3146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003148
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003151 *
3152 * Enable simple SSL cache implementation.
3153 *
3154 * Module: library/ssl_cache.c
3155 * Caller:
3156 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003158 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003160
3161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003162 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003163 *
3164 * Enable basic implementation of DTLS cookies for hello verification.
3165 *
3166 * Module: library/ssl_cookie.c
3167 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003170
3171/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003172 * \def MBEDTLS_SSL_TICKET_C
3173 *
3174 * Enable an implementation of TLS server-side callbacks for session tickets.
3175 *
3176 * Module: library/ssl_ticket.c
3177 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003178 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003179 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003180 */
3181#define MBEDTLS_SSL_TICKET_C
3182
3183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003185 *
3186 * Enable the SSL/TLS client code.
3187 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003188 * Module: library/ssl_cli.c
3189 * Caller:
3190 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003192 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003193 * This module is required for SSL/TLS client support.
3194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003196
Paul Bakker9a736322012-11-14 12:39:52 +00003197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003199 *
3200 * Enable the SSL/TLS server code.
3201 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003202 * Module: library/ssl_srv.c
3203 * Caller:
3204 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003206 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003207 * This module is required for SSL/TLS server support.
3208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003210
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003211/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003213 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003214 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003215 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003216 * Module: library/ssl_tls.c
3217 * Caller: library/ssl_cli.c
3218 * library/ssl_srv.c
3219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3221 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003222 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003223 * This module is required for SSL/TLS.
3224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003226
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003229 *
3230 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003231 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003232 * contexts are not shared between threads. If you do intend to use contexts
3233 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003234 * conditions. See also our Knowledge Base article about threading:
3235 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003236 *
3237 * Module: library/threading.c
3238 *
3239 * This allows different threading implementations (self-implemented or
3240 * provided).
3241 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242 * You will have to enable either MBEDTLS_THREADING_ALT or
3243 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003244 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003245 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003248
3249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003251 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003252 * Enable the semi-portable timing interface.
3253 *
Simon Butcherd567a232016-03-09 20:19:21 +00003254 * \note The provided implementation only works on POSIX/Unix (including Linux,
3255 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003256 * module and provide your own implementations of the callbacks needed by
3257 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3258 * your own implementation of the whole module by setting
3259 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003260 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003261 * \note See also our Knowledge Base article about porting to a new
3262 * environment:
3263 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3264 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003265 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003267#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003268
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003271 *
3272 * Enable run-time version information.
3273 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003274 * Module: library/version.c
3275 *
3276 * This module provides run-time version information.
3277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003278#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003279
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003281 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003282 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003283 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003284 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003285 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003286 * Caller: library/x509_crl.c
3287 * library/x509_crt.c
3288 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003289 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003290 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3291 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003292 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003293 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003296
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003297/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003298 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003299 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003300 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003301 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003302 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003303 * Caller: library/ssl_cli.c
3304 * library/ssl_srv.c
3305 * library/ssl_tls.c
3306 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003308 *
3309 * This module is required for X.509 certificate parsing.
3310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003312
3313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003315 *
3316 * Enable X.509 CRL parsing.
3317 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003318 * Module: library/x509_crl.c
3319 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003320 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003321 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003322 *
3323 * This module is required for X.509 CRL parsing.
3324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003326
3327/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003329 *
3330 * Enable X.509 Certificate Signing Request (CSR) parsing.
3331 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003332 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003333 * Caller: library/x509_crt_write.c
3334 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003336 *
3337 * This module is used for reading X.509 certificate request.
3338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003340
3341/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003343 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003344 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003345 *
3346 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003347 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003349 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003350 * This module is the basis for creating X.509 certificates and CSRs.
3351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003353
3354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003356 *
3357 * Enable creating X.509 certificates.
3358 *
3359 * Module: library/x509_crt_write.c
3360 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003362 *
3363 * This module is required for X.509 certificate creation.
3364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003366
3367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003369 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003370 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003371 *
3372 * Module: library/x509_csr_write.c
3373 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003375 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003376 * This module is required for X.509 certificate request writing.
3377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003379
3380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003382 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003383 * Enable the XTEA block cipher.
3384 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003385 * Module: library/xtea.c
3386 * Caller:
3387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003389
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003390/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003391
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003392/**
3393 * \name SECTION: Module configuration options
3394 *
3395 * This section allows for the setting of module specific sizes and
3396 * configuration options. The default values are already present in the
3397 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003398 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003399 * Our advice is to enable options and change their values here
3400 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003401 *
3402 * Please check the respective header file for documentation on these
3403 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003404 * \{
3405 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003406
Paul Bakker088c5c52014-04-25 11:11:10 +02003407/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003408//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003410
Paul Bakker088c5c52014-04-25 11:11:10 +02003411/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3413//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3414//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3415//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3416//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003417
Paul Bakker088c5c52014-04-25 11:11:10 +02003418/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3420//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3421//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3422//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003423
Paul Bakker088c5c52014-04-25 11:11:10 +02003424/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3426//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3427//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003428
Paul Bakker088c5c52014-04-25 11:11:10 +02003429/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3431//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003432//#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 +01003433
Paul Bakker088c5c52014-04-25 11:11:10 +02003434/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003436
Paul Bakker088c5c52014-04-25 11:11:10 +02003437/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438//#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. */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003439//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3441//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003442//#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 +02003443//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3444//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003445/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003447//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3448//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003449//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3450//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3451//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003452
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3454/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003455//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3457//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003458//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3459//#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 +02003460//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3461//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003462/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003464//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003465//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3466//#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 +02003467
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003468/**
3469 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003470 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003471 * (see the documentation of that option for context).
3472 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003473 * When you leave this undefined here, the library provides
3474 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3475 * is defined, the default definition is `assert(cond)`,
3476 * otherwise the default definition calls a function
3477 * mbedtls_param_failed(). This function is declared in
3478 * `platform_util.h` for the benefit of the library, but
3479 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003480 *
3481 * When you define this here, this replaces the default
3482 * definition in platform_util.h (which no longer declares the
3483 * function mbedtls_param_failed()) and it is your responsibility
3484 * to make sure this macro expands to something suitable (in
3485 * particular, that all the necessary declarations are visible
3486 * from within the library - you can ensure that by providing
3487 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003488 * If you define this macro to call `assert`, also define
3489 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3490 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003491 *
3492 * Note that you may define this macro to expand to nothing, in
3493 * which case you don't have to worry about declarations or
3494 * definitions. However, you will then be notified about invalid
3495 * parameters only in non-void functions, and void function will
3496 * just silently return early on invalid parameters, which
3497 * partially negates the benefits of enabling
3498 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3499 *
3500 * \param cond The expression that should evaluate to true, but doesn't.
3501 */
3502//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3503
Gilles Peskineed038902020-11-13 21:33:21 +01003504/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003505/**
Gilles Peskineed038902020-11-13 21:33:21 +01003506 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3507 * PSA crypto subsystem.
3508 *
3509 * If this option is unset:
3510 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003511 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003512 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3513 * on unspecified heuristics.
3514 */
3515//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3516
Steven Cooreman863470a2021-02-15 14:03:19 +01003517/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003518 * Restrict the PSA library to supporting a maximum amount of simultaneously
3519 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3520 * volatile key, or a persistent key which is loaded temporarily by the
3521 * library as part of a crypto operation in flight.
3522 *
3523 * If this option is unset, the library will fall back to a default value of
3524 * 32 keys.
3525 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003526//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003527
Paul Bakker088c5c52014-04-25 11:11:10 +02003528/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003529//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3530//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003531
Paul Bakker088c5c52014-04-25 11:11:10 +02003532/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003533
Angus Grattond8213d02016-05-25 20:56:48 +10003534/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3535 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003536 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003537 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003538 * This determines the size of the incoming TLS I/O buffer in such a way
3539 * that it is capable of holding the specified amount of plaintext data,
3540 * regardless of the protection mechanism used.
3541 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003542 * \note When using a value less than the default of 16KB on the client, it is
3543 * recommended to use the Maximum Fragment Length (MFL) extension to
3544 * inform the server about this limitation. On the server, there
3545 * is no supported, standardized way of informing the client about
3546 * restriction on the maximum size of incoming messages, and unless
3547 * the limitation has been communicated by other means, it is recommended
3548 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3549 * while keeping the default value of 16KB for the incoming buffer.
3550 *
David Horstmann95d516f2021-05-04 18:36:56 +01003551 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003552 */
3553//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3554
Gilles Peskined3d02902020-03-04 21:35:27 +01003555/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3556 *
3557 * The maximum length of CIDs used for incoming DTLS messages.
3558 *
3559 */
3560//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3561
3562/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3563 *
3564 * The maximum length of CIDs used for outgoing DTLS messages.
3565 *
3566 */
3567//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3568
3569/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3570 *
3571 * This option controls the use of record plaintext padding
3572 * when using the Connection ID extension in DTLS 1.2.
3573 *
3574 * The padding will always be chosen so that the length of the
3575 * padded plaintext is a multiple of the value of this option.
3576 *
3577 * Note: A value of \c 1 means that no padding will be used
3578 * for outgoing records.
3579 *
3580 * Note: On systems lacking division instructions,
3581 * a power of two should be preferred.
3582 *
3583 */
3584//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3585
Hanno Beckerceef8482020-06-02 06:16:00 +01003586/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003587 *
3588 * This option controls the use of record plaintext padding
3589 * in TLS 1.3.
3590 *
3591 * The padding will always be chosen so that the length of the
3592 * padded plaintext is a multiple of the value of this option.
3593 *
3594 * Note: A value of \c 1 means that no padding will be used
3595 * for outgoing records.
3596 *
3597 * Note: On systems lacking division instructions,
3598 * a power of two should be preferred.
3599 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003600//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003601
Angus Grattond8213d02016-05-25 20:56:48 +10003602/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3603 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003604 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003605 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003606 * This determines the size of the outgoing TLS I/O buffer in such a way
3607 * that it is capable of holding the specified amount of plaintext data,
3608 * regardless of the protection mechanism used.
3609 *
Angus Grattond8213d02016-05-25 20:56:48 +10003610 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3611 * the default inward 16384 byte buffer to conform to the TLS specification.
3612 *
3613 * The minimum required outward buffer size is determined by the handshake
3614 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3615 * The specific size requirement depends on the configured ciphers and any
3616 * certificate data which is sent during the handshake.
3617 *
David Horstmann95d516f2021-05-04 18:36:56 +01003618 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003619 */
3620//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3621
Hanno Beckere0b150f2018-08-21 15:51:03 +01003622/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3623 *
3624 * Maximum number of heap-allocated bytes for the purpose of
3625 * DTLS handshake message reassembly and future message buffering.
3626 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003627 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003628 * to account for a reassembled handshake message of maximum size,
3629 * together with its reassembly bitmap.
3630 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003631 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003632 * should be sufficient for all practical situations as it allows
3633 * to reassembly a large handshake message (such as a certificate)
3634 * while buffering multiple smaller handshake messages.
3635 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003636 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003637//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003638
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003639//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3640//#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 +02003641
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003642/**
3643 * Complete list of ciphersuites to use, in order of preference.
3644 *
3645 * \warning No dependency checking is done on that field! This option can only
3646 * be used to restrict the set of available ciphersuites. It is your
3647 * responsibility to make sure the needed modules are active.
3648 *
3649 * Use this to save a few hundred bytes of ROM (default ordering of all
3650 * available ciphersuites) and a few to a few hundred bytes of RAM.
3651 *
3652 * The value below is only an example, not the default.
3653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003654//#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 +02003655
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003656/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003657//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003658//#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 +01003659
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003660/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003661 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3662 * signature and ciphersuite selection. Without this build-time option, SHA-1
3663 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3664 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3665 * default. At the time of writing, there is no practical attack on the use
3666 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003667 * to preserve compatibility with existing peers, but the general
3668 * warning applies nonetheless:
3669 *
3670 * \warning SHA-1 is considered a weak message digest and its use constitutes
3671 * a security risk. If possible, we recommend avoiding dependencies
3672 * on it, and considering stronger message digests instead.
3673 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003674 */
3675#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003676
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003677/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003678 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003679 * mbedtls_platform_zeroize(). This replaces the default implementation in
3680 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003681 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003682 * mbedtls_platform_zeroize() is a widely used function across the library to
3683 * zero a block of memory. The implementation is expected to be secure in the
3684 * sense that it has been written to prevent the compiler from removing calls
3685 * to mbedtls_platform_zeroize() as part of redundant code elimination
3686 * optimizations. However, it is difficult to guarantee that calls to
3687 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3688 * versions of the C language standards do not provide a secure implementation
3689 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3690 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003691 * example by using directives specific to their compiler, features from newer
3692 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003693 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003694 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003695//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003696
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003697/**
3698 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003699 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003700 * platform_util.c.
3701 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003702 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003703 * library will try to use safer implementations of this function, such as
3704 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003705 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003706 * using the standard gmtime(). In this case, calls from the library to
3707 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003708 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003709 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003710 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3711 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3712 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003713 */
Hanno Becker6a739782018-09-05 15:06:19 +01003714//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003715
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003716/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003717 * Enable the verified implementations of ECDH primitives from Project Everest
3718 * (currently only Curve25519). This feature changes the layout of ECDH
3719 * contexts and therefore is a compatibility break for applications that access
3720 * fields of a mbedtls_ecdh_context structure directly. See also
3721 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003722 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003723//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003724
Simon Butcher30b5f972016-06-08 19:00:23 +01003725/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003726
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003727/* Target and application specific configurations
3728 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003729 * Allow user to override any previous default.
3730 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003731 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003732#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003733#include MBEDTLS_USER_CONFIG_FILE
3734#endif
3735
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003736#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07003737#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003738#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07003739
Jaeden Amero6609aef2019-07-04 20:01:14 +01003740#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742#endif /* MBEDTLS_CONFIG_H */