blob: 993b90ff66f14a02222274222fffddf084c9d741 [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 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200424 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100425 * 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/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200531 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200532 *
533 * Uncomment this macro to let mbed TLS use your own implementation of a
534 * hardware entropy collector.
535 *
536 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000537 * prototype as declared in library/entropy_poll.h, and accept NULL as first
538 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200539 *
540 * Uncomment to use your own hardware entropy collector.
541 */
542//#define MBEDTLS_ENTROPY_HARDWARE_ALT
543
544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000546 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100547 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000548 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100549 * Uncomment this macro to use precomputed AES tables stored in ROM.
550 * Comment this macro to generate AES tables in RAM at runtime.
551 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100552 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
553 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100554 * initialization time before the first AES operation can be performed.
555 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
556 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
557 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100558 *
559 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
560 *
Paul Bakker15566e42011-04-24 21:19:15 +0000561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200562//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000563
564/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100565 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200566 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100567 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200568 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100569 * Uncommenting this macro omits 75% of the AES tables from
570 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
571 * by computing their values on the fly during operations
572 * (the tables are entry-wise rotations of one another).
573 *
574 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100575 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100576 * runtime. Specifically, one has to compare 4 accesses within
577 * different tables to 4 accesses with additional arithmetic
578 * operations within the same table. The performance gain/loss
579 * depends on the system and memory details.
580 *
581 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
582 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200583 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100584//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200585
586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200588 *
589 * Use less ROM for the Camellia implementation (saves about 768 bytes).
590 *
591 * Uncomment this macro to use less memory for Camellia.
592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200594
595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200597 *
598 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200601
602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000604 *
605 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000608
609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000611 *
612 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000615
616/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100617 * \def MBEDTLS_CIPHER_MODE_OFB
618 *
619 * Enable Output Feedback mode (OFB) for symmetric ciphers.
620 */
621#define MBEDTLS_CIPHER_MODE_OFB
622
623/**
624 * \def MBEDTLS_CIPHER_MODE_XTS
625 *
626 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
627 */
628#define MBEDTLS_CIPHER_MODE_XTS
629
630/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000632 *
633 * Enable NULL cipher.
634 * Warning: Only do so when you know what you are doing. This allows for
635 * encryption or channels without any security!
636 *
Ronald Croncee42702021-04-26 11:34:44 +0200637 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200638 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
639 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
640 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
641 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
642 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
643 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
644 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
645 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
646 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
647 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
648 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
649 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
650 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
651 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
652 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
653 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
654 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
655 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
656 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000657 *
658 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000661
662/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100663 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200664 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100665 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
666 * specific padding modes in the cipher layer with cipher modes that support
667 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200668 *
669 * If you disable all padding modes, only full blocks can be used with CBC.
670 *
671 * Enable padding modes in the cipher layer.
672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673#define MBEDTLS_CIPHER_PADDING_PKCS7
674#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
675#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
676#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200677
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200678/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
679 *
680 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
681 * By default, CTR_DRBG uses a 256-bit key.
682 */
683//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
684
Paul Bakker48e93c82013-08-14 12:21:18 +0200685/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000686 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
687 *
688 * Remove 3DES ciphersuites by default in SSL / TLS.
689 * This flag removes the ciphersuites based on 3DES from the default list as
690 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
691 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
692 * them explicitly.
693 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000694 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000695 * a TLS connection using a 3DES based cipher suite (see "On the Practical
696 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
697 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
698 * in your threat model or you are unsure, then you should keep this option
699 * enabled to remove 3DES based cipher suites.
700 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000701 * Comment this macro to keep 3DES in the default ciphersuite list.
702 */
703#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
704
705/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100706 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200707 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100708 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
709 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200710 *
711 * Comment macros to disable the curve and functions for it
712 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200713/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
715#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
716#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
717#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
718#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
719#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
720#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
721#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
722#define MBEDTLS_ECP_DP_BP256R1_ENABLED
723#define MBEDTLS_ECP_DP_BP384R1_ENABLED
724#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200725/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200726#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000727#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200728
729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200730 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200731 *
732 * Enable specific 'modulo p' routines for each NIST prime.
733 * Depending on the prime and architecture, makes operations 4 to 8 times
734 * faster on the corresponding curve.
735 *
736 * Comment this macro to disable NIST curves optimisation.
737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200739
740/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200741 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
742 *
743 * When this option is disabled, mbedtls_ecp_mul() will make use of an
744 * internal RNG when called with a NULL \c f_rng argument, in order to protect
745 * against some side-channel attacks.
746 *
747 * This protection introduces a dependency of the ECP module on one of the
748 * DRBG modules. For very constrained implementations that don't require this
749 * protection (for example, because you're only doing signature verification,
750 * so not manipulating any secret, or because local/physical side-channel
751 * attacks are outside your threat model), it might be desirable to get rid of
752 * that dependency.
753 *
754 * \warning Enabling this option makes some uses of ECP vulnerable to some
755 * side-channel attacks. Only enable it if you know that's not a problem for
756 * your use case.
757 *
758 * Uncomment this macro to disable some counter-measures in ECP.
759 */
760//#define MBEDTLS_ECP_NO_INTERNAL_RNG
761
762/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200763 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100764 *
765 * Enable "non-blocking" ECC operations that can return early and be resumed.
766 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200767 * This allows various functions to pause by returning
768 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
769 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
770 * order to further progress and eventually complete their operation. This is
771 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
772 * number of ECC operations a function may perform before pausing; see
773 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100774 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200775 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200776 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100777 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200778 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200779 *
Ron Eldor19779c42018-11-05 16:58:13 +0200780 * \note This option only works with the default software implementation of
781 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100782 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
783 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100784 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200785//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100786
787/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100788 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
789 *
790 * Use a backward compatible ECDH context.
791 *
792 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
793 * defined in `ecdh.h`). For most applications, the choice of format makes
794 * no difference, since all library functions can work with either format,
795 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
796
797 * The new format used when this option is disabled is smaller
798 * (56 bytes on a 32-bit platform). In future versions of the library, it
799 * will support alternative implementations of ECDH operations.
800 * The new format is incompatible with applications that access
801 * context fields directly and with restartable ECP operations.
802 *
803 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
804 * want to access ECDH context fields directly. Otherwise you should
805 * comment out this macro definition.
806 *
807 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
808 *
809 * \note This configuration option is experimental. Future versions of the
810 * library may modify the way the ECDH context layout is configured
811 * and may modify the layout of the new context type.
812 */
813#define MBEDTLS_ECDH_LEGACY_CONTEXT
814
815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100817 *
818 * Enable deterministic ECDSA (RFC 6979).
819 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
820 * may result in a compromise of the long-term signing key. This is avoided by
821 * the deterministic variant.
822 *
John Durkop36a82e52020-10-26 09:39:05 -0700823 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100824 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100825 * Comment this macro to disable deterministic ECDSA.
826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100828
829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200831 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200832 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200833 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 * This enables the following ciphersuites (if other requisites are
835 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
837 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
838 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
839 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
840 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
841 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
842 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
843 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
844 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
845 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
846 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200849
850/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200852 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200853 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 *
857 * This enables the following ciphersuites (if other requisites are
858 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
860 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
861 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
862 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
863 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
864 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
865 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
866 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
867 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
868 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
869 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100870 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100871 * \warning Using DHE constitutes a security risk as it
872 * is not possible to validate custom DH parameters.
873 * If possible, it is recommended users should consider
874 * preferring other methods of key exchange.
875 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100876 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200878#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200879
880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200882 *
883 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
884 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200886 *
887 * This enables the following ciphersuites (if other requisites are
888 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
890 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
891 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
892 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
893 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
894 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
895 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200896 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200898
899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200902 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200903 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
905 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906 *
907 * This enables the following ciphersuites (if other requisites are
908 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
910 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
911 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
912 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
913 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
914 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
915 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
916 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
917 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
918 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
919 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200922
923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200925 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200926 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200927 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
929 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200930 *
931 * This enables the following ciphersuites (if other requisites are
932 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
934 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
935 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
936 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
937 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
938 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
939 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
940 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
942 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
943 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
944 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
945 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200948
949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200951 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200952 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
955 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200956 *
957 * This enables the following ciphersuites (if other requisites are
958 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
960 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
961 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
962 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
963 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
964 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
965 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
966 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
967 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
968 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
969 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
970 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
971 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100972 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100973 * \warning Using DHE constitutes a security risk as it
974 * is not possible to validate custom DH parameters.
975 * If possible, it is recommended users should consider
976 * preferring other methods of key exchange.
977 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100978 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200979 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200981
982/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200984 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200985 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
988 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200989 *
990 * This enables the following ciphersuites (if other requisites are
991 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
993 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
994 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
995 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
996 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
997 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
998 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
999 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1000 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1001 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1002 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001008 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001009 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001010 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001012 *
1013 * This enables the following ciphersuites (if other requisites are
1014 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1016 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1017 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1018 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1019 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1020 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1021 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1022 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1023 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1024 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1025 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001028
1029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001031 *
1032 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1033 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001034 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001035 *
1036 * This enables the following ciphersuites (if other requisites are
1037 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1039 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1040 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1041 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1042 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1043 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1044 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1045 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1046 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1047 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1048 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001051
1052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001054 *
1055 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1056 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001057 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001058 *
1059 * This enables the following ciphersuites (if other requisites are
1060 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1062 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1063 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1064 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1065 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1066 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1067 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1068 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1069 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1070 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1071 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001074
1075/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001076 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1077 *
1078 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1079 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001080 * \warning This is currently experimental. EC J-PAKE support is based on the
1081 * Thread v1.0.0 specification; incompatible changes to the specification
1082 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001083 *
1084 * Requires: MBEDTLS_ECJPAKE_C
1085 * MBEDTLS_SHA256_C
1086 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1087 *
1088 * This enables the following ciphersuites (if other requisites are
1089 * enabled as well):
1090 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1091 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001092//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001093
1094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001096 *
1097 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1098 * RFC 5915 and RFC 5480.
1099 *
1100 * Currently this means parsing the SpecifiedECDomain choice of EC
1101 * parameters (only known groups are supported, not arbitrary domains, to
1102 * avoid validation issues).
1103 *
1104 * Disable if you only need to support RFC 5915 + 5480 key formats.
1105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001107
1108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001110 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 * Enable a dummy error function to make use of mbedtls_strerror() in
1112 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1113 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001114 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1116 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001117 *
1118 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001122
1123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001125 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001126 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001127 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001131
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001134 *
1135 * Enable functions that use the filesystem.
1136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001138
1139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001141 *
Mateusz Starzyk0fdcc8e2021-01-29 16:46:31 +01001142 * Do not add default entropy sources. These are the platform specific
1143 * or mbedtls_timing_hardclock poll function.
Paul Bakker43655f42011-12-15 20:11:16 +00001144 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001145 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001146 * application.
1147 *
1148 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001151
1152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001154 *
1155 * Do not use built-in platform entropy functions.
1156 * This is useful if your platform does not support
1157 * standards like the /dev/urandom or Windows CryptoAPI.
1158 *
1159 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001162
1163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001165 *
1166 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1167 * default SHA-512 based one (if both are available).
1168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001170 *
1171 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1172 * if you have performance concerns.
1173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174 * This option is only useful if both MBEDTLS_SHA256_C and
1175 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001178
1179/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001180 * \def MBEDTLS_ENTROPY_NV_SEED
1181 *
1182 * Enable the non-volatile (NV) seed file-based entropy source.
1183 * (Also enables the NV seed read/write functions in the platform layer)
1184 *
1185 * This is crucial (if not required) on systems that do not have a
1186 * cryptographic entropy source (in hardware or kernel) available.
1187 *
1188 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1189 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001190 * \note The read/write functions that are used by the entropy source are
1191 * determined in the platform layer, and can be modified at runtime and/or
1192 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1193 *
1194 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001195 * with regular fopen(), please make sure you make a seedfile with the
1196 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1197 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001198 * and written to or you will get an entropy source error! The default
1199 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1200 * bytes from the file.
1201 *
1202 * \note The entropy collector will write to the seed file before entropy is
1203 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001204 */
1205//#define MBEDTLS_ENTROPY_NV_SEED
1206
Ronald Cron71016a92020-08-28 19:01:50 +02001207/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001208 *
Ronald Cron71016a92020-08-28 19:01:50 +02001209 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001210 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001211 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1212 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001213 *
1214 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001215 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001216 */
Ronald Cron71016a92020-08-28 19:01:50 +02001217//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001218
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001219/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001221 *
1222 * Enable debugging of buffer allocator memory issues. Automatically prints
1223 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1224 * function for 'debug output' of allocated memory.
1225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001227 *
1228 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001231
1232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001234 *
1235 * Include backtrace information with each allocated block.
1236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001238 * GLIBC-compatible backtrace() an backtrace_symbols() support
1239 *
1240 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001243
1244/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001246 *
1247 * Support external private RSA keys (eg from a HSM) in the PK layer.
1248 *
1249 * Comment this macro to disable support for external private RSA keys.
1250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001251#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001252
1253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001255 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001256 * Enable support for PKCS#1 v1.5 encoding.
1257 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001259 *
Paul Bakker48377d92013-08-30 12:06:24 +02001260 * This enables support for PKCS#1 v1.5 operations.
1261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001263
1264/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001266 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001267 * Enable support for PKCS#1 v2.1 encoding.
1268 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001270 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001271 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001274
Steven Cooreman6801f082021-02-19 17:21:22 +01001275/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1276 *
1277 * Enable support for platform built-in keys. If you enable this feature,
1278 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1279 * See the documentation of that function for more information.
1280 *
1281 * Built-in keys are typically derived from a hardware unique key or
1282 * stored in a secure element.
1283 *
1284 * Requires: MBEDTLS_PSA_CRYPTO_C.
1285 *
1286 * \warning This interface is experimental and may change or be removed
1287 * without notice.
1288 */
1289//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1290
Ronald Cron3768ac12021-01-26 16:58:00 +01001291/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1292 *
1293 * Enable support for PSA crypto client.
1294 *
1295 * \note This option allows to include the code necessary for a PSA
1296 * crypto client when the PSA crypto implementation is not included in
1297 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1298 * code to set and get PSA key attributes.
1299 * The development of PSA drivers partially relying on the library to
1300 * fulfill the hardware gaps is another possible usage of this option.
1301 *
1302 * \warning This interface is experimental and may change or be removed
1303 * without notice.
1304 */
1305//#define MBEDTLS_PSA_CRYPTO_CLIENT
1306
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001307/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1308 *
1309 * Enable support for the experimental PSA crypto driver interface.
1310 *
John Durkop185764f2020-10-12 21:32:12 -07001311 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001312 *
1313 * \warning This interface is experimental and may change or be removed
1314 * without notice.
1315 */
1316//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1317
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001318/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1319 *
1320 * Make the PSA Crypto module use an external random generator provided
1321 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1322 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001323 * \note This random generator must deliver random numbers with cryptographic
1324 * quality and high performance. It must supply unpredictable numbers
1325 * with a uniform distribution. The implementation of this function
1326 * is responsible for ensuring that the random generator is seeded
1327 * with sufficient entropy. If you have a hardware TRNG which is slow
1328 * or delivers non-uniform output, declare it as an entropy source
1329 * with mbedtls_entropy_add_source() instead of enabling this option.
1330 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001331 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001332 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1333 * and define a function called mbedtls_psa_external_get_random()
1334 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001335 * ```
1336 * psa_status_t mbedtls_psa_external_get_random(
1337 * mbedtls_psa_external_random_context_t *context,
1338 * uint8_t *output, size_t output_size, size_t *output_length);
1339 * );
1340 * ```
1341 * The \c context value is initialized to 0 before the first call.
1342 * The function must fill the \c output buffer with \p output_size bytes
1343 * of random data and set \c *output_length to \p output_size.
1344 *
1345 * Requires: MBEDTLS_PSA_CRYPTO_C
1346 *
1347 * \warning If you enable this option, code that uses the PSA cryptography
1348 * interface will not use any of the entropy sources set up for
1349 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1350 * enables.
1351 *
1352 * \note This option is experimental and may be removed without notice.
1353 */
1354//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1355
Paul Bakker9dcc3222011-03-08 14:16:06 +00001356/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001357 * \def MBEDTLS_PSA_CRYPTO_SPM
1358 *
1359 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1360 * Partition Manager) integration which separates the code into two parts: a
1361 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1362 * Environment).
1363 *
1364 * Module: library/psa_crypto.c
1365 * Requires: MBEDTLS_PSA_CRYPTO_C
1366 *
1367 */
1368//#define MBEDTLS_PSA_CRYPTO_SPM
1369
1370/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001371 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001372 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001373 * Enable support for entropy injection at first boot. This feature is
1374 * required on systems that do not have a built-in entropy source (TRNG).
1375 * This feature is currently not supported on systems that have a built-in
1376 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001377 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001378 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001379 *
1380 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001381//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001382
1383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001385 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001386 * Do not use the Chinese Remainder Theorem
1387 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001388 *
1389 * Uncomment this macro to disable the use of CRT in RSA.
1390 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001393
1394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001396 *
1397 * Enable the checkup functions (*_self_test).
1398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001399#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001400
1401/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001402 * \def MBEDTLS_SHA256_SMALLER
1403 *
1404 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1405 * lower performance.
1406 *
1407 * The default implementation is meant to be a reasonnable compromise between
1408 * performance and size. This version optimizes more aggressively for size at
1409 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1410 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1411 * 30%.
1412 *
1413 * Uncomment to enable the smaller implementation of SHA256.
1414 */
1415//#define MBEDTLS_SHA256_SMALLER
1416
1417/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001418 * \def MBEDTLS_SHA512_SMALLER
1419 *
1420 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1421 * lower performance.
1422 *
1423 * Uncomment to enable the smaller implementation of SHA512.
1424 */
1425//#define MBEDTLS_SHA512_SMALLER
1426
1427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001429 *
1430 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001431 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001432 * with other servers, only debugging of failures is harder.
1433 *
1434 * The advantage of not sending alert messages, is that no information is given
1435 * about reasons for failures thus preventing adversaries of gaining intel.
1436 *
1437 * Enable sending of all alert messages
1438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001439#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001440
1441/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001442 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1443 *
1444 * Enable support for the DTLS Connection ID extension
1445 * (version draft-ietf-tls-dtls-connection-id-05,
1446 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1447 * which allows to identify DTLS connections across changes
1448 * in the underlying transport.
1449 *
1450 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1451 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1452 * See the corresponding documentation for more information.
1453 *
1454 * \warning The Connection ID extension is still in draft state.
1455 * We make no stability promises for the availability
1456 * or the shape of the API controlled by this option.
1457 *
1458 * The maximum lengths of outgoing and incoming CIDs can be configured
1459 * through the options
1460 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1461 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1462 *
1463 * Requires: MBEDTLS_SSL_PROTO_DTLS
1464 *
1465 * Uncomment to enable the Connection ID extension.
1466 */
1467//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1468
1469/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001470 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1471 *
1472 * Enable asynchronous external private key operations in SSL. This allows
1473 * you to configure an SSL connection to call an external cryptographic
1474 * module to perform private key operations instead of performing the
1475 * operation inside the library.
1476 *
1477 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001478//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001479
1480/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001481 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1482 *
1483 * Enable serialization of the TLS context structures, through use of the
1484 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1485 *
1486 * This pair of functions allows one side of a connection to serialize the
1487 * context associated with the connection, then free or re-use that context
1488 * while the serialized state is persisted elsewhere, and finally deserialize
1489 * that state to a live context for resuming read/write operations on the
1490 * connection. From a protocol perspective, the state of the connection is
1491 * unaffected, in particular this is entirely transparent to the peer.
1492 *
1493 * Note: this is distinct from TLS session resumption, which is part of the
1494 * protocol and fully visible by the peer. TLS session resumption enables
1495 * establishing new connections associated to a saved session with shorter,
1496 * lighter handshakes, while context serialization is a local optimization in
1497 * handling a single, potentially long-lived connection.
1498 *
1499 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1500 * saved after the handshake to allow for more efficient serialization, so if
1501 * you don't need this feature you'll save RAM by disabling it.
1502 *
1503 * Comment to disable the context serialization APIs.
1504 */
1505#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1506
1507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001509 *
1510 * Enable the debug messages in SSL module for all issues.
1511 * Debug messages have been disabled in some places to prevent timing
1512 * attacks due to (unbalanced) debugging function calls.
1513 *
1514 * If you need all error reporting you should enable this during debugging,
1515 * but remove this for production servers that should log as well.
1516 *
1517 * Uncomment this macro to report all debug messages on errors introducing
1518 * a timing side-channel.
1519 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001524 *
1525 * Enable support for Encrypt-then-MAC, RFC 7366.
1526 *
1527 * This allows peers that both support it to use a more robust protection for
1528 * ciphersuites using CBC, providing deep resistance against timing attacks
1529 * on the padding or underlying cipher.
1530 *
1531 * This only affects CBC ciphersuites, and is useless if none is defined.
1532 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001533 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001534 *
1535 * Comment this macro to disable support for Encrypt-then-MAC
1536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001540 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001541 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1542 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001543 *
1544 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1545 * attacks, but it is recommended to always use it (even if you disable
1546 * renegotiation), since it actually fixes a more fundamental issue in the
1547 * original SSL/TLS design, and has implications beyond Triple Handshake.
1548 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001549 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001550 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001551 * Comment this macro to disable support for Extended Master Secret.
1552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001554
Paul Bakkerd66f0702013-01-31 16:57:45 +01001555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001557 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001558 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1559 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001560 *
1561 * For servers, it is recommended to always enable this, unless you support
1562 * only one version of TLS, or know for sure that none of your clients
1563 * implements a fallback strategy.
1564 *
1565 * For clients, you only need this if you're using a fallback strategy, which
1566 * is not recommended in the first place, unless you absolutely need it to
1567 * interoperate with buggy (version-intolerant) servers.
1568 *
1569 * Comment this macro to disable support for FALLBACK_SCSV
1570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001572
1573/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001574 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1575 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001576 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001577 * giving access to the peer's certificate after completion of the handshake.
1578 *
1579 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1580 * recommended to disable this option for reduced RAM usage.
1581 *
1582 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1583 * defined, but always returns \c NULL.
1584 *
1585 * \note This option has no influence on the protection against the
1586 * triple handshake attack. Even if it is disabled, Mbed TLS will
1587 * still ensure that certificates do not change during renegotiation,
1588 * for exaple by keeping a hash of the peer's certificate.
1589 *
1590 * Comment this macro to disable storing the peer's certificate
1591 * after the handshake.
1592 */
1593#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1594
1595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001597 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001598 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001599 *
1600 * The two main uses of renegotiation are (1) refresh keys on long-lived
1601 * connections and (2) client authentication after the initial handshake.
1602 * If you don't need renegotiation, it's probably better to disable it, since
1603 * it has been associated with security issues in the past and is easy to
1604 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001605 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001606 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001607 *
1608 * \note Even if this option is disabled, both client and server are aware
1609 * of the Renegotiation Indication Extension (RFC 5746) used to
1610 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1611 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1612 * configuration of this extension).
1613 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001616
1617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001619 *
1620 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001622 *
1623 * Uncomment this macro to respect client's ciphersuite order
1624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001626
1627/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001629 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001630 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001631 *
1632 * Comment this macro to disable support for the max_fragment_length extension
1633 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001635
1636/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001638 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001639 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001640 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001642 * (Depends on ciphersuites)
1643 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001644 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001647
1648/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001649 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1650 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001651 * This macro is used to selectively enable experimental parts
1652 * of the code that contribute to the ongoing development of
1653 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1654 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001655 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001656 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1657 * and no feature exposed through this macro is part of the
1658 * public API. In particular, features under the control
1659 * of this macro are experimental and don't come with any
1660 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001661 *
1662 * Uncomment this macro to enable experimental and partial
1663 * functionality specific to TLS 1.3.
1664 */
Hanno Beckere4160602020-05-07 15:11:45 +01001665//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001666
1667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001669 *
1670 * Enable support for DTLS (all available versions).
1671 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001672 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001673 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001674 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001675 *
1676 * Comment this macro to disable support for DTLS
1677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001679
1680/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001682 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001683 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001684 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001685 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001688
1689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001691 *
1692 * Enable support for the anti-replay mechanism in DTLS.
1693 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 * Requires: MBEDTLS_SSL_TLS_C
1695 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001696 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001697 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001698 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001699 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001700 * Comment this to disable anti-replay in DTLS.
1701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001703
1704/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001706 *
1707 * Enable support for HelloVerifyRequest on DTLS servers.
1708 *
1709 * This feature is highly recommended to prevent DTLS servers being used as
1710 * amplifiers in DoS attacks against other hosts. It should always be enabled
1711 * unless you know for sure amplification cannot be a problem in the
1712 * environment in which your server operates.
1713 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001714 * \warning Disabling this can ba a security risk! (see above)
1715 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001716 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001717 *
1718 * Comment this to disable support for HelloVerifyRequest.
1719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001721
1722/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001723 * \def MBEDTLS_SSL_DTLS_SRTP
1724 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001725 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001726 * through the use_srtp extension.
1727 *
1728 * \note This feature provides the minimum functionality required
1729 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1730 * the associated SRTP packet protection key material.
1731 * In particular, the SRTP packet protection itself, as well as the
1732 * demultiplexing of RTP and DTLS packets at the datagram layer
1733 * (see Section 5 of RFC 5764), are not handled by this feature.
1734 * Instead, after successful completion of a handshake negotiating
1735 * the use of DTLS-SRTP, the extended key exporter API
1736 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1737 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1738 * (this is implemented in the SSL example programs).
1739 * The resulting key should then be passed to an SRTP stack.
1740 *
1741 * Setting this option enables the runtime API
1742 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1743 * through which the supported DTLS-SRTP protection
1744 * profiles can be configured. You must call this API at
1745 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001746 *
1747 * Requires: MBEDTLS_SSL_PROTO_DTLS
1748 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001749 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001750 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001751//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001752
1753/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001754 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1755 *
1756 * Enable server-side support for clients that reconnect from the same port.
1757 *
1758 * Some clients unexpectedly close the connection and try to reconnect using the
1759 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001760 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001761 * flag enables that support.
1762 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001763 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001764 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001765 * Comment this to disable support for clients reusing the source port.
1766 */
1767#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1768
1769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001771 *
1772 * Enable support for a limit of records with bad MAC.
1773 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001774 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001775 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001779
1780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001782 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001783 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001784 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001785 * session store remains the responsibility of the application, though).
1786 * Server-side, you also need to provide callbacks for writing and parsing
1787 * tickets, including authenticated encryption and key management. Example
1788 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001789 *
1790 * Comment this macro to disable support for SSL session tickets
1791 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001793
1794/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001795 * \def MBEDTLS_SSL_EXPORT_KEYS
1796 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001797 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001798 * This is required for certain users of TLS, e.g. EAP-TLS.
1799 *
1800 * Comment this macro to disable support for key export
1801 */
1802#define MBEDTLS_SSL_EXPORT_KEYS
1803
1804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001807 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001808 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001810 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001811 * Comment this macro to disable support for server name indication in SSL
1812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001814
1815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001817 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001818 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001819 *
1820 * Comment this macro to disable support for truncated HMAC in SSL
1821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001823
1824/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001825 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1826 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001827 * When this option is enabled, the SSL buffer will be resized automatically
1828 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001829 *
1830 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001831 */
1832//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1833
1834/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001835 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1836 *
1837 * Enable testing of the constant-flow nature of some sensitive functions with
1838 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001839 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001840 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001841 * This setting requires compiling with clang -fsanitize=memory. The test
1842 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001843 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001844 * \warning This macro is only used for extended testing; it is not considered
1845 * part of the library's API, so it may change or disappear at any time.
1846 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001847 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001848 */
1849//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1850
1851/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001852 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1853 *
1854 * Enable testing of the constant-flow nature of some sensitive functions with
1855 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001856 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001857 *
1858 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001859 * testing if the tests suites are run with valgrind's memcheck. This can be
1860 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1861 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001862 *
1863 * \warning This macro is only used for extended testing; it is not considered
1864 * part of the library's API, so it may change or disappear at any time.
1865 *
1866 * Uncomment to enable testing of the constant-flow nature of selected code.
1867 */
1868//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1869
1870/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001871 * \def MBEDTLS_TEST_HOOKS
1872 *
1873 * Enable features for invasive testing such as introspection functions and
1874 * hooks for fault injection. This enables additional unit tests.
1875 *
1876 * Merely enabling this feature should not change the behavior of the product.
1877 * It only adds new code, and new branching points where the default behavior
1878 * is the same as when this feature is disabled.
1879 * However, this feature increases the attack surface: there is an added
1880 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1881 * Therefore this feature must never be enabled in production.
1882 *
1883 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1884 * information.
1885 *
1886 * Uncomment to enable invasive tests.
1887 */
1888//#define MBEDTLS_TEST_HOOKS
1889
1890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001892 *
1893 * Provide your own alternate threading implementation.
1894 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001896 *
1897 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001900
1901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001903 *
1904 * Enable the pthread wrapper layer for the threading layer.
1905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001907 *
1908 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001911
1912/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001913 * \def MBEDTLS_USE_PSA_CRYPTO
1914 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001915 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1916 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001917 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001918 * \note Development of this option is currently in progress, and parts of Mbed
1919 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001920 * will still continue to work as usual, so enabling this option should not
1921 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001922 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001923 * \warning The PSA Crypto API is in beta stage. While you're welcome to
1924 * experiment using it, incompatible API changes are still possible, and some
1925 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001926 *
1927 * \warning This option enables new Mbed TLS APIs that are dependent on the
1928 * PSA Crypto API, so can't come with the same stability guarantees as the
1929 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001930 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001931 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00001932 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001933 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001934 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001935 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001936 */
1937//#define MBEDTLS_USE_PSA_CRYPTO
1938
1939/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001940 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1941 *
John Durkop185764f2020-10-12 21:32:12 -07001942 * This setting allows support for cryptographic mechanisms through the PSA
1943 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001944 *
John Durkop185764f2020-10-12 21:32:12 -07001945 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01001946 * can be found in include/psa/crypto_config.h.
1947 *
1948 * If you enable this option and write your own configuration file, you must
1949 * include mbedtls/config_psa.h in your configuration file. The default
1950 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07001951 *
1952 * This feature is still experimental and is not ready for production since
1953 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001954 */
1955//#define MBEDTLS_PSA_CRYPTO_CONFIG
1956
1957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001959 *
1960 * Allow run-time checking of compile-time enabled features. Thus allowing users
1961 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001965 *
1966 * Comment this to disable run-time checking and save ROM space
1967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001969
1970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001972 *
1973 * If set, the X509 parser will not break-off when parsing an X509 certificate
1974 * and encountering an extension in a v1 or v2 certificate.
1975 *
1976 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001979
1980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00001982 *
1983 * If set, the X509 parser will not break-off when parsing an X509 certificate
1984 * and encountering an unknown critical extension.
1985 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01001986 * \warning Depending on your PKI use, enabling this can be a security risk!
1987 *
Paul Bakker5c721f92011-07-27 16:51:09 +00001988 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00001989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00001991
1992/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001993 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1994 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001995 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001996 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1997 * the set of trusted certificates through a callback instead of a linked
1998 * list.
1999 *
2000 * This is useful for example in environments where a large number of trusted
2001 * certificates is present and storing them in a linked list isn't efficient
2002 * enough, or when the set of trusted certificates changes frequently.
2003 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002004 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002005 * `mbedtls_ssl_conf_ca_cb()` for more information.
2006 *
2007 * Uncomment to enable trusted certificate callbacks.
2008 */
2009//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2010
2011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002013 *
2014 * Enable verification of the keyUsage extension (CA and leaf certificates).
2015 *
2016 * Disabling this avoids problems with mis-issued and/or misused
2017 * (intermediate) CA and leaf certificates.
2018 *
2019 * \warning Depending on your PKI use, disabling this can be a security risk!
2020 *
2021 * Comment to skip keyUsage checking for both CA and leaf certificates.
2022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002024
2025/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002027 *
2028 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2029 *
2030 * Disabling this avoids problems with mis-issued and/or misused certificates.
2031 *
2032 * \warning Depending on your PKI use, disabling this can be a security risk!
2033 *
2034 * Comment to skip extendedKeyUsage checking for certificates.
2035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002037
2038/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002039 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002040 *
Chris Jones2c745862020-12-16 11:41:06 +00002041 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002042 *
Chris Jones2c745862020-12-16 11:41:06 +00002043 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002044 * and other functions/constants only used by these functions, thus reducing
2045 * the code footprint by several KB.
2046 */
Chris Jones2c745862020-12-16 11:41:06 +00002047//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002048
2049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002051 *
2052 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2053 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2054 *
2055 * Comment this macro to disallow using RSASSA-PSS in certificates.
2056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002058/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002059
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002060/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002061 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002062 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002063 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002064 * \{
2065 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002066
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002069 *
2070 * Enable AES-NI support on x86-64.
2071 *
2072 * Module: library/aesni.c
2073 * Caller: library/aes.c
2074 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002076 *
2077 * This modules adds support for the AES-NI instructions on x86-64
2078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002080
2081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002083 *
2084 * Enable the AES block cipher.
2085 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002086 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002087 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002088 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002089 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002090 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002091 * This module enables the following ciphersuites (if other requisites are
2092 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2094 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2095 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2096 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2097 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2098 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2099 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2100 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2101 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2102 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2103 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2104 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2105 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2106 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2107 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2108 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2109 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2110 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2111 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2112 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2113 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2114 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2115 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2116 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2117 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2118 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2119 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2120 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2121 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2122 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2123 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2124 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2125 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2126 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2127 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2128 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2129 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2130 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2131 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2132 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2133 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2135 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2136 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2137 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2138 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2139 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2140 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2141 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2142 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2143 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2144 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2145 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2146 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2147 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2148 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2149 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2150 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002151 *
Paul Bakkercff68422013-09-15 20:43:33 +02002152 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002155
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002158 *
2159 * Enable the ARCFOUR stream cipher.
2160 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002162 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002163 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002164 * This module enables the following ciphersuites (if other requisites are
2165 * enabled as well):
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002166 *
2167 * \warning ARC4 is considered a weak cipher and its use constitutes a
2168 * security risk. If possible, we recommend avoidng dependencies on
2169 * it, and considering stronger ciphers instead.
2170 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002173
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002176 *
2177 * Enable the generic ASN1 parser.
2178 *
2179 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002180 * Caller: library/x509.c
2181 * library/dhm.c
2182 * library/pkcs12.c
2183 * library/pkcs5.c
2184 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002187
2188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002190 *
2191 * Enable the generic ASN1 writer.
2192 *
2193 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002194 * Caller: library/ecdsa.c
2195 * library/pkwrite.c
2196 * library/x509_create.c
2197 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002198 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002201
2202/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002204 *
2205 * Enable the Base64 module.
2206 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002207 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002208 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002209 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002210 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002211 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002213
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002214/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002216 *
Paul Bakker9a736322012-11-14 12:39:52 +00002217 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002218 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002219 * Module: library/bignum.c
2220 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002221 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002222 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002223 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002224 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002225 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002226 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002227 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002230
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002233 *
2234 * Enable the Blowfish block cipher.
2235 *
2236 * Module: library/blowfish.c
2237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002239
2240/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002242 *
2243 * Enable the Camellia block cipher.
2244 *
Paul Bakker38119b12009-01-10 23:31:23 +00002245 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002246 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002247 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002248 * This module enables the following ciphersuites (if other requisites are
2249 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2251 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2252 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2254 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2255 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2256 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2257 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2258 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2259 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2261 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2262 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2263 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2264 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2265 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2266 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2267 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2268 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2269 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2270 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2271 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2272 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2273 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2274 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2275 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2276 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2277 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2278 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2279 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2280 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2281 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2282 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2283 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2284 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2286 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2287 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2288 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2289 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002294
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002295/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002296 * \def MBEDTLS_ARIA_C
2297 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002298 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002299 *
2300 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002301 * Caller: library/cipher.c
2302 *
2303 * This module enables the following ciphersuites (if other requisites are
2304 * enabled as well):
2305 *
2306 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2308 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2309 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2310 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2311 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2312 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2313 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2314 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2315 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2316 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2317 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2318 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2319 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2320 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2321 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2322 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2323 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2324 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2325 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2326 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2327 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2328 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2329 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2330 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2331 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2332 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2333 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2337 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2338 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2339 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2340 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2343 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002344 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002345#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002346
2347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002349 *
2350 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2351 *
2352 * Module: library/ccm.c
2353 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002355 *
2356 * This module enables the AES-CCM ciphersuites, if other requisites are
2357 * enabled as well.
2358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002360
2361/**
Daniel King34b822c2016-05-15 17:28:08 -03002362 * \def MBEDTLS_CHACHA20_C
2363 *
2364 * Enable the ChaCha20 stream cipher.
2365 *
2366 * Module: library/chacha20.c
2367 */
2368#define MBEDTLS_CHACHA20_C
2369
2370/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002371 * \def MBEDTLS_CHACHAPOLY_C
2372 *
2373 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2374 *
2375 * Module: library/chachapoly.c
2376 *
2377 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2378 */
2379#define MBEDTLS_CHACHAPOLY_C
2380
2381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002383 *
2384 * Enable the generic cipher layer.
2385 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002386 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002387 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002388 *
2389 * Uncomment to enable generic cipher wrappers.
2390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002392
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002393/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002394 * \def MBEDTLS_CMAC_C
2395 *
Simon Butcher327398a2016-10-05 14:09:11 +01002396 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2397 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002398 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002399 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2400 * implementation of the CMAC algorithm is provided by an alternate
2401 * implementation, that alternate implementation may opt to not support
2402 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2403 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002404 * Module: library/cmac.c
2405 *
Simon Butcher69283e52016-10-06 12:49:58 +01002406 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002407 *
2408 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002409#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002410
2411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002413 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002414 * Enable the CTR_DRBG AES-based random generator.
2415 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002416 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002417 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002418 * \note To achieve a 256-bit security strength with CTR_DRBG,
2419 * you must use AES-256 *and* use sufficient entropy.
2420 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002421 *
2422 * Module: library/ctr_drbg.c
2423 * Caller:
2424 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002426 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002427 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002430
2431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002433 *
2434 * Enable the debug functions.
2435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002436 * Module: library/debug.c
2437 * Caller: library/ssl_cli.c
2438 * library/ssl_srv.c
2439 * library/ssl_tls.c
2440 *
2441 * This module provides debugging functions.
2442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002444
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002447 *
2448 * Enable the DES block cipher.
2449 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002450 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002451 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002452 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002453 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002454 * This module enables the following ciphersuites (if other requisites are
2455 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002456 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2457 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2458 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2459 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2460 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2461 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2462 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2463 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2464 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2465 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002466 *
Paul Bakkercff68422013-09-15 20:43:33 +02002467 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002468 *
2469 * \warning DES is considered a weak cipher and its use constitutes a
2470 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002473
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002474/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002476 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002477 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002478 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 * Module: library/dhm.c
2480 * Caller: library/ssl_cli.c
2481 * library/ssl_srv.c
2482 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002483 * This module is used by the following key exchanges:
2484 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002485 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002486 * \warning Using DHE constitutes a security risk as it
2487 * is not possible to validate custom DH parameters.
2488 * If possible, it is recommended users should consider
2489 * preferring other methods of key exchange.
2490 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002491 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002494
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002497 *
2498 * Enable the elliptic curve Diffie-Hellman library.
2499 *
2500 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002501 * Caller: library/ssl_cli.c
2502 * library/ssl_srv.c
2503 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002504 * This module is used by the following key exchanges:
2505 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002506 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002510
2511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002513 *
2514 * Enable the elliptic curve DSA library.
2515 *
2516 * Module: library/ecdsa.c
2517 * Caller:
2518 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002519 * This module is used by the following key exchanges:
2520 * ECDHE-ECDSA
2521 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002522 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2523 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2524 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002527
2528/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002529 * \def MBEDTLS_ECJPAKE_C
2530 *
2531 * Enable the elliptic curve J-PAKE library.
2532 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002533 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2534 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002535 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002536 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002537 * Module: library/ecjpake.c
2538 * Caller:
2539 *
2540 * This module is used by the following key exchanges:
2541 * ECJPAKE
2542 *
2543 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2544 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002545#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002546
2547/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002549 *
2550 * Enable the elliptic curve over GF(p) library.
2551 *
2552 * Module: library/ecp.c
2553 * Caller: library/ecdh.c
2554 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002555 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002556 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002560
2561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002563 *
2564 * Enable the platform-specific entropy code.
2565 *
2566 * Module: library/entropy.c
2567 * Caller:
2568 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002570 *
2571 * This module provides a generic entropy pool
2572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002574
2575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002577 *
2578 * Enable error code to error string conversion.
2579 *
2580 * Module: library/error.c
2581 * Caller:
2582 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002586
2587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002589 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002590 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002591 *
2592 * Module: library/gcm.c
2593 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002594 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002595 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002596 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2597 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002600
2601/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002602 * \def MBEDTLS_HKDF_C
2603 *
2604 * Enable the HKDF algorithm (RFC 5869).
2605 *
2606 * Module: library/hkdf.c
2607 * Caller:
2608 *
2609 * Requires: MBEDTLS_MD_C
2610 *
2611 * This module adds support for the Hashed Message Authentication Code
2612 * (HMAC)-based key derivation function (HKDF).
2613 */
2614#define MBEDTLS_HKDF_C
2615
2616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002618 *
2619 * Enable the HMAC_DRBG random generator.
2620 *
2621 * Module: library/hmac_drbg.c
2622 * Caller:
2623 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002625 *
2626 * Uncomment to enable the HMAC_DRBG random number geerator.
2627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002629
2630/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002631 * \def MBEDTLS_NIST_KW_C
2632 *
2633 * Enable the Key Wrapping mode for 128-bit block ciphers,
2634 * as defined in NIST SP 800-38F. Only KW and KWP modes
2635 * are supported. At the moment, only AES is approved by NIST.
2636 *
2637 * Module: library/nist_kw.c
2638 *
2639 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2640 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002641#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002642
2643/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002645 *
2646 * Enable the generic message digest layer.
2647 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002648 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002649 * Caller:
2650 *
2651 * Uncomment to enable generic message digest wrappers.
2652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002654
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002655/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002657 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002658 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002659 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002660 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002661 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002662 *
2663 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002664 *
2665 * \warning MD2 is considered a weak message digest and its use constitutes a
2666 * security risk. If possible, we recommend avoiding dependencies on
2667 * it, and considering stronger message digests instead.
2668 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002669 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002671
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002674 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002675 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002676 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002677 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002678 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002679 *
2680 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002681 *
2682 * \warning MD4 is considered a weak message digest and its use constitutes a
2683 * security risk. If possible, we recommend avoiding dependencies on
2684 * it, and considering stronger message digests instead.
2685 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002688
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002691 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002692 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002693 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002694 * Module: library/md5.c
2695 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002696 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002697 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002698 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002699 * This module is required for TLS 1.2 depending on the handshake parameters.
2700 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2701 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002702 *
2703 * \warning MD5 is considered a weak message digest and its use constitutes a
2704 * security risk. If possible, we recommend avoiding dependencies on
2705 * it, and considering stronger message digests instead.
2706 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002709
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002712 *
2713 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002714 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002715 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002716 *
2717 * Module: library/memory_buffer_alloc.c
2718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * Requires: MBEDTLS_PLATFORM_C
2720 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002721 *
2722 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002725
2726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002728 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002729 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2730 *
Simon Butcherd567a232016-03-09 20:19:21 +00002731 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2732 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002733 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002734 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002735 * \note See also our Knowledge Base article about porting to a new
2736 * environment:
2737 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2738 *
Andres AG788aa4a2016-09-14 14:32:09 +01002739 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002740 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002741 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002744
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002747 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002748 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002749 *
2750 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002751 * Caller: library/asn1write.c
2752 * library/pkcs5.c
2753 * library/pkparse.c
2754 * library/pkwrite.c
2755 * library/rsa.c
2756 * library/x509.c
2757 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002758 * library/x509_crl.c
2759 * library/x509_crt.c
2760 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002761 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002762 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002763 *
2764 * This modules translates between OIDs and internal values.
2765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002767
2768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002770 *
2771 * Enable VIA Padlock support on x86.
2772 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002773 * Module: library/padlock.c
2774 * Caller: library/aes.c
2775 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002777 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002778 * This modules adds support for the VIA PadLock on x86.
2779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002781
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002784 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002785 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002786 *
2787 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002788 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002789 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002790 * library/x509_crl.c
2791 * library/x509_crt.c
2792 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002793 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002795 *
Paul Bakkercff68422013-09-15 20:43:33 +02002796 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002799
2800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002802 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002803 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002804 *
2805 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002806 * Caller: library/pkwrite.c
2807 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002808 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002811 *
2812 * This modules adds support for encoding / writing PEM files.
2813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002815
2816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002818 *
2819 * Enable the generic public (asymetric) key layer.
2820 *
2821 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002822 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002823 * library/ssl_cli.c
2824 * library/ssl_srv.c
2825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002827 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002828 * Uncomment to enable generic public key wrappers.
2829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002831
2832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002834 *
2835 * Enable the generic public (asymetric) key parser.
2836 *
2837 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002838 * Caller: library/x509_crt.c
2839 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002840 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002842 *
2843 * Uncomment to enable generic public key parse functions.
2844 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002846
2847/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002849 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002850 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002851 *
2852 * Module: library/pkwrite.c
2853 * Caller: library/x509write.c
2854 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002856 *
2857 * Uncomment to enable generic public key write functions.
2858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002860
2861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002864 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002865 *
2866 * Module: library/pkcs5.c
2867 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002869 *
2870 * This module adds support for the PKCS#5 functions.
2871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002873
2874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002876 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002877 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002878 * Adds algorithms for parsing PKCS#8 encrypted private keys
2879 *
2880 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002881 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002882 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2884 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002885 *
2886 * This module enables PKCS#12 functions.
2887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002889
2890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002892 *
2893 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002894 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2897 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002898 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002899 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002900 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2901 * as other module rely on it for a fixed snprintf implementation.
2902 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002903 * Module: library/platform.c
2904 * Caller: Most other .c files
2905 *
2906 * This module enables abstraction of common (libc) functions.
2907 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002908#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002909
2910/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002911 * \def MBEDTLS_POLY1305_C
2912 *
2913 * Enable the Poly1305 MAC algorithm.
2914 *
2915 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002916 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002917 */
2918#define MBEDTLS_POLY1305_C
2919
2920/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002921 * \def MBEDTLS_PSA_CRYPTO_C
2922 *
2923 * Enable the Platform Security Architecture cryptography API.
2924 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002925 * \warning The PSA Crypto API is still beta status. While you're welcome to
2926 * experiment using it, incompatible API changes are still possible, and some
2927 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01002928 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002929 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002930 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002931 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002932 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002933 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002934 *
2935 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002936#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002937
2938/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002939 * \def MBEDTLS_PSA_CRYPTO_SE_C
2940 *
2941 * Enable secure element support in the Platform Security Architecture
2942 * cryptography API.
2943 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02002944 * \warning This feature is not yet suitable for production. It is provided
2945 * for API evaluation and testing purposes only.
2946 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002947 * Module: library/psa_crypto_se.c
2948 *
2949 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2950 *
2951 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002952//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002953
2954/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002955 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2956 *
2957 * Enable the Platform Security Architecture persistent key storage.
2958 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002959 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002960 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002961 * Requires: MBEDTLS_PSA_CRYPTO_C,
2962 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2963 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002964 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002965#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002966
2967/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002968 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002969 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002970 * Enable the emulation of the Platform Security Architecture
2971 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002972 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002973 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002974 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002975 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002976 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002977#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002978
2979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002981 *
2982 * Enable the RIPEMD-160 hash algorithm.
2983 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002984 * Module: library/ripemd160.c
2985 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002986 *
2987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002989
2990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002992 *
2993 * Enable the RSA public-key cryptosystem.
2994 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002995 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002996 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 * Caller: library/ssl_cli.c
2998 * library/ssl_srv.c
2999 * library/ssl_tls.c
3000 * library/x509.c
3001 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003002 * This module is used by the following key exchanges:
3003 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003011 *
3012 * Enable the SHA1 cryptographic hash algorithm.
3013 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003014 * Module: library/sha1.c
3015 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003016 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003017 * library/ssl_srv.c
3018 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003019 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003020 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003021 * This module is required for TLS 1.2 depending on the handshake parameters,
3022 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003023 *
3024 * \warning SHA-1 is considered a weak message digest and its use constitutes
3025 * a security risk. If possible, we recommend avoiding dependencies
3026 * on it, and considering stronger message digests instead.
3027 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003030
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003031/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003032 * \def MBEDTLS_SHA224_C
3033 *
3034 * Enable the SHA-224 cryptographic hash algorithm.
3035 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003036 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02003037 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003038 *
3039 * Module: library/sha256.c
3040 * Caller: library/md.c
3041 * library/ssl_cookie.c
3042 *
3043 * This module adds support for SHA-224.
3044 */
3045#define MBEDTLS_SHA224_C
3046
3047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003049 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003050 * Enable the SHA-256 cryptographic hash algorithm.
3051 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003052 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003053 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003054 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003055 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003056 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003057 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003058 * library/ssl_cli.c
3059 * library/ssl_srv.c
3060 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003061 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003062 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003063 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003066
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003067/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003068 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003069 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003070 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003071 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003072 * Requires: MBEDTLS_SHA512_C
3073 *
3074 * Module: library/sha512.c
3075 * Caller: library/md.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003076 * library/ssl_cli.c
3077 * library/ssl_srv.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003078 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003079 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003080 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003081#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003082
3083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003085 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003086 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003087 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003088 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003089 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003090 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003091 * library/ssl_tls.c
3092 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003093 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003094 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003097
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003100 *
3101 * Enable simple SSL cache implementation.
3102 *
3103 * Module: library/ssl_cache.c
3104 * Caller:
3105 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003109
3110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003112 *
3113 * Enable basic implementation of DTLS cookies for hello verification.
3114 *
3115 * Module: library/ssl_cookie.c
3116 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003119
3120/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003121 * \def MBEDTLS_SSL_TICKET_C
3122 *
3123 * Enable an implementation of TLS server-side callbacks for session tickets.
3124 *
3125 * Module: library/ssl_ticket.c
3126 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003127 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003128 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003129 */
3130#define MBEDTLS_SSL_TICKET_C
3131
3132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003134 *
3135 * Enable the SSL/TLS client code.
3136 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003137 * Module: library/ssl_cli.c
3138 * Caller:
3139 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003141 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 * This module is required for SSL/TLS client support.
3143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003145
Paul Bakker9a736322012-11-14 12:39:52 +00003146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003148 *
3149 * Enable the SSL/TLS server code.
3150 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 * Module: library/ssl_srv.c
3152 * Caller:
3153 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003155 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003156 * This module is required for SSL/TLS server support.
3157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003159
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003160/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003162 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003163 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003164 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003165 * Module: library/ssl_tls.c
3166 * Caller: library/ssl_cli.c
3167 * library/ssl_srv.c
3168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3170 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003171 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003172 * This module is required for SSL/TLS.
3173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003175
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003178 *
3179 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003180 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003181 * contexts are not shared between threads. If you do intend to use contexts
3182 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003183 * conditions. See also our Knowledge Base article about threading:
3184 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003185 *
3186 * Module: library/threading.c
3187 *
3188 * This allows different threading implementations (self-implemented or
3189 * provided).
3190 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191 * You will have to enable either MBEDTLS_THREADING_ALT or
3192 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003193 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003194 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003197
3198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003200 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003201 * Enable the semi-portable timing interface.
3202 *
Simon Butcherd567a232016-03-09 20:19:21 +00003203 * \note The provided implementation only works on POSIX/Unix (including Linux,
3204 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003205 * module and provide your own implementations of the callbacks needed by
3206 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3207 * your own implementation of the whole module by setting
3208 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003209 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003210 * \note See also our Knowledge Base article about porting to a new
3211 * environment:
3212 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3213 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003214 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003217
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003220 *
3221 * Enable run-time version information.
3222 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003223 * Module: library/version.c
3224 *
3225 * This module provides run-time version information.
3226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003227#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003228
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003229/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003231 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003232 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003233 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003234 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003235 * Caller: library/x509_crl.c
3236 * library/x509_crt.c
3237 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003238 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3240 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003241 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003242 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003245
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003248 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003249 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003250 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003251 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003252 * Caller: library/ssl_cli.c
3253 * library/ssl_srv.c
3254 * library/ssl_tls.c
3255 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003257 *
3258 * This module is required for X.509 certificate parsing.
3259 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003261
3262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003264 *
3265 * Enable X.509 CRL parsing.
3266 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003267 * Module: library/x509_crl.c
3268 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003269 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003271 *
3272 * This module is required for X.509 CRL parsing.
3273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003274#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003275
3276/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003278 *
3279 * Enable X.509 Certificate Signing Request (CSR) parsing.
3280 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003281 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003282 * Caller: library/x509_crt_write.c
3283 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003285 *
3286 * This module is used for reading X.509 certificate request.
3287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003289
3290/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003292 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003293 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003294 *
3295 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003296 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003298 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003299 * This module is the basis for creating X.509 certificates and CSRs.
3300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003302
3303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003305 *
3306 * Enable creating X.509 certificates.
3307 *
3308 * Module: library/x509_crt_write.c
3309 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003311 *
3312 * This module is required for X.509 certificate creation.
3313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003315
3316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003318 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003319 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003320 *
3321 * Module: library/x509_csr_write.c
3322 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003324 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003325 * This module is required for X.509 certificate request writing.
3326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003328
3329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003331 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003332 * Enable the XTEA block cipher.
3333 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003334 * Module: library/xtea.c
3335 * Caller:
3336 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003338
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003339/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003340
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003341/**
3342 * \name SECTION: Module configuration options
3343 *
3344 * This section allows for the setting of module specific sizes and
3345 * configuration options. The default values are already present in the
3346 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003347 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003348 * Our advice is to enable options and change their values here
3349 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003350 *
3351 * Please check the respective header file for documentation on these
3352 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003353 * \{
3354 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003355
Paul Bakker088c5c52014-04-25 11:11:10 +02003356/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003357//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003359
Paul Bakker088c5c52014-04-25 11:11:10 +02003360/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3362//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3363//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3364//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3365//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003366
Paul Bakker088c5c52014-04-25 11:11:10 +02003367/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3369//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3370//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3371//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003372
Paul Bakker088c5c52014-04-25 11:11:10 +02003373/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3375//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3376//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003377
Paul Bakker088c5c52014-04-25 11:11:10 +02003378/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3380//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003381//#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 +01003382
Paul Bakker088c5c52014-04-25 11:11:10 +02003383/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003385
Paul Bakker088c5c52014-04-25 11:11:10 +02003386/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387//#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 +02003388//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3390//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003391//#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 +02003392//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3393//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003394/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003396//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3397//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003398//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3399//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3400//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3403/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003404//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3406//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003407//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3408//#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 +02003409//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3410//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003411/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003413//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003414//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3415//#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 +02003416
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003417/**
3418 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003419 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003420 * (see the documentation of that option for context).
3421 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003422 * When you leave this undefined here, the library provides
3423 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3424 * is defined, the default definition is `assert(cond)`,
3425 * otherwise the default definition calls a function
3426 * mbedtls_param_failed(). This function is declared in
3427 * `platform_util.h` for the benefit of the library, but
3428 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003429 *
3430 * When you define this here, this replaces the default
3431 * definition in platform_util.h (which no longer declares the
3432 * function mbedtls_param_failed()) and it is your responsibility
3433 * to make sure this macro expands to something suitable (in
3434 * particular, that all the necessary declarations are visible
3435 * from within the library - you can ensure that by providing
3436 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003437 * If you define this macro to call `assert`, also define
3438 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3439 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003440 *
3441 * Note that you may define this macro to expand to nothing, in
3442 * which case you don't have to worry about declarations or
3443 * definitions. However, you will then be notified about invalid
3444 * parameters only in non-void functions, and void function will
3445 * just silently return early on invalid parameters, which
3446 * partially negates the benefits of enabling
3447 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3448 *
3449 * \param cond The expression that should evaluate to true, but doesn't.
3450 */
3451//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3452
Gilles Peskineed038902020-11-13 21:33:21 +01003453/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003454/**
Gilles Peskineed038902020-11-13 21:33:21 +01003455 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3456 * PSA crypto subsystem.
3457 *
3458 * If this option is unset:
3459 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003460 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003461 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3462 * on unspecified heuristics.
3463 */
3464//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3465
Steven Cooreman863470a2021-02-15 14:03:19 +01003466/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003467 * Restrict the PSA library to supporting a maximum amount of simultaneously
3468 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3469 * volatile key, or a persistent key which is loaded temporarily by the
3470 * library as part of a crypto operation in flight.
3471 *
3472 * If this option is unset, the library will fall back to a default value of
3473 * 32 keys.
3474 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003475//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003476
Paul Bakker088c5c52014-04-25 11:11:10 +02003477/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3479//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003480
Paul Bakker088c5c52014-04-25 11:11:10 +02003481/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003482
Angus Grattond8213d02016-05-25 20:56:48 +10003483/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3484 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003485 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003486 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003487 * This determines the size of the incoming TLS I/O buffer in such a way
3488 * that it is capable of holding the specified amount of plaintext data,
3489 * regardless of the protection mechanism used.
3490 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003491 * \note When using a value less than the default of 16KB on the client, it is
3492 * recommended to use the Maximum Fragment Length (MFL) extension to
3493 * inform the server about this limitation. On the server, there
3494 * is no supported, standardized way of informing the client about
3495 * restriction on the maximum size of incoming messages, and unless
3496 * the limitation has been communicated by other means, it is recommended
3497 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3498 * while keeping the default value of 16KB for the incoming buffer.
3499 *
David Horstmann95d516f2021-05-04 18:36:56 +01003500 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003501 */
3502//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3503
Gilles Peskined3d02902020-03-04 21:35:27 +01003504/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3505 *
3506 * The maximum length of CIDs used for incoming DTLS messages.
3507 *
3508 */
3509//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3510
3511/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3512 *
3513 * The maximum length of CIDs used for outgoing DTLS messages.
3514 *
3515 */
3516//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3517
3518/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3519 *
3520 * This option controls the use of record plaintext padding
3521 * when using the Connection ID extension in DTLS 1.2.
3522 *
3523 * The padding will always be chosen so that the length of the
3524 * padded plaintext is a multiple of the value of this option.
3525 *
3526 * Note: A value of \c 1 means that no padding will be used
3527 * for outgoing records.
3528 *
3529 * Note: On systems lacking division instructions,
3530 * a power of two should be preferred.
3531 *
3532 */
3533//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3534
Hanno Beckerceef8482020-06-02 06:16:00 +01003535/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003536 *
3537 * This option controls the use of record plaintext padding
3538 * in TLS 1.3.
3539 *
3540 * The padding will always be chosen so that the length of the
3541 * padded plaintext is a multiple of the value of this option.
3542 *
3543 * Note: A value of \c 1 means that no padding will be used
3544 * for outgoing records.
3545 *
3546 * Note: On systems lacking division instructions,
3547 * a power of two should be preferred.
3548 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003549//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003550
Angus Grattond8213d02016-05-25 20:56:48 +10003551/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3552 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003553 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003554 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003555 * This determines the size of the outgoing TLS I/O buffer in such a way
3556 * that it is capable of holding the specified amount of plaintext data,
3557 * regardless of the protection mechanism used.
3558 *
Angus Grattond8213d02016-05-25 20:56:48 +10003559 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3560 * the default inward 16384 byte buffer to conform to the TLS specification.
3561 *
3562 * The minimum required outward buffer size is determined by the handshake
3563 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3564 * The specific size requirement depends on the configured ciphers and any
3565 * certificate data which is sent during the handshake.
3566 *
David Horstmann95d516f2021-05-04 18:36:56 +01003567 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003568 */
3569//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3570
Hanno Beckere0b150f2018-08-21 15:51:03 +01003571/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3572 *
3573 * Maximum number of heap-allocated bytes for the purpose of
3574 * DTLS handshake message reassembly and future message buffering.
3575 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003576 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003577 * to account for a reassembled handshake message of maximum size,
3578 * together with its reassembly bitmap.
3579 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003580 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003581 * should be sufficient for all practical situations as it allows
3582 * to reassembly a large handshake message (such as a certificate)
3583 * while buffering multiple smaller handshake messages.
3584 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003585 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003586//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3589//#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 +02003590
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003591/**
3592 * Complete list of ciphersuites to use, in order of preference.
3593 *
3594 * \warning No dependency checking is done on that field! This option can only
3595 * be used to restrict the set of available ciphersuites. It is your
3596 * responsibility to make sure the needed modules are active.
3597 *
3598 * Use this to save a few hundred bytes of ROM (default ordering of all
3599 * available ciphersuites) and a few to a few hundred bytes of RAM.
3600 *
3601 * The value below is only an example, not the default.
3602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603//#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 +02003604
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003605/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003607//#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 +01003608
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003609/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003610 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3611 * signature and ciphersuite selection. Without this build-time option, SHA-1
3612 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3613 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3614 * default. At the time of writing, there is no practical attack on the use
3615 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003616 * to preserve compatibility with existing peers, but the general
3617 * warning applies nonetheless:
3618 *
3619 * \warning SHA-1 is considered a weak message digest and its use constitutes
3620 * a security risk. If possible, we recommend avoiding dependencies
3621 * on it, and considering stronger message digests instead.
3622 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003623 */
3624#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003625
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003626/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003627 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003628 * mbedtls_platform_zeroize(). This replaces the default implementation in
3629 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003630 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003631 * mbedtls_platform_zeroize() is a widely used function across the library to
3632 * zero a block of memory. The implementation is expected to be secure in the
3633 * sense that it has been written to prevent the compiler from removing calls
3634 * to mbedtls_platform_zeroize() as part of redundant code elimination
3635 * optimizations. However, it is difficult to guarantee that calls to
3636 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3637 * versions of the C language standards do not provide a secure implementation
3638 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3639 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003640 * example by using directives specific to their compiler, features from newer
3641 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003642 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003643 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003644//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003645
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003646/**
3647 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003648 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003649 * platform_util.c.
3650 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003651 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003652 * library will try to use safer implementations of this function, such as
3653 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003654 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003655 * using the standard gmtime(). In this case, calls from the library to
3656 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003657 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003658 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003659 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3660 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3661 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003662 */
Hanno Becker6a739782018-09-05 15:06:19 +01003663//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003664
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003665/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003666 * Enable the verified implementations of ECDH primitives from Project Everest
3667 * (currently only Curve25519). This feature changes the layout of ECDH
3668 * contexts and therefore is a compatibility break for applications that access
3669 * fields of a mbedtls_ecdh_context structure directly. See also
3670 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003671 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003672//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003673
Simon Butcher30b5f972016-06-08 19:00:23 +01003674/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003675
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003676/* Target and application specific configurations
3677 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003678 * Allow user to override any previous default.
3679 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003680 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003681#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003682#include MBEDTLS_USER_CONFIG_FILE
3683#endif
3684
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003685#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07003686#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003687#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07003688
Jaeden Amero6609aef2019-07-04 20:01:14 +01003689#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003691#endif /* MBEDTLS_CONFIG_H */