blob: dff4522574bf4c3baa1c2319c11534b183c81db2 [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/*
Shaun Case0e7791f2021-12-20 21:14:10 -0800403 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100404 * 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é-Gonnard875d1eb2022-12-06 10:42:44 +0100862 * This option:
863 * - Adds xxx_restartable() variants of existing operations in the
864 * following modules, with corresponding restart context types:
865 * - ECP: scalar multiplication (mult), linear combination (muladd);
866 * - ECDSA: signature generation & verification;
867 * - PK: signature generation & verification;
868 * - X509: certificate chain verification.
869 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
870 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
871 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
872 * computations restartable:
873 * - ECDH operations from the key exchange;
874 * - verification of the server's key exchange signature;
875 * - verification of the server's certificate chain;
876 * - generation of our signature if client authentication is used, with an
877 * ECC key/certificate.
878 *
879 * \note In the cases above, the usual SSL/TLS functions, such as
880 * mbedtls_ssl_handshake(), can now return
881 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200882 *
Ron Eldor19779c42018-11-05 16:58:13 +0200883 * \note This option only works with the default software implementation of
884 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100885 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT,
886 * MBEDTLS_ECDH_LEGACY_CONTEXT, and MBEDTLS_USE_PSA_CRYPTO.
887 *
888 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100889 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200890//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100891
892/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100893 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
894 *
895 * Use a backward compatible ECDH context.
896 *
897 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
898 * defined in `ecdh.h`). For most applications, the choice of format makes
899 * no difference, since all library functions can work with either format,
900 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
901
902 * The new format used when this option is disabled is smaller
903 * (56 bytes on a 32-bit platform). In future versions of the library, it
904 * will support alternative implementations of ECDH operations.
905 * The new format is incompatible with applications that access
906 * context fields directly and with restartable ECP operations.
907 *
908 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
909 * want to access ECDH context fields directly. Otherwise you should
910 * comment out this macro definition.
911 *
912 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
913 *
914 * \note This configuration option is experimental. Future versions of the
915 * library may modify the way the ECDH context layout is configured
916 * and may modify the layout of the new context type.
917 */
918#define MBEDTLS_ECDH_LEGACY_CONTEXT
919
920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100922 *
923 * Enable deterministic ECDSA (RFC 6979).
924 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
925 * may result in a compromise of the long-term signing key. This is avoided by
926 * the deterministic variant.
927 *
John Durkop36a82e52020-10-26 09:39:05 -0700928 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100929 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100930 * Comment this macro to disable deterministic ECDSA.
931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100933
934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200936 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200937 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200938 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200939 * This enables the following ciphersuites (if other requisites are
940 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
942 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
943 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
944 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
945 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
946 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
947 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
948 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
949 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
950 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
951 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
952 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200955
956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200958 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200959 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200960 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200962 *
963 * This enables the following ciphersuites (if other requisites are
964 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
966 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
967 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
968 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
969 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
970 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
971 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
972 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
973 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
974 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
975 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
976 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100977 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100978 * \warning Using DHE constitutes a security risk as it
979 * is not possible to validate custom DH parameters.
980 * If possible, it is recommended users should consider
981 * preferring other methods of key exchange.
982 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100983 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200989 *
990 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
991 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +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_ECDHE_PSK_WITH_AES_256_CBC_SHA384
997 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
998 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
999 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1000 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1001 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1002 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
1003 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001006
1007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001009 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001010 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +02001011 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1013 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001014 *
1015 * This enables the following ciphersuites (if other requisites are
1016 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1018 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1019 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1020 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
1021 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
1022 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1023 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1024 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1025 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
1026 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
1027 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
1028 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001031
1032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001034 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001035 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001036 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1038 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001039 *
1040 * This enables the following ciphersuites (if other requisites are
1041 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1043 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1044 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1045 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
1046 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
1047 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
1048 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1049 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1050 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1051 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1052 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1053 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1054 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
1055 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
1056 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +02001057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001059
1060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001062 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001063 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001064 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1066 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001067 *
1068 * This enables the following ciphersuites (if other requisites are
1069 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1071 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1072 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1073 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1074 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1075 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1076 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1077 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1078 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1079 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1080 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1081 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1082 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001083 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001084 * \warning Using DHE constitutes a security risk as it
1085 * is not possible to validate custom DH parameters.
1086 * If possible, it is recommended users should consider
1087 * preferring other methods of key exchange.
1088 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001089 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001092
1093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001095 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001096 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001097 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1099 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001100 *
1101 * This enables the following ciphersuites (if other requisites are
1102 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1104 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1105 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1106 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1107 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1108 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1109 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1110 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1111 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1112 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1113 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1114 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001117
1118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001120 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001121 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001122 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001124 *
1125 * This enables the following ciphersuites (if other requisites are
1126 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1128 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1129 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1130 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1131 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1132 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1135 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1137 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001141
1142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001144 *
1145 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1146 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001147 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001148 *
1149 * This enables the following ciphersuites (if other requisites are
1150 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1152 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1153 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1154 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1155 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1156 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1157 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1158 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1159 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1160 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1161 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1162 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001165
1166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001168 *
1169 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1170 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001171 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001172 *
1173 * This enables the following ciphersuites (if other requisites are
1174 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1176 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1177 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1180 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1183 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1184 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1185 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1186 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001189
1190/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001191 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1192 *
1193 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1194 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001195 * \warning This is currently experimental. EC J-PAKE support is based on the
1196 * Thread v1.0.0 specification; incompatible changes to the specification
1197 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001198 *
1199 * Requires: MBEDTLS_ECJPAKE_C
1200 * MBEDTLS_SHA256_C
1201 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1202 *
1203 * This enables the following ciphersuites (if other requisites are
1204 * enabled as well):
1205 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1206 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001207//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001208
1209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001211 *
1212 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1213 * RFC 5915 and RFC 5480.
1214 *
1215 * Currently this means parsing the SpecifiedECDomain choice of EC
1216 * parameters (only known groups are supported, not arbitrary domains, to
1217 * avoid validation issues).
1218 *
1219 * Disable if you only need to support RFC 5915 + 5480 key formats.
1220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001222
1223/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 * Enable a dummy error function to make use of mbedtls_strerror() in
1227 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1228 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001229 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1231 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001232 *
1233 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001235 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001237
1238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001240 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001241 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001242 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001246
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001249 *
1250 * Enable functions that use the filesystem.
1251 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001253
1254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001256 *
1257 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001259 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001260 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001261 * application.
1262 *
1263 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001266
1267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001269 *
1270 * Do not use built-in platform entropy functions.
1271 * This is useful if your platform does not support
1272 * standards like the /dev/urandom or Windows CryptoAPI.
1273 *
1274 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001277
1278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001280 *
1281 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1282 * default SHA-512 based one (if both are available).
1283 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001285 *
1286 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1287 * if you have performance concerns.
1288 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 * This option is only useful if both MBEDTLS_SHA256_C and
1290 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001293
1294/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001295 * \def MBEDTLS_ENTROPY_NV_SEED
1296 *
1297 * Enable the non-volatile (NV) seed file-based entropy source.
1298 * (Also enables the NV seed read/write functions in the platform layer)
1299 *
1300 * This is crucial (if not required) on systems that do not have a
1301 * cryptographic entropy source (in hardware or kernel) available.
1302 *
1303 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1304 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001305 * \note The read/write functions that are used by the entropy source are
1306 * determined in the platform layer, and can be modified at runtime and/or
1307 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1308 *
1309 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001310 * with regular fopen(), please make sure you make a seedfile with the
1311 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1312 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001313 * and written to or you will get an entropy source error! The default
1314 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1315 * bytes from the file.
1316 *
1317 * \note The entropy collector will write to the seed file before entropy is
1318 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001319 */
1320//#define MBEDTLS_ENTROPY_NV_SEED
1321
Ronald Cron71016a92020-08-28 19:01:50 +02001322/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001323 *
Ronald Cron71016a92020-08-28 19:01:50 +02001324 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001325 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001326 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1327 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001328 *
1329 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001330 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001331 */
Ronald Cron71016a92020-08-28 19:01:50 +02001332//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001333
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001336 *
1337 * Enable debugging of buffer allocator memory issues. Automatically prints
1338 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1339 * function for 'debug output' of allocated memory.
1340 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001342 *
1343 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001346
1347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001349 *
1350 * Include backtrace information with each allocated block.
1351 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrove5205c972022-07-28 06:12:08 +01001353 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001354 *
1355 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001358
1359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001361 *
1362 * Support external private RSA keys (eg from a HSM) in the PK layer.
1363 *
1364 * Comment this macro to disable support for external private RSA keys.
1365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001366#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001367
1368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001369 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001370 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001371 * Enable support for PKCS#1 v1.5 encoding.
1372 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001374 *
Paul Bakker48377d92013-08-30 12:06:24 +02001375 * This enables support for PKCS#1 v1.5 operations.
1376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001378
1379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001380 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001381 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001382 * Enable support for PKCS#1 v2.1 encoding.
1383 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001385 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001386 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001389
Steven Cooreman6801f082021-02-19 17:21:22 +01001390/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1391 *
1392 * Enable support for platform built-in keys. If you enable this feature,
1393 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1394 * See the documentation of that function for more information.
1395 *
1396 * Built-in keys are typically derived from a hardware unique key or
1397 * stored in a secure element.
1398 *
1399 * Requires: MBEDTLS_PSA_CRYPTO_C.
1400 *
1401 * \warning This interface is experimental and may change or be removed
1402 * without notice.
1403 */
1404//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1405
Ronald Cron3768ac12021-01-26 16:58:00 +01001406/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1407 *
1408 * Enable support for PSA crypto client.
1409 *
1410 * \note This option allows to include the code necessary for a PSA
1411 * crypto client when the PSA crypto implementation is not included in
1412 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1413 * code to set and get PSA key attributes.
1414 * The development of PSA drivers partially relying on the library to
1415 * fulfill the hardware gaps is another possible usage of this option.
1416 *
1417 * \warning This interface is experimental and may change or be removed
1418 * without notice.
1419 */
1420//#define MBEDTLS_PSA_CRYPTO_CLIENT
1421
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001422/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1423 *
1424 * Enable support for the experimental PSA crypto driver interface.
1425 *
John Durkop185764f2020-10-12 21:32:12 -07001426 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001427 *
1428 * \warning This interface is experimental and may change or be removed
1429 * without notice.
1430 */
1431//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1432
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001433/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1434 *
1435 * Make the PSA Crypto module use an external random generator provided
1436 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1437 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001438 * \note This random generator must deliver random numbers with cryptographic
1439 * quality and high performance. It must supply unpredictable numbers
1440 * with a uniform distribution. The implementation of this function
1441 * is responsible for ensuring that the random generator is seeded
1442 * with sufficient entropy. If you have a hardware TRNG which is slow
1443 * or delivers non-uniform output, declare it as an entropy source
1444 * with mbedtls_entropy_add_source() instead of enabling this option.
1445 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001446 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001447 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1448 * and define a function called mbedtls_psa_external_get_random()
1449 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001450 * ```
1451 * psa_status_t mbedtls_psa_external_get_random(
1452 * mbedtls_psa_external_random_context_t *context,
1453 * uint8_t *output, size_t output_size, size_t *output_length);
1454 * );
1455 * ```
1456 * The \c context value is initialized to 0 before the first call.
1457 * The function must fill the \c output buffer with \p output_size bytes
1458 * of random data and set \c *output_length to \p output_size.
1459 *
1460 * Requires: MBEDTLS_PSA_CRYPTO_C
1461 *
1462 * \warning If you enable this option, code that uses the PSA cryptography
1463 * interface will not use any of the entropy sources set up for
1464 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1465 * enables.
1466 *
1467 * \note This option is experimental and may be removed without notice.
1468 */
1469//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1470
Paul Bakker9dcc3222011-03-08 14:16:06 +00001471/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001472 * \def MBEDTLS_PSA_CRYPTO_SPM
1473 *
1474 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1475 * Partition Manager) integration which separates the code into two parts: a
1476 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1477 * Environment).
1478 *
1479 * Module: library/psa_crypto.c
1480 * Requires: MBEDTLS_PSA_CRYPTO_C
1481 *
1482 */
1483//#define MBEDTLS_PSA_CRYPTO_SPM
1484
1485/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001486 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001487 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001488 * Enable support for entropy injection at first boot. This feature is
1489 * required on systems that do not have a built-in entropy source (TRNG).
1490 * This feature is currently not supported on systems that have a built-in
1491 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001492 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001493 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001494 *
1495 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001496//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001497
1498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001500 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001501 * Do not use the Chinese Remainder Theorem
1502 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001503 *
1504 * Uncomment this macro to disable the use of CRT in RSA.
1505 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001507//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001508
1509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001511 *
1512 * Enable the checkup functions (*_self_test).
1513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001515
1516/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001517 * \def MBEDTLS_SHA256_SMALLER
1518 *
1519 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1520 * lower performance.
1521 *
Adam Wolfef30d902019-09-10 09:53:08 -05001522 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001523 * performance and size. This version optimizes more aggressively for size at
1524 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1525 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1526 * 30%.
1527 *
1528 * Uncomment to enable the smaller implementation of SHA256.
1529 */
1530//#define MBEDTLS_SHA256_SMALLER
1531
1532/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001533 * \def MBEDTLS_SHA512_SMALLER
1534 *
1535 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1536 * lower performance.
1537 *
1538 * Uncomment to enable the smaller implementation of SHA512.
1539 */
1540//#define MBEDTLS_SHA512_SMALLER
1541
1542/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001543 * \def MBEDTLS_SHA512_NO_SHA384
1544 *
1545 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1546 * code size on devices that don't use SHA-384.
1547 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001548 * Requires: MBEDTLS_SHA512_C
1549 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001550 * Uncomment to disable SHA-384
1551 */
1552//#define MBEDTLS_SHA512_NO_SHA384
1553
1554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001556 *
1557 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001558 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001559 * with other servers, only debugging of failures is harder.
1560 *
1561 * The advantage of not sending alert messages, is that no information is given
1562 * about reasons for failures thus preventing adversaries of gaining intel.
1563 *
1564 * Enable sending of all alert messages
1565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001567
1568/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001569 * \def MBEDTLS_SSL_RECORD_CHECKING
1570 *
1571 * Enable the function mbedtls_ssl_check_record() which can be used to check
1572 * the validity and authenticity of an incoming record, to verify that it has
1573 * not been seen before. These checks are performed without modifying the
1574 * externally visible state of the SSL context.
1575 *
1576 * See mbedtls_ssl_check_record() for more information.
1577 *
1578 * Uncomment to enable support for record checking.
1579 */
1580#define MBEDTLS_SSL_RECORD_CHECKING
1581
1582/**
1583 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1584 *
1585 * Enable support for the DTLS Connection ID extension
1586 * (version draft-ietf-tls-dtls-connection-id-05,
1587 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1588 * which allows to identify DTLS connections across changes
1589 * in the underlying transport.
1590 *
1591 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1592 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1593 * See the corresponding documentation for more information.
1594 *
1595 * \warning The Connection ID extension is still in draft state.
1596 * We make no stability promises for the availability
1597 * or the shape of the API controlled by this option.
1598 *
1599 * The maximum lengths of outgoing and incoming CIDs can be configured
1600 * through the options
1601 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1602 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1603 *
1604 * Requires: MBEDTLS_SSL_PROTO_DTLS
1605 *
1606 * Uncomment to enable the Connection ID extension.
1607 */
1608//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1609
1610/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001611 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1612 *
1613 * Enable asynchronous external private key operations in SSL. This allows
1614 * you to configure an SSL connection to call an external cryptographic
1615 * module to perform private key operations instead of performing the
1616 * operation inside the library.
1617 *
1618 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001619//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001620
1621/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001622 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1623 *
1624 * Enable serialization of the TLS context structures, through use of the
1625 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1626 *
1627 * This pair of functions allows one side of a connection to serialize the
1628 * context associated with the connection, then free or re-use that context
1629 * while the serialized state is persisted elsewhere, and finally deserialize
1630 * that state to a live context for resuming read/write operations on the
1631 * connection. From a protocol perspective, the state of the connection is
1632 * unaffected, in particular this is entirely transparent to the peer.
1633 *
1634 * Note: this is distinct from TLS session resumption, which is part of the
1635 * protocol and fully visible by the peer. TLS session resumption enables
1636 * establishing new connections associated to a saved session with shorter,
1637 * lighter handshakes, while context serialization is a local optimization in
1638 * handling a single, potentially long-lived connection.
1639 *
1640 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1641 * saved after the handshake to allow for more efficient serialization, so if
1642 * you don't need this feature you'll save RAM by disabling it.
1643 *
Przemek Stekiel864b43d2022-10-05 11:47:29 +02001644 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1645 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001646 * Comment to disable the context serialization APIs.
1647 */
1648#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1649
1650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001652 *
1653 * Enable the debug messages in SSL module for all issues.
1654 * Debug messages have been disabled in some places to prevent timing
1655 * attacks due to (unbalanced) debugging function calls.
1656 *
1657 * If you need all error reporting you should enable this during debugging,
1658 * but remove this for production servers that should log as well.
1659 *
1660 * Uncomment this macro to report all debug messages on errors introducing
1661 * a timing side-channel.
1662 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001667 *
1668 * Enable support for Encrypt-then-MAC, RFC 7366.
1669 *
1670 * This allows peers that both support it to use a more robust protection for
1671 * ciphersuites using CBC, providing deep resistance against timing attacks
1672 * on the padding or underlying cipher.
1673 *
1674 * This only affects CBC ciphersuites, and is useless if none is defined.
1675 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1677 * MBEDTLS_SSL_PROTO_TLS1_1 or
1678 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001679 *
1680 * Comment this macro to disable support for Encrypt-then-MAC
1681 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001685 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001686 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1687 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001688 *
Shaun Case0e7791f2021-12-20 21:14:10 -08001689 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001690 * attacks, but it is recommended to always use it (even if you disable
1691 * renegotiation), since it actually fixes a more fundamental issue in the
1692 * original SSL/TLS design, and has implications beyond Triple Handshake.
1693 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1695 * MBEDTLS_SSL_PROTO_TLS1_1 or
1696 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001697 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001698 * Comment this macro to disable support for Extended Master Secret.
1699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001701
Paul Bakkerd66f0702013-01-31 16:57:45 +01001702/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001704 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001705 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1706 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001707 *
1708 * For servers, it is recommended to always enable this, unless you support
1709 * only one version of TLS, or know for sure that none of your clients
1710 * implements a fallback strategy.
1711 *
1712 * For clients, you only need this if you're using a fallback strategy, which
1713 * is not recommended in the first place, unless you absolutely need it to
1714 * interoperate with buggy (version-intolerant) servers.
1715 *
1716 * Comment this macro to disable support for FALLBACK_SCSV
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001719
1720/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001721 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1722 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001723 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001724 * giving access to the peer's certificate after completion of the handshake.
1725 *
1726 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1727 * recommended to disable this option for reduced RAM usage.
1728 *
1729 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1730 * defined, but always returns \c NULL.
1731 *
1732 * \note This option has no influence on the protection against the
1733 * triple handshake attack. Even if it is disabled, Mbed TLS will
1734 * still ensure that certificates do not change during renegotiation,
Shaun Case0e7791f2021-12-20 21:14:10 -08001735 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001736 *
1737 * Comment this macro to disable storing the peer's certificate
1738 * after the handshake.
1739 */
1740#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1741
1742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001744 *
1745 * Enable hooking functions in SSL module for hardware acceleration of
1746 * individual records.
1747 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001748 * \deprecated This option is deprecated and will be removed in a future
1749 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001750 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001751 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001753//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001754
1755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001757 *
1758 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1759 *
1760 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1761 * of interoperability issues compared to sending 0-length records.
1762 *
1763 * Comment this macro to disable 1/n-1 record splitting.
1764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001766
1767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001769 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001770 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001771 *
1772 * The two main uses of renegotiation are (1) refresh keys on long-lived
1773 * connections and (2) client authentication after the initial handshake.
1774 * If you don't need renegotiation, it's probably better to disable it, since
1775 * it has been associated with security issues in the past and is easy to
1776 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001777 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001778 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001779 *
1780 * \note Even if this option is disabled, both client and server are aware
1781 * of the Renegotiation Indication Extension (RFC 5746) used to
1782 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1783 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1784 * configuration of this extension).
1785 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001788
1789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001791 *
1792 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001794 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001795 * \deprecated This option is deprecated and will be removed in a future
1796 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001797 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001798 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001801
1802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001804 *
1805 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001807 *
1808 * Uncomment this macro to respect client's ciphersuite order
1809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001811
1812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001814 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001815 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001816 *
1817 * Comment this macro to disable support for the max_fragment_length extension
1818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001820
1821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001823 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001824 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * Requires: MBEDTLS_MD5_C
1827 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001828 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001829 * \deprecated This option is deprecated and will be removed in a future
1830 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001831 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001832 * Comment this macro to disable support for SSL 3.0
1833 */
Janos Follathe2681a42016-03-07 15:57:05 +00001834//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001835
1836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001839 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001840 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841 * Requires: MBEDTLS_MD5_C
1842 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001843 *
1844 * Comment this macro to disable support for TLS 1.0
1845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001847
1848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001850 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001851 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001852 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 * Requires: MBEDTLS_MD5_C
1854 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001855 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001856 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001859
1860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001862 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001863 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001864 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001866 * (Depends on ciphersuites)
1867 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001868 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001871
1872/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001873 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1874 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001875 * This macro is used to selectively enable experimental parts
1876 * of the code that contribute to the ongoing development of
1877 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1878 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001879 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001880 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1881 * and no feature exposed through this macro is part of the
1882 * public API. In particular, features under the control
1883 * of this macro are experimental and don't come with any
1884 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001885 *
1886 * Uncomment this macro to enable experimental and partial
1887 * functionality specific to TLS 1.3.
1888 */
Hanno Beckere4160602020-05-07 15:11:45 +01001889//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001890
1891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001893 *
1894 * Enable support for DTLS (all available versions).
1895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1897 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001898 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1900 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001901 *
1902 * Comment this macro to disable support for DTLS
1903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001905
1906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001908 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001909 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001910 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001911 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001914
1915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001917 *
1918 * Enable support for the anti-replay mechanism in DTLS.
1919 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 * Requires: MBEDTLS_SSL_TLS_C
1921 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001922 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001923 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001924 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001925 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001926 * Comment this to disable anti-replay in DTLS.
1927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001929
1930/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001932 *
1933 * Enable support for HelloVerifyRequest on DTLS servers.
1934 *
1935 * This feature is highly recommended to prevent DTLS servers being used as
1936 * amplifiers in DoS attacks against other hosts. It should always be enabled
1937 * unless you know for sure amplification cannot be a problem in the
1938 * environment in which your server operates.
1939 *
Andrzej Kurek293e4522022-04-13 14:28:52 -04001940 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001941 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001942 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001943 *
1944 * Comment this to disable support for HelloVerifyRequest.
1945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001946#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001947
1948/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001949 * \def MBEDTLS_SSL_DTLS_SRTP
1950 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02001951 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001952 * through the use_srtp extension.
1953 *
1954 * \note This feature provides the minimum functionality required
1955 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1956 * the associated SRTP packet protection key material.
1957 * In particular, the SRTP packet protection itself, as well as the
1958 * demultiplexing of RTP and DTLS packets at the datagram layer
1959 * (see Section 5 of RFC 5764), are not handled by this feature.
1960 * Instead, after successful completion of a handshake negotiating
1961 * the use of DTLS-SRTP, the extended key exporter API
1962 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1963 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1964 * (this is implemented in the SSL example programs).
1965 * The resulting key should then be passed to an SRTP stack.
1966 *
1967 * Setting this option enables the runtime API
1968 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1969 * through which the supported DTLS-SRTP protection
1970 * profiles can be configured. You must call this API at
1971 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001972 *
1973 * Requires: MBEDTLS_SSL_PROTO_DTLS
1974 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001975 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001976 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001977//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001978
1979/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001980 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1981 *
1982 * Enable server-side support for clients that reconnect from the same port.
1983 *
1984 * Some clients unexpectedly close the connection and try to reconnect using the
1985 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001986 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001987 * flag enables that support.
1988 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001989 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001990 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001991 * Comment this to disable support for clients reusing the source port.
1992 */
1993#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1994
1995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001997 *
1998 * Enable support for a limit of records with bad MAC.
1999 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002000 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002001 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002005
2006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002008 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002009 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01002010 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02002011 * session store remains the responsibility of the application, though).
2012 * Server-side, you also need to provide callbacks for writing and parsing
2013 * tickets, including authenticated encryption and key management. Example
2014 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02002015 *
2016 * Comment this macro to disable support for SSL session tickets
2017 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002019
2020/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002021 * \def MBEDTLS_SSL_EXPORT_KEYS
2022 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002023 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002024 * This is required for certain users of TLS, e.g. EAP-TLS.
2025 *
2026 * Comment this macro to disable support for key export
2027 */
2028#define MBEDTLS_SSL_EXPORT_KEYS
2029
2030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002032 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002033 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02002034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00002036 *
Paul Bakker0be444a2013-08-27 21:55:01 +02002037 * Comment this macro to disable support for server name indication in SSL
2038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002040
2041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002044 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02002045 *
2046 * Comment this macro to disable support for truncated HMAC in SSL
2047 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002049
2050/**
Hanno Beckere89353a2017-11-20 16:36:41 +00002051 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2052 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002053 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
2054 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002055 * only meant for a transitory upgrade period and will be removed in a future
2056 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00002057 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002058 * \warning The old implementation is non-compliant and has a security weakness
2059 * (2^80 brute force attack on the HMAC key used for a single,
2060 * uninterrupted connection). This should only be enabled temporarily
2061 * when (1) the use of truncated HMAC is essential in order to save
2062 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
2063 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00002064 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002065 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00002066 * future version of Mbed TLS.
2067 *
Hanno Beckere89353a2017-11-20 16:36:41 +00002068 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
2069 *
2070 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
2071 */
2072//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2073
2074/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002075 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2076 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002077 * When this option is enabled, the SSL buffer will be resized automatically
2078 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002079 *
2080 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002081 */
2082//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2083
2084/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002085 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2086 *
2087 * Enable testing of the constant-flow nature of some sensitive functions with
2088 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002089 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002090 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002091 * This setting requires compiling with clang -fsanitize=memory. The test
2092 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002093 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002094 * \warning This macro is only used for extended testing; it is not considered
2095 * part of the library's API, so it may change or disappear at any time.
2096 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002097 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002098 */
2099//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2100
2101/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002102 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2103 *
2104 * Enable testing of the constant-flow nature of some sensitive functions with
2105 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002106 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002107 *
2108 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002109 * testing if the tests suites are run with valgrind's memcheck. This can be
2110 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2111 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002112 *
2113 * \warning This macro is only used for extended testing; it is not considered
2114 * part of the library's API, so it may change or disappear at any time.
2115 *
2116 * Uncomment to enable testing of the constant-flow nature of selected code.
2117 */
2118//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2119
2120/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002121 * \def MBEDTLS_TEST_HOOKS
2122 *
2123 * Enable features for invasive testing such as introspection functions and
2124 * hooks for fault injection. This enables additional unit tests.
2125 *
2126 * Merely enabling this feature should not change the behavior of the product.
2127 * It only adds new code, and new branching points where the default behavior
2128 * is the same as when this feature is disabled.
2129 * However, this feature increases the attack surface: there is an added
2130 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2131 * Therefore this feature must never be enabled in production.
2132 *
2133 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2134 * information.
2135 *
2136 * Uncomment to enable invasive tests.
2137 */
2138//#define MBEDTLS_TEST_HOOKS
2139
2140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002142 *
2143 * Provide your own alternate threading implementation.
2144 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002146 *
2147 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002150
2151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002153 *
2154 * Enable the pthread wrapper layer for the threading layer.
2155 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002157 *
2158 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002161
2162/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002163 * \def MBEDTLS_USE_PSA_CRYPTO
2164 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002165 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2166 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002167 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002168 * \note Development of this option is currently in progress, and parts of Mbed
2169 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002170 * will still continue to work as usual, so enabling this option should not
2171 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002172 *
Manuel Pégourié-Gonnard00b72fc2021-09-20 13:21:25 +02002173 * \note See docs/use-psa-crypto.md for a complete description of what this
2174 * option currently does, and of parts that are not affected by it so far.
2175 *
Manuel Pégourié-Gonnardb52b91d2021-09-21 11:30:52 +02002176 * \warning This option enables new Mbed TLS APIs which are currently
2177 * considered experimental and may change in incompatible ways at any time.
2178 * That is, the APIs enabled by this option are not covered by the usual
2179 * promises of API stability.
Hanno Becker51560b62018-11-19 09:46:26 +00002180 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002181 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002182 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002183 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002184 */
2185//#define MBEDTLS_USE_PSA_CRYPTO
2186
2187/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002188 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2189 *
John Durkop185764f2020-10-12 21:32:12 -07002190 * This setting allows support for cryptographic mechanisms through the PSA
2191 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002192 *
Gilles Peskine33665c42022-04-13 23:22:49 +02002193 * When this option is disabled, the PSA API exposes the cryptographic
2194 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2195 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine52834352022-03-16 17:03:55 +01002196 *
2197 * When this option is enabled, the PSA API exposes the cryptographic
2198 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2199 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2200 * automatically enabled if required (i.e. if no PSA driver provides the
2201 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
Gilles Peskine82909762022-04-26 18:10:11 +02002202 * in config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002203 *
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002204 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine8a557752022-04-14 12:44:01 +02002205 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002206 *
Gilles Peskine58858b72020-11-09 15:26:09 +01002207 * If you enable this option and write your own configuration file, you must
2208 * include mbedtls/config_psa.h in your configuration file. The default
2209 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002210 *
2211 * This feature is still experimental and is not ready for production since
2212 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002213 */
2214//#define MBEDTLS_PSA_CRYPTO_CONFIG
2215
2216/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002218 *
2219 * Allow run-time checking of compile-time enabled features. Thus allowing users
2220 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002222 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002224 *
2225 * Comment this to disable run-time checking and save ROM space
2226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002228
2229/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002231 *
2232 * If set, the X509 parser will not break-off when parsing an X509 certificate
2233 * and encountering an extension in a v1 or v2 certificate.
2234 *
2235 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002238
2239/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002240 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002241 *
2242 * If set, the X509 parser will not break-off when parsing an X509 certificate
2243 * and encountering an unknown critical extension.
2244 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002245 * \warning Depending on your PKI use, enabling this can be a security risk!
2246 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002247 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002250
2251/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002252 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2253 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002254 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002255 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2256 * the set of trusted certificates through a callback instead of a linked
2257 * list.
2258 *
2259 * This is useful for example in environments where a large number of trusted
2260 * certificates is present and storing them in a linked list isn't efficient
2261 * enough, or when the set of trusted certificates changes frequently.
2262 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002263 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002264 * `mbedtls_ssl_conf_ca_cb()` for more information.
2265 *
2266 * Uncomment to enable trusted certificate callbacks.
2267 */
2268//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2269
2270/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002272 *
2273 * Enable verification of the keyUsage extension (CA and leaf certificates).
2274 *
2275 * Disabling this avoids problems with mis-issued and/or misused
2276 * (intermediate) CA and leaf certificates.
2277 *
2278 * \warning Depending on your PKI use, disabling this can be a security risk!
2279 *
2280 * Comment to skip keyUsage checking for both CA and leaf certificates.
2281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002283
2284/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002286 *
2287 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2288 *
2289 * Disabling this avoids problems with mis-issued and/or misused certificates.
2290 *
2291 * \warning Depending on your PKI use, disabling this can be a security risk!
2292 *
2293 * Comment to skip extendedKeyUsage checking for certificates.
2294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002296
2297/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002299 *
2300 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2301 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2302 *
2303 * Comment this macro to disallow using RSASSA-PSS in certificates.
2304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002306
2307/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002309 *
2310 * If set, the SSL/TLS module uses ZLIB to support compression and
2311 * decompression of packet data.
2312 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002313 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2314 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002315 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002316 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002317 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002318 *
Hanno Beckere494e202018-03-08 13:26:12 +00002319 * \deprecated This feature is deprecated and will be removed
2320 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002321 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002322 * Used in: library/ssl_tls.c
2323 * library/ssl_cli.c
2324 * library/ssl_srv.c
2325 *
2326 * This feature requires zlib library and headers to be present.
2327 *
2328 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330//#define MBEDTLS_ZLIB_SUPPORT
Andrzej Kurek73afe272022-01-24 10:31:06 -05002331/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002332
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002333/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002334 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002335 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002336 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002337 * \{
2338 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002339
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002342 *
2343 * Enable AES-NI support on x86-64.
2344 *
2345 * Module: library/aesni.c
2346 * Caller: library/aes.c
2347 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002349 *
2350 * This modules adds support for the AES-NI instructions on x86-64
2351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002353
2354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002356 *
2357 * Enable the AES block cipher.
2358 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002359 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002360 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002361 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002362 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002363 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002364 * This module enables the following ciphersuites (if other requisites are
2365 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2367 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2368 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2369 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2370 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2371 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2372 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2373 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2374 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2375 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2376 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2377 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2378 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2379 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2380 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2381 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2382 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2383 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2384 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2385 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2386 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2387 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2388 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2389 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2390 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2391 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2392 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2394 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2395 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2396 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2397 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2398 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2399 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2400 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2401 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2402 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2403 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2404 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2405 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2406 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2407 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2408 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2409 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2410 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2411 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2412 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2413 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2414 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2415 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2416 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2417 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2418 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2419 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2420 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2421 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2422 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2423 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002424 *
Paul Bakkercff68422013-09-15 20:43:33 +02002425 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002428
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002431 *
2432 * Enable the ARCFOUR stream cipher.
2433 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002434 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002435 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002436 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002437 * This module enables the following ciphersuites (if other requisites are
2438 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2440 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2441 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2442 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2443 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2444 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2445 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2446 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2447 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2448 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002449 *
2450 * \warning ARC4 is considered a weak cipher and its use constitutes a
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00002451 * security risk. If possible, we recommend avoiding dependencies on
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002452 * it, and considering stronger ciphers instead.
2453 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002456
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002457/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002459 *
2460 * Enable the generic ASN1 parser.
2461 *
2462 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002463 * Caller: library/x509.c
2464 * library/dhm.c
2465 * library/pkcs12.c
2466 * library/pkcs5.c
2467 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002470
2471/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002473 *
2474 * Enable the generic ASN1 writer.
2475 *
2476 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002477 * Caller: library/ecdsa.c
2478 * library/pkwrite.c
2479 * library/x509_create.c
2480 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002481 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002484
2485/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002487 *
2488 * Enable the Base64 module.
2489 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002490 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002491 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002493 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002496
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002499 *
Paul Bakker9a736322012-11-14 12:39:52 +00002500 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002501 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002502 * Module: library/bignum.c
2503 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002504 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002505 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002506 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002507 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002508 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002509 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002510 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002513
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002516 *
2517 * Enable the Blowfish block cipher.
2518 *
2519 * Module: library/blowfish.c
2520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002522
2523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002525 *
2526 * Enable the Camellia block cipher.
2527 *
Paul Bakker38119b12009-01-10 23:31:23 +00002528 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002529 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002530 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002531 * This module enables the following ciphersuites (if other requisites are
2532 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2534 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2535 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2536 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2537 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2538 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2539 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2540 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2541 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2542 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2543 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2544 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2545 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2546 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2547 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2548 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2549 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2550 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2551 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2552 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2553 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2554 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2555 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2556 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2557 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2558 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2559 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2560 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2561 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2562 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2563 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2564 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2565 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2566 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2567 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2568 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2569 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2570 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2571 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2572 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2573 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2574 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002577
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002578/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002579 * \def MBEDTLS_ARIA_C
2580 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002581 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002582 *
2583 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002584 * Caller: library/cipher.c
2585 *
2586 * This module enables the following ciphersuites (if other requisites are
2587 * enabled as well):
2588 *
2589 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2590 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2591 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2592 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2593 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2594 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2595 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2596 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2597 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2598 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2599 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2600 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2601 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2602 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2603 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2604 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2605 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2606 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2607 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2608 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2609 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2610 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2611 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2612 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2613 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2614 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2615 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2616 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2617 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2618 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2619 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2620 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2621 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2622 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2623 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2624 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2625 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2626 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002627 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002628//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002629
2630/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002632 *
2633 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2634 *
2635 * Module: library/ccm.c
2636 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002638 *
2639 * This module enables the AES-CCM ciphersuites, if other requisites are
2640 * enabled as well.
2641 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002643
2644/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002646 *
2647 * Enable the test certificates.
2648 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002649 * Module: library/certs.c
2650 * Caller:
2651 *
2652 * This module is used for testing (ssl_client/server).
2653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002655
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002656/**
Daniel King34b822c2016-05-15 17:28:08 -03002657 * \def MBEDTLS_CHACHA20_C
2658 *
2659 * Enable the ChaCha20 stream cipher.
2660 *
2661 * Module: library/chacha20.c
2662 */
2663#define MBEDTLS_CHACHA20_C
2664
2665/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002666 * \def MBEDTLS_CHACHAPOLY_C
2667 *
2668 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2669 *
2670 * Module: library/chachapoly.c
2671 *
2672 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2673 */
2674#define MBEDTLS_CHACHAPOLY_C
2675
2676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678 *
2679 * Enable the generic cipher layer.
2680 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002681 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002682 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002683 *
2684 * Uncomment to enable generic cipher wrappers.
2685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002687
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002688/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002689 * \def MBEDTLS_CMAC_C
2690 *
Simon Butcher327398a2016-10-05 14:09:11 +01002691 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2692 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002693 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002694 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2695 * implementation of the CMAC algorithm is provided by an alternate
2696 * implementation, that alternate implementation may opt to not support
2697 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2698 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002699 * Module: library/cmac.c
2700 *
Simon Butcher69283e52016-10-06 12:49:58 +01002701 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002702 *
2703 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002704//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002705
2706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002708 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002709 * Enable the CTR_DRBG AES-based random generator.
2710 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002711 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002712 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002713 * \note To achieve a 256-bit security strength with CTR_DRBG,
2714 * you must use AES-256 *and* use sufficient entropy.
2715 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002716 *
2717 * Module: library/ctr_drbg.c
2718 * Caller:
2719 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002721 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002722 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002725
2726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002728 *
2729 * Enable the debug functions.
2730 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002731 * Module: library/debug.c
2732 * Caller: library/ssl_cli.c
2733 * library/ssl_srv.c
2734 * library/ssl_tls.c
2735 *
2736 * This module provides debugging functions.
2737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002739
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002742 *
2743 * Enable the DES block cipher.
2744 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002745 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002746 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002747 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002748 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002749 * This module enables the following ciphersuites (if other requisites are
2750 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2752 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2753 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2754 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2755 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2756 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2757 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2758 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2759 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2760 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002761 *
Paul Bakkercff68422013-09-15 20:43:33 +02002762 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002763 *
2764 * \warning DES is considered a weak cipher and its use constitutes a
2765 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002767#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002768
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002771 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002772 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002773 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002774 * Module: library/dhm.c
2775 * Caller: library/ssl_cli.c
2776 * library/ssl_srv.c
2777 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002778 * This module is used by the following key exchanges:
2779 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002780 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002781 * \warning Using DHE constitutes a security risk as it
2782 * is not possible to validate custom DH parameters.
2783 * If possible, it is recommended users should consider
2784 * preferring other methods of key exchange.
2785 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002786 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002789
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002792 *
2793 * Enable the elliptic curve Diffie-Hellman library.
2794 *
2795 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002796 * Caller: library/ssl_cli.c
2797 * library/ssl_srv.c
2798 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002799 * This module is used by the following key exchanges:
2800 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002801 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002805
2806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002808 *
2809 * Enable the elliptic curve DSA library.
2810 *
2811 * Module: library/ecdsa.c
2812 * Caller:
2813 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002814 * This module is used by the following key exchanges:
2815 * ECDHE-ECDSA
2816 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002817 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2818 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2819 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002822
2823/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002824 * \def MBEDTLS_ECJPAKE_C
2825 *
2826 * Enable the elliptic curve J-PAKE library.
2827 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002828 * \warning This is currently experimental. EC J-PAKE support is based on the
2829 * Thread v1.0.0 specification; incompatible changes to the specification
2830 * might still happen. For this reason, this is disabled by default.
2831 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002832 * Module: library/ecjpake.c
2833 * Caller:
2834 *
2835 * This module is used by the following key exchanges:
2836 * ECJPAKE
2837 *
2838 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2839 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002840//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002841
2842/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002844 *
2845 * Enable the elliptic curve over GF(p) library.
2846 *
2847 * Module: library/ecp.c
2848 * Caller: library/ecdh.c
2849 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002850 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002851 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002855
2856/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002858 *
2859 * Enable the platform-specific entropy code.
2860 *
2861 * Module: library/entropy.c
2862 * Caller:
2863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002865 *
2866 * This module provides a generic entropy pool
2867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002869
2870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002872 *
2873 * Enable error code to error string conversion.
2874 *
2875 * Module: library/error.c
2876 * Caller:
2877 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002881
2882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002884 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002885 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002886 *
2887 * Module: library/gcm.c
2888 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002889 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002890 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002891 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2892 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002895
2896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002898 *
2899 * Enable the HAVEGE random generator.
2900 *
Paul Bakker2a844242013-06-24 13:01:53 +02002901 * Warning: the HAVEGE random generator is not suitable for virtualized
2902 * environments
2903 *
2904 * Warning: the HAVEGE random generator is dependent on timing and specific
2905 * processor traits. It is therefore not advised to use HAVEGE as
2906 * your applications primary random generator or primary entropy pool
2907 * input. As a secondary input to your entropy pool, it IS able add
2908 * the (limited) extra entropy it provides.
2909 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002910 * Module: library/havege.c
2911 * Caller:
2912 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002914 *
Paul Bakker2a844242013-06-24 13:01:53 +02002915 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002918
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002919/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002920 * \def MBEDTLS_HKDF_C
2921 *
2922 * Enable the HKDF algorithm (RFC 5869).
2923 *
2924 * Module: library/hkdf.c
2925 * Caller:
2926 *
2927 * Requires: MBEDTLS_MD_C
2928 *
2929 * This module adds support for the Hashed Message Authentication Code
2930 * (HMAC)-based key derivation function (HKDF).
2931 */
2932#define MBEDTLS_HKDF_C
2933
2934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002936 *
2937 * Enable the HMAC_DRBG random generator.
2938 *
2939 * Module: library/hmac_drbg.c
2940 * Caller:
2941 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002943 *
Tom Cosgrove2b150752022-05-26 11:55:43 +01002944 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002947
2948/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002949 * \def MBEDTLS_NIST_KW_C
2950 *
2951 * Enable the Key Wrapping mode for 128-bit block ciphers,
2952 * as defined in NIST SP 800-38F. Only KW and KWP modes
2953 * are supported. At the moment, only AES is approved by NIST.
2954 *
2955 * Module: library/nist_kw.c
2956 *
2957 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2958 */
2959//#define MBEDTLS_NIST_KW_C
2960
2961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002963 *
2964 * Enable the generic message digest layer.
2965 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002966 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002967 * Caller:
2968 *
2969 * Uncomment to enable generic message digest wrappers.
2970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002972
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002975 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002976 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002977 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002978 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002979 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002980 *
2981 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002982 *
2983 * \warning MD2 is considered a weak message digest and its use constitutes a
2984 * security risk. If possible, we recommend avoiding dependencies on
2985 * it, and considering stronger message digests instead.
2986 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002989
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002992 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002993 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002994 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002995 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002996 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 *
2998 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002999 *
3000 * \warning MD4 is considered a weak message digest and its use constitutes a
3001 * security risk. If possible, we recommend avoiding dependencies on
3002 * it, and considering stronger message digests instead.
3003 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003006
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003009 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003010 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003011 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003012 * Module: library/md5.c
3013 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003014 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01003015 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003016 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003017 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
3018 * depending on the handshake parameters. Further, it is used for checking
3019 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
3020 * encrypted keys.
3021 *
3022 * \warning MD5 is considered a weak message digest and its use constitutes a
3023 * security risk. If possible, we recommend avoiding dependencies on
3024 * it, and considering stronger message digests instead.
3025 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003028
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003031 *
3032 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003033 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003034 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02003035 *
3036 * Module: library/memory_buffer_alloc.c
3037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 * Requires: MBEDTLS_PLATFORM_C
3039 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02003040 *
3041 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02003042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02003044
3045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003047 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003048 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
3049 *
Simon Butcherd567a232016-03-09 20:19:21 +00003050 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
3051 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003052 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003053 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003054 * \note See also our Knowledge Base article about porting to a new
3055 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003056 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003057 *
Andres AG788aa4a2016-09-14 14:32:09 +01003058 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003059 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003060 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003063
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003066 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003067 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003068 *
3069 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003070 * Caller: library/asn1write.c
3071 * library/pkcs5.c
3072 * library/pkparse.c
3073 * library/pkwrite.c
3074 * library/rsa.c
3075 * library/x509.c
3076 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003077 * library/x509_crl.c
3078 * library/x509_crt.c
3079 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003080 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003081 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003082 *
3083 * This modules translates between OIDs and internal values.
3084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003086
3087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003089 *
3090 * Enable VIA Padlock support on x86.
3091 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003092 * Module: library/padlock.c
3093 * Caller: library/aes.c
3094 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003096 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003097 * This modules adds support for the VIA PadLock on x86.
3098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003100
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003101/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003103 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003104 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003105 *
3106 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003107 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003108 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003109 * library/x509_crl.c
3110 * library/x509_crt.c
3111 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003112 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003114 *
Paul Bakkercff68422013-09-15 20:43:33 +02003115 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003118
3119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003121 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003122 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003123 *
3124 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003125 * Caller: library/pkwrite.c
3126 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003127 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003128 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003130 *
3131 * This modules adds support for encoding / writing PEM files.
3132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003134
3135/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003137 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003138 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003139 *
3140 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003141 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003142 * library/ssl_cli.c
3143 * library/ssl_srv.c
3144 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003146 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003147 * Uncomment to enable generic public key wrappers.
3148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003150
3151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003153 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003154 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003155 *
3156 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003157 * Caller: library/x509_crt.c
3158 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003161 *
3162 * Uncomment to enable generic public key parse functions.
3163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003165
3166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003168 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003169 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003170 *
3171 * Module: library/pkwrite.c
3172 * Caller: library/x509write.c
3173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003175 *
3176 * Uncomment to enable generic public key write functions.
3177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003179
3180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003182 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003183 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003184 *
3185 * Module: library/pkcs5.c
3186 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003188 *
3189 * This module adds support for the PKCS#5 functions.
3190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003192
3193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003195 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003196 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003197 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003198 * \deprecated This option is deprecated and will be removed in a future
3199 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003200 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003201 * Module: library/pkcs11.c
3202 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003203 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003205 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003206 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003207 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003210
3211/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003213 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003214 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003215 * Adds algorithms for parsing PKCS#8 encrypted private keys
3216 *
3217 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003218 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3221 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003222 *
3223 * This module enables PKCS#12 functions.
3224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003226
3227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003229 *
3230 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003231 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003232 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3234 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003235 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003236 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003237 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3238 * as other module rely on it for a fixed snprintf implementation.
3239 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003240 * Module: library/platform.c
3241 * Caller: Most other .c files
3242 *
3243 * This module enables abstraction of common (libc) functions.
3244 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003245#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003246
3247/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003248 * \def MBEDTLS_POLY1305_C
3249 *
3250 * Enable the Poly1305 MAC algorithm.
3251 *
3252 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003253 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003254 */
3255#define MBEDTLS_POLY1305_C
3256
3257/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003258 * \def MBEDTLS_PSA_CRYPTO_C
3259 *
3260 * Enable the Platform Security Architecture cryptography API.
3261 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003262 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003263 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003264 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003265 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003266 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003267 *
3268 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003269#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003270
3271/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003272 * \def MBEDTLS_PSA_CRYPTO_SE_C
3273 *
3274 * Enable secure element support in the Platform Security Architecture
3275 * cryptography API.
3276 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003277 * \warning This feature is not yet suitable for production. It is provided
3278 * for API evaluation and testing purposes only.
3279 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003280 * Module: library/psa_crypto_se.c
3281 *
3282 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3283 *
3284 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003285//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003286
3287/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003288 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3289 *
3290 * Enable the Platform Security Architecture persistent key storage.
3291 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003292 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003293 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003294 * Requires: MBEDTLS_PSA_CRYPTO_C,
3295 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3296 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003297 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003298#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003299
3300/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003301 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003302 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003303 * Enable the emulation of the Platform Security Architecture
3304 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003305 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003306 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003307 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003308 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003309 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003310#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003311
3312/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003314 *
3315 * Enable the RIPEMD-160 hash algorithm.
3316 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003317 * Module: library/ripemd160.c
3318 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003319 *
3320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003321#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003322
3323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325 *
3326 * Enable the RSA public-key cryptosystem.
3327 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003328 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003329 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003330 * Caller: library/ssl_cli.c
3331 * library/ssl_srv.c
3332 * library/ssl_tls.c
3333 * library/x509.c
3334 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003335 * This module is used by the following key exchanges:
3336 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003337 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003341
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003344 *
3345 * Enable the SHA1 cryptographic hash algorithm.
3346 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003347 * Module: library/sha1.c
3348 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003349 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003350 * library/ssl_srv.c
3351 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003352 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003353 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003354 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3355 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003356 *
3357 * \warning SHA-1 is considered a weak message digest and its use constitutes
3358 * a security risk. If possible, we recommend avoiding dependencies
3359 * on it, and considering stronger message digests instead.
3360 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003363
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003364/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003366 *
3367 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3368 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003369 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003370 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003371 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003372 * library/ssl_cli.c
3373 * library/ssl_srv.c
3374 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003375 *
3376 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003377 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003380
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003383 *
3384 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3385 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003386 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003387 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003388 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003389 * library/ssl_cli.c
3390 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003391 *
3392 * This module adds support for SHA-384 and SHA-512.
3393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003395
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003396/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003398 *
3399 * Enable simple SSL cache implementation.
3400 *
3401 * Module: library/ssl_cache.c
3402 * Caller:
3403 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003407
3408/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003410 *
3411 * Enable basic implementation of DTLS cookies for hello verification.
3412 *
3413 * Module: library/ssl_cookie.c
3414 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003417
3418/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003419 * \def MBEDTLS_SSL_TICKET_C
3420 *
3421 * Enable an implementation of TLS server-side callbacks for session tickets.
3422 *
3423 * Module: library/ssl_ticket.c
3424 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003425 *
Przemek Stekiel97d57402022-10-10 14:08:51 +02003426 * Requires: MBEDTLS_CIPHER_C &&
3427 * ( MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C )
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003428 */
3429#define MBEDTLS_SSL_TICKET_C
3430
3431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003433 *
3434 * Enable the SSL/TLS client code.
3435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003436 * Module: library/ssl_cli.c
3437 * Caller:
3438 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003440 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003441 * This module is required for SSL/TLS client support.
3442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003444
Paul Bakker9a736322012-11-14 12:39:52 +00003445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447 *
3448 * Enable the SSL/TLS server code.
3449 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003450 * Module: library/ssl_srv.c
3451 * Caller:
3452 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003454 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003455 * This module is required for SSL/TLS server support.
3456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003458
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003461 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003462 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003463 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003464 * Module: library/ssl_tls.c
3465 * Caller: library/ssl_cli.c
3466 * library/ssl_srv.c
3467 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3469 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003470 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003471 * This module is required for SSL/TLS.
3472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003474
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003475/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003477 *
3478 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003479 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003480 * contexts are not shared between threads. If you do intend to use contexts
3481 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003482 * conditions. See also our Knowledge Base article about threading:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003483 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003484 *
3485 * Module: library/threading.c
3486 *
3487 * This allows different threading implementations (self-implemented or
3488 * provided).
3489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * You will have to enable either MBEDTLS_THREADING_ALT or
3491 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003492 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003493 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003496
3497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003499 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003500 * Enable the semi-portable timing interface.
3501 *
Simon Butcherd567a232016-03-09 20:19:21 +00003502 * \note The provided implementation only works on POSIX/Unix (including Linux,
3503 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003504 * module and provide your own implementations of the callbacks needed by
3505 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3506 * your own implementation of the whole module by setting
3507 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003508 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -04003509 * \note The timing module will include time.h on suitable platforms
3510 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3511 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3512 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003513 * \note See also our Knowledge Base article about porting to a new
3514 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003515 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003516 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003517 * Module: library/timing.c
3518 * Caller: library/havege.c
3519 *
3520 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#define MBEDTLS_TIMING_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_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003526 *
3527 * Enable run-time version information.
3528 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003529 * Module: library/version.c
3530 *
3531 * This module provides run-time version information.
3532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003534
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003537 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003538 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003539 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003540 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003541 * Caller: library/x509_crl.c
3542 * library/x509_crt.c
3543 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003544 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3546 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003547 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003548 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003551
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003554 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003556 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003557 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 * Caller: library/ssl_cli.c
3559 * library/ssl_srv.c
3560 * library/ssl_tls.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 required for X.509 certificate parsing.
3565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567
3568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 *
3571 * Enable X.509 CRL parsing.
3572 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003573 * Module: library/x509_crl.c
3574 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003575 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 *
3578 * This module is required for X.509 CRL parsing.
3579 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581
3582/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584 *
3585 * Enable X.509 Certificate Signing Request (CSR) parsing.
3586 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003587 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003588 * Caller: library/x509_crt_write.c
3589 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003591 *
3592 * This module is used for reading X.509 certificate request.
3593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595
3596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003599 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003600 *
3601 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003602 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003604 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 * This module is the basis for creating X.509 certificates and CSRs.
3606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003608
3609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611 *
3612 * Enable creating X.509 certificates.
3613 *
3614 * Module: library/x509_crt_write.c
3615 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617 *
3618 * This module is required for X.509 certificate creation.
3619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003621
3622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003623 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003624 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003625 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003626 *
3627 * Module: library/x509_csr_write.c
3628 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003630 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003631 * This module is required for X.509 certificate request writing.
3632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003634
3635/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003637 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003638 * Enable the XTEA block cipher.
3639 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003640 * Module: library/xtea.c
3641 * Caller:
3642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003644
Andrzej Kurek73afe272022-01-24 10:31:06 -05003645/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003646
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003647/**
Gilles Peskine86198d72022-04-11 17:04:38 +02003648 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003649 *
Gilles Peskine72665262022-04-13 23:05:10 +02003650 * This section contains Mbed TLS build settings that are not associated
3651 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003652 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003653 * \{
3654 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003655
Gilles Peskine781f7342022-03-16 17:03:19 +01003656/**
3657 * \def MBEDTLS_CONFIG_FILE
3658 *
3659 * If defined, this is a header which will be included instead of
Gilles Peskine82909762022-04-26 18:10:11 +02003660 * `"mbedtls/config.h"`.
Gilles Peskine781f7342022-03-16 17:03:19 +01003661 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskine238f9762022-04-26 18:13:01 +02003662 * Unlike other configuration options, this one must be defined on the
3663 * compiler command line: a definition in `config.h` would have no effect.
Gilles Peskine781f7342022-03-16 17:03:19 +01003664 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003665 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003666 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003667 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003668 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003669 * The value of this symbol is typically a path in double quotes, either
3670 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003671 */
Gilles Peskine82909762022-04-26 18:10:11 +02003672//#define MBEDTLS_CONFIG_FILE "mbedtls/config.h"
Gilles Peskine781f7342022-03-16 17:03:19 +01003673
3674/**
3675 * \def MBEDTLS_USER_CONFIG_FILE
3676 *
3677 * If defined, this is a header which will be included after
Gilles Peskine82909762022-04-26 18:10:11 +02003678 * `"mbedtls/config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003679 * This allows you to modify the default configuration, including the ability
3680 * to undefine options that are enabled by default.
Gilles Peskine781f7342022-03-16 17:03:19 +01003681 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003682 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003683 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003684 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003685 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003686 * The value of this symbol is typically a path in double quotes, either
3687 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003688 */
3689//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3690
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003691/**
3692 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3693 *
3694 * If defined, this is a header which will be included instead of
3695 * `"psa/crypto_config.h"`.
3696 * This header file specifies which cryptographic mechanisms are available
3697 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3698 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3699 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003700 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003701 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003702 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003703 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003704 * The value of this symbol is typically a path in double quotes, either
3705 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003706 */
3707//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3708
3709/**
3710 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3711 *
3712 * If defined, this is a header which will be included after
3713 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003714 * This allows you to modify the default configuration, including the ability
3715 * to undefine options that are enabled by default.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003716 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003717 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003718 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003719 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003720 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003721 * The value of this symbol is typically a path in double quotes, either
3722 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003723 */
3724//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3725
Gilles Peskine86198d72022-04-11 17:04:38 +02003726/** \} name SECTION: General configuration options */
3727
3728/**
3729 * \name SECTION: Module configuration options
3730 *
3731 * This section allows for the setting of module specific sizes and
3732 * configuration options. The default values are already present in the
3733 * relevant header files and should suffice for the regular use cases.
3734 *
3735 * Our advice is to enable options and change their values here
3736 * only if you have a good reason and know the consequences.
Gilles Peskine86198d72022-04-11 17:04:38 +02003737 * \{
3738 */
Gilles Peskine25496d02022-04-13 23:21:16 +02003739/* The Doxygen documentation here is used when a user comments out a
3740 * setting and runs doxygen themselves. On the other hand, when we typeset
3741 * the full documentation including disabled settings, the documentation
3742 * in specific modules' header files is used if present. When editing this
3743 * file, make sure that each option is documented in exactly one place,
3744 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3745 * comment in the specific module. */
Gilles Peskine86198d72022-04-11 17:04:38 +02003746
Paul Bakker088c5c52014-04-25 11:11:10 +02003747/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003748//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003749//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003750
Paul Bakker088c5c52014-04-25 11:11:10 +02003751/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003752//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3753//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3754//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3755//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3756//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003757
Paul Bakker088c5c52014-04-25 11:11:10 +02003758/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003759//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3760//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3761//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3762//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003763
Paul Bakker088c5c52014-04-25 11:11:10 +02003764/* ECP options */
Gilles Peskine33c92f02021-06-02 23:34:02 +02003765//#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 +02003766//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003767//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003768
Paul Bakker088c5c52014-04-25 11:11:10 +02003769/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3771//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003772//#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 +01003773
Paul Bakker088c5c52014-04-25 11:11:10 +02003774/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003776
Paul Bakker088c5c52014-04-25 11:11:10 +02003777/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778//#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 +02003779//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3781//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003782//#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 +02003783//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3784//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003785/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003786//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003787//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3788//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003789//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3790//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3791//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3794/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003795//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003796//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3797//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003798//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3799//#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 +02003800//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3801//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003802/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003803//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003804//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003805//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3806//#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 +02003807
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003808/**
3809 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003810 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003811 * (see the documentation of that option for context).
3812 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003813 * When you leave this undefined here, the library provides
3814 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3815 * is defined, the default definition is `assert(cond)`,
3816 * otherwise the default definition calls a function
3817 * mbedtls_param_failed(). This function is declared in
3818 * `platform_util.h` for the benefit of the library, but
3819 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003820 *
3821 * When you define this here, this replaces the default
3822 * definition in platform_util.h (which no longer declares the
3823 * function mbedtls_param_failed()) and it is your responsibility
3824 * to make sure this macro expands to something suitable (in
3825 * particular, that all the necessary declarations are visible
3826 * from within the library - you can ensure that by providing
3827 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003828 * If you define this macro to call `assert`, also define
3829 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3830 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003831 *
3832 * Note that you may define this macro to expand to nothing, in
3833 * which case you don't have to worry about declarations or
3834 * definitions. However, you will then be notified about invalid
3835 * parameters only in non-void functions, and void function will
3836 * just silently return early on invalid parameters, which
3837 * partially negates the benefits of enabling
3838 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3839 *
3840 * \param cond The expression that should evaluate to true, but doesn't.
3841 */
3842//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3843
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003844/** \def MBEDTLS_CHECK_RETURN
3845 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003846 * This macro is used at the beginning of the declaration of a function
3847 * to indicate that its return value should be checked. It should
3848 * instruct the compiler to emit a warning or an error if the function
3849 * is called without checking its return value.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003850 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003851 * There is a default implementation for popular compilers in platform_util.h.
3852 * You can override the default implementation by defining your own here.
3853 *
3854 * If the implementation here is empty, this will effectively disable the
3855 * checking of functions' return values.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003856 */
Gilles Peskine91108092021-09-30 18:53:36 +02003857//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003858
Gilles Peskinec2779322021-09-30 18:56:17 +02003859/** \def MBEDTLS_IGNORE_RETURN
3860 *
3861 * This macro requires one argument, which should be a C function call.
3862 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3863 * warning is suppressed.
3864 */
3865//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3866
Gilles Peskineed038902020-11-13 21:33:21 +01003867/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003868/**
Gilles Peskineed038902020-11-13 21:33:21 +01003869 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3870 * PSA crypto subsystem.
3871 *
3872 * If this option is unset:
3873 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003874 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003875 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3876 * on unspecified heuristics.
3877 */
3878//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3879
Steven Cooreman863470a2021-02-15 14:03:19 +01003880/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003881 * Restrict the PSA library to supporting a maximum amount of simultaneously
3882 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3883 * volatile key, or a persistent key which is loaded temporarily by the
3884 * library as part of a crypto operation in flight.
3885 *
3886 * If this option is unset, the library will fall back to a default value of
3887 * 32 keys.
3888 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003889//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003890
Paul Bakker088c5c52014-04-25 11:11:10 +02003891/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003892//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3893//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003894
Paul Bakker088c5c52014-04-25 11:11:10 +02003895/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003896
3897/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3898 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003899 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003900 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003901 * This determines the size of both the incoming and outgoing TLS I/O buffers
3902 * in such a way that both are capable of holding the specified amount of
3903 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003904 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003905 * To configure incoming and outgoing I/O buffers separately, use
3906 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3907 * which overwrite the value set by this option.
3908 *
3909 * \note When using a value less than the default of 16KB on the client, it is
3910 * recommended to use the Maximum Fragment Length (MFL) extension to
3911 * inform the server about this limitation. On the server, there
3912 * is no supported, standardized way of informing the client about
3913 * restriction on the maximum size of incoming messages, and unless
3914 * the limitation has been communicated by other means, it is recommended
3915 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3916 * while keeping the default value of 16KB for the incoming buffer.
3917 *
3918 * Uncomment to set the maximum plaintext size of both
3919 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003920 */
3921//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3922
3923/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3924 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003925 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003926 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003927 * This determines the size of the incoming TLS I/O buffer in such a way
3928 * that it is capable of holding the specified amount of plaintext data,
3929 * regardless of the protection mechanism used.
3930 *
3931 * If this option is undefined, it inherits its value from
3932 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3933 *
3934 * \note When using a value less than the default of 16KB on the client, it is
3935 * recommended to use the Maximum Fragment Length (MFL) extension to
3936 * inform the server about this limitation. On the server, there
3937 * is no supported, standardized way of informing the client about
3938 * restriction on the maximum size of incoming messages, and unless
3939 * the limitation has been communicated by other means, it is recommended
3940 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3941 * while keeping the default value of 16KB for the incoming buffer.
3942 *
3943 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3944 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003945 */
3946//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3947
Gilles Peskined3d02902020-03-04 21:35:27 +01003948/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3949 *
3950 * The maximum length of CIDs used for incoming DTLS messages.
3951 *
3952 */
3953//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3954
3955/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3956 *
3957 * The maximum length of CIDs used for outgoing DTLS messages.
3958 *
3959 */
3960//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3961
3962/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3963 *
3964 * This option controls the use of record plaintext padding
3965 * when using the Connection ID extension in DTLS 1.2.
3966 *
3967 * The padding will always be chosen so that the length of the
3968 * padded plaintext is a multiple of the value of this option.
3969 *
3970 * Note: A value of \c 1 means that no padding will be used
3971 * for outgoing records.
3972 *
3973 * Note: On systems lacking division instructions,
3974 * a power of two should be preferred.
3975 *
3976 */
3977//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3978
Hanno Beckerceef8482020-06-02 06:16:00 +01003979/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003980 *
3981 * This option controls the use of record plaintext padding
3982 * in TLS 1.3.
3983 *
3984 * The padding will always be chosen so that the length of the
3985 * padded plaintext is a multiple of the value of this option.
3986 *
3987 * Note: A value of \c 1 means that no padding will be used
3988 * for outgoing records.
3989 *
3990 * Note: On systems lacking division instructions,
3991 * a power of two should be preferred.
3992 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003993//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003994
Angus Grattond8213d02016-05-25 20:56:48 +10003995/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3996 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003997 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003998 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003999 * This determines the size of the outgoing TLS I/O buffer in such a way
4000 * that it is capable of holding the specified amount of plaintext data,
4001 * regardless of the protection mechanism used.
4002 *
4003 * If this option undefined, it inherits its value from
4004 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10004005 *
4006 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4007 * the default inward 16384 byte buffer to conform to the TLS specification.
4008 *
4009 * The minimum required outward buffer size is determined by the handshake
4010 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4011 * The specific size requirement depends on the configured ciphers and any
4012 * certificate data which is sent during the handshake.
4013 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004014 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
4015 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004016 */
4017//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4018
Hanno Beckere0b150f2018-08-21 15:51:03 +01004019/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4020 *
4021 * Maximum number of heap-allocated bytes for the purpose of
4022 * DTLS handshake message reassembly and future message buffering.
4023 *
Yuto Takano5b4caf22021-08-10 11:26:15 +01004024 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004025 * to account for a reassembled handshake message of maximum size,
4026 * together with its reassembly bitmap.
4027 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004028 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004029 * should be sufficient for all practical situations as it allows
4030 * to reassembly a large handshake message (such as a certificate)
4031 * while buffering multiple smaller handshake messages.
4032 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004033 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004034//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004036//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
4037//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
4038//#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 +02004039
Gilles Peskine065a1c82021-04-24 13:35:41 +02004040/** \def MBEDTLS_TLS_EXT_CID
4041 *
4042 * At the time of writing, the CID extension has not been assigned its
4043 * final value. Set this configuration option to make Mbed TLS use a
4044 * different value.
4045 *
4046 * A future minor revision of Mbed TLS may change the default value of
4047 * this option to match evolving standards and usage.
4048 */
4049//#define MBEDTLS_TLS_EXT_CID 254
4050
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004051/**
4052 * Complete list of ciphersuites to use, in order of preference.
4053 *
4054 * \warning No dependency checking is done on that field! This option can only
4055 * be used to restrict the set of available ciphersuites. It is your
4056 * responsibility to make sure the needed modules are active.
4057 *
4058 * Use this to save a few hundred bytes of ROM (default ordering of all
4059 * available ciphersuites) and a few to a few hundred bytes of RAM.
4060 *
4061 * The value below is only an example, not the default.
4062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004063//#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 +02004064
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004065/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004066//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004067//#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 +01004068
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004069/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004070 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
4071 * signature and ciphersuite selection. Without this build-time option, SHA-1
4072 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
4073 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
4074 * default. At the time of writing, there is no practical attack on the use
4075 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01004076 * to preserve compatibility with existing peers, but the general
4077 * warning applies nonetheless:
4078 *
4079 * \warning SHA-1 is considered a weak message digest and its use constitutes
4080 * a security risk. If possible, we recommend avoiding dependencies
4081 * on it, and considering stronger message digests instead.
4082 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004083 */
Mateusz Starzyk7d135392021-08-27 15:36:47 +02004084//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004085
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004086/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004087 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004088 * mbedtls_platform_zeroize(). This replaces the default implementation in
4089 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00004090 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004091 * mbedtls_platform_zeroize() is a widely used function across the library to
4092 * zero a block of memory. The implementation is expected to be secure in the
4093 * sense that it has been written to prevent the compiler from removing calls
4094 * to mbedtls_platform_zeroize() as part of redundant code elimination
4095 * optimizations. However, it is difficult to guarantee that calls to
4096 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
4097 * versions of the C language standards do not provide a secure implementation
4098 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
4099 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05004100 * example by using directives specific to their compiler, features from newer
4101 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004102 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004103 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004104//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004105
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004106/**
4107 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01004108 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004109 * platform_util.c.
4110 *
Hanno Becker921b76d2018-09-05 16:21:36 +01004111 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004112 * library will try to use safer implementations of this function, such as
4113 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01004114 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004115 * using the standard gmtime(). In this case, calls from the library to
4116 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01004117 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004118 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01004119 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
4120 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
4121 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004122 */
Hanno Becker6a739782018-09-05 15:06:19 +01004123//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004124
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00004125/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00004126 * Enable the verified implementations of ECDH primitives from Project Everest
4127 * (currently only Curve25519). This feature changes the layout of ECDH
4128 * contexts and therefore is a compatibility break for applications that access
4129 * fields of a mbedtls_ecdh_context structure directly. See also
4130 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004131 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00004132//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004133
Gilles Peskine1341e212022-04-13 23:04:48 +02004134/** \} name SECTION: Module configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02004135
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004136/* Target and application specific configurations
4137 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004138 * Allow user to override any previous default.
4139 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004140 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004141#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004142#include MBEDTLS_USER_CONFIG_FILE
4143#endif
4144
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004145#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07004146#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004147#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07004148
Jaeden Amero6609aef2019-07-04 20:01:14 +01004149#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01004150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004151#endif /* MBEDTLS_CONFIG_H */