blob: 2bb161062985a6527d4fed00ef5e076e70847c12 [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 *
Adam Wolfef30d902019-09-10 09:53:08 -05001501 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001502 * 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 *
Gilles Peskine52834352022-03-16 17:03:55 +01002170 * When this option is disabled, the PSA API exposes the same cryptographic
2171 * mechanism as the `mbedtls_xxx` API configured with `MBEDTLS_XXX` symbols.
2172 *
2173 * When this option is enabled, the PSA API exposes the cryptographic
2174 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2175 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2176 * automatically enabled if required (i.e. if no PSA driver provides the
2177 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2178 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002179 *
2180 * If you enable this option and write your own configuration file, you must
2181 * include mbedtls/config_psa.h in your configuration file. The default
2182 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002183 *
2184 * This feature is still experimental and is not ready for production since
2185 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002186 */
2187//#define MBEDTLS_PSA_CRYPTO_CONFIG
2188
2189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002191 *
2192 * Allow run-time checking of compile-time enabled features. Thus allowing users
2193 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002195 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002197 *
2198 * Comment this to disable run-time checking and save ROM space
2199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002201
2202/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002204 *
2205 * If set, the X509 parser will not break-off when parsing an X509 certificate
2206 * and encountering an extension in a v1 or v2 certificate.
2207 *
2208 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002211
2212/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002214 *
2215 * If set, the X509 parser will not break-off when parsing an X509 certificate
2216 * and encountering an unknown critical extension.
2217 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002218 * \warning Depending on your PKI use, enabling this can be a security risk!
2219 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002220 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002223
2224/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002225 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2226 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002227 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002228 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2229 * the set of trusted certificates through a callback instead of a linked
2230 * list.
2231 *
2232 * This is useful for example in environments where a large number of trusted
2233 * certificates is present and storing them in a linked list isn't efficient
2234 * enough, or when the set of trusted certificates changes frequently.
2235 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002236 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002237 * `mbedtls_ssl_conf_ca_cb()` for more information.
2238 *
2239 * Uncomment to enable trusted certificate callbacks.
2240 */
2241//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2242
2243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002245 *
2246 * Enable verification of the keyUsage extension (CA and leaf certificates).
2247 *
2248 * Disabling this avoids problems with mis-issued and/or misused
2249 * (intermediate) CA and leaf certificates.
2250 *
2251 * \warning Depending on your PKI use, disabling this can be a security risk!
2252 *
2253 * Comment to skip keyUsage checking for both CA and leaf certificates.
2254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002256
2257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002259 *
2260 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2261 *
2262 * Disabling this avoids problems with mis-issued and/or misused certificates.
2263 *
2264 * \warning Depending on your PKI use, disabling this can be a security risk!
2265 *
2266 * Comment to skip extendedKeyUsage checking for certificates.
2267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002269
2270/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002272 *
2273 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2274 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2275 *
2276 * Comment this macro to disallow using RSASSA-PSS in certificates.
2277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002279
2280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002282 *
2283 * If set, the SSL/TLS module uses ZLIB to support compression and
2284 * decompression of packet data.
2285 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002286 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2287 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002288 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002289 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002290 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002291 *
Hanno Beckere494e202018-03-08 13:26:12 +00002292 * \deprecated This feature is deprecated and will be removed
2293 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002294 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002295 * Used in: library/ssl_tls.c
2296 * library/ssl_cli.c
2297 * library/ssl_srv.c
2298 *
2299 * This feature requires zlib library and headers to be present.
2300 *
2301 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303//#define MBEDTLS_ZLIB_SUPPORT
Andrzej Kurek73afe272022-01-24 10:31:06 -05002304/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002305
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002306/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002307 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002308 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002309 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002310 * \{
2311 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002312
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002315 *
2316 * Enable AES-NI support on x86-64.
2317 *
2318 * Module: library/aesni.c
2319 * Caller: library/aes.c
2320 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002322 *
2323 * This modules adds support for the AES-NI instructions on x86-64
2324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002326
2327/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002329 *
2330 * Enable the AES block cipher.
2331 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002332 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002333 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002334 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002335 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002336 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002337 * This module enables the following ciphersuites (if other requisites are
2338 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2341 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2343 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2344 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2345 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2346 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2347 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2349 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2351 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2352 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2353 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2354 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2355 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2356 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2357 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2358 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2359 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2360 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2361 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2362 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2363 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2364 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2365 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2366 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2367 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2368 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2369 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2370 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2371 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2372 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2373 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2374 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2375 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2376 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2377 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2378 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2379 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2380 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2381 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2382 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2383 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2384 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2385 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2386 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2387 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2388 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2389 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2390 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2391 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2392 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2393 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2394 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2395 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2396 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002397 *
Paul Bakkercff68422013-09-15 20:43:33 +02002398 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002401
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002402/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002404 *
2405 * Enable the ARCFOUR stream cipher.
2406 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002407 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002408 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002409 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002410 * This module enables the following ciphersuites (if other requisites are
2411 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2413 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2414 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2415 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2416 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2417 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2418 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2419 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2420 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2421 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002422 *
2423 * \warning ARC4 is considered a weak cipher and its use constitutes a
2424 * security risk. If possible, we recommend avoidng dependencies on
2425 * it, and considering stronger ciphers instead.
2426 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002429
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002432 *
2433 * Enable the generic ASN1 parser.
2434 *
2435 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002436 * Caller: library/x509.c
2437 * library/dhm.c
2438 * library/pkcs12.c
2439 * library/pkcs5.c
2440 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002443
2444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002446 *
2447 * Enable the generic ASN1 writer.
2448 *
2449 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002450 * Caller: library/ecdsa.c
2451 * library/pkwrite.c
2452 * library/x509_create.c
2453 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002454 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002456#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002457
2458/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002460 *
2461 * Enable the Base64 module.
2462 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002463 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002464 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002465 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002466 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002469
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002472 *
Paul Bakker9a736322012-11-14 12:39:52 +00002473 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002474 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 * Module: library/bignum.c
2476 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002477 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002478 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002480 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002481 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002482 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002483 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002486
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002489 *
2490 * Enable the Blowfish block cipher.
2491 *
2492 * Module: library/blowfish.c
2493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002495
2496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002498 *
2499 * Enable the Camellia block cipher.
2500 *
Paul Bakker38119b12009-01-10 23:31:23 +00002501 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002502 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002503 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002504 * This module enables the following ciphersuites (if other requisites are
2505 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2507 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2508 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2509 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2510 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2511 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2512 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2513 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2514 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2515 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2516 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2517 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2518 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2519 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2520 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2521 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2522 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2523 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2524 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2525 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2526 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2527 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2528 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2529 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2530 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2531 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2532 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2533 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2534 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2535 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2536 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2537 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2538 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2539 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2540 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2541 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2542 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2543 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2544 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2545 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2546 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2547 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002550
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002551/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002552 * \def MBEDTLS_ARIA_C
2553 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002554 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002555 *
2556 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002557 * Caller: library/cipher.c
2558 *
2559 * This module enables the following ciphersuites (if other requisites are
2560 * enabled as well):
2561 *
2562 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2563 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2564 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2565 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2566 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2567 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2568 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2569 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2570 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2571 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2572 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2573 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2574 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2575 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2576 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2577 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2578 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2579 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2580 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2581 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2582 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2583 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2584 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2585 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2586 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2587 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2588 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2589 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2590 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2591 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2592 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2593 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2594 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2595 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2596 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2597 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2598 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2599 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002600 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002601//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002602
2603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002605 *
2606 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2607 *
2608 * Module: library/ccm.c
2609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002611 *
2612 * This module enables the AES-CCM ciphersuites, if other requisites are
2613 * enabled as well.
2614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002616
2617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002619 *
2620 * Enable the test certificates.
2621 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002622 * Module: library/certs.c
2623 * Caller:
2624 *
2625 * This module is used for testing (ssl_client/server).
2626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002628
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002629/**
Daniel King34b822c2016-05-15 17:28:08 -03002630 * \def MBEDTLS_CHACHA20_C
2631 *
2632 * Enable the ChaCha20 stream cipher.
2633 *
2634 * Module: library/chacha20.c
2635 */
2636#define MBEDTLS_CHACHA20_C
2637
2638/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002639 * \def MBEDTLS_CHACHAPOLY_C
2640 *
2641 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2642 *
2643 * Module: library/chachapoly.c
2644 *
2645 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2646 */
2647#define MBEDTLS_CHACHAPOLY_C
2648
2649/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002651 *
2652 * Enable the generic cipher layer.
2653 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002654 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002655 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002656 *
2657 * Uncomment to enable generic cipher wrappers.
2658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002660
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002661/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002662 * \def MBEDTLS_CMAC_C
2663 *
Simon Butcher327398a2016-10-05 14:09:11 +01002664 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2665 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002666 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002667 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2668 * implementation of the CMAC algorithm is provided by an alternate
2669 * implementation, that alternate implementation may opt to not support
2670 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2671 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002672 * Module: library/cmac.c
2673 *
Simon Butcher69283e52016-10-06 12:49:58 +01002674 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002675 *
2676 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002677//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002678
2679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002681 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002682 * Enable the CTR_DRBG AES-based random generator.
2683 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002684 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002685 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002686 * \note To achieve a 256-bit security strength with CTR_DRBG,
2687 * you must use AES-256 *and* use sufficient entropy.
2688 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002689 *
2690 * Module: library/ctr_drbg.c
2691 * Caller:
2692 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002694 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002695 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002696 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002697#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002698
2699/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002701 *
2702 * Enable the debug functions.
2703 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002704 * Module: library/debug.c
2705 * Caller: library/ssl_cli.c
2706 * library/ssl_srv.c
2707 * library/ssl_tls.c
2708 *
2709 * This module provides debugging functions.
2710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002712
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002715 *
2716 * Enable the DES block cipher.
2717 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002718 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002719 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002720 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002721 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002722 * This module enables the following ciphersuites (if other requisites are
2723 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2725 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2726 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2727 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2728 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2729 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2730 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2731 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2732 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2733 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002734 *
Paul Bakkercff68422013-09-15 20:43:33 +02002735 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002736 *
2737 * \warning DES is considered a weak cipher and its use constitutes a
2738 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002741
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002744 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002745 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002746 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002747 * Module: library/dhm.c
2748 * Caller: library/ssl_cli.c
2749 * library/ssl_srv.c
2750 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002751 * This module is used by the following key exchanges:
2752 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002753 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002754 * \warning Using DHE constitutes a security risk as it
2755 * is not possible to validate custom DH parameters.
2756 * If possible, it is recommended users should consider
2757 * preferring other methods of key exchange.
2758 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002759 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002762
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002765 *
2766 * Enable the elliptic curve Diffie-Hellman library.
2767 *
2768 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002769 * Caller: library/ssl_cli.c
2770 * library/ssl_srv.c
2771 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002772 * This module is used by the following key exchanges:
2773 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002778
2779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002781 *
2782 * Enable the elliptic curve DSA library.
2783 *
2784 * Module: library/ecdsa.c
2785 * Caller:
2786 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002787 * This module is used by the following key exchanges:
2788 * ECDHE-ECDSA
2789 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002790 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2791 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2792 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002795
2796/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002797 * \def MBEDTLS_ECJPAKE_C
2798 *
2799 * Enable the elliptic curve J-PAKE library.
2800 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002801 * \warning This is currently experimental. EC J-PAKE support is based on the
2802 * Thread v1.0.0 specification; incompatible changes to the specification
2803 * might still happen. For this reason, this is disabled by default.
2804 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002805 * Module: library/ecjpake.c
2806 * Caller:
2807 *
2808 * This module is used by the following key exchanges:
2809 * ECJPAKE
2810 *
2811 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2812 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002813//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002814
2815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002817 *
2818 * Enable the elliptic curve over GF(p) library.
2819 *
2820 * Module: library/ecp.c
2821 * Caller: library/ecdh.c
2822 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002823 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002824 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002828
2829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002831 *
2832 * Enable the platform-specific entropy code.
2833 *
2834 * Module: library/entropy.c
2835 * Caller:
2836 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002838 *
2839 * This module provides a generic entropy pool
2840 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002842
2843/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002845 *
2846 * Enable error code to error string conversion.
2847 *
2848 * Module: library/error.c
2849 * Caller:
2850 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002854
2855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002857 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002858 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002859 *
2860 * Module: library/gcm.c
2861 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002862 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002863 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002864 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2865 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002866 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002868
2869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002871 *
2872 * Enable the HAVEGE random generator.
2873 *
Paul Bakker2a844242013-06-24 13:01:53 +02002874 * Warning: the HAVEGE random generator is not suitable for virtualized
2875 * environments
2876 *
2877 * Warning: the HAVEGE random generator is dependent on timing and specific
2878 * processor traits. It is therefore not advised to use HAVEGE as
2879 * your applications primary random generator or primary entropy pool
2880 * input. As a secondary input to your entropy pool, it IS able add
2881 * the (limited) extra entropy it provides.
2882 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002883 * Module: library/havege.c
2884 * Caller:
2885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002887 *
Paul Bakker2a844242013-06-24 13:01:53 +02002888 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002891
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002892/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002893 * \def MBEDTLS_HKDF_C
2894 *
2895 * Enable the HKDF algorithm (RFC 5869).
2896 *
2897 * Module: library/hkdf.c
2898 * Caller:
2899 *
2900 * Requires: MBEDTLS_MD_C
2901 *
2902 * This module adds support for the Hashed Message Authentication Code
2903 * (HMAC)-based key derivation function (HKDF).
2904 */
2905#define MBEDTLS_HKDF_C
2906
2907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002909 *
2910 * Enable the HMAC_DRBG random generator.
2911 *
2912 * Module: library/hmac_drbg.c
2913 * Caller:
2914 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002916 *
2917 * Uncomment to enable the HMAC_DRBG random number geerator.
2918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002920
2921/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002922 * \def MBEDTLS_NIST_KW_C
2923 *
2924 * Enable the Key Wrapping mode for 128-bit block ciphers,
2925 * as defined in NIST SP 800-38F. Only KW and KWP modes
2926 * are supported. At the moment, only AES is approved by NIST.
2927 *
2928 * Module: library/nist_kw.c
2929 *
2930 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2931 */
2932//#define MBEDTLS_NIST_KW_C
2933
2934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002936 *
2937 * Enable the generic message digest layer.
2938 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002939 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002940 * Caller:
2941 *
2942 * Uncomment to enable generic message digest wrappers.
2943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002945
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002948 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002949 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002950 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002951 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002952 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002953 *
2954 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002955 *
2956 * \warning MD2 is considered a weak message digest and its use constitutes a
2957 * security risk. If possible, we recommend avoiding dependencies on
2958 * it, and considering stronger message digests instead.
2959 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002962
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002965 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002966 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002967 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002968 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002969 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002970 *
2971 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002972 *
2973 * \warning MD4 is considered a weak message digest and its use constitutes a
2974 * security risk. If possible, we recommend avoiding dependencies on
2975 * it, and considering stronger message digests instead.
2976 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002979
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002982 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002983 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002984 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002985 * Module: library/md5.c
2986 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002987 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002988 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002989 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002990 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2991 * depending on the handshake parameters. Further, it is used for checking
2992 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2993 * encrypted keys.
2994 *
2995 * \warning MD5 is considered a weak message digest and its use constitutes a
2996 * security risk. If possible, we recommend avoiding dependencies on
2997 * it, and considering stronger message digests instead.
2998 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003001
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003004 *
3005 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003006 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003007 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02003008 *
3009 * Module: library/memory_buffer_alloc.c
3010 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011 * Requires: MBEDTLS_PLATFORM_C
3012 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02003013 *
3014 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02003015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02003017
3018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003020 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003021 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
3022 *
Simon Butcherd567a232016-03-09 20:19:21 +00003023 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
3024 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003025 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003026 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003027 * \note See also our Knowledge Base article about porting to a new
3028 * environment:
3029 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3030 *
Andres AG788aa4a2016-09-14 14:32:09 +01003031 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003032 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003033 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003036
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003039 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003040 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003041 *
3042 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003043 * Caller: library/asn1write.c
3044 * library/pkcs5.c
3045 * library/pkparse.c
3046 * library/pkwrite.c
3047 * library/rsa.c
3048 * library/x509.c
3049 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003050 * library/x509_crl.c
3051 * library/x509_crt.c
3052 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003053 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003054 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003055 *
3056 * This modules translates between OIDs and internal values.
3057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003058#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003059
3060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003062 *
3063 * Enable VIA Padlock support on x86.
3064 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003065 * Module: library/padlock.c
3066 * Caller: library/aes.c
3067 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003069 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003070 * This modules adds support for the VIA PadLock on x86.
3071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003073
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003076 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003077 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003078 *
3079 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003080 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003081 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003082 * library/x509_crl.c
3083 * library/x509_crt.c
3084 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003085 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003087 *
Paul Bakkercff68422013-09-15 20:43:33 +02003088 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003091
3092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003094 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003095 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003096 *
3097 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003098 * Caller: library/pkwrite.c
3099 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003100 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003103 *
3104 * This modules adds support for encoding / writing PEM files.
3105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003107
3108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003110 *
3111 * Enable the generic public (asymetric) key layer.
3112 *
3113 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003114 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003115 * library/ssl_cli.c
3116 * library/ssl_srv.c
3117 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003119 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003120 * Uncomment to enable generic public key wrappers.
3121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003123
3124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003126 *
3127 * Enable the generic public (asymetric) key parser.
3128 *
3129 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003130 * Caller: library/x509_crt.c
3131 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003132 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003134 *
3135 * Uncomment to enable generic public key parse functions.
3136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003138
3139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003141 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02003142 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003143 *
3144 * Module: library/pkwrite.c
3145 * Caller: library/x509write.c
3146 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003148 *
3149 * Uncomment to enable generic public key write functions.
3150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003152
3153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003155 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003156 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003157 *
3158 * Module: library/pkcs5.c
3159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003161 *
3162 * This module adds support for the PKCS#5 functions.
3163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003165
3166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003168 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003169 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003170 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003171 * \deprecated This option is deprecated and will be removed in a future
3172 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003173 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003174 * Module: library/pkcs11.c
3175 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003176 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003178 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003179 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003180 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003183
3184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003186 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003187 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003188 * Adds algorithms for parsing PKCS#8 encrypted private keys
3189 *
3190 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003191 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003192 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3194 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003195 *
3196 * This module enables PKCS#12 functions.
3197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003199
3200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003202 *
3203 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003204 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003205 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3207 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003208 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003209 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003210 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3211 * as other module rely on it for a fixed snprintf implementation.
3212 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003213 * Module: library/platform.c
3214 * Caller: Most other .c files
3215 *
3216 * This module enables abstraction of common (libc) functions.
3217 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003218#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003219
3220/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003221 * \def MBEDTLS_POLY1305_C
3222 *
3223 * Enable the Poly1305 MAC algorithm.
3224 *
3225 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003226 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003227 */
3228#define MBEDTLS_POLY1305_C
3229
3230/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003231 * \def MBEDTLS_PSA_CRYPTO_C
3232 *
3233 * Enable the Platform Security Architecture cryptography API.
3234 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003235 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003236 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003237 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003238 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003239 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003240 *
3241 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003242#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003243
3244/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003245 * \def MBEDTLS_PSA_CRYPTO_SE_C
3246 *
3247 * Enable secure element support in the Platform Security Architecture
3248 * cryptography API.
3249 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003250 * \warning This feature is not yet suitable for production. It is provided
3251 * for API evaluation and testing purposes only.
3252 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003253 * Module: library/psa_crypto_se.c
3254 *
3255 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3256 *
3257 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003258//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003259
3260/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003261 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3262 *
3263 * Enable the Platform Security Architecture persistent key storage.
3264 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003265 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003266 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003267 * Requires: MBEDTLS_PSA_CRYPTO_C,
3268 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3269 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003270 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003271#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003272
3273/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003274 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003275 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003276 * Enable the emulation of the Platform Security Architecture
3277 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003278 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003279 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003280 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003281 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003282 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003283#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003284
3285/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003287 *
3288 * Enable the RIPEMD-160 hash algorithm.
3289 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003290 * Module: library/ripemd160.c
3291 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003292 *
3293 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003295
3296/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003298 *
3299 * Enable the RSA public-key cryptosystem.
3300 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003301 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003302 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003303 * Caller: library/ssl_cli.c
3304 * library/ssl_srv.c
3305 * library/ssl_tls.c
3306 * library/x509.c
3307 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003308 * This module is used by the following key exchanges:
3309 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003310 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003314
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003315/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003317 *
3318 * Enable the SHA1 cryptographic hash algorithm.
3319 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003320 * Module: library/sha1.c
3321 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003322 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003323 * library/ssl_srv.c
3324 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003325 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003326 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003327 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3328 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003329 *
3330 * \warning SHA-1 is considered a weak message digest and its use constitutes
3331 * a security risk. If possible, we recommend avoiding dependencies
3332 * on it, and considering stronger message digests instead.
3333 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003336
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003339 *
3340 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3341 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003342 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003343 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003344 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003345 * library/ssl_cli.c
3346 * library/ssl_srv.c
3347 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003348 *
3349 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003350 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003353
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003356 *
3357 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3358 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003359 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003360 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003361 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003362 * library/ssl_cli.c
3363 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 *
3365 * This module adds support for SHA-384 and SHA-512.
3366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003368
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003371 *
3372 * Enable simple SSL cache implementation.
3373 *
3374 * Module: library/ssl_cache.c
3375 * Caller:
3376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003380
3381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003383 *
3384 * Enable basic implementation of DTLS cookies for hello verification.
3385 *
3386 * Module: library/ssl_cookie.c
3387 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003390
3391/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003392 * \def MBEDTLS_SSL_TICKET_C
3393 *
3394 * Enable an implementation of TLS server-side callbacks for session tickets.
3395 *
3396 * Module: library/ssl_ticket.c
3397 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003398 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003399 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003400 */
3401#define MBEDTLS_SSL_TICKET_C
3402
3403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003405 *
3406 * Enable the SSL/TLS client code.
3407 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003408 * Module: library/ssl_cli.c
3409 * Caller:
3410 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003412 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003413 * This module is required for SSL/TLS client support.
3414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003416
Paul Bakker9a736322012-11-14 12:39:52 +00003417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003419 *
3420 * Enable the SSL/TLS server code.
3421 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003422 * Module: library/ssl_srv.c
3423 * Caller:
3424 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003426 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 * This module is required for SSL/TLS server support.
3428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003430
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003433 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003434 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003436 * Module: library/ssl_tls.c
3437 * Caller: library/ssl_cli.c
3438 * library/ssl_srv.c
3439 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3441 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003442 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003443 * This module is required for SSL/TLS.
3444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003446
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003449 *
3450 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003451 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003452 * contexts are not shared between threads. If you do intend to use contexts
3453 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003454 * conditions. See also our Knowledge Base article about threading:
3455 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003456 *
3457 * Module: library/threading.c
3458 *
3459 * This allows different threading implementations (self-implemented or
3460 * provided).
3461 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * You will have to enable either MBEDTLS_THREADING_ALT or
3463 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003464 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003465 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003466 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003468
3469/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003471 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003472 * Enable the semi-portable timing interface.
3473 *
Simon Butcherd567a232016-03-09 20:19:21 +00003474 * \note The provided implementation only works on POSIX/Unix (including Linux,
3475 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003476 * module and provide your own implementations of the callbacks needed by
3477 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3478 * your own implementation of the whole module by setting
3479 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003480 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -04003481 * \note The timing module will include time.h on suitable platforms
3482 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3483 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3484 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003485 * \note See also our Knowledge Base article about porting to a new
3486 * environment:
3487 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3488 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003489 * Module: library/timing.c
3490 * Caller: library/havege.c
3491 *
3492 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003495
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003498 *
3499 * Enable run-time version information.
3500 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003501 * Module: library/version.c
3502 *
3503 * This module provides run-time version information.
3504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003506
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003509 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003510 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003511 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003512 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003513 * Caller: library/x509_crl.c
3514 * library/x509_crt.c
3515 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003516 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3518 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003519 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003523
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003525 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003526 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003528 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003529 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003530 * Caller: library/ssl_cli.c
3531 * library/ssl_srv.c
3532 * library/ssl_tls.c
3533 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 *
3536 * This module is required for X.509 certificate parsing.
3537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539
3540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003542 *
3543 * Enable X.509 CRL parsing.
3544 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003545 * Module: library/x509_crl.c
3546 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
3550 * This module is required for X.509 CRL parsing.
3551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553
3554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
3557 * Enable X.509 Certificate Signing Request (CSR) parsing.
3558 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003559 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560 * Caller: library/x509_crt_write.c
3561 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
3564 * This module is used for reading X.509 certificate request.
3565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567
3568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003571 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003572 *
3573 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003574 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003576 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 * This module is the basis for creating X.509 certificates and CSRs.
3578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003580
3581/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 *
3584 * Enable creating X.509 certificates.
3585 *
3586 * Module: library/x509_crt_write.c
3587 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589 *
3590 * This module is required for X.509 certificate creation.
3591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003592#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003593
3594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003596 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003597 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598 *
3599 * Module: library/x509_csr_write.c
3600 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003603 * This module is required for X.509 certificate request writing.
3604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003606
3607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003609 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003610 * Enable the XTEA block cipher.
3611 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003612 * Module: library/xtea.c
3613 * Caller:
3614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003616
Andrzej Kurek73afe272022-01-24 10:31:06 -05003617/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003618
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003619/**
3620 * \name SECTION: Module configuration options
3621 *
3622 * This section allows for the setting of module specific sizes and
3623 * configuration options. The default values are already present in the
3624 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003625 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003626 * Our advice is to enable options and change their values here
3627 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003628 *
3629 * Please check the respective header file for documentation on these
3630 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003631 * \{
3632 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633
Gilles Peskine781f7342022-03-16 17:03:19 +01003634/* Meta configuration */
3635/**
3636 * \def MBEDTLS_CONFIG_FILE
3637 *
3638 * If defined, this is a header which will be included instead of
3639 * `"mbedtls/mbedtls_config.h"`.
3640 * This header file specifies the compile-time configuration of Mbed TLS.
3641 *
3642 * This macro is expanded after an `#include` directive. This is a popular but
3643 * non-standard feature of the C language, so this feature is only available
3644 * with compilers that perform macro expansion on an `#include` line.
3645 *
3646 * The value of this symbol is typically a path in double quotes, relative
3647 * to a directory on the include search pah.
3648 */
3649//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3650
3651/**
3652 * \def MBEDTLS_USER_CONFIG_FILE
3653 *
3654 * If defined, this is a header which will be included after
3655 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
3656 *
3657 * This macro is expanded after an `#include` directive. This is a popular but
3658 * non-standard feature of the C language, so this feature is only available
3659 * with compilers that perform macro expansion on an `#include` line.
3660 *
3661 * The value of this symbol is typically a path in double quotes, relative
3662 * to a directory on the include search pah.
3663 */
3664//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3665
Paul Bakker088c5c52014-04-25 11:11:10 +02003666/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003667//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003669
Paul Bakker088c5c52014-04-25 11:11:10 +02003670/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3672//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3673//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3674//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3675//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003676
Paul Bakker088c5c52014-04-25 11:11:10 +02003677/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003678//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3679//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3680//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3681//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003682
Paul Bakker088c5c52014-04-25 11:11:10 +02003683/* ECP options */
Gilles Peskine33c92f02021-06-02 23:34:02 +02003684//#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 +02003685//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003686//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003687
Paul Bakker088c5c52014-04-25 11:11:10 +02003688/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003689//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3690//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003691//#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 +01003692
Paul Bakker088c5c52014-04-25 11:11:10 +02003693/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003695
Paul Bakker088c5c52014-04-25 11:11:10 +02003696/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003697//#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 +02003698//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003699//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3700//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003701//#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 +02003702//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3703//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003704/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003705//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003706//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3707//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003708//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3709//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3710//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3713/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003714//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003715//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3716//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003717//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3718//#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 +02003719//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3720//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003721/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003722//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003723//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003724//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3725//#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 +02003726
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003727/**
3728 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003729 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003730 * (see the documentation of that option for context).
3731 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003732 * When you leave this undefined here, the library provides
3733 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3734 * is defined, the default definition is `assert(cond)`,
3735 * otherwise the default definition calls a function
3736 * mbedtls_param_failed(). This function is declared in
3737 * `platform_util.h` for the benefit of the library, but
3738 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003739 *
3740 * When you define this here, this replaces the default
3741 * definition in platform_util.h (which no longer declares the
3742 * function mbedtls_param_failed()) and it is your responsibility
3743 * to make sure this macro expands to something suitable (in
3744 * particular, that all the necessary declarations are visible
3745 * from within the library - you can ensure that by providing
3746 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003747 * If you define this macro to call `assert`, also define
3748 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3749 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003750 *
3751 * Note that you may define this macro to expand to nothing, in
3752 * which case you don't have to worry about declarations or
3753 * definitions. However, you will then be notified about invalid
3754 * parameters only in non-void functions, and void function will
3755 * just silently return early on invalid parameters, which
3756 * partially negates the benefits of enabling
3757 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3758 *
3759 * \param cond The expression that should evaluate to true, but doesn't.
3760 */
3761//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3762
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003763/** \def MBEDTLS_CHECK_RETURN
3764 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003765 * This macro is used at the beginning of the declaration of a function
3766 * to indicate that its return value should be checked. It should
3767 * instruct the compiler to emit a warning or an error if the function
3768 * is called without checking its return value.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003769 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003770 * There is a default implementation for popular compilers in platform_util.h.
3771 * You can override the default implementation by defining your own here.
3772 *
3773 * If the implementation here is empty, this will effectively disable the
3774 * checking of functions' return values.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003775 */
Gilles Peskine91108092021-09-30 18:53:36 +02003776//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003777
Gilles Peskinec2779322021-09-30 18:56:17 +02003778/** \def MBEDTLS_IGNORE_RETURN
3779 *
3780 * This macro requires one argument, which should be a C function call.
3781 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3782 * warning is suppressed.
3783 */
3784//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3785
Gilles Peskineed038902020-11-13 21:33:21 +01003786/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003787/**
Gilles Peskineed038902020-11-13 21:33:21 +01003788 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3789 * PSA crypto subsystem.
3790 *
3791 * If this option is unset:
3792 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003793 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003794 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3795 * on unspecified heuristics.
3796 */
3797//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3798
Steven Cooreman863470a2021-02-15 14:03:19 +01003799/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003800 * Restrict the PSA library to supporting a maximum amount of simultaneously
3801 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3802 * volatile key, or a persistent key which is loaded temporarily by the
3803 * library as part of a crypto operation in flight.
3804 *
3805 * If this option is unset, the library will fall back to a default value of
3806 * 32 keys.
3807 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003808//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003809
Paul Bakker088c5c52014-04-25 11:11:10 +02003810/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003811//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3812//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003813
Paul Bakker088c5c52014-04-25 11:11:10 +02003814/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003815
3816/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3817 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003818 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003819 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003820 * This determines the size of both the incoming and outgoing TLS I/O buffers
3821 * in such a way that both are capable of holding the specified amount of
3822 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003823 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003824 * To configure incoming and outgoing I/O buffers separately, use
3825 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3826 * which overwrite the value set by this option.
3827 *
3828 * \note When using a value less than the default of 16KB on the client, it is
3829 * recommended to use the Maximum Fragment Length (MFL) extension to
3830 * inform the server about this limitation. On the server, there
3831 * is no supported, standardized way of informing the client about
3832 * restriction on the maximum size of incoming messages, and unless
3833 * the limitation has been communicated by other means, it is recommended
3834 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3835 * while keeping the default value of 16KB for the incoming buffer.
3836 *
3837 * Uncomment to set the maximum plaintext size of both
3838 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003839 */
3840//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3841
3842/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3843 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003844 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003845 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003846 * This determines the size of the incoming TLS I/O buffer in such a way
3847 * that it is capable of holding the specified amount of plaintext data,
3848 * regardless of the protection mechanism used.
3849 *
3850 * If this option is undefined, it inherits its value from
3851 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3852 *
3853 * \note When using a value less than the default of 16KB on the client, it is
3854 * recommended to use the Maximum Fragment Length (MFL) extension to
3855 * inform the server about this limitation. On the server, there
3856 * is no supported, standardized way of informing the client about
3857 * restriction on the maximum size of incoming messages, and unless
3858 * the limitation has been communicated by other means, it is recommended
3859 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3860 * while keeping the default value of 16KB for the incoming buffer.
3861 *
3862 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3863 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003864 */
3865//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3866
Gilles Peskined3d02902020-03-04 21:35:27 +01003867/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3868 *
3869 * The maximum length of CIDs used for incoming DTLS messages.
3870 *
3871 */
3872//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3873
3874/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3875 *
3876 * The maximum length of CIDs used for outgoing DTLS messages.
3877 *
3878 */
3879//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3880
3881/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3882 *
3883 * This option controls the use of record plaintext padding
3884 * when using the Connection ID extension in DTLS 1.2.
3885 *
3886 * The padding will always be chosen so that the length of the
3887 * padded plaintext is a multiple of the value of this option.
3888 *
3889 * Note: A value of \c 1 means that no padding will be used
3890 * for outgoing records.
3891 *
3892 * Note: On systems lacking division instructions,
3893 * a power of two should be preferred.
3894 *
3895 */
3896//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3897
Hanno Beckerceef8482020-06-02 06:16:00 +01003898/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003899 *
3900 * This option controls the use of record plaintext padding
3901 * in TLS 1.3.
3902 *
3903 * The padding will always be chosen so that the length of the
3904 * padded plaintext is a multiple of the value of this option.
3905 *
3906 * Note: A value of \c 1 means that no padding will be used
3907 * for outgoing records.
3908 *
3909 * Note: On systems lacking division instructions,
3910 * a power of two should be preferred.
3911 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003912//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003913
Angus Grattond8213d02016-05-25 20:56:48 +10003914/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3915 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003916 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003917 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003918 * This determines the size of the outgoing TLS I/O buffer in such a way
3919 * that it is capable of holding the specified amount of plaintext data,
3920 * regardless of the protection mechanism used.
3921 *
3922 * If this option undefined, it inherits its value from
3923 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003924 *
3925 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3926 * the default inward 16384 byte buffer to conform to the TLS specification.
3927 *
3928 * The minimum required outward buffer size is determined by the handshake
3929 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3930 * The specific size requirement depends on the configured ciphers and any
3931 * certificate data which is sent during the handshake.
3932 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003933 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3934 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003935 */
3936//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3937
Hanno Beckere0b150f2018-08-21 15:51:03 +01003938/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3939 *
3940 * Maximum number of heap-allocated bytes for the purpose of
3941 * DTLS handshake message reassembly and future message buffering.
3942 *
Yuto Takano5b4caf22021-08-10 11:26:15 +01003943 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003944 * to account for a reassembled handshake message of maximum size,
3945 * together with its reassembly bitmap.
3946 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003947 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003948 * should be sufficient for all practical situations as it allows
3949 * to reassembly a large handshake message (such as a certificate)
3950 * while buffering multiple smaller handshake messages.
3951 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003952 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003953//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003955//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3956//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3957//#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 +02003958
Gilles Peskine065a1c82021-04-24 13:35:41 +02003959/** \def MBEDTLS_TLS_EXT_CID
3960 *
3961 * At the time of writing, the CID extension has not been assigned its
3962 * final value. Set this configuration option to make Mbed TLS use a
3963 * different value.
3964 *
3965 * A future minor revision of Mbed TLS may change the default value of
3966 * this option to match evolving standards and usage.
3967 */
3968//#define MBEDTLS_TLS_EXT_CID 254
3969
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003970/**
3971 * Complete list of ciphersuites to use, in order of preference.
3972 *
3973 * \warning No dependency checking is done on that field! This option can only
3974 * be used to restrict the set of available ciphersuites. It is your
3975 * responsibility to make sure the needed modules are active.
3976 *
3977 * Use this to save a few hundred bytes of ROM (default ordering of all
3978 * available ciphersuites) and a few to a few hundred bytes of RAM.
3979 *
3980 * The value below is only an example, not the default.
3981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003982//#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 +02003983
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003984/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003986//#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 +01003987
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003988/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003989 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3990 * signature and ciphersuite selection. Without this build-time option, SHA-1
3991 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3992 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3993 * default. At the time of writing, there is no practical attack on the use
3994 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003995 * to preserve compatibility with existing peers, but the general
3996 * warning applies nonetheless:
3997 *
3998 * \warning SHA-1 is considered a weak message digest and its use constitutes
3999 * a security risk. If possible, we recommend avoiding dependencies
4000 * on it, and considering stronger message digests instead.
4001 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004002 */
Mateusz Starzyk7d135392021-08-27 15:36:47 +02004003//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004004
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004005/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004006 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004007 * mbedtls_platform_zeroize(). This replaces the default implementation in
4008 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00004009 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004010 * mbedtls_platform_zeroize() is a widely used function across the library to
4011 * zero a block of memory. The implementation is expected to be secure in the
4012 * sense that it has been written to prevent the compiler from removing calls
4013 * to mbedtls_platform_zeroize() as part of redundant code elimination
4014 * optimizations. However, it is difficult to guarantee that calls to
4015 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
4016 * versions of the C language standards do not provide a secure implementation
4017 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
4018 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05004019 * example by using directives specific to their compiler, features from newer
4020 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004021 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004022 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004023//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004024
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004025/**
4026 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01004027 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004028 * platform_util.c.
4029 *
Hanno Becker921b76d2018-09-05 16:21:36 +01004030 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004031 * library will try to use safer implementations of this function, such as
4032 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01004033 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004034 * using the standard gmtime(). In this case, calls from the library to
4035 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01004036 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004037 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01004038 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
4039 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
4040 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004041 */
Hanno Becker6a739782018-09-05 15:06:19 +01004042//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004043
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00004044/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00004045 * Enable the verified implementations of ECDH primitives from Project Everest
4046 * (currently only Curve25519). This feature changes the layout of ECDH
4047 * contexts and therefore is a compatibility break for applications that access
4048 * fields of a mbedtls_ecdh_context structure directly. See also
4049 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004050 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00004051//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004052
Andrzej Kurek73afe272022-01-24 10:31:06 -05004053/** \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02004054
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004055/* Target and application specific configurations
4056 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004057 * Allow user to override any previous default.
4058 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004059 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004060#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004061#include MBEDTLS_USER_CONFIG_FILE
4062#endif
4063
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004064#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07004065#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004066#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07004067
Jaeden Amero6609aef2019-07-04 20:01:14 +01004068#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01004069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004070#endif /* MBEDTLS_CONFIG_H */