blob: 109f217bf32d27556ef1454ac000e71fcc7d1e04 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file config.h
3 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#ifndef MBEDTLS_CONFIG_H
28#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakkercce9d772011-11-18 14:26:47 +000030#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000031#define _CRT_SECURE_NO_DEPRECATE 1
32#endif
33
Paul Bakkerf3b86c12011-01-27 15:24:17 +000034/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000035 * \name SECTION: System support
36 *
37 * This section sets system specific settings.
38 * \{
39 */
40
Paul Bakkerf3b86c12011-01-27 15:24:17 +000041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020044 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000045 *
46 * Requires support for asm() in compiler.
47 *
48 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010049 * library/aria.c
Paul Bakker68041ec2009-04-19 21:17:55 +000050 * library/timing.c
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000051 * include/mbedtls/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000052 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010053 * Required by:
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 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -0400131 * Comment if your system does not support time functions.
132 *
133 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
134 * interface - timing.c will include time.h on suitable platforms
135 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
136 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100139
140/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200141 * \def MBEDTLS_HAVE_TIME_DATE
142 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100143 * System has time.h, time(), and an implementation for
144 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100145 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * the date should be correct). This is used to verify the validity period of
147 * X.509 certificates.
148 *
149 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100150 *
Hanno Becker6a739782018-09-05 15:06:19 +0100151 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100152 * behaves similarly to the gmtime_r() function from the C standard. Refer to
153 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100154 *
155 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * mbedtls_platform_gmtime_r() at compile-time by using the macro
157 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200158 */
159#define MBEDTLS_HAVE_TIME_DATE
160
161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100163 *
164 * Enable the memory allocation layer.
165 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200166 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100167 * This allows different allocators (self-implemented or provided) to be
168 * provided to the platform abstraction layer.
169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
172 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000173 * free() function pointer at runtime.
174 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000177 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100178 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100180 *
181 * Enable this layer to allow use of alternative memory allocators.
182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100184
185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200187 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200188 * Do not assign standard functions in the platform layer (e.g. calloc() to
189 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200190 *
191 * This makes sure there are no linking errors on platforms that do not support
192 * these functions. You will HAVE to provide alternatives, either at runtime
193 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
195 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200196 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200198 *
199 * Uncomment to prevent default assignment of standard functions in the
200 * platform layer.
201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200203
204/**
Janos Follathc351d182016-03-21 08:43:59 +0000205 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100206 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100207 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
208 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100209 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
211 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100212 * alternative printf function pointer.
213 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100215 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200216 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
217 * it will be enabled automatically by check_config.h
218 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200219 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000221 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100222 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
223 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100224 * Uncomment a macro to enable alternate implementation of specific base
225 * platform function
226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100228//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229//#define MBEDTLS_PLATFORM_FPRINTF_ALT
230//#define MBEDTLS_PLATFORM_PRINTF_ALT
231//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200232//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100233//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100234//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100235
236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100238 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000239 * Mark deprecated functions and features so that they generate a warning if
240 * used. Functionality deprecated in one version will usually be removed in the
241 * next version. You can enable this to help you prepare the transition to a
242 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 *
244 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100246 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000247 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250
251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Remove deprecated functions and features so that they generate an error if
255 * used. Functionality deprecated in one version will usually be removed in the
256 * next version. You can enable this to help you prepare the transition to a
257 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100258 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000259 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100262
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500263/**
264 * \def MBEDTLS_CHECK_PARAMS
265 *
266 * This configuration option controls whether the library validates more of
267 * the parameters passed to it.
268 *
269 * When this flag is not defined, the library only attempts to validate an
270 * input parameter if: (1) they may come from the outside world (such as the
271 * network, the filesystem, etc.) or (2) not validating them could result in
272 * internal memory errors such as overflowing a buffer controlled by the
273 * library. On the other hand, it doesn't attempt to validate parameters whose
274 * values are fully controlled by the application (such as pointers).
275 *
276 * When this flag is defined, the library additionally attempts to validate
277 * parameters that are fully controlled by the application, and should always
278 * be valid if the application code is fully correct and trusted.
279 *
280 * For example, when a function accepts as input a pointer to a buffer that may
281 * contain untrusted data, and its documentation mentions that this pointer
282 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200283 * - The pointer is checked to be non-NULL only if this option is enabled.
284 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500285 *
286 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200287 * is invalid:
288 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
289 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
290 * will immediately return. If the function returns an Mbed TLS error code,
291 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500292 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200293 * When defining this flag, you also need to arrange a definition for
294 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
295 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
296 * function mbedtls_param_failed(), but the library does not define this
297 * function. If you do not make any other arrangements, you must provide
298 * the function mbedtls_param_failed() in your application.
299 * See `platform_util.h` for its prototype.
300 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100301 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200302 * You can still supply an alternative definition of
303 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
304 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
305 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
306 * the library will call the macro that you defined and will not supply
307 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
308 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
309 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500310 *
311 * Uncomment to enable validation of application-controlled parameters.
312 */
313//#define MBEDTLS_CHECK_PARAMS
314
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200315/**
316 * \def MBEDTLS_CHECK_PARAMS_ASSERT
317 *
318 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
319 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
320 *
321 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
322 * calling a function mbedtls_param_failed(). See the documentation of
323 * #MBEDTLS_CHECK_PARAMS for details.
324 *
325 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
326 */
327//#define MBEDTLS_CHECK_PARAMS_ASSERT
328
Andrzej Kurek73afe272022-01-24 10:31:06 -0500329/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000330
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000331/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000332 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000333 *
334 * This section sets support for features that are or are not needed
335 * within the modules that are enabled.
336 * \{
337 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000338
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000339/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100341 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200342 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200343 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100344 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100346 *
347 * You will need to provide a header "timing_alt.h" and an implementation at
348 * compile time.
349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100351
352/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100353 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200354 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100355 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100356 * alternate core implementation of a symmetric crypto, an arithmetic or hash
357 * module (e.g. platform specific assembly optimized implementations). Keep
358 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200359 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200360 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000364 * provide the "struct mbedtls_aes_context" definition and omit the base
365 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200366 * "aes.h" to include the new function definitions.
367 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200368 * Uncomment a macro to enable alternate implementation of the corresponding
369 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100370 *
371 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
372 * use constitutes a security risk. If possible, we recommend
373 * avoiding dependencies on them, and considering stronger message
374 * digests and ciphers instead.
375 *
Paul Bakker90995b52013-06-24 19:20:35 +0200376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377//#define MBEDTLS_AES_ALT
378//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000379//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_BLOWFISH_ALT
381//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200382//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300383//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200384//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200385//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000387//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000388//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100389//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300390//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391//#define MBEDTLS_MD2_ALT
392//#define MBEDTLS_MD4_ALT
393//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300394//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000396//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200397//#define MBEDTLS_SHA1_ALT
398//#define MBEDTLS_SHA256_ALT
399//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000400//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000401
Janos Follathb0697532016-08-18 12:38:46 +0100402/*
403 * When replacing the elliptic curve module, pleace consider, that it is
404 * implemented with two .c files:
405 * - ecp.c
406 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000407 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
408 * macros as described above. The only difference is that you have to make sure
409 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100410 */
411//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200412
413/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100414 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100416 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
417 * alternate core implementation of symmetric crypto or hash function. Keep in
418 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200419 *
420 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200421 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
424 * no longer provide the mbedtls_sha1_process() function, but it will still provide
425 * the other function (using your mbedtls_sha1_process() function) and the definition
426 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200427 * with this definition.
428 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100429 * \note Because of a signature change, the core AES encryption and decryption routines are
430 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
431 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100432 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100433 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100434 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +0200435 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100436 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
437 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200438 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200439 * Uncomment a macro to enable alternate implementation of the corresponding
440 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100441 *
442 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
443 * constitutes a security risk. If possible, we recommend avoiding
444 * dependencies on them, and considering stronger message digests
445 * and ciphers instead.
446 *
Janos Follath1231d212019-01-07 15:01:32 +0000447 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
448 * enabled, then the deterministic ECDH signature functions pass the
449 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
450 * alternative implementations should use the RNG only for generating
451 * the ephemeral key and nothing else. If this is not possible, then
452 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
453 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
454 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
455 * desirable).
456 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200458//#define MBEDTLS_MD2_PROCESS_ALT
459//#define MBEDTLS_MD4_PROCESS_ALT
460//#define MBEDTLS_MD5_PROCESS_ALT
461//#define MBEDTLS_RIPEMD160_PROCESS_ALT
462//#define MBEDTLS_SHA1_PROCESS_ALT
463//#define MBEDTLS_SHA256_PROCESS_ALT
464//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200465//#define MBEDTLS_DES_SETKEY_ALT
466//#define MBEDTLS_DES_CRYPT_ECB_ALT
467//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200468//#define MBEDTLS_AES_SETKEY_ENC_ALT
469//#define MBEDTLS_AES_SETKEY_DEC_ALT
470//#define MBEDTLS_AES_ENCRYPT_ALT
471//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300472//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300473//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300474//#define MBEDTLS_ECDSA_VERIFY_ALT
475//#define MBEDTLS_ECDSA_SIGN_ALT
476//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200477
478/**
Janos Follathc44ab972016-11-18 16:38:23 +0000479 * \def MBEDTLS_ECP_INTERNAL_ALT
480 *
481 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100482 *
483 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100484 * alternative core implementation of elliptic curve arithmetic. Keep in mind
485 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100486 *
487 * This partially replaces one function. The header file from mbed TLS is still
488 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
489 * is still present and it is used for group structures not supported by the
490 * alternative.
491 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100492 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100493 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100494 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
495 * able to fallback to curves not supported by the alternative implementation.
496 *
Janos Follathc44ab972016-11-18 16:38:23 +0000497 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
498 * and implementing the following functions:
499 * unsigned char mbedtls_internal_ecp_grp_capable(
500 * const mbedtls_ecp_group *grp )
501 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500502 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000503 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
504 * replacement functions implement arithmetic for the given group and 0
505 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500506 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000507 * called before and after each point operation and provide an opportunity to
508 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100509 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100510 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
511 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
512 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
513 * for the operation is supported by your implementation (i.e. your
514 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
515 * group is not supported by your implementation, then the original mbed TLS
516 * implementation of ecp_double_jac() is used instead, unless this fallback
517 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
518 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
519 *
520 * The function prototypes and the definition of mbedtls_ecp_group and
521 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
522 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
523 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100524 *
525 * Uncomment a macro to enable alternate implementation of the corresponding
526 * function.
527 */
528/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000529//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100530/* Turn off software fallback for curves not supported in hardware */
531//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100532/* Support for Weierstrass curves with Jacobi representation */
533//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
534//#define MBEDTLS_ECP_ADD_MIXED_ALT
535//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
536//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
537//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
538/* Support for curves with Montgomery arithmetic */
539//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
540//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
541//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
542
543/**
Simon Butcherab5df402016-06-11 02:31:21 +0100544 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100545 *
Simon Butcherab5df402016-06-11 02:31:21 +0100546 * Enables testing and use of mbed TLS without any configured entropy sources.
547 * This permits use of the library on platforms before an entropy source has
548 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
549 * MBEDTLS_ENTROPY_NV_SEED switches).
550 *
551 * WARNING! This switch MUST be disabled in production builds, and is suitable
552 * only for development.
553 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100554 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100555 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
556 *
Janos Follath53de7842016-06-08 15:29:18 +0100557 */
Simon Butcherab5df402016-06-11 02:31:21 +0100558//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100559
560/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200561 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200562 *
563 * Uncomment this macro to let mbed TLS use your own implementation of a
564 * hardware entropy collector.
565 *
566 * Your function must be called \c mbedtls_hardware_poll(), have the same
567 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
568 *
569 * Uncomment to use your own hardware entropy collector.
570 */
571//#define MBEDTLS_ENTROPY_HARDWARE_ALT
572
573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000575 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100576 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000577 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100578 * Uncomment this macro to use precomputed AES tables stored in ROM.
579 * Comment this macro to generate AES tables in RAM at runtime.
580 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100581 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
582 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100583 * initialization time before the first AES operation can be performed.
584 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
585 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
586 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100587 *
588 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
589 *
Paul Bakker15566e42011-04-24 21:19:15 +0000590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000592
593/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100594 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200595 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100596 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200597 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100598 * Uncommenting this macro omits 75% of the AES tables from
599 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
600 * by computing their values on the fly during operations
601 * (the tables are entry-wise rotations of one another).
602 *
603 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100604 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100605 * runtime. Specifically, one has to compare 4 accesses within
606 * different tables to 4 accesses with additional arithmetic
607 * operations within the same table. The performance gain/loss
608 * depends on the system and memory details.
609 *
610 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
611 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200612 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100613//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200614
615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200617 *
618 * Use less ROM for the Camellia implementation (saves about 768 bytes).
619 *
620 * Uncomment this macro to use less memory for Camellia.
621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200622//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200623
624/**
Gilles Peskine8472a102021-09-23 18:07:36 +0200625 * \def MBEDTLS_CHECK_RETURN_WARNING
626 *
627 * If this macro is defined, emit a compile-time warning if application code
628 * calls a function without checking its return value, but the return value
629 * should generally be checked in portable applications.
630 *
631 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
632 * implemented. Otherwise this option has no effect.
633 *
634 * Uncomment to get warnings on using fallible functions without checking
635 * their return value.
636 *
637 * \note This feature is a work in progress.
638 * Warnings will be added to more functions in the future.
639 *
640 * \note A few functions are considered critical, and ignoring the return
641 * value of these functions will trigger a warning even if this
642 * macro is not defined. To completely disable return value check
643 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
644 */
645//#define MBEDTLS_CHECK_RETURN_WARNING
646
647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200649 *
650 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200653
654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000656 *
657 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000660
661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000663 *
664 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200666#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000667
668/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100669 * \def MBEDTLS_CIPHER_MODE_OFB
670 *
671 * Enable Output Feedback mode (OFB) for symmetric ciphers.
672 */
673#define MBEDTLS_CIPHER_MODE_OFB
674
675/**
676 * \def MBEDTLS_CIPHER_MODE_XTS
677 *
678 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
679 */
680#define MBEDTLS_CIPHER_MODE_XTS
681
682/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000684 *
685 * Enable NULL cipher.
686 * Warning: Only do so when you know what you are doing. This allows for
687 * encryption or channels without any security!
688 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000690 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
692 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
693 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
694 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
695 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
696 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
697 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
698 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
699 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
700 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
701 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
702 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
703 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
704 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
705 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
706 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
707 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
708 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
709 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000710 *
711 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000714
715/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100716 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200717 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100718 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
719 * specific padding modes in the cipher layer with cipher modes that support
720 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200721 *
722 * If you disable all padding modes, only full blocks can be used with CBC.
723 *
724 * Enable padding modes in the cipher layer.
725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726#define MBEDTLS_CIPHER_PADDING_PKCS7
727#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
728#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
729#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200730
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200731/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
732 *
733 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
734 * By default, CTR_DRBG uses a 256-bit key.
735 */
736//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
737
Paul Bakker48e93c82013-08-14 12:21:18 +0200738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000740 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200741 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000742 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000743 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000744 *
745 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
747 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000748 *
749 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100750 *
751 * \warning DES is considered a weak cipher and its use constitutes a
752 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000755
756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200758 *
759 * Remove RC4 ciphersuites by default in SSL / TLS.
760 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200762 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200763 * explicitly.
764 *
765 * Uncomment this macro to remove RC4 ciphersuites by default.
766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200768
769/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000770 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
771 *
772 * Remove 3DES ciphersuites by default in SSL / TLS.
773 * This flag removes the ciphersuites based on 3DES from the default list as
774 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
775 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
776 * them explicitly.
777 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000778 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000779 * a TLS connection using a 3DES based cipher suite (see "On the Practical
780 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
781 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
782 * in your threat model or you are unsure, then you should keep this option
783 * enabled to remove 3DES based cipher suites.
784 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000785 * Comment this macro to keep 3DES in the default ciphersuite list.
786 */
787#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
788
789/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100790 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200791 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100792 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
793 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200794 *
795 * Comment macros to disable the curve and functions for it
796 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200797/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
799#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
800#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
801#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
802#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
803#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
804#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
805#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
806#define MBEDTLS_ECP_DP_BP256R1_ENABLED
807#define MBEDTLS_ECP_DP_BP384R1_ENABLED
808#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200809/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200810#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000811#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200812
813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200815 *
816 * Enable specific 'modulo p' routines for each NIST prime.
817 * Depending on the prime and architecture, makes operations 4 to 8 times
818 * faster on the corresponding curve.
819 *
820 * Comment this macro to disable NIST curves optimisation.
821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200823
824/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200825 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
826 *
827 * When this option is disabled, mbedtls_ecp_mul() will make use of an
828 * internal RNG when called with a NULL \c f_rng argument, in order to protect
829 * against some side-channel attacks.
830 *
831 * This protection introduces a dependency of the ECP module on one of the
832 * DRBG modules. For very constrained implementations that don't require this
833 * protection (for example, because you're only doing signature verification,
834 * so not manipulating any secret, or because local/physical side-channel
835 * attacks are outside your threat model), it might be desirable to get rid of
836 * that dependency.
837 *
838 * \warning Enabling this option makes some uses of ECP vulnerable to some
839 * side-channel attacks. Only enable it if you know that's not a problem for
840 * your use case.
841 *
842 * Uncomment this macro to disable some counter-measures in ECP.
843 */
844//#define MBEDTLS_ECP_NO_INTERNAL_RNG
845
846/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200847 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100848 *
849 * Enable "non-blocking" ECC operations that can return early and be resumed.
850 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200851 * This allows various functions to pause by returning
852 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
853 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
854 * order to further progress and eventually complete their operation. This is
855 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
856 * number of ECC operations a function may perform before pausing; see
857 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100858 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200859 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200860 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100861 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200862 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200863 *
Ron Eldor19779c42018-11-05 16:58:13 +0200864 * \note This option only works with the default software implementation of
865 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100866 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
867 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100868 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200869//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100870
871/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100872 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
873 *
874 * Use a backward compatible ECDH context.
875 *
876 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
877 * defined in `ecdh.h`). For most applications, the choice of format makes
878 * no difference, since all library functions can work with either format,
879 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
880
881 * The new format used when this option is disabled is smaller
882 * (56 bytes on a 32-bit platform). In future versions of the library, it
883 * will support alternative implementations of ECDH operations.
884 * The new format is incompatible with applications that access
885 * context fields directly and with restartable ECP operations.
886 *
887 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
888 * want to access ECDH context fields directly. Otherwise you should
889 * comment out this macro definition.
890 *
891 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
892 *
893 * \note This configuration option is experimental. Future versions of the
894 * library may modify the way the ECDH context layout is configured
895 * and may modify the layout of the new context type.
896 */
897#define MBEDTLS_ECDH_LEGACY_CONTEXT
898
899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100901 *
902 * Enable deterministic ECDSA (RFC 6979).
903 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
904 * may result in a compromise of the long-term signing key. This is avoided by
905 * the deterministic variant.
906 *
John Durkop36a82e52020-10-26 09:39:05 -0700907 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100908 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100909 * Comment this macro to disable deterministic ECDSA.
910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100912
913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200915 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200916 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200917 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 * This enables the following ciphersuites (if other requisites are
919 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
921 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
922 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
923 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
924 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
925 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
926 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
927 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
928 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
929 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
930 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
931 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200934
935/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200937 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200938 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200939 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200941 *
942 * This enables the following ciphersuites (if other requisites are
943 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
945 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
946 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
947 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
948 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
949 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
950 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
951 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
952 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
953 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
954 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
955 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100956 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100957 * \warning Using DHE constitutes a security risk as it
958 * is not possible to validate custom DH parameters.
959 * If possible, it is recommended users should consider
960 * preferring other methods of key exchange.
961 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100962 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200965
966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200968 *
969 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
970 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200972 *
973 * This enables the following ciphersuites (if other requisites are
974 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
976 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
977 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
978 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
979 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
980 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
981 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
982 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200985
986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200988 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200989 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
992 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200993 *
994 * This enables the following ciphersuites (if other requisites are
995 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
997 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
998 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
999 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
1000 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
1001 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1002 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1003 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1004 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
1005 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
1006 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
1007 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001010
1011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001013 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001014 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001015 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1017 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001018 *
1019 * This enables the following ciphersuites (if other requisites are
1020 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1022 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1023 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1024 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
1025 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
1026 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
1027 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1028 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1029 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1030 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1031 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1032 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1033 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
1034 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
1035 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +02001036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001038
1039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001041 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001042 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1045 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001046 *
1047 * This enables the following ciphersuites (if other requisites are
1048 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1050 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1051 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1052 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1053 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1054 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1055 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1056 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1057 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1058 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1059 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1060 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1061 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001062 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001063 * \warning Using DHE constitutes a security risk as it
1064 * is not possible to validate custom DH parameters.
1065 * If possible, it is recommended users should consider
1066 * preferring other methods of key exchange.
1067 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001068 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001071
1072/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001074 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001075 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001076 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1078 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001079 *
1080 * This enables the following ciphersuites (if other requisites are
1081 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1083 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1084 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1085 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1086 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1087 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1088 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1089 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1090 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1091 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1092 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1093 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001096
1097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001099 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001100 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001103 *
1104 * This enables the following ciphersuites (if other requisites are
1105 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1107 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1108 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1109 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1110 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1111 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1112 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1113 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1114 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1115 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1116 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1117 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001120
1121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001123 *
1124 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1125 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001126 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001127 *
1128 * This enables the following ciphersuites (if other requisites are
1129 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1131 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1132 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1133 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1134 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1135 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1136 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1137 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1138 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1139 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1140 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1141 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001144
1145/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001146 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001147 *
1148 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1149 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001150 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001151 *
1152 * This enables the following ciphersuites (if other requisites are
1153 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1155 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1156 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1157 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1158 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1159 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1160 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1161 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1162 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1163 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1164 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1165 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001168
1169/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001170 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1171 *
1172 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1173 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001174 * \warning This is currently experimental. EC J-PAKE support is based on the
1175 * Thread v1.0.0 specification; incompatible changes to the specification
1176 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001177 *
1178 * Requires: MBEDTLS_ECJPAKE_C
1179 * MBEDTLS_SHA256_C
1180 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1181 *
1182 * This enables the following ciphersuites (if other requisites are
1183 * enabled as well):
1184 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1185 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001186//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001187
1188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001190 *
1191 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1192 * RFC 5915 and RFC 5480.
1193 *
1194 * Currently this means parsing the SpecifiedECDomain choice of EC
1195 * parameters (only known groups are supported, not arbitrary domains, to
1196 * avoid validation issues).
1197 *
1198 * Disable if you only need to support RFC 5915 + 5480 key formats.
1199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001201
1202/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001204 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205 * Enable a dummy error function to make use of mbedtls_strerror() in
1206 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1207 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1210 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001211 *
1212 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001216
1217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001219 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001220 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001221 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001225
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001226/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001227 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001228 *
1229 * Enable functions that use the filesystem.
1230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001232
1233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001235 *
1236 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001238 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001239 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001240 * application.
1241 *
1242 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001244//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001245
1246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001248 *
1249 * Do not use built-in platform entropy functions.
1250 * This is useful if your platform does not support
1251 * standards like the /dev/urandom or Windows CryptoAPI.
1252 *
1253 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001256
1257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001259 *
1260 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1261 * default SHA-512 based one (if both are available).
1262 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001264 *
1265 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1266 * if you have performance concerns.
1267 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 * This option is only useful if both MBEDTLS_SHA256_C and
1269 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001272
1273/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001274 * \def MBEDTLS_ENTROPY_NV_SEED
1275 *
1276 * Enable the non-volatile (NV) seed file-based entropy source.
1277 * (Also enables the NV seed read/write functions in the platform layer)
1278 *
1279 * This is crucial (if not required) on systems that do not have a
1280 * cryptographic entropy source (in hardware or kernel) available.
1281 *
1282 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1283 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001284 * \note The read/write functions that are used by the entropy source are
1285 * determined in the platform layer, and can be modified at runtime and/or
1286 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1287 *
1288 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001289 * with regular fopen(), please make sure you make a seedfile with the
1290 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1291 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001292 * and written to or you will get an entropy source error! The default
1293 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1294 * bytes from the file.
1295 *
1296 * \note The entropy collector will write to the seed file before entropy is
1297 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001298 */
1299//#define MBEDTLS_ENTROPY_NV_SEED
1300
Ronald Cron71016a92020-08-28 19:01:50 +02001301/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001302 *
Ronald Cron71016a92020-08-28 19:01:50 +02001303 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001304 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001305 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1306 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001307 *
1308 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001309 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001310 */
Ronald Cron71016a92020-08-28 19:01:50 +02001311//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001312
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001315 *
1316 * Enable debugging of buffer allocator memory issues. Automatically prints
1317 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1318 * function for 'debug output' of allocated memory.
1319 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001321 *
1322 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001325
1326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001328 *
1329 * Include backtrace information with each allocated block.
1330 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001332 * GLIBC-compatible backtrace() an backtrace_symbols() support
1333 *
1334 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001336//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001337
1338/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001340 *
1341 * Support external private RSA keys (eg from a HSM) in the PK layer.
1342 *
1343 * Comment this macro to disable support for external private RSA keys.
1344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001346
1347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001349 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001350 * Enable support for PKCS#1 v1.5 encoding.
1351 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001353 *
Paul Bakker48377d92013-08-30 12:06:24 +02001354 * This enables support for PKCS#1 v1.5 operations.
1355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001357
1358/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001360 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001361 * Enable support for PKCS#1 v2.1 encoding.
1362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001364 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001365 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001368
Steven Cooreman6801f082021-02-19 17:21:22 +01001369/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1370 *
1371 * Enable support for platform built-in keys. If you enable this feature,
1372 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1373 * See the documentation of that function for more information.
1374 *
1375 * Built-in keys are typically derived from a hardware unique key or
1376 * stored in a secure element.
1377 *
1378 * Requires: MBEDTLS_PSA_CRYPTO_C.
1379 *
1380 * \warning This interface is experimental and may change or be removed
1381 * without notice.
1382 */
1383//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1384
Ronald Cron3768ac12021-01-26 16:58:00 +01001385/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1386 *
1387 * Enable support for PSA crypto client.
1388 *
1389 * \note This option allows to include the code necessary for a PSA
1390 * crypto client when the PSA crypto implementation is not included in
1391 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1392 * code to set and get PSA key attributes.
1393 * The development of PSA drivers partially relying on the library to
1394 * fulfill the hardware gaps is another possible usage of this option.
1395 *
1396 * \warning This interface is experimental and may change or be removed
1397 * without notice.
1398 */
1399//#define MBEDTLS_PSA_CRYPTO_CLIENT
1400
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001401/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1402 *
1403 * Enable support for the experimental PSA crypto driver interface.
1404 *
John Durkop185764f2020-10-12 21:32:12 -07001405 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001406 *
1407 * \warning This interface is experimental and may change or be removed
1408 * without notice.
1409 */
1410//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1411
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001412/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1413 *
1414 * Make the PSA Crypto module use an external random generator provided
1415 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1416 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001417 * \note This random generator must deliver random numbers with cryptographic
1418 * quality and high performance. It must supply unpredictable numbers
1419 * with a uniform distribution. The implementation of this function
1420 * is responsible for ensuring that the random generator is seeded
1421 * with sufficient entropy. If you have a hardware TRNG which is slow
1422 * or delivers non-uniform output, declare it as an entropy source
1423 * with mbedtls_entropy_add_source() instead of enabling this option.
1424 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001425 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001426 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1427 * and define a function called mbedtls_psa_external_get_random()
1428 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001429 * ```
1430 * psa_status_t mbedtls_psa_external_get_random(
1431 * mbedtls_psa_external_random_context_t *context,
1432 * uint8_t *output, size_t output_size, size_t *output_length);
1433 * );
1434 * ```
1435 * The \c context value is initialized to 0 before the first call.
1436 * The function must fill the \c output buffer with \p output_size bytes
1437 * of random data and set \c *output_length to \p output_size.
1438 *
1439 * Requires: MBEDTLS_PSA_CRYPTO_C
1440 *
1441 * \warning If you enable this option, code that uses the PSA cryptography
1442 * interface will not use any of the entropy sources set up for
1443 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1444 * enables.
1445 *
1446 * \note This option is experimental and may be removed without notice.
1447 */
1448//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1449
Paul Bakker9dcc3222011-03-08 14:16:06 +00001450/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001451 * \def MBEDTLS_PSA_CRYPTO_SPM
1452 *
1453 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1454 * Partition Manager) integration which separates the code into two parts: a
1455 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1456 * Environment).
1457 *
1458 * Module: library/psa_crypto.c
1459 * Requires: MBEDTLS_PSA_CRYPTO_C
1460 *
1461 */
1462//#define MBEDTLS_PSA_CRYPTO_SPM
1463
1464/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001465 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001466 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001467 * Enable support for entropy injection at first boot. This feature is
1468 * required on systems that do not have a built-in entropy source (TRNG).
1469 * This feature is currently not supported on systems that have a built-in
1470 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001471 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001472 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001473 *
1474 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001475//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001476
1477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001478 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001479 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001480 * Do not use the Chinese Remainder Theorem
1481 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001482 *
1483 * Uncomment this macro to disable the use of CRT in RSA.
1484 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001487
1488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001490 *
1491 * Enable the checkup functions (*_self_test).
1492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001494
1495/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001496 * \def MBEDTLS_SHA256_SMALLER
1497 *
1498 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1499 * lower performance.
1500 *
1501 * The default implementation is meant to be a reasonnable compromise between
1502 * performance and size. This version optimizes more aggressively for size at
1503 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1504 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1505 * 30%.
1506 *
1507 * Uncomment to enable the smaller implementation of SHA256.
1508 */
1509//#define MBEDTLS_SHA256_SMALLER
1510
1511/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001512 * \def MBEDTLS_SHA512_SMALLER
1513 *
1514 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1515 * lower performance.
1516 *
1517 * Uncomment to enable the smaller implementation of SHA512.
1518 */
1519//#define MBEDTLS_SHA512_SMALLER
1520
1521/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001522 * \def MBEDTLS_SHA512_NO_SHA384
1523 *
1524 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1525 * code size on devices that don't use SHA-384.
1526 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001527 * Requires: MBEDTLS_SHA512_C
1528 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001529 * Uncomment to disable SHA-384
1530 */
1531//#define MBEDTLS_SHA512_NO_SHA384
1532
1533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001535 *
1536 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001537 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001538 * with other servers, only debugging of failures is harder.
1539 *
1540 * The advantage of not sending alert messages, is that no information is given
1541 * about reasons for failures thus preventing adversaries of gaining intel.
1542 *
1543 * Enable sending of all alert messages
1544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001546
1547/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001548 * \def MBEDTLS_SSL_RECORD_CHECKING
1549 *
1550 * Enable the function mbedtls_ssl_check_record() which can be used to check
1551 * the validity and authenticity of an incoming record, to verify that it has
1552 * not been seen before. These checks are performed without modifying the
1553 * externally visible state of the SSL context.
1554 *
1555 * See mbedtls_ssl_check_record() for more information.
1556 *
1557 * Uncomment to enable support for record checking.
1558 */
1559#define MBEDTLS_SSL_RECORD_CHECKING
1560
1561/**
1562 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1563 *
1564 * Enable support for the DTLS Connection ID extension
1565 * (version draft-ietf-tls-dtls-connection-id-05,
1566 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1567 * which allows to identify DTLS connections across changes
1568 * in the underlying transport.
1569 *
1570 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1571 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1572 * See the corresponding documentation for more information.
1573 *
1574 * \warning The Connection ID extension is still in draft state.
1575 * We make no stability promises for the availability
1576 * or the shape of the API controlled by this option.
1577 *
1578 * The maximum lengths of outgoing and incoming CIDs can be configured
1579 * through the options
1580 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1581 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1582 *
1583 * Requires: MBEDTLS_SSL_PROTO_DTLS
1584 *
1585 * Uncomment to enable the Connection ID extension.
1586 */
1587//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1588
1589/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001590 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1591 *
1592 * Enable asynchronous external private key operations in SSL. This allows
1593 * you to configure an SSL connection to call an external cryptographic
1594 * module to perform private key operations instead of performing the
1595 * operation inside the library.
1596 *
1597 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001598//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001599
1600/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001601 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1602 *
1603 * Enable serialization of the TLS context structures, through use of the
1604 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1605 *
1606 * This pair of functions allows one side of a connection to serialize the
1607 * context associated with the connection, then free or re-use that context
1608 * while the serialized state is persisted elsewhere, and finally deserialize
1609 * that state to a live context for resuming read/write operations on the
1610 * connection. From a protocol perspective, the state of the connection is
1611 * unaffected, in particular this is entirely transparent to the peer.
1612 *
1613 * Note: this is distinct from TLS session resumption, which is part of the
1614 * protocol and fully visible by the peer. TLS session resumption enables
1615 * establishing new connections associated to a saved session with shorter,
1616 * lighter handshakes, while context serialization is a local optimization in
1617 * handling a single, potentially long-lived connection.
1618 *
1619 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1620 * saved after the handshake to allow for more efficient serialization, so if
1621 * you don't need this feature you'll save RAM by disabling it.
1622 *
1623 * Comment to disable the context serialization APIs.
1624 */
1625#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1626
1627/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001629 *
1630 * Enable the debug messages in SSL module for all issues.
1631 * Debug messages have been disabled in some places to prevent timing
1632 * attacks due to (unbalanced) debugging function calls.
1633 *
1634 * If you need all error reporting you should enable this during debugging,
1635 * but remove this for production servers that should log as well.
1636 *
1637 * Uncomment this macro to report all debug messages on errors introducing
1638 * a timing side-channel.
1639 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001640 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001644 *
1645 * Enable support for Encrypt-then-MAC, RFC 7366.
1646 *
1647 * This allows peers that both support it to use a more robust protection for
1648 * ciphersuites using CBC, providing deep resistance against timing attacks
1649 * on the padding or underlying cipher.
1650 *
1651 * This only affects CBC ciphersuites, and is useless if none is defined.
1652 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1654 * MBEDTLS_SSL_PROTO_TLS1_1 or
1655 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001656 *
1657 * Comment this macro to disable support for Encrypt-then-MAC
1658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001662 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001663 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1664 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001665 *
1666 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1667 * attacks, but it is recommended to always use it (even if you disable
1668 * renegotiation), since it actually fixes a more fundamental issue in the
1669 * original SSL/TLS design, and has implications beyond Triple Handshake.
1670 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1672 * MBEDTLS_SSL_PROTO_TLS1_1 or
1673 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001674 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001675 * Comment this macro to disable support for Extended Master Secret.
1676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001678
Paul Bakkerd66f0702013-01-31 16:57:45 +01001679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001681 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001682 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1683 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001684 *
1685 * For servers, it is recommended to always enable this, unless you support
1686 * only one version of TLS, or know for sure that none of your clients
1687 * implements a fallback strategy.
1688 *
1689 * For clients, you only need this if you're using a fallback strategy, which
1690 * is not recommended in the first place, unless you absolutely need it to
1691 * interoperate with buggy (version-intolerant) servers.
1692 *
1693 * Comment this macro to disable support for FALLBACK_SCSV
1694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001695#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001696
1697/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001698 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1699 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001700 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001701 * giving access to the peer's certificate after completion of the handshake.
1702 *
1703 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1704 * recommended to disable this option for reduced RAM usage.
1705 *
1706 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1707 * defined, but always returns \c NULL.
1708 *
1709 * \note This option has no influence on the protection against the
1710 * triple handshake attack. Even if it is disabled, Mbed TLS will
1711 * still ensure that certificates do not change during renegotiation,
1712 * for exaple by keeping a hash of the peer's certificate.
1713 *
1714 * Comment this macro to disable storing the peer's certificate
1715 * after the handshake.
1716 */
1717#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1718
1719/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001721 *
1722 * Enable hooking functions in SSL module for hardware acceleration of
1723 * individual records.
1724 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001725 * \deprecated This option is deprecated and will be removed in a future
1726 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001727 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001728 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001731
1732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001734 *
1735 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1736 *
1737 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1738 * of interoperability issues compared to sending 0-length records.
1739 *
1740 * Comment this macro to disable 1/n-1 record splitting.
1741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001743
1744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001746 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001747 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001748 *
1749 * The two main uses of renegotiation are (1) refresh keys on long-lived
1750 * connections and (2) client authentication after the initial handshake.
1751 * If you don't need renegotiation, it's probably better to disable it, since
1752 * it has been associated with security issues in the past and is easy to
1753 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001754 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001755 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001756 *
1757 * \note Even if this option is disabled, both client and server are aware
1758 * of the Renegotiation Indication Extension (RFC 5746) used to
1759 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1760 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1761 * configuration of this extension).
1762 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001765
1766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001768 *
1769 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001771 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001772 * \deprecated This option is deprecated and will be removed in a future
1773 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001774 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001775 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001778
1779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001781 *
1782 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001784 *
1785 * Uncomment this macro to respect client's ciphersuite order
1786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001788
1789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001791 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001792 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001793 *
1794 * Comment this macro to disable support for the max_fragment_length extension
1795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001797
1798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001800 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001801 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001802 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 * Requires: MBEDTLS_MD5_C
1804 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001805 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001806 * \deprecated This option is deprecated and will be removed in a future
1807 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001808 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001809 * Comment this macro to disable support for SSL 3.0
1810 */
Janos Follathe2681a42016-03-07 15:57:05 +00001811//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001812
1813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001816 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 * Requires: MBEDTLS_MD5_C
1819 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001820 *
1821 * Comment this macro to disable support for TLS 1.0
1822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001824
1825/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001827 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001828 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001829 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 * Requires: MBEDTLS_MD5_C
1831 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001832 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001833 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001836
1837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001838 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001839 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001840 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001841 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001842 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001843 * (Depends on ciphersuites)
1844 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001845 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001846 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001848
1849/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001850 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1851 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001852 * This macro is used to selectively enable experimental parts
1853 * of the code that contribute to the ongoing development of
1854 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1855 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001856 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001857 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1858 * and no feature exposed through this macro is part of the
1859 * public API. In particular, features under the control
1860 * of this macro are experimental and don't come with any
1861 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001862 *
1863 * Uncomment this macro to enable experimental and partial
1864 * functionality specific to TLS 1.3.
1865 */
Hanno Beckere4160602020-05-07 15:11:45 +01001866//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001867
1868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001870 *
1871 * Enable support for DTLS (all available versions).
1872 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1874 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001875 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1877 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001878 *
1879 * Comment this macro to disable support for DTLS
1880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001882
1883/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001885 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001886 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001887 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001888 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001891
1892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001894 *
1895 * Enable support for the anti-replay mechanism in DTLS.
1896 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 * Requires: MBEDTLS_SSL_TLS_C
1898 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001899 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001900 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001901 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001902 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001903 * Comment this to disable anti-replay in DTLS.
1904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001906
1907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001909 *
1910 * Enable support for HelloVerifyRequest on DTLS servers.
1911 *
1912 * This feature is highly recommended to prevent DTLS servers being used as
1913 * amplifiers in DoS attacks against other hosts. It should always be enabled
1914 * unless you know for sure amplification cannot be a problem in the
1915 * environment in which your server operates.
1916 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001917 * \warning Disabling this can ba a security risk! (see above)
1918 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001919 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001920 *
1921 * Comment this to disable support for HelloVerifyRequest.
1922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001924
1925/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001926 * \def MBEDTLS_SSL_DTLS_SRTP
1927 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02001928 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001929 * through the use_srtp extension.
1930 *
1931 * \note This feature provides the minimum functionality required
1932 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1933 * the associated SRTP packet protection key material.
1934 * In particular, the SRTP packet protection itself, as well as the
1935 * demultiplexing of RTP and DTLS packets at the datagram layer
1936 * (see Section 5 of RFC 5764), are not handled by this feature.
1937 * Instead, after successful completion of a handshake negotiating
1938 * the use of DTLS-SRTP, the extended key exporter API
1939 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1940 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1941 * (this is implemented in the SSL example programs).
1942 * The resulting key should then be passed to an SRTP stack.
1943 *
1944 * Setting this option enables the runtime API
1945 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1946 * through which the supported DTLS-SRTP protection
1947 * profiles can be configured. You must call this API at
1948 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001949 *
1950 * Requires: MBEDTLS_SSL_PROTO_DTLS
1951 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001952 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001953 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001954//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001955
1956/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001957 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1958 *
1959 * Enable server-side support for clients that reconnect from the same port.
1960 *
1961 * Some clients unexpectedly close the connection and try to reconnect using the
1962 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001963 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001964 * flag enables that support.
1965 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001966 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001967 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001968 * Comment this to disable support for clients reusing the source port.
1969 */
1970#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1971
1972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001974 *
1975 * Enable support for a limit of records with bad MAC.
1976 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001977 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001978 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001982
1983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001985 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001986 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001987 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001988 * session store remains the responsibility of the application, though).
1989 * Server-side, you also need to provide callbacks for writing and parsing
1990 * tickets, including authenticated encryption and key management. Example
1991 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001992 *
1993 * Comment this macro to disable support for SSL session tickets
1994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001996
1997/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001998 * \def MBEDTLS_SSL_EXPORT_KEYS
1999 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002000 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002001 * This is required for certain users of TLS, e.g. EAP-TLS.
2002 *
2003 * Comment this macro to disable support for key export
2004 */
2005#define MBEDTLS_SSL_EXPORT_KEYS
2006
2007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002009 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002010 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02002011 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00002013 *
Paul Bakker0be444a2013-08-27 21:55:01 +02002014 * Comment this macro to disable support for server name indication in SSL
2015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002017
2018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002020 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002021 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02002022 *
2023 * Comment this macro to disable support for truncated HMAC in SSL
2024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002026
2027/**
Hanno Beckere89353a2017-11-20 16:36:41 +00002028 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2029 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002030 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
2031 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002032 * only meant for a transitory upgrade period and will be removed in a future
2033 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00002034 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002035 * \warning The old implementation is non-compliant and has a security weakness
2036 * (2^80 brute force attack on the HMAC key used for a single,
2037 * uninterrupted connection). This should only be enabled temporarily
2038 * when (1) the use of truncated HMAC is essential in order to save
2039 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
2040 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00002041 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002042 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00002043 * future version of Mbed TLS.
2044 *
Hanno Beckere89353a2017-11-20 16:36:41 +00002045 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
2046 *
2047 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
2048 */
2049//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2050
2051/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002052 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2053 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002054 * When this option is enabled, the SSL buffer will be resized automatically
2055 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002056 *
2057 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002058 */
2059//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2060
2061/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002062 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2063 *
2064 * Enable testing of the constant-flow nature of some sensitive functions with
2065 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002066 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002067 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002068 * This setting requires compiling with clang -fsanitize=memory. The test
2069 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002070 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002071 * \warning This macro is only used for extended testing; it is not considered
2072 * part of the library's API, so it may change or disappear at any time.
2073 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002074 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002075 */
2076//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2077
2078/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002079 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2080 *
2081 * Enable testing of the constant-flow nature of some sensitive functions with
2082 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002083 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002084 *
2085 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002086 * testing if the tests suites are run with valgrind's memcheck. This can be
2087 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2088 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002089 *
2090 * \warning This macro is only used for extended testing; it is not considered
2091 * part of the library's API, so it may change or disappear at any time.
2092 *
2093 * Uncomment to enable testing of the constant-flow nature of selected code.
2094 */
2095//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2096
2097/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002098 * \def MBEDTLS_TEST_HOOKS
2099 *
2100 * Enable features for invasive testing such as introspection functions and
2101 * hooks for fault injection. This enables additional unit tests.
2102 *
2103 * Merely enabling this feature should not change the behavior of the product.
2104 * It only adds new code, and new branching points where the default behavior
2105 * is the same as when this feature is disabled.
2106 * However, this feature increases the attack surface: there is an added
2107 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2108 * Therefore this feature must never be enabled in production.
2109 *
2110 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2111 * information.
2112 *
2113 * Uncomment to enable invasive tests.
2114 */
2115//#define MBEDTLS_TEST_HOOKS
2116
2117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002119 *
2120 * Provide your own alternate threading implementation.
2121 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002123 *
2124 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002127
2128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002130 *
2131 * Enable the pthread wrapper layer for the threading layer.
2132 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002134 *
2135 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002138
2139/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002140 * \def MBEDTLS_USE_PSA_CRYPTO
2141 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002142 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2143 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002144 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002145 * \note Development of this option is currently in progress, and parts of Mbed
2146 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002147 * will still continue to work as usual, so enabling this option should not
2148 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002149 *
Manuel Pégourié-Gonnard00b72fc2021-09-20 13:21:25 +02002150 * \note See docs/use-psa-crypto.md for a complete description of what this
2151 * option currently does, and of parts that are not affected by it so far.
2152 *
Manuel Pégourié-Gonnardb52b91d2021-09-21 11:30:52 +02002153 * \warning This option enables new Mbed TLS APIs which are currently
2154 * considered experimental and may change in incompatible ways at any time.
2155 * That is, the APIs enabled by this option are not covered by the usual
2156 * promises of API stability.
Hanno Becker51560b62018-11-19 09:46:26 +00002157 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002158 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002159 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002160 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002161 */
2162//#define MBEDTLS_USE_PSA_CRYPTO
2163
2164/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002165 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2166 *
John Durkop185764f2020-10-12 21:32:12 -07002167 * This setting allows support for cryptographic mechanisms through the PSA
2168 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002169 *
John Durkop185764f2020-10-12 21:32:12 -07002170 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01002171 * can be found in include/psa/crypto_config.h.
2172 *
2173 * If you enable this option and write your own configuration file, you must
2174 * include mbedtls/config_psa.h in your configuration file. The default
2175 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002176 *
2177 * This feature is still experimental and is not ready for production since
2178 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002179 */
2180//#define MBEDTLS_PSA_CRYPTO_CONFIG
2181
2182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002184 *
2185 * Allow run-time checking of compile-time enabled features. Thus allowing users
2186 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002188 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002190 *
2191 * Comment this to disable run-time checking and save ROM space
2192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002194
2195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002197 *
2198 * If set, the X509 parser will not break-off when parsing an X509 certificate
2199 * and encountering an extension in a v1 or v2 certificate.
2200 *
2201 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002204
2205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002207 *
2208 * If set, the X509 parser will not break-off when parsing an X509 certificate
2209 * and encountering an unknown critical extension.
2210 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002211 * \warning Depending on your PKI use, enabling this can be a security risk!
2212 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002213 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002216
2217/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002218 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2219 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002220 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002221 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2222 * the set of trusted certificates through a callback instead of a linked
2223 * list.
2224 *
2225 * This is useful for example in environments where a large number of trusted
2226 * certificates is present and storing them in a linked list isn't efficient
2227 * enough, or when the set of trusted certificates changes frequently.
2228 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002229 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002230 * `mbedtls_ssl_conf_ca_cb()` for more information.
2231 *
2232 * Uncomment to enable trusted certificate callbacks.
2233 */
2234//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2235
2236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002238 *
2239 * Enable verification of the keyUsage extension (CA and leaf certificates).
2240 *
2241 * Disabling this avoids problems with mis-issued and/or misused
2242 * (intermediate) CA and leaf certificates.
2243 *
2244 * \warning Depending on your PKI use, disabling this can be a security risk!
2245 *
2246 * Comment to skip keyUsage checking for both CA and leaf certificates.
2247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002249
2250/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002252 *
2253 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2254 *
2255 * Disabling this avoids problems with mis-issued and/or misused certificates.
2256 *
2257 * \warning Depending on your PKI use, disabling this can be a security risk!
2258 *
2259 * Comment to skip extendedKeyUsage checking for certificates.
2260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002262
2263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002265 *
2266 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2267 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2268 *
2269 * Comment this macro to disallow using RSASSA-PSS in certificates.
2270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002272
2273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002275 *
2276 * If set, the SSL/TLS module uses ZLIB to support compression and
2277 * decompression of packet data.
2278 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002279 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2280 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002281 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002282 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002283 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002284 *
Hanno Beckere494e202018-03-08 13:26:12 +00002285 * \deprecated This feature is deprecated and will be removed
2286 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002287 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002288 * Used in: library/ssl_tls.c
2289 * library/ssl_cli.c
2290 * library/ssl_srv.c
2291 *
2292 * This feature requires zlib library and headers to be present.
2293 *
2294 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002296//#define MBEDTLS_ZLIB_SUPPORT
Andrzej Kurek73afe272022-01-24 10:31:06 -05002297/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002298
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002299/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002300 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002301 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002302 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002303 * \{
2304 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002305
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002308 *
2309 * Enable AES-NI support on x86-64.
2310 *
2311 * Module: library/aesni.c
2312 * Caller: library/aes.c
2313 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002315 *
2316 * This modules adds support for the AES-NI instructions on x86-64
2317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002319
2320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002322 *
2323 * Enable the AES block cipher.
2324 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002325 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002326 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002327 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002328 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002329 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002330 * This module enables the following ciphersuites (if other requisites are
2331 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2333 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2334 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2335 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2337 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2339 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2341 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2343 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2346 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2348 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2349 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2350 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2351 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2352 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2353 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2354 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2355 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2356 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2357 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2358 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2359 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2360 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2361 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2362 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2363 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2364 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2365 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2366 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2367 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2368 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2369 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2370 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2371 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2372 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2373 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2374 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2375 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2376 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2377 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2378 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2379 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2380 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2381 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2382 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2383 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2384 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2385 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2386 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2387 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2388 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2389 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002390 *
Paul Bakkercff68422013-09-15 20:43:33 +02002391 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002394
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002395/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002397 *
2398 * Enable the ARCFOUR stream cipher.
2399 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002400 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002401 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002403 * This module enables the following ciphersuites (if other requisites are
2404 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002405 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2406 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2407 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2408 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2409 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2410 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2411 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2412 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2413 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2414 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002415 *
2416 * \warning ARC4 is considered a weak cipher and its use constitutes a
2417 * security risk. If possible, we recommend avoidng dependencies on
2418 * it, and considering stronger ciphers instead.
2419 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002422
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002425 *
2426 * Enable the generic ASN1 parser.
2427 *
2428 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002429 * Caller: library/x509.c
2430 * library/dhm.c
2431 * library/pkcs12.c
2432 * library/pkcs5.c
2433 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002436
2437/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002439 *
2440 * Enable the generic ASN1 writer.
2441 *
2442 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002443 * Caller: library/ecdsa.c
2444 * library/pkwrite.c
2445 * library/x509_create.c
2446 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002447 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002450
2451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002453 *
2454 * Enable the Base64 module.
2455 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002456 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002457 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002458 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002459 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002462
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002465 *
Paul Bakker9a736322012-11-14 12:39:52 +00002466 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002467 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002468 * Module: library/bignum.c
2469 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002470 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002471 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002472 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002473 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002474 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002476 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002479
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002482 *
2483 * Enable the Blowfish block cipher.
2484 *
2485 * Module: library/blowfish.c
2486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002488
2489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002491 *
2492 * Enable the Camellia block cipher.
2493 *
Paul Bakker38119b12009-01-10 23:31:23 +00002494 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002495 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002496 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002497 * This module enables the following ciphersuites (if other requisites are
2498 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2500 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2501 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2502 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2503 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2504 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2505 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2506 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2507 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2508 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2509 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2510 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2511 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2512 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2513 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2514 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2515 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2516 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2517 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2518 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2519 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2520 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2521 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2522 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2523 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2524 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2525 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2526 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2527 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2528 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2529 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2530 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2531 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2532 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2533 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2534 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2535 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2536 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2537 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2538 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2539 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2540 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002543
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002544/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002545 * \def MBEDTLS_ARIA_C
2546 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002547 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002548 *
2549 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002550 * Caller: library/cipher.c
2551 *
2552 * This module enables the following ciphersuites (if other requisites are
2553 * enabled as well):
2554 *
2555 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2556 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2557 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2558 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2559 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2560 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2561 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2562 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2563 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2564 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2565 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2566 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2567 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2568 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2569 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2570 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2571 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2572 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2573 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2574 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2575 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2576 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2577 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2578 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2579 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2580 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2581 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2582 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2583 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2584 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2585 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2586 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2587 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2588 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2589 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2590 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2591 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2592 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002593 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002594//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002595
2596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002598 *
2599 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2600 *
2601 * Module: library/ccm.c
2602 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002604 *
2605 * This module enables the AES-CCM ciphersuites, if other requisites are
2606 * enabled as well.
2607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002609
2610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002612 *
2613 * Enable the test certificates.
2614 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002615 * Module: library/certs.c
2616 * Caller:
2617 *
2618 * This module is used for testing (ssl_client/server).
2619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002621
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002622/**
Daniel King34b822c2016-05-15 17:28:08 -03002623 * \def MBEDTLS_CHACHA20_C
2624 *
2625 * Enable the ChaCha20 stream cipher.
2626 *
2627 * Module: library/chacha20.c
2628 */
2629#define MBEDTLS_CHACHA20_C
2630
2631/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002632 * \def MBEDTLS_CHACHAPOLY_C
2633 *
2634 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2635 *
2636 * Module: library/chachapoly.c
2637 *
2638 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2639 */
2640#define MBEDTLS_CHACHAPOLY_C
2641
2642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002644 *
2645 * Enable the generic cipher layer.
2646 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002647 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002648 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002649 *
2650 * Uncomment to enable generic cipher wrappers.
2651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002653
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002654/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002655 * \def MBEDTLS_CMAC_C
2656 *
Simon Butcher327398a2016-10-05 14:09:11 +01002657 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2658 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002659 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002660 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2661 * implementation of the CMAC algorithm is provided by an alternate
2662 * implementation, that alternate implementation may opt to not support
2663 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2664 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002665 * Module: library/cmac.c
2666 *
Simon Butcher69283e52016-10-06 12:49:58 +01002667 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002668 *
2669 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002670//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002671
2672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002674 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002675 * Enable the CTR_DRBG AES-based random generator.
2676 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002677 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002678 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002679 * \note To achieve a 256-bit security strength with CTR_DRBG,
2680 * you must use AES-256 *and* use sufficient entropy.
2681 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002682 *
2683 * Module: library/ctr_drbg.c
2684 * Caller:
2685 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002687 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002688 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002691
2692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002694 *
2695 * Enable the debug functions.
2696 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002697 * Module: library/debug.c
2698 * Caller: library/ssl_cli.c
2699 * library/ssl_srv.c
2700 * library/ssl_tls.c
2701 *
2702 * This module provides debugging functions.
2703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002705
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002708 *
2709 * Enable the DES block cipher.
2710 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002711 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002712 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002713 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002714 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002715 * This module enables the following ciphersuites (if other requisites are
2716 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2718 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2719 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2720 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2721 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2722 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2723 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2724 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2725 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2726 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002727 *
Paul Bakkercff68422013-09-15 20:43:33 +02002728 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002729 *
2730 * \warning DES is considered a weak cipher and its use constitutes a
2731 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002734
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002737 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002738 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002739 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002740 * Module: library/dhm.c
2741 * Caller: library/ssl_cli.c
2742 * library/ssl_srv.c
2743 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002744 * This module is used by the following key exchanges:
2745 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002746 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002747 * \warning Using DHE constitutes a security risk as it
2748 * is not possible to validate custom DH parameters.
2749 * If possible, it is recommended users should consider
2750 * preferring other methods of key exchange.
2751 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002752 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002755
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002758 *
2759 * Enable the elliptic curve Diffie-Hellman library.
2760 *
2761 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002762 * Caller: library/ssl_cli.c
2763 * library/ssl_srv.c
2764 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002765 * This module is used by the following key exchanges:
2766 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002767 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002771
2772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002774 *
2775 * Enable the elliptic curve DSA library.
2776 *
2777 * Module: library/ecdsa.c
2778 * Caller:
2779 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002780 * This module is used by the following key exchanges:
2781 * ECDHE-ECDSA
2782 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002783 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2784 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2785 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002787#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002788
2789/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002790 * \def MBEDTLS_ECJPAKE_C
2791 *
2792 * Enable the elliptic curve J-PAKE library.
2793 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002794 * \warning This is currently experimental. EC J-PAKE support is based on the
2795 * Thread v1.0.0 specification; incompatible changes to the specification
2796 * might still happen. For this reason, this is disabled by default.
2797 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002798 * Module: library/ecjpake.c
2799 * Caller:
2800 *
2801 * This module is used by the following key exchanges:
2802 * ECJPAKE
2803 *
2804 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2805 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002806//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002807
2808/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002810 *
2811 * Enable the elliptic curve over GF(p) library.
2812 *
2813 * Module: library/ecp.c
2814 * Caller: library/ecdh.c
2815 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002816 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002821
2822/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002824 *
2825 * Enable the platform-specific entropy code.
2826 *
2827 * Module: library/entropy.c
2828 * Caller:
2829 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002831 *
2832 * This module provides a generic entropy pool
2833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002835
2836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002838 *
2839 * Enable error code to error string conversion.
2840 *
2841 * Module: library/error.c
2842 * Caller:
2843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002847
2848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002850 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002851 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002852 *
2853 * Module: library/gcm.c
2854 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002855 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002856 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002857 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2858 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002861
2862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002863 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002864 *
2865 * Enable the HAVEGE random generator.
2866 *
Paul Bakker2a844242013-06-24 13:01:53 +02002867 * Warning: the HAVEGE random generator is not suitable for virtualized
2868 * environments
2869 *
2870 * Warning: the HAVEGE random generator is dependent on timing and specific
2871 * processor traits. It is therefore not advised to use HAVEGE as
2872 * your applications primary random generator or primary entropy pool
2873 * input. As a secondary input to your entropy pool, it IS able add
2874 * the (limited) extra entropy it provides.
2875 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002876 * Module: library/havege.c
2877 * Caller:
2878 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002880 *
Paul Bakker2a844242013-06-24 13:01:53 +02002881 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002884
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002885/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002886 * \def MBEDTLS_HKDF_C
2887 *
2888 * Enable the HKDF algorithm (RFC 5869).
2889 *
2890 * Module: library/hkdf.c
2891 * Caller:
2892 *
2893 * Requires: MBEDTLS_MD_C
2894 *
2895 * This module adds support for the Hashed Message Authentication Code
2896 * (HMAC)-based key derivation function (HKDF).
2897 */
2898#define MBEDTLS_HKDF_C
2899
2900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002902 *
2903 * Enable the HMAC_DRBG random generator.
2904 *
2905 * Module: library/hmac_drbg.c
2906 * Caller:
2907 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002909 *
2910 * Uncomment to enable the HMAC_DRBG random number geerator.
2911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002913
2914/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002915 * \def MBEDTLS_NIST_KW_C
2916 *
2917 * Enable the Key Wrapping mode for 128-bit block ciphers,
2918 * as defined in NIST SP 800-38F. Only KW and KWP modes
2919 * are supported. At the moment, only AES is approved by NIST.
2920 *
2921 * Module: library/nist_kw.c
2922 *
2923 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2924 */
2925//#define MBEDTLS_NIST_KW_C
2926
2927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002929 *
2930 * Enable the generic message digest layer.
2931 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002932 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002933 * Caller:
2934 *
2935 * Uncomment to enable generic message digest wrappers.
2936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002938
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002941 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002942 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002943 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002944 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002945 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002946 *
2947 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002948 *
2949 * \warning MD2 is considered a weak message digest and its use constitutes a
2950 * security risk. If possible, we recommend avoiding dependencies on
2951 * it, and considering stronger message digests instead.
2952 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002955
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002958 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002959 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002960 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002961 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002962 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002963 *
2964 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002965 *
2966 * \warning MD4 is considered a weak message digest and its use constitutes a
2967 * security risk. If possible, we recommend avoiding dependencies on
2968 * it, and considering stronger message digests instead.
2969 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002972
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002975 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002976 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002977 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002978 * Module: library/md5.c
2979 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002980 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002981 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002982 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002983 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2984 * depending on the handshake parameters. Further, it is used for checking
2985 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2986 * encrypted keys.
2987 *
2988 * \warning MD5 is considered a weak message digest and its use constitutes a
2989 * security risk. If possible, we recommend avoiding dependencies on
2990 * it, and considering stronger message digests instead.
2991 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002994
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002997 *
2998 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002999 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003000 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02003001 *
3002 * Module: library/memory_buffer_alloc.c
3003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004 * Requires: MBEDTLS_PLATFORM_C
3005 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02003006 *
3007 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02003008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02003010
3011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003013 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003014 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
3015 *
Simon Butcherd567a232016-03-09 20:19:21 +00003016 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
3017 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003018 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003019 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003020 * \note See also our Knowledge Base article about porting to a new
3021 * environment:
3022 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3023 *
Andres AG788aa4a2016-09-14 14:32:09 +01003024 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003025 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003026 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003029
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003032 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003033 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003034 *
3035 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003036 * Caller: library/asn1write.c
3037 * library/pkcs5.c
3038 * library/pkparse.c
3039 * library/pkwrite.c
3040 * library/rsa.c
3041 * library/x509.c
3042 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003043 * library/x509_crl.c
3044 * library/x509_crt.c
3045 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003046 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003047 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003048 *
3049 * This modules translates between OIDs and internal values.
3050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003052
3053/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003055 *
3056 * Enable VIA Padlock support on x86.
3057 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 * Module: library/padlock.c
3059 * Caller: library/aes.c
3060 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003062 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003063 * This modules adds support for the VIA PadLock on x86.
3064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003066
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003069 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003070 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003071 *
3072 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003073 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003074 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003075 * library/x509_crl.c
3076 * library/x509_crt.c
3077 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003078 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003080 *
Paul Bakkercff68422013-09-15 20:43:33 +02003081 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003084
3085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003087 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003088 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003089 *
3090 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003091 * Caller: library/pkwrite.c
3092 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003093 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003094 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003096 *
3097 * This modules adds support for encoding / writing PEM files.
3098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003100
3101/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003103 *
3104 * Enable the generic public (asymetric) key layer.
3105 *
3106 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003107 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003108 * library/ssl_cli.c
3109 * library/ssl_srv.c
3110 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003112 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003113 * Uncomment to enable generic public key wrappers.
3114 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003115#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003116
3117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003119 *
3120 * Enable the generic public (asymetric) key parser.
3121 *
3122 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003123 * Caller: library/x509_crt.c
3124 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003125 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003127 *
3128 * Uncomment to enable generic public key parse functions.
3129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003131
3132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003134 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02003135 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003136 *
3137 * Module: library/pkwrite.c
3138 * Caller: library/x509write.c
3139 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003141 *
3142 * Uncomment to enable generic public key write functions.
3143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003145
3146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003148 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003149 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003150 *
3151 * Module: library/pkcs5.c
3152 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003154 *
3155 * This module adds support for the PKCS#5 functions.
3156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003158
3159/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003161 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003162 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003163 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003164 * \deprecated This option is deprecated and will be removed in a future
3165 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003166 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003167 * Module: library/pkcs11.c
3168 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003171 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003172 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003173 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003176
3177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003179 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003180 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003181 * Adds algorithms for parsing PKCS#8 encrypted private keys
3182 *
3183 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003184 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003185 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3187 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003188 *
3189 * This module enables PKCS#12 functions.
3190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003192
3193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003195 *
3196 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003197 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003198 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3200 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003201 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003202 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003203 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3204 * as other module rely on it for a fixed snprintf implementation.
3205 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003206 * Module: library/platform.c
3207 * Caller: Most other .c files
3208 *
3209 * This module enables abstraction of common (libc) functions.
3210 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003211#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003212
3213/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003214 * \def MBEDTLS_POLY1305_C
3215 *
3216 * Enable the Poly1305 MAC algorithm.
3217 *
3218 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003219 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003220 */
3221#define MBEDTLS_POLY1305_C
3222
3223/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003224 * \def MBEDTLS_PSA_CRYPTO_C
3225 *
3226 * Enable the Platform Security Architecture cryptography API.
3227 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003228 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003229 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003230 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003231 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003232 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003233 *
3234 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003235#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003236
3237/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003238 * \def MBEDTLS_PSA_CRYPTO_SE_C
3239 *
3240 * Enable secure element support in the Platform Security Architecture
3241 * cryptography API.
3242 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003243 * \warning This feature is not yet suitable for production. It is provided
3244 * for API evaluation and testing purposes only.
3245 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003246 * Module: library/psa_crypto_se.c
3247 *
3248 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3249 *
3250 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003251//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003252
3253/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003254 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3255 *
3256 * Enable the Platform Security Architecture persistent key storage.
3257 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003258 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003259 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003260 * Requires: MBEDTLS_PSA_CRYPTO_C,
3261 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3262 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003263 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003264#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003265
3266/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003267 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003268 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003269 * Enable the emulation of the Platform Security Architecture
3270 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003271 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003272 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003273 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003274 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003275 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003276#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003277
3278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003279 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003280 *
3281 * Enable the RIPEMD-160 hash algorithm.
3282 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003283 * Module: library/ripemd160.c
3284 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003285 *
3286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003288
3289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003290 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003291 *
3292 * Enable the RSA public-key cryptosystem.
3293 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003294 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003295 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003296 * Caller: library/ssl_cli.c
3297 * library/ssl_srv.c
3298 * library/ssl_tls.c
3299 * library/x509.c
3300 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003301 * This module is used by the following key exchanges:
3302 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003303 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003307
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003308/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003310 *
3311 * Enable the SHA1 cryptographic hash algorithm.
3312 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003313 * Module: library/sha1.c
3314 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003315 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003316 * library/ssl_srv.c
3317 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003318 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003319 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003320 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3321 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003322 *
3323 * \warning SHA-1 is considered a weak message digest and its use constitutes
3324 * a security risk. If possible, we recommend avoiding dependencies
3325 * on it, and considering stronger message digests instead.
3326 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003329
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003330/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003332 *
3333 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3334 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003335 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003336 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003337 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003338 * library/ssl_cli.c
3339 * library/ssl_srv.c
3340 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003341 *
3342 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003343 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003346
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003349 *
3350 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3351 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003352 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003353 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003354 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003355 * library/ssl_cli.c
3356 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003357 *
3358 * This module adds support for SHA-384 and SHA-512.
3359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003361
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003362/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003364 *
3365 * Enable simple SSL cache implementation.
3366 *
3367 * Module: library/ssl_cache.c
3368 * Caller:
3369 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003373
3374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003376 *
3377 * Enable basic implementation of DTLS cookies for hello verification.
3378 *
3379 * Module: library/ssl_cookie.c
3380 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003383
3384/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003385 * \def MBEDTLS_SSL_TICKET_C
3386 *
3387 * Enable an implementation of TLS server-side callbacks for session tickets.
3388 *
3389 * Module: library/ssl_ticket.c
3390 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003391 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003392 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003393 */
3394#define MBEDTLS_SSL_TICKET_C
3395
3396/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003398 *
3399 * Enable the SSL/TLS client code.
3400 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003401 * Module: library/ssl_cli.c
3402 * Caller:
3403 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003405 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003406 * This module is required for SSL/TLS client support.
3407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003409
Paul Bakker9a736322012-11-14 12:39:52 +00003410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003412 *
3413 * Enable the SSL/TLS server code.
3414 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003415 * Module: library/ssl_srv.c
3416 * Caller:
3417 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003419 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003420 * This module is required for SSL/TLS server support.
3421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003423
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003424/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003426 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003427 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003428 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 * Module: library/ssl_tls.c
3430 * Caller: library/ssl_cli.c
3431 * library/ssl_srv.c
3432 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3434 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003436 * This module is required for SSL/TLS.
3437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003439
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003440/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003442 *
3443 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003444 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003445 * contexts are not shared between threads. If you do intend to use contexts
3446 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003447 * conditions. See also our Knowledge Base article about threading:
3448 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003449 *
3450 * Module: library/threading.c
3451 *
3452 * This allows different threading implementations (self-implemented or
3453 * provided).
3454 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * You will have to enable either MBEDTLS_THREADING_ALT or
3456 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003457 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003458 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003461
3462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003464 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003465 * Enable the semi-portable timing interface.
3466 *
Simon Butcherd567a232016-03-09 20:19:21 +00003467 * \note The provided implementation only works on POSIX/Unix (including Linux,
3468 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003469 * module and provide your own implementations of the callbacks needed by
3470 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3471 * your own implementation of the whole module by setting
3472 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003473 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -04003474 * \note The timing module will include time.h on suitable platforms
3475 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3476 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3477 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003478 * \note See also our Knowledge Base article about porting to a new
3479 * environment:
3480 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3481 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003482 * Module: library/timing.c
3483 * Caller: library/havege.c
3484 *
3485 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003488
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003491 *
3492 * Enable run-time version information.
3493 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003494 * Module: library/version.c
3495 *
3496 * This module provides run-time version information.
3497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003499
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003502 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003503 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003504 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003505 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003506 * Caller: library/x509_crl.c
3507 * library/x509_crt.c
3508 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003509 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3511 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003512 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003513 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003516
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003517/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003519 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003521 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003522 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 * Caller: library/ssl_cli.c
3524 * library/ssl_srv.c
3525 * library/ssl_tls.c
3526 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003528 *
3529 * This module is required for X.509 certificate parsing.
3530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003531#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003532
3533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 *
3536 * Enable X.509 CRL parsing.
3537 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003538 * Module: library/x509_crl.c
3539 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003540 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003542 *
3543 * This module is required for X.509 CRL parsing.
3544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003546
3547/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
3550 * Enable X.509 Certificate Signing Request (CSR) parsing.
3551 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003552 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 * Caller: library/x509_crt_write.c
3554 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
3557 * This module is used for reading X.509 certificate request.
3558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560
3561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003564 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003565 *
3566 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003567 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003569 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 * This module is the basis for creating X.509 certificates and CSRs.
3571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003573
3574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003576 *
3577 * Enable creating X.509 certificates.
3578 *
3579 * Module: library/x509_crt_write.c
3580 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
3583 * This module is required for X.509 certificate creation.
3584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003586
3587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003590 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003591 *
3592 * Module: library/x509_csr_write.c
3593 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003596 * This module is required for X.509 certificate request writing.
3597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003599
3600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003602 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003603 * Enable the XTEA block cipher.
3604 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003605 * Module: library/xtea.c
3606 * Caller:
3607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003609
Andrzej Kurek73afe272022-01-24 10:31:06 -05003610/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003611
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003612/**
3613 * \name SECTION: Module configuration options
3614 *
3615 * This section allows for the setting of module specific sizes and
3616 * configuration options. The default values are already present in the
3617 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003618 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003619 * Our advice is to enable options and change their values here
3620 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003621 *
3622 * Please check the respective header file for documentation on these
3623 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003624 * \{
3625 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003626
Paul Bakker088c5c52014-04-25 11:11:10 +02003627/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003628//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003630
Paul Bakker088c5c52014-04-25 11:11:10 +02003631/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3633//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3634//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3635//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3636//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003637
Paul Bakker088c5c52014-04-25 11:11:10 +02003638/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003639//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3640//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3641//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3642//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003643
Paul Bakker088c5c52014-04-25 11:11:10 +02003644/* ECP options */
Gilles Peskine33c92f02021-06-02 23:34:02 +02003645//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups. Normally determined automatically from the configured curves. */
Gilles Peskineb3ca90b2021-06-02 13:27:03 +02003646//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003648
Paul Bakker088c5c52014-04-25 11:11:10 +02003649/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003650//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3651//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003652//#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 +01003653
Paul Bakker088c5c52014-04-25 11:11:10 +02003654/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003656
Paul Bakker088c5c52014-04-25 11:11:10 +02003657/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658//#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 +02003659//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003660//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3661//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003662//#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 +02003663//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3664//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003665/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003666//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003667//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3668//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003669//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3670//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3671//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003673/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3674/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003675//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003676//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3677//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003678//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3679//#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 +02003680//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3681//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003682/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003683//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003684//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003685//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3686//#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 +02003687
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003688/**
3689 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003690 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003691 * (see the documentation of that option for context).
3692 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003693 * When you leave this undefined here, the library provides
3694 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3695 * is defined, the default definition is `assert(cond)`,
3696 * otherwise the default definition calls a function
3697 * mbedtls_param_failed(). This function is declared in
3698 * `platform_util.h` for the benefit of the library, but
3699 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003700 *
3701 * When you define this here, this replaces the default
3702 * definition in platform_util.h (which no longer declares the
3703 * function mbedtls_param_failed()) and it is your responsibility
3704 * to make sure this macro expands to something suitable (in
3705 * particular, that all the necessary declarations are visible
3706 * from within the library - you can ensure that by providing
3707 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003708 * If you define this macro to call `assert`, also define
3709 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3710 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003711 *
3712 * Note that you may define this macro to expand to nothing, in
3713 * which case you don't have to worry about declarations or
3714 * definitions. However, you will then be notified about invalid
3715 * parameters only in non-void functions, and void function will
3716 * just silently return early on invalid parameters, which
3717 * partially negates the benefits of enabling
3718 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3719 *
3720 * \param cond The expression that should evaluate to true, but doesn't.
3721 */
3722//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3723
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003724/** \def MBEDTLS_CHECK_RETURN
3725 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003726 * This macro is used at the beginning of the declaration of a function
3727 * to indicate that its return value should be checked. It should
3728 * instruct the compiler to emit a warning or an error if the function
3729 * is called without checking its return value.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003730 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003731 * There is a default implementation for popular compilers in platform_util.h.
3732 * You can override the default implementation by defining your own here.
3733 *
3734 * If the implementation here is empty, this will effectively disable the
3735 * checking of functions' return values.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003736 */
Gilles Peskine91108092021-09-30 18:53:36 +02003737//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003738
Gilles Peskinec2779322021-09-30 18:56:17 +02003739/** \def MBEDTLS_IGNORE_RETURN
3740 *
3741 * This macro requires one argument, which should be a C function call.
3742 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3743 * warning is suppressed.
3744 */
3745//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3746
Gilles Peskineed038902020-11-13 21:33:21 +01003747/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003748/**
Gilles Peskineed038902020-11-13 21:33:21 +01003749 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3750 * PSA crypto subsystem.
3751 *
3752 * If this option is unset:
3753 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003754 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003755 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3756 * on unspecified heuristics.
3757 */
3758//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3759
Steven Cooreman863470a2021-02-15 14:03:19 +01003760/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003761 * Restrict the PSA library to supporting a maximum amount of simultaneously
3762 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3763 * volatile key, or a persistent key which is loaded temporarily by the
3764 * library as part of a crypto operation in flight.
3765 *
3766 * If this option is unset, the library will fall back to a default value of
3767 * 32 keys.
3768 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003769//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003770
Paul Bakker088c5c52014-04-25 11:11:10 +02003771/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003772//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3773//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003774
Paul Bakker088c5c52014-04-25 11:11:10 +02003775/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003776
3777/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3778 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003779 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003780 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003781 * This determines the size of both the incoming and outgoing TLS I/O buffers
3782 * in such a way that both are capable of holding the specified amount of
3783 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003784 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003785 * To configure incoming and outgoing I/O buffers separately, use
3786 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3787 * which overwrite the value set by this option.
3788 *
3789 * \note When using a value less than the default of 16KB on the client, it is
3790 * recommended to use the Maximum Fragment Length (MFL) extension to
3791 * inform the server about this limitation. On the server, there
3792 * is no supported, standardized way of informing the client about
3793 * restriction on the maximum size of incoming messages, and unless
3794 * the limitation has been communicated by other means, it is recommended
3795 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3796 * while keeping the default value of 16KB for the incoming buffer.
3797 *
3798 * Uncomment to set the maximum plaintext size of both
3799 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003800 */
3801//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3802
3803/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3804 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003805 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003806 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003807 * This determines the size of the incoming TLS I/O buffer in such a way
3808 * that it is capable of holding the specified amount of plaintext data,
3809 * regardless of the protection mechanism used.
3810 *
3811 * If this option is undefined, it inherits its value from
3812 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3813 *
3814 * \note When using a value less than the default of 16KB on the client, it is
3815 * recommended to use the Maximum Fragment Length (MFL) extension to
3816 * inform the server about this limitation. On the server, there
3817 * is no supported, standardized way of informing the client about
3818 * restriction on the maximum size of incoming messages, and unless
3819 * the limitation has been communicated by other means, it is recommended
3820 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3821 * while keeping the default value of 16KB for the incoming buffer.
3822 *
3823 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3824 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003825 */
3826//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3827
Gilles Peskined3d02902020-03-04 21:35:27 +01003828/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3829 *
3830 * The maximum length of CIDs used for incoming DTLS messages.
3831 *
3832 */
3833//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3834
3835/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3836 *
3837 * The maximum length of CIDs used for outgoing DTLS messages.
3838 *
3839 */
3840//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3841
3842/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3843 *
3844 * This option controls the use of record plaintext padding
3845 * when using the Connection ID extension in DTLS 1.2.
3846 *
3847 * The padding will always be chosen so that the length of the
3848 * padded plaintext is a multiple of the value of this option.
3849 *
3850 * Note: A value of \c 1 means that no padding will be used
3851 * for outgoing records.
3852 *
3853 * Note: On systems lacking division instructions,
3854 * a power of two should be preferred.
3855 *
3856 */
3857//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3858
Hanno Beckerceef8482020-06-02 06:16:00 +01003859/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003860 *
3861 * This option controls the use of record plaintext padding
3862 * in TLS 1.3.
3863 *
3864 * The padding will always be chosen so that the length of the
3865 * padded plaintext is a multiple of the value of this option.
3866 *
3867 * Note: A value of \c 1 means that no padding will be used
3868 * for outgoing records.
3869 *
3870 * Note: On systems lacking division instructions,
3871 * a power of two should be preferred.
3872 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003873//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003874
Angus Grattond8213d02016-05-25 20:56:48 +10003875/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3876 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003877 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003878 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003879 * This determines the size of the outgoing TLS I/O buffer in such a way
3880 * that it is capable of holding the specified amount of plaintext data,
3881 * regardless of the protection mechanism used.
3882 *
3883 * If this option undefined, it inherits its value from
3884 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003885 *
3886 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3887 * the default inward 16384 byte buffer to conform to the TLS specification.
3888 *
3889 * The minimum required outward buffer size is determined by the handshake
3890 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3891 * The specific size requirement depends on the configured ciphers and any
3892 * certificate data which is sent during the handshake.
3893 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003894 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3895 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003896 */
3897//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3898
Hanno Beckere0b150f2018-08-21 15:51:03 +01003899/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3900 *
3901 * Maximum number of heap-allocated bytes for the purpose of
3902 * DTLS handshake message reassembly and future message buffering.
3903 *
Yuto Takano5b4caf22021-08-10 11:26:15 +01003904 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003905 * to account for a reassembled handshake message of maximum size,
3906 * together with its reassembly bitmap.
3907 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003908 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003909 * should be sufficient for all practical situations as it allows
3910 * to reassembly a large handshake message (such as a certificate)
3911 * while buffering multiple smaller handshake messages.
3912 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003913 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003914//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003916//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3917//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3918//#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 +02003919
Gilles Peskine065a1c82021-04-24 13:35:41 +02003920/** \def MBEDTLS_TLS_EXT_CID
3921 *
3922 * At the time of writing, the CID extension has not been assigned its
3923 * final value. Set this configuration option to make Mbed TLS use a
3924 * different value.
3925 *
3926 * A future minor revision of Mbed TLS may change the default value of
3927 * this option to match evolving standards and usage.
3928 */
3929//#define MBEDTLS_TLS_EXT_CID 254
3930
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003931/**
3932 * Complete list of ciphersuites to use, in order of preference.
3933 *
3934 * \warning No dependency checking is done on that field! This option can only
3935 * be used to restrict the set of available ciphersuites. It is your
3936 * responsibility to make sure the needed modules are active.
3937 *
3938 * Use this to save a few hundred bytes of ROM (default ordering of all
3939 * available ciphersuites) and a few to a few hundred bytes of RAM.
3940 *
3941 * The value below is only an example, not the default.
3942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943//#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 +02003944
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003945/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003946//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003947//#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 +01003948
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003949/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003950 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3951 * signature and ciphersuite selection. Without this build-time option, SHA-1
3952 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3953 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3954 * default. At the time of writing, there is no practical attack on the use
3955 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003956 * to preserve compatibility with existing peers, but the general
3957 * warning applies nonetheless:
3958 *
3959 * \warning SHA-1 is considered a weak message digest and its use constitutes
3960 * a security risk. If possible, we recommend avoiding dependencies
3961 * on it, and considering stronger message digests instead.
3962 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003963 */
Mateusz Starzyk7d135392021-08-27 15:36:47 +02003964//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003965
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003966/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003967 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003968 * mbedtls_platform_zeroize(). This replaces the default implementation in
3969 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003970 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003971 * mbedtls_platform_zeroize() is a widely used function across the library to
3972 * zero a block of memory. The implementation is expected to be secure in the
3973 * sense that it has been written to prevent the compiler from removing calls
3974 * to mbedtls_platform_zeroize() as part of redundant code elimination
3975 * optimizations. However, it is difficult to guarantee that calls to
3976 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3977 * versions of the C language standards do not provide a secure implementation
3978 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3979 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003980 * example by using directives specific to their compiler, features from newer
3981 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003982 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003983 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003984//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003985
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003986/**
3987 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003988 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003989 * platform_util.c.
3990 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003991 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003992 * library will try to use safer implementations of this function, such as
3993 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003994 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003995 * using the standard gmtime(). In this case, calls from the library to
3996 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003997 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003998 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003999 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
4000 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
4001 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004002 */
Hanno Becker6a739782018-09-05 15:06:19 +01004003//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004004
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00004005/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00004006 * Enable the verified implementations of ECDH primitives from Project Everest
4007 * (currently only Curve25519). This feature changes the layout of ECDH
4008 * contexts and therefore is a compatibility break for applications that access
4009 * fields of a mbedtls_ecdh_context structure directly. See also
4010 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004011 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00004012//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004013
Andrzej Kurek73afe272022-01-24 10:31:06 -05004014/** \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02004015
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004016/* Target and application specific configurations
4017 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004018 * Allow user to override any previous default.
4019 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004020 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004021#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004022#include MBEDTLS_USER_CONFIG_FILE
4023#endif
4024
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004025#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07004026#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004027#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07004028
Jaeden Amero6609aef2019-07-04 20:01:14 +01004029#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01004030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004031#endif /* MBEDTLS_CONFIG_H */