blob: 1ae51252eb975d2b2272319c45e17b7ded246e22 [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 *
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 * Comment if your system does not support time functions
132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100134
135/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200136 * \def MBEDTLS_HAVE_TIME_DATE
137 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100138 * System has time.h, time(), and an implementation for
139 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100140 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200141 * the date should be correct). This is used to verify the validity period of
142 * X.509 certificates.
143 *
144 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100145 *
Hanno Becker6a739782018-09-05 15:06:19 +0100146 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100147 * behaves similarly to the gmtime_r() function from the C standard. Refer to
148 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100149 *
150 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100151 * mbedtls_platform_gmtime_r() at compile-time by using the macro
152 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200153 */
154#define MBEDTLS_HAVE_TIME_DATE
155
156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 *
159 * Enable the memory allocation layer.
160 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200161 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100162 * This allows different allocators (self-implemented or provided) to be
163 * provided to the platform abstraction layer.
164 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200166 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
167 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * free() function pointer at runtime.
169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000172 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100175 *
176 * Enable this layer to allow use of alternative memory allocators.
177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179
180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200182 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200183 * Do not assign standard functions in the platform layer (e.g. calloc() to
184 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200185 *
186 * This makes sure there are no linking errors on platforms that do not support
187 * these functions. You will HAVE to provide alternatives, either at runtime
188 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
190 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200193 *
194 * Uncomment to prevent default assignment of standard functions in the
195 * platform layer.
196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200198
199/**
Janos Follathc351d182016-03-21 08:43:59 +0000200 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100201 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100202 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
203 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100204 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
206 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 * alternative printf function pointer.
208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200211 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
212 * it will be enabled automatically by check_config.h
213 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200214 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000216 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100217 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
218 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100219 * Uncomment a macro to enable alternate implementation of specific base
220 * platform function
221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100223//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224//#define MBEDTLS_PLATFORM_FPRINTF_ALT
225//#define MBEDTLS_PLATFORM_PRINTF_ALT
226//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200227//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100228//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100229//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100230
231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100233 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000234 * Mark deprecated functions and features so that they generate a warning if
235 * used. Functionality deprecated in one version will usually be removed in the
236 * next version. You can enable this to help you prepare the transition to a
237 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100238 *
239 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100241 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000242 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245
246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000249 * Remove deprecated functions and features so that they generate an error if
250 * used. Functionality deprecated in one version will usually be removed in the
251 * next version. You can enable this to help you prepare the transition to a
252 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100257
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500258/**
259 * \def MBEDTLS_CHECK_PARAMS
260 *
261 * This configuration option controls whether the library validates more of
262 * the parameters passed to it.
263 *
264 * When this flag is not defined, the library only attempts to validate an
265 * input parameter if: (1) they may come from the outside world (such as the
266 * network, the filesystem, etc.) or (2) not validating them could result in
267 * internal memory errors such as overflowing a buffer controlled by the
268 * library. On the other hand, it doesn't attempt to validate parameters whose
269 * values are fully controlled by the application (such as pointers).
270 *
271 * When this flag is defined, the library additionally attempts to validate
272 * parameters that are fully controlled by the application, and should always
273 * be valid if the application code is fully correct and trusted.
274 *
275 * For example, when a function accepts as input a pointer to a buffer that may
276 * contain untrusted data, and its documentation mentions that this pointer
277 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200278 * - The pointer is checked to be non-NULL only if this option is enabled.
279 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500280 *
281 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200282 * is invalid:
283 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
284 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
285 * will immediately return. If the function returns an Mbed TLS error code,
286 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500287 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200288 * When defining this flag, you also need to arrange a definition for
289 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
290 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
291 * function mbedtls_param_failed(), but the library does not define this
292 * function. If you do not make any other arrangements, you must provide
293 * the function mbedtls_param_failed() in your application.
294 * See `platform_util.h` for its prototype.
295 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100296 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200297 * You can still supply an alternative definition of
298 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
299 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
300 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
301 * the library will call the macro that you defined and will not supply
302 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
303 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
304 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500305 *
306 * Uncomment to enable validation of application-controlled parameters.
307 */
308//#define MBEDTLS_CHECK_PARAMS
309
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200310/**
311 * \def MBEDTLS_CHECK_PARAMS_ASSERT
312 *
313 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
314 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
315 *
316 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
317 * calling a function mbedtls_param_failed(). See the documentation of
318 * #MBEDTLS_CHECK_PARAMS for details.
319 *
320 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
321 */
322//#define MBEDTLS_CHECK_PARAMS_ASSERT
323
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200324/* \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000325
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000326/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000327 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000328 *
329 * This section sets support for features that are or are not needed
330 * within the modules that are enabled.
331 * \{
332 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000333
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200335 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100336 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200338 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100339 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100341 *
342 * You will need to provide a header "timing_alt.h" and an implementation at
343 * compile time.
344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100346
347/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100348 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200349 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100350 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100351 * alternate core implementation of a symmetric crypto, an arithmetic or hash
352 * module (e.g. platform specific assembly optimized implementations). Keep
353 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200354 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200355 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000359 * provide the "struct mbedtls_aes_context" definition and omit the base
360 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200361 * "aes.h" to include the new function definitions.
362 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 * Uncomment a macro to enable alternate implementation of the corresponding
364 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100365 *
366 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
367 * use constitutes a security risk. If possible, we recommend
368 * avoiding dependencies on them, and considering stronger message
369 * digests and ciphers instead.
370 *
Paul Bakker90995b52013-06-24 19:20:35 +0200371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372//#define MBEDTLS_AES_ALT
373//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000374//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375//#define MBEDTLS_BLOWFISH_ALT
376//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200377//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300378//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200379//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200380//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000382//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000383//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100384//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300385//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_MD2_ALT
387//#define MBEDTLS_MD4_ALT
388//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300389//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000391//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_SHA1_ALT
393//#define MBEDTLS_SHA256_ALT
394//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000395//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000396
Janos Follathb0697532016-08-18 12:38:46 +0100397/*
398 * When replacing the elliptic curve module, pleace consider, that it is
399 * implemented with two .c files:
400 * - ecp.c
401 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000402 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
403 * macros as described above. The only difference is that you have to make sure
404 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100405 */
406//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200407
408/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100409 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200410 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100411 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
412 * alternate core implementation of symmetric crypto or hash function. Keep in
413 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200414 *
415 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200417 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
419 * no longer provide the mbedtls_sha1_process() function, but it will still provide
420 * the other function (using your mbedtls_sha1_process() function) and the definition
421 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200422 * with this definition.
423 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100424 * \note Because of a signature change, the core AES encryption and decryption routines are
425 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
426 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100427 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100428 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100429 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +0200430 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100431 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
432 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200433 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200434 * Uncomment a macro to enable alternate implementation of the corresponding
435 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100436 *
437 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
438 * constitutes a security risk. If possible, we recommend avoiding
439 * dependencies on them, and considering stronger message digests
440 * and ciphers instead.
441 *
Janos Follath1231d212019-01-07 15:01:32 +0000442 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
443 * enabled, then the deterministic ECDH signature functions pass the
444 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
445 * alternative implementations should use the RNG only for generating
446 * the ephemeral key and nothing else. If this is not possible, then
447 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
448 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
449 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
450 * desirable).
451 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200452 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453//#define MBEDTLS_MD2_PROCESS_ALT
454//#define MBEDTLS_MD4_PROCESS_ALT
455//#define MBEDTLS_MD5_PROCESS_ALT
456//#define MBEDTLS_RIPEMD160_PROCESS_ALT
457//#define MBEDTLS_SHA1_PROCESS_ALT
458//#define MBEDTLS_SHA256_PROCESS_ALT
459//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200460//#define MBEDTLS_DES_SETKEY_ALT
461//#define MBEDTLS_DES_CRYPT_ECB_ALT
462//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200463//#define MBEDTLS_AES_SETKEY_ENC_ALT
464//#define MBEDTLS_AES_SETKEY_DEC_ALT
465//#define MBEDTLS_AES_ENCRYPT_ALT
466//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300467//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300468//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300469//#define MBEDTLS_ECDSA_VERIFY_ALT
470//#define MBEDTLS_ECDSA_SIGN_ALT
471//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200472
473/**
Janos Follathc44ab972016-11-18 16:38:23 +0000474 * \def MBEDTLS_ECP_INTERNAL_ALT
475 *
476 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100477 *
478 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100479 * alternative core implementation of elliptic curve arithmetic. Keep in mind
480 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100481 *
482 * This partially replaces one function. The header file from mbed TLS is still
483 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
484 * is still present and it is used for group structures not supported by the
485 * alternative.
486 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100487 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100488 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100489 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
490 * able to fallback to curves not supported by the alternative implementation.
491 *
Janos Follathc44ab972016-11-18 16:38:23 +0000492 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
493 * and implementing the following functions:
494 * unsigned char mbedtls_internal_ecp_grp_capable(
495 * const mbedtls_ecp_group *grp )
496 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500497 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000498 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
499 * replacement functions implement arithmetic for the given group and 0
500 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500501 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000502 * called before and after each point operation and provide an opportunity to
503 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100504 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100505 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
506 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
507 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
508 * for the operation is supported by your implementation (i.e. your
509 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
510 * group is not supported by your implementation, then the original mbed TLS
511 * implementation of ecp_double_jac() is used instead, unless this fallback
512 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
513 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
514 *
515 * The function prototypes and the definition of mbedtls_ecp_group and
516 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
517 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
518 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100519 *
520 * Uncomment a macro to enable alternate implementation of the corresponding
521 * function.
522 */
523/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000524//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100525/* Turn off software fallback for curves not supported in hardware */
526//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100527/* Support for Weierstrass curves with Jacobi representation */
528//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
529//#define MBEDTLS_ECP_ADD_MIXED_ALT
530//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
531//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
532//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
533/* Support for curves with Montgomery arithmetic */
534//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
535//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
536//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
537
538/**
Simon Butcherab5df402016-06-11 02:31:21 +0100539 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100540 *
Simon Butcherab5df402016-06-11 02:31:21 +0100541 * Enables testing and use of mbed TLS without any configured entropy sources.
542 * This permits use of the library on platforms before an entropy source has
543 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
544 * MBEDTLS_ENTROPY_NV_SEED switches).
545 *
546 * WARNING! This switch MUST be disabled in production builds, and is suitable
547 * only for development.
548 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100549 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100550 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
551 *
Janos Follath53de7842016-06-08 15:29:18 +0100552 */
Simon Butcherab5df402016-06-11 02:31:21 +0100553//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100554
555/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200556 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200557 *
558 * Uncomment this macro to let mbed TLS use your own implementation of a
559 * hardware entropy collector.
560 *
561 * Your function must be called \c mbedtls_hardware_poll(), have the same
562 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
563 *
564 * Uncomment to use your own hardware entropy collector.
565 */
566//#define MBEDTLS_ENTROPY_HARDWARE_ALT
567
568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000570 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000572 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100573 * Uncomment this macro to use precomputed AES tables stored in ROM.
574 * Comment this macro to generate AES tables in RAM at runtime.
575 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100576 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
577 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100578 * initialization time before the first AES operation can be performed.
579 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
580 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
581 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100582 *
583 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
584 *
Paul Bakker15566e42011-04-24 21:19:15 +0000585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000587
588/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100589 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200590 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100591 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200592 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100593 * Uncommenting this macro omits 75% of the AES tables from
594 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
595 * by computing their values on the fly during operations
596 * (the tables are entry-wise rotations of one another).
597 *
598 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100599 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100600 * runtime. Specifically, one has to compare 4 accesses within
601 * different tables to 4 accesses with additional arithmetic
602 * operations within the same table. The performance gain/loss
603 * depends on the system and memory details.
604 *
605 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
606 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200607 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100608//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200609
610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200612 *
613 * Use less ROM for the Camellia implementation (saves about 768 bytes).
614 *
615 * Uncomment this macro to use less memory for Camellia.
616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200618
619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200621 *
622 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200625
626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000628 *
629 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000632
633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000635 *
636 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200638#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000639
640/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100641 * \def MBEDTLS_CIPHER_MODE_OFB
642 *
643 * Enable Output Feedback mode (OFB) for symmetric ciphers.
644 */
645#define MBEDTLS_CIPHER_MODE_OFB
646
647/**
648 * \def MBEDTLS_CIPHER_MODE_XTS
649 *
650 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
651 */
652#define MBEDTLS_CIPHER_MODE_XTS
653
654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000656 *
657 * Enable NULL cipher.
658 * Warning: Only do so when you know what you are doing. This allows for
659 * encryption or channels without any security!
660 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000662 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
664 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
665 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
666 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
667 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
668 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
669 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
670 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
671 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
672 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
673 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
674 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
675 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
676 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
677 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
678 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
679 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
680 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
681 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000682 *
683 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000686
687/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100688 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200689 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100690 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
691 * specific padding modes in the cipher layer with cipher modes that support
692 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200693 *
694 * If you disable all padding modes, only full blocks can be used with CBC.
695 *
696 * Enable padding modes in the cipher layer.
697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698#define MBEDTLS_CIPHER_PADDING_PKCS7
699#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
700#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
701#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200702
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200703/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
704 *
705 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
706 * By default, CTR_DRBG uses a 256-bit key.
707 */
708//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
709
Paul Bakker48e93c82013-08-14 12:21:18 +0200710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000712 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200713 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000714 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000715 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000716 *
717 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
719 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000720 *
721 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100722 *
723 * \warning DES is considered a weak cipher and its use constitutes a
724 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000727
728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200730 *
731 * Remove RC4 ciphersuites by default in SSL / TLS.
732 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200734 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200735 * explicitly.
736 *
737 * Uncomment this macro to remove RC4 ciphersuites by default.
738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200740
741/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000742 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
743 *
744 * Remove 3DES ciphersuites by default in SSL / TLS.
745 * This flag removes the ciphersuites based on 3DES from the default list as
746 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
747 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
748 * them explicitly.
749 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000750 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000751 * a TLS connection using a 3DES based cipher suite (see "On the Practical
752 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
753 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
754 * in your threat model or you are unsure, then you should keep this option
755 * enabled to remove 3DES based cipher suites.
756 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000757 * Comment this macro to keep 3DES in the default ciphersuite list.
758 */
759#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
760
761/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100762 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200763 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100764 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
765 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200766 *
767 * Comment macros to disable the curve and functions for it
768 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200769/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200770#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
771#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
772#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
773#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
774#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
775#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
776#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
777#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
778#define MBEDTLS_ECP_DP_BP256R1_ENABLED
779#define MBEDTLS_ECP_DP_BP384R1_ENABLED
780#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200781/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200782#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000783#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200784
785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200787 *
788 * Enable specific 'modulo p' routines for each NIST prime.
789 * Depending on the prime and architecture, makes operations 4 to 8 times
790 * faster on the corresponding curve.
791 *
792 * Comment this macro to disable NIST curves optimisation.
793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200795
796/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200797 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
798 *
799 * When this option is disabled, mbedtls_ecp_mul() will make use of an
800 * internal RNG when called with a NULL \c f_rng argument, in order to protect
801 * against some side-channel attacks.
802 *
803 * This protection introduces a dependency of the ECP module on one of the
804 * DRBG modules. For very constrained implementations that don't require this
805 * protection (for example, because you're only doing signature verification,
806 * so not manipulating any secret, or because local/physical side-channel
807 * attacks are outside your threat model), it might be desirable to get rid of
808 * that dependency.
809 *
810 * \warning Enabling this option makes some uses of ECP vulnerable to some
811 * side-channel attacks. Only enable it if you know that's not a problem for
812 * your use case.
813 *
814 * Uncomment this macro to disable some counter-measures in ECP.
815 */
816//#define MBEDTLS_ECP_NO_INTERNAL_RNG
817
818/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200819 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100820 *
821 * Enable "non-blocking" ECC operations that can return early and be resumed.
822 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200823 * This allows various functions to pause by returning
824 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
825 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
826 * order to further progress and eventually complete their operation. This is
827 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
828 * number of ECC operations a function may perform before pausing; see
829 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100830 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200831 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200832 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100833 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200834 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200835 *
Ron Eldor19779c42018-11-05 16:58:13 +0200836 * \note This option only works with the default software implementation of
837 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100838 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
839 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100840 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200841//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100842
843/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100844 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
845 *
846 * Use a backward compatible ECDH context.
847 *
848 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
849 * defined in `ecdh.h`). For most applications, the choice of format makes
850 * no difference, since all library functions can work with either format,
851 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
852
853 * The new format used when this option is disabled is smaller
854 * (56 bytes on a 32-bit platform). In future versions of the library, it
855 * will support alternative implementations of ECDH operations.
856 * The new format is incompatible with applications that access
857 * context fields directly and with restartable ECP operations.
858 *
859 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
860 * want to access ECDH context fields directly. Otherwise you should
861 * comment out this macro definition.
862 *
863 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
864 *
865 * \note This configuration option is experimental. Future versions of the
866 * library may modify the way the ECDH context layout is configured
867 * and may modify the layout of the new context type.
868 */
869#define MBEDTLS_ECDH_LEGACY_CONTEXT
870
871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100873 *
874 * Enable deterministic ECDSA (RFC 6979).
875 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
876 * may result in a compromise of the long-term signing key. This is avoided by
877 * the deterministic variant.
878 *
John Durkop36a82e52020-10-26 09:39:05 -0700879 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100880 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100881 * Comment this macro to disable deterministic ECDSA.
882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100884
885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200887 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200888 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200889 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890 * This enables the following ciphersuites (if other requisites are
891 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
893 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
894 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
895 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
896 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
897 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
898 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
899 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
900 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
901 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
902 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
903 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200910 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200913 *
914 * This enables the following ciphersuites (if other requisites are
915 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
917 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
918 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
919 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
920 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
921 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
922 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
923 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
924 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
925 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
926 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
927 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100928 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100929 * \warning Using DHE constitutes a security risk as it
930 * is not possible to validate custom DH parameters.
931 * If possible, it is recommended users should consider
932 * preferring other methods of key exchange.
933 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100934 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200937
938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200940 *
941 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
942 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200944 *
945 * This enables the following ciphersuites (if other requisites are
946 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
948 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
949 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
950 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
951 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
952 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
953 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
954 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200957
958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200960 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200961 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
964 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200965 *
966 * This enables the following ciphersuites (if other requisites are
967 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
969 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
970 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
971 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
972 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
973 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
974 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
975 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
976 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
977 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
978 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
979 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200982
983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200985 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200986 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200987 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
989 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200990 *
991 * This enables the following ciphersuites (if other requisites are
992 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
994 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
995 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
996 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
997 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
998 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
999 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1000 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1001 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1002 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1003 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1004 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1005 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
1006 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
1007 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +02001008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001010
1011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001013 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001014 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001015 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1017 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001018 *
1019 * This enables the following ciphersuites (if other requisites are
1020 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1022 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1023 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1024 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1025 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1026 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1027 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1028 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1029 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1030 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1031 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1032 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1033 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001034 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001035 * \warning Using DHE constitutes a security risk as it
1036 * is not possible to validate custom DH parameters.
1037 * If possible, it is recommended users should consider
1038 * preferring other methods of key exchange.
1039 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001040 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001043
1044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001046 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001047 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1050 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001051 *
1052 * This enables the following ciphersuites (if other requisites are
1053 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1055 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1056 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1057 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1058 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1059 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1060 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1061 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1062 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1063 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1064 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1065 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001068
1069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001071 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001072 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001073 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001075 *
1076 * This enables the following ciphersuites (if other requisites are
1077 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1079 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1080 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1081 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1082 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1083 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1084 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1085 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1086 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1087 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1088 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1089 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001092
1093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001095 *
1096 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1097 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001098 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001099 *
1100 * This enables the following ciphersuites (if other requisites are
1101 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1103 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1104 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1105 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1106 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1107 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1108 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1109 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1110 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1111 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1112 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1113 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001114 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001116
1117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001118 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001119 *
1120 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1121 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001122 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001123 *
1124 * This enables the following ciphersuites (if other requisites are
1125 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1127 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1129 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1130 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1131 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1132 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1133 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1134 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1135 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1136 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1137 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001140
1141/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001142 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1143 *
1144 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1145 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001146 * \warning This is currently experimental. EC J-PAKE support is based on the
1147 * Thread v1.0.0 specification; incompatible changes to the specification
1148 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001149 *
1150 * Requires: MBEDTLS_ECJPAKE_C
1151 * MBEDTLS_SHA256_C
1152 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1153 *
1154 * This enables the following ciphersuites (if other requisites are
1155 * enabled as well):
1156 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1157 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001158//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001159
1160/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001162 *
1163 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1164 * RFC 5915 and RFC 5480.
1165 *
1166 * Currently this means parsing the SpecifiedECDomain choice of EC
1167 * parameters (only known groups are supported, not arbitrary domains, to
1168 * avoid validation issues).
1169 *
1170 * Disable if you only need to support RFC 5915 + 5480 key formats.
1171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001173
1174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001176 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * Enable a dummy error function to make use of mbedtls_strerror() in
1178 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1179 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001180 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1182 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001183 *
1184 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001188
1189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001191 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001192 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001193 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001197
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001200 *
1201 * Enable functions that use the filesystem.
1202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001204
1205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001207 *
1208 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001210 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001211 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001212 * application.
1213 *
1214 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001217
1218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001220 *
1221 * Do not use built-in platform entropy functions.
1222 * This is useful if your platform does not support
1223 * standards like the /dev/urandom or Windows CryptoAPI.
1224 *
1225 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001227//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001228
1229/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001231 *
1232 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1233 * default SHA-512 based one (if both are available).
1234 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001236 *
1237 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1238 * if you have performance concerns.
1239 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240 * This option is only useful if both MBEDTLS_SHA256_C and
1241 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001244
1245/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001246 * \def MBEDTLS_ENTROPY_NV_SEED
1247 *
1248 * Enable the non-volatile (NV) seed file-based entropy source.
1249 * (Also enables the NV seed read/write functions in the platform layer)
1250 *
1251 * This is crucial (if not required) on systems that do not have a
1252 * cryptographic entropy source (in hardware or kernel) available.
1253 *
1254 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1255 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001256 * \note The read/write functions that are used by the entropy source are
1257 * determined in the platform layer, and can be modified at runtime and/or
1258 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1259 *
1260 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001261 * with regular fopen(), please make sure you make a seedfile with the
1262 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1263 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001264 * and written to or you will get an entropy source error! The default
1265 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1266 * bytes from the file.
1267 *
1268 * \note The entropy collector will write to the seed file before entropy is
1269 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001270 */
1271//#define MBEDTLS_ENTROPY_NV_SEED
1272
Ronald Cron71016a92020-08-28 19:01:50 +02001273/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001274 *
Ronald Cron71016a92020-08-28 19:01:50 +02001275 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001276 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001277 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1278 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001279 *
1280 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001281 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001282 */
Ronald Cron71016a92020-08-28 19:01:50 +02001283//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001284
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001285/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001287 *
1288 * Enable debugging of buffer allocator memory issues. Automatically prints
1289 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1290 * function for 'debug output' of allocated memory.
1291 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001293 *
1294 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001297
1298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001300 *
1301 * Include backtrace information with each allocated block.
1302 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001304 * GLIBC-compatible backtrace() an backtrace_symbols() support
1305 *
1306 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001309
1310/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001312 *
1313 * Support external private RSA keys (eg from a HSM) in the PK layer.
1314 *
1315 * Comment this macro to disable support for external private RSA keys.
1316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001318
1319/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001321 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001322 * Enable support for PKCS#1 v1.5 encoding.
1323 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001325 *
Paul Bakker48377d92013-08-30 12:06:24 +02001326 * This enables support for PKCS#1 v1.5 operations.
1327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001329
1330/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001332 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001333 * Enable support for PKCS#1 v2.1 encoding.
1334 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001336 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001337 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001340
Steven Cooreman6801f082021-02-19 17:21:22 +01001341/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1342 *
1343 * Enable support for platform built-in keys. If you enable this feature,
1344 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1345 * See the documentation of that function for more information.
1346 *
1347 * Built-in keys are typically derived from a hardware unique key or
1348 * stored in a secure element.
1349 *
1350 * Requires: MBEDTLS_PSA_CRYPTO_C.
1351 *
1352 * \warning This interface is experimental and may change or be removed
1353 * without notice.
1354 */
1355//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1356
Ronald Cron3768ac12021-01-26 16:58:00 +01001357/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1358 *
1359 * Enable support for PSA crypto client.
1360 *
1361 * \note This option allows to include the code necessary for a PSA
1362 * crypto client when the PSA crypto implementation is not included in
1363 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1364 * code to set and get PSA key attributes.
1365 * The development of PSA drivers partially relying on the library to
1366 * fulfill the hardware gaps is another possible usage of this option.
1367 *
1368 * \warning This interface is experimental and may change or be removed
1369 * without notice.
1370 */
1371//#define MBEDTLS_PSA_CRYPTO_CLIENT
1372
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001373/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1374 *
1375 * Enable support for the experimental PSA crypto driver interface.
1376 *
John Durkop185764f2020-10-12 21:32:12 -07001377 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001378 *
1379 * \warning This interface is experimental and may change or be removed
1380 * without notice.
1381 */
1382//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1383
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001384/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1385 *
1386 * Make the PSA Crypto module use an external random generator provided
1387 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1388 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001389 * \note This random generator must deliver random numbers with cryptographic
1390 * quality and high performance. It must supply unpredictable numbers
1391 * with a uniform distribution. The implementation of this function
1392 * is responsible for ensuring that the random generator is seeded
1393 * with sufficient entropy. If you have a hardware TRNG which is slow
1394 * or delivers non-uniform output, declare it as an entropy source
1395 * with mbedtls_entropy_add_source() instead of enabling this option.
1396 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001397 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001398 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1399 * and define a function called mbedtls_psa_external_get_random()
1400 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001401 * ```
1402 * psa_status_t mbedtls_psa_external_get_random(
1403 * mbedtls_psa_external_random_context_t *context,
1404 * uint8_t *output, size_t output_size, size_t *output_length);
1405 * );
1406 * ```
1407 * The \c context value is initialized to 0 before the first call.
1408 * The function must fill the \c output buffer with \p output_size bytes
1409 * of random data and set \c *output_length to \p output_size.
1410 *
1411 * Requires: MBEDTLS_PSA_CRYPTO_C
1412 *
1413 * \warning If you enable this option, code that uses the PSA cryptography
1414 * interface will not use any of the entropy sources set up for
1415 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1416 * enables.
1417 *
1418 * \note This option is experimental and may be removed without notice.
1419 */
1420//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1421
Paul Bakker9dcc3222011-03-08 14:16:06 +00001422/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001423 * \def MBEDTLS_PSA_CRYPTO_SPM
1424 *
1425 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1426 * Partition Manager) integration which separates the code into two parts: a
1427 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1428 * Environment).
1429 *
1430 * Module: library/psa_crypto.c
1431 * Requires: MBEDTLS_PSA_CRYPTO_C
1432 *
1433 */
1434//#define MBEDTLS_PSA_CRYPTO_SPM
1435
1436/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001437 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001438 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001439 * Enable support for entropy injection at first boot. This feature is
1440 * required on systems that do not have a built-in entropy source (TRNG).
1441 * This feature is currently not supported on systems that have a built-in
1442 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001443 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001444 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001445 *
1446 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001447//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001448
1449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001451 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001452 * Do not use the Chinese Remainder Theorem
1453 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001454 *
1455 * Uncomment this macro to disable the use of CRT in RSA.
1456 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001459
1460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001462 *
1463 * Enable the checkup functions (*_self_test).
1464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001466
1467/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001468 * \def MBEDTLS_SHA256_SMALLER
1469 *
1470 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1471 * lower performance.
1472 *
1473 * The default implementation is meant to be a reasonnable compromise between
1474 * performance and size. This version optimizes more aggressively for size at
1475 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1476 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1477 * 30%.
1478 *
1479 * Uncomment to enable the smaller implementation of SHA256.
1480 */
1481//#define MBEDTLS_SHA256_SMALLER
1482
1483/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001484 * \def MBEDTLS_SHA512_SMALLER
1485 *
1486 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1487 * lower performance.
1488 *
1489 * Uncomment to enable the smaller implementation of SHA512.
1490 */
1491//#define MBEDTLS_SHA512_SMALLER
1492
1493/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001494 * \def MBEDTLS_SHA512_NO_SHA384
1495 *
1496 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1497 * code size on devices that don't use SHA-384.
1498 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001499 * Requires: MBEDTLS_SHA512_C
1500 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001501 * Uncomment to disable SHA-384
1502 */
1503//#define MBEDTLS_SHA512_NO_SHA384
1504
1505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001507 *
1508 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001509 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001510 * with other servers, only debugging of failures is harder.
1511 *
1512 * The advantage of not sending alert messages, is that no information is given
1513 * about reasons for failures thus preventing adversaries of gaining intel.
1514 *
1515 * Enable sending of all alert messages
1516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001518
1519/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001520 * \def MBEDTLS_SSL_RECORD_CHECKING
1521 *
1522 * Enable the function mbedtls_ssl_check_record() which can be used to check
1523 * the validity and authenticity of an incoming record, to verify that it has
1524 * not been seen before. These checks are performed without modifying the
1525 * externally visible state of the SSL context.
1526 *
1527 * See mbedtls_ssl_check_record() for more information.
1528 *
1529 * Uncomment to enable support for record checking.
1530 */
1531#define MBEDTLS_SSL_RECORD_CHECKING
1532
1533/**
1534 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1535 *
1536 * Enable support for the DTLS Connection ID extension
1537 * (version draft-ietf-tls-dtls-connection-id-05,
1538 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1539 * which allows to identify DTLS connections across changes
1540 * in the underlying transport.
1541 *
1542 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1543 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1544 * See the corresponding documentation for more information.
1545 *
1546 * \warning The Connection ID extension is still in draft state.
1547 * We make no stability promises for the availability
1548 * or the shape of the API controlled by this option.
1549 *
1550 * The maximum lengths of outgoing and incoming CIDs can be configured
1551 * through the options
1552 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1553 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1554 *
1555 * Requires: MBEDTLS_SSL_PROTO_DTLS
1556 *
1557 * Uncomment to enable the Connection ID extension.
1558 */
1559//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1560
1561/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001562 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1563 *
1564 * Enable asynchronous external private key operations in SSL. This allows
1565 * you to configure an SSL connection to call an external cryptographic
1566 * module to perform private key operations instead of performing the
1567 * operation inside the library.
1568 *
1569 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001570//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001571
1572/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001573 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1574 *
1575 * Enable serialization of the TLS context structures, through use of the
1576 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1577 *
1578 * This pair of functions allows one side of a connection to serialize the
1579 * context associated with the connection, then free or re-use that context
1580 * while the serialized state is persisted elsewhere, and finally deserialize
1581 * that state to a live context for resuming read/write operations on the
1582 * connection. From a protocol perspective, the state of the connection is
1583 * unaffected, in particular this is entirely transparent to the peer.
1584 *
1585 * Note: this is distinct from TLS session resumption, which is part of the
1586 * protocol and fully visible by the peer. TLS session resumption enables
1587 * establishing new connections associated to a saved session with shorter,
1588 * lighter handshakes, while context serialization is a local optimization in
1589 * handling a single, potentially long-lived connection.
1590 *
1591 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1592 * saved after the handshake to allow for more efficient serialization, so if
1593 * you don't need this feature you'll save RAM by disabling it.
1594 *
1595 * Comment to disable the context serialization APIs.
1596 */
1597#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1598
1599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001601 *
1602 * Enable the debug messages in SSL module for all issues.
1603 * Debug messages have been disabled in some places to prevent timing
1604 * attacks due to (unbalanced) debugging function calls.
1605 *
1606 * If you need all error reporting you should enable this during debugging,
1607 * but remove this for production servers that should log as well.
1608 *
1609 * Uncomment this macro to report all debug messages on errors introducing
1610 * a timing side-channel.
1611 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001616 *
1617 * Enable support for Encrypt-then-MAC, RFC 7366.
1618 *
1619 * This allows peers that both support it to use a more robust protection for
1620 * ciphersuites using CBC, providing deep resistance against timing attacks
1621 * on the padding or underlying cipher.
1622 *
1623 * This only affects CBC ciphersuites, and is useless if none is defined.
1624 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1626 * MBEDTLS_SSL_PROTO_TLS1_1 or
1627 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001628 *
1629 * Comment this macro to disable support for Encrypt-then-MAC
1630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001634 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001635 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1636 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001637 *
1638 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1639 * attacks, but it is recommended to always use it (even if you disable
1640 * renegotiation), since it actually fixes a more fundamental issue in the
1641 * original SSL/TLS design, and has implications beyond Triple Handshake.
1642 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1644 * MBEDTLS_SSL_PROTO_TLS1_1 or
1645 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001646 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001647 * Comment this macro to disable support for Extended Master Secret.
1648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001650
Paul Bakkerd66f0702013-01-31 16:57:45 +01001651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001653 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001654 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1655 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001656 *
1657 * For servers, it is recommended to always enable this, unless you support
1658 * only one version of TLS, or know for sure that none of your clients
1659 * implements a fallback strategy.
1660 *
1661 * For clients, you only need this if you're using a fallback strategy, which
1662 * is not recommended in the first place, unless you absolutely need it to
1663 * interoperate with buggy (version-intolerant) servers.
1664 *
1665 * Comment this macro to disable support for FALLBACK_SCSV
1666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001668
1669/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001670 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1671 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001672 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001673 * giving access to the peer's certificate after completion of the handshake.
1674 *
1675 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1676 * recommended to disable this option for reduced RAM usage.
1677 *
1678 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1679 * defined, but always returns \c NULL.
1680 *
1681 * \note This option has no influence on the protection against the
1682 * triple handshake attack. Even if it is disabled, Mbed TLS will
1683 * still ensure that certificates do not change during renegotiation,
1684 * for exaple by keeping a hash of the peer's certificate.
1685 *
1686 * Comment this macro to disable storing the peer's certificate
1687 * after the handshake.
1688 */
1689#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1690
1691/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001693 *
1694 * Enable hooking functions in SSL module for hardware acceleration of
1695 * individual records.
1696 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001697 * \deprecated This option is deprecated and will be removed in a future
1698 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001699 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001700 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001703
1704/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001706 *
1707 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1708 *
1709 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1710 * of interoperability issues compared to sending 0-length records.
1711 *
1712 * Comment this macro to disable 1/n-1 record splitting.
1713 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001715
1716/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001718 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001719 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001720 *
1721 * The two main uses of renegotiation are (1) refresh keys on long-lived
1722 * connections and (2) client authentication after the initial handshake.
1723 * If you don't need renegotiation, it's probably better to disable it, since
1724 * it has been associated with security issues in the past and is easy to
1725 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001726 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001727 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001728 *
1729 * \note Even if this option is disabled, both client and server are aware
1730 * of the Renegotiation Indication Extension (RFC 5746) used to
1731 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1732 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1733 * configuration of this extension).
1734 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001737
1738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001740 *
1741 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001743 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001744 * \deprecated This option is deprecated and will be removed in a future
1745 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001746 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001747 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001750
1751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001753 *
1754 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001756 *
1757 * Uncomment this macro to respect client's ciphersuite order
1758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001760
1761/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001763 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001764 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001765 *
1766 * Comment this macro to disable support for the max_fragment_length extension
1767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001769
1770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001772 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001773 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 * Requires: MBEDTLS_MD5_C
1776 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001777 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001778 * \deprecated This option is deprecated and will be removed in a future
1779 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001780 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001781 * Comment this macro to disable support for SSL 3.0
1782 */
Janos Follathe2681a42016-03-07 15:57:05 +00001783//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001784
1785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001787 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001788 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001789 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 * Requires: MBEDTLS_MD5_C
1791 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001792 *
1793 * Comment this macro to disable support for TLS 1.0
1794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001796
1797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001799 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001800 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001801 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 * Requires: MBEDTLS_MD5_C
1803 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001804 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001805 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001808
1809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001811 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001812 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001813 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001815 * (Depends on ciphersuites)
1816 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001817 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001820
1821/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001822 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1823 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001824 * This macro is used to selectively enable experimental parts
1825 * of the code that contribute to the ongoing development of
1826 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1827 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001828 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001829 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1830 * and no feature exposed through this macro is part of the
1831 * public API. In particular, features under the control
1832 * of this macro are experimental and don't come with any
1833 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001834 *
1835 * Uncomment this macro to enable experimental and partial
1836 * functionality specific to TLS 1.3.
1837 */
Hanno Beckere4160602020-05-07 15:11:45 +01001838//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001839
1840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001842 *
1843 * Enable support for DTLS (all available versions).
1844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1846 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001847 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1849 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001850 *
1851 * Comment this macro to disable support for DTLS
1852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001854
1855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001857 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001858 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001859 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001860 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001863
1864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001866 *
1867 * Enable support for the anti-replay mechanism in DTLS.
1868 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * Requires: MBEDTLS_SSL_TLS_C
1870 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001871 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001872 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001873 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001874 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001875 * Comment this to disable anti-replay in DTLS.
1876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001878
1879/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001881 *
1882 * Enable support for HelloVerifyRequest on DTLS servers.
1883 *
1884 * This feature is highly recommended to prevent DTLS servers being used as
1885 * amplifiers in DoS attacks against other hosts. It should always be enabled
1886 * unless you know for sure amplification cannot be a problem in the
1887 * environment in which your server operates.
1888 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001889 * \warning Disabling this can ba a security risk! (see above)
1890 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001891 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001892 *
1893 * Comment this to disable support for HelloVerifyRequest.
1894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001896
1897/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001898 * \def MBEDTLS_SSL_DTLS_SRTP
1899 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02001900 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001901 * through the use_srtp extension.
1902 *
1903 * \note This feature provides the minimum functionality required
1904 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1905 * the associated SRTP packet protection key material.
1906 * In particular, the SRTP packet protection itself, as well as the
1907 * demultiplexing of RTP and DTLS packets at the datagram layer
1908 * (see Section 5 of RFC 5764), are not handled by this feature.
1909 * Instead, after successful completion of a handshake negotiating
1910 * the use of DTLS-SRTP, the extended key exporter API
1911 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1912 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1913 * (this is implemented in the SSL example programs).
1914 * The resulting key should then be passed to an SRTP stack.
1915 *
1916 * Setting this option enables the runtime API
1917 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1918 * through which the supported DTLS-SRTP protection
1919 * profiles can be configured. You must call this API at
1920 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001921 *
1922 * Requires: MBEDTLS_SSL_PROTO_DTLS
1923 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001924 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001925 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001926//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001927
1928/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001929 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1930 *
1931 * Enable server-side support for clients that reconnect from the same port.
1932 *
1933 * Some clients unexpectedly close the connection and try to reconnect using the
1934 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001935 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001936 * flag enables that support.
1937 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001938 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001939 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001940 * Comment this to disable support for clients reusing the source port.
1941 */
1942#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1943
1944/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001946 *
1947 * Enable support for a limit of records with bad MAC.
1948 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001949 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001950 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001954
1955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001957 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001958 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001959 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001960 * session store remains the responsibility of the application, though).
1961 * Server-side, you also need to provide callbacks for writing and parsing
1962 * tickets, including authenticated encryption and key management. Example
1963 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001964 *
1965 * Comment this macro to disable support for SSL session tickets
1966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001968
1969/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001970 * \def MBEDTLS_SSL_EXPORT_KEYS
1971 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001972 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001973 * This is required for certain users of TLS, e.g. EAP-TLS.
1974 *
1975 * Comment this macro to disable support for key export
1976 */
1977#define MBEDTLS_SSL_EXPORT_KEYS
1978
1979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001981 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001982 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001983 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001985 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001986 * Comment this macro to disable support for server name indication in SSL
1987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001989
1990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001992 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001993 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001994 *
1995 * Comment this macro to disable support for truncated HMAC in SSL
1996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001998
1999/**
Hanno Beckere89353a2017-11-20 16:36:41 +00002000 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2001 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002002 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
2003 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002004 * only meant for a transitory upgrade period and will be removed in a future
2005 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00002006 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002007 * \warning The old implementation is non-compliant and has a security weakness
2008 * (2^80 brute force attack on the HMAC key used for a single,
2009 * uninterrupted connection). This should only be enabled temporarily
2010 * when (1) the use of truncated HMAC is essential in order to save
2011 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
2012 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00002013 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002014 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00002015 * future version of Mbed TLS.
2016 *
Hanno Beckere89353a2017-11-20 16:36:41 +00002017 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
2018 *
2019 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
2020 */
2021//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2022
2023/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002024 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2025 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002026 * When this option is enabled, the SSL buffer will be resized automatically
2027 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002028 *
2029 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002030 */
2031//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2032
2033/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002034 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2035 *
2036 * Enable testing of the constant-flow nature of some sensitive functions with
2037 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002038 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002039 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002040 * This setting requires compiling with clang -fsanitize=memory. The test
2041 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002042 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002043 * \warning This macro is only used for extended testing; it is not considered
2044 * part of the library's API, so it may change or disappear at any time.
2045 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002046 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002047 */
2048//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2049
2050/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002051 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2052 *
2053 * Enable testing of the constant-flow nature of some sensitive functions with
2054 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002055 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002056 *
2057 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002058 * testing if the tests suites are run with valgrind's memcheck. This can be
2059 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2060 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002061 *
2062 * \warning This macro is only used for extended testing; it is not considered
2063 * part of the library's API, so it may change or disappear at any time.
2064 *
2065 * Uncomment to enable testing of the constant-flow nature of selected code.
2066 */
2067//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2068
2069/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002070 * \def MBEDTLS_TEST_HOOKS
2071 *
2072 * Enable features for invasive testing such as introspection functions and
2073 * hooks for fault injection. This enables additional unit tests.
2074 *
2075 * Merely enabling this feature should not change the behavior of the product.
2076 * It only adds new code, and new branching points where the default behavior
2077 * is the same as when this feature is disabled.
2078 * However, this feature increases the attack surface: there is an added
2079 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2080 * Therefore this feature must never be enabled in production.
2081 *
2082 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2083 * information.
2084 *
2085 * Uncomment to enable invasive tests.
2086 */
2087//#define MBEDTLS_TEST_HOOKS
2088
2089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002091 *
2092 * Provide your own alternate threading implementation.
2093 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002095 *
2096 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002099
2100/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002102 *
2103 * Enable the pthread wrapper layer for the threading layer.
2104 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002106 *
2107 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002110
2111/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002112 * \def MBEDTLS_USE_PSA_CRYPTO
2113 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002114 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2115 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002116 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002117 * \note Development of this option is currently in progress, and parts of Mbed
2118 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002119 * will still continue to work as usual, so enabling this option should not
2120 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002121 *
Gilles Peskined3d02902020-03-04 21:35:27 +01002122 * \warning The PSA Crypto API is in beta stage. While you're welcome to
2123 * experiment using it, incompatible API changes are still possible, and some
2124 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002125 *
2126 * \warning This option enables new Mbed TLS APIs that are dependent on the
2127 * PSA Crypto API, so can't come with the same stability guarantees as the
2128 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002129 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002130 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00002131 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002132 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002133 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002134 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002135 */
2136//#define MBEDTLS_USE_PSA_CRYPTO
2137
2138/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002139 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2140 *
John Durkop185764f2020-10-12 21:32:12 -07002141 * This setting allows support for cryptographic mechanisms through the PSA
2142 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002143 *
John Durkop185764f2020-10-12 21:32:12 -07002144 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01002145 * can be found in include/psa/crypto_config.h.
2146 *
2147 * If you enable this option and write your own configuration file, you must
2148 * include mbedtls/config_psa.h in your configuration file. The default
2149 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002150 *
2151 * This feature is still experimental and is not ready for production since
2152 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002153 */
2154//#define MBEDTLS_PSA_CRYPTO_CONFIG
2155
2156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002158 *
2159 * Allow run-time checking of compile-time enabled features. Thus allowing users
2160 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002161 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002162 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002164 *
2165 * Comment this to disable run-time checking and save ROM space
2166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002168
2169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002171 *
2172 * If set, the X509 parser will not break-off when parsing an X509 certificate
2173 * and encountering an extension in a v1 or v2 certificate.
2174 *
2175 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002178
2179/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002181 *
2182 * If set, the X509 parser will not break-off when parsing an X509 certificate
2183 * and encountering an unknown critical extension.
2184 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002185 * \warning Depending on your PKI use, enabling this can be a security risk!
2186 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002187 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002190
2191/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002192 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2193 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002194 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002195 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2196 * the set of trusted certificates through a callback instead of a linked
2197 * list.
2198 *
2199 * This is useful for example in environments where a large number of trusted
2200 * certificates is present and storing them in a linked list isn't efficient
2201 * enough, or when the set of trusted certificates changes frequently.
2202 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002203 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002204 * `mbedtls_ssl_conf_ca_cb()` for more information.
2205 *
2206 * Uncomment to enable trusted certificate callbacks.
2207 */
2208//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2209
2210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002212 *
2213 * Enable verification of the keyUsage extension (CA and leaf certificates).
2214 *
2215 * Disabling this avoids problems with mis-issued and/or misused
2216 * (intermediate) CA and leaf certificates.
2217 *
2218 * \warning Depending on your PKI use, disabling this can be a security risk!
2219 *
2220 * Comment to skip keyUsage checking for both CA and leaf certificates.
2221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002223
2224/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002226 *
2227 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2228 *
2229 * Disabling this avoids problems with mis-issued and/or misused certificates.
2230 *
2231 * \warning Depending on your PKI use, disabling this can be a security risk!
2232 *
2233 * Comment to skip extendedKeyUsage checking for certificates.
2234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002236
2237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002239 *
2240 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2241 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2242 *
2243 * Comment this macro to disallow using RSASSA-PSS in certificates.
2244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002246
2247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002249 *
2250 * If set, the SSL/TLS module uses ZLIB to support compression and
2251 * decompression of packet data.
2252 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002253 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2254 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002255 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002256 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002257 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002258 *
Hanno Beckere494e202018-03-08 13:26:12 +00002259 * \deprecated This feature is deprecated and will be removed
2260 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002261 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002262 * Used in: library/ssl_tls.c
2263 * library/ssl_cli.c
2264 * library/ssl_srv.c
2265 *
2266 * This feature requires zlib library and headers to be present.
2267 *
2268 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002271/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002272
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002273/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002274 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002275 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002276 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002277 * \{
2278 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002279
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002282 *
2283 * Enable AES-NI support on x86-64.
2284 *
2285 * Module: library/aesni.c
2286 * Caller: library/aes.c
2287 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002289 *
2290 * This modules adds support for the AES-NI instructions on x86-64
2291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002293
2294/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002296 *
2297 * Enable the AES block cipher.
2298 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002299 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002300 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002301 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002302 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002303 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002304 * This module enables the following ciphersuites (if other requisites are
2305 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2307 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2308 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2309 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2310 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2311 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2312 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2313 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2314 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2315 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2316 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2317 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2318 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2319 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2320 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2321 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2322 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2323 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2324 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2325 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2326 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2327 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2328 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2329 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2330 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2331 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2332 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2333 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2334 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2335 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2336 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2337 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2338 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2340 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2341 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2343 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2344 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2345 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2346 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2347 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2348 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2349 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2350 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2351 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2352 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2353 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2354 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2355 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2356 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2357 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2358 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2359 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2360 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2361 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2362 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2363 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002364 *
Paul Bakkercff68422013-09-15 20:43:33 +02002365 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002368
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002371 *
2372 * Enable the ARCFOUR stream cipher.
2373 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002374 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002375 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002376 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002377 * This module enables the following ciphersuites (if other requisites are
2378 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2380 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2381 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2382 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2383 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2384 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2385 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2386 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2387 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2388 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002389 *
2390 * \warning ARC4 is considered a weak cipher and its use constitutes a
2391 * security risk. If possible, we recommend avoidng dependencies on
2392 * it, and considering stronger ciphers instead.
2393 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002399 *
2400 * Enable the generic ASN1 parser.
2401 *
2402 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002403 * Caller: library/x509.c
2404 * library/dhm.c
2405 * library/pkcs12.c
2406 * library/pkcs5.c
2407 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002410
2411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002413 *
2414 * Enable the generic ASN1 writer.
2415 *
2416 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002417 * Caller: library/ecdsa.c
2418 * library/pkwrite.c
2419 * library/x509_create.c
2420 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002421 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002424
2425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002427 *
2428 * Enable the Base64 module.
2429 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002430 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002431 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002432 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002433 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002436
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002437/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002439 *
Paul Bakker9a736322012-11-14 12:39:52 +00002440 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002441 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002442 * Module: library/bignum.c
2443 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002444 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002445 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002446 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002447 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002448 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002449 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002450 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002453
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002456 *
2457 * Enable the Blowfish block cipher.
2458 *
2459 * Module: library/blowfish.c
2460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002462
2463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002465 *
2466 * Enable the Camellia block cipher.
2467 *
Paul Bakker38119b12009-01-10 23:31:23 +00002468 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002469 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002470 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002471 * This module enables the following ciphersuites (if other requisites are
2472 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2474 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2475 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2476 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2477 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2478 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2479 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2480 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2481 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2482 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2483 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2484 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2485 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2486 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2487 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2488 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2489 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2490 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2491 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2492 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2493 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2494 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2495 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2496 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2497 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2498 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2499 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2500 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2501 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2502 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2503 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2504 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2505 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2506 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2507 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2508 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2509 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2510 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2511 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2512 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2513 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2514 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002517
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002518/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002519 * \def MBEDTLS_ARIA_C
2520 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002521 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002522 *
2523 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002524 * Caller: library/cipher.c
2525 *
2526 * This module enables the following ciphersuites (if other requisites are
2527 * enabled as well):
2528 *
2529 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2530 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2531 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2532 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2533 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2534 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2535 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2536 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2537 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2538 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2539 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2540 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2541 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2542 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2543 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2544 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2545 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2546 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2547 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2548 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2549 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2550 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2551 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2552 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2553 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2554 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2555 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2556 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2557 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2558 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2559 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2560 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2561 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2562 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2563 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2564 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2565 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2566 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002567 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002568//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002569
2570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002572 *
2573 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2574 *
2575 * Module: library/ccm.c
2576 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002578 *
2579 * This module enables the AES-CCM ciphersuites, if other requisites are
2580 * enabled as well.
2581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002583
2584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002586 *
2587 * Enable the test certificates.
2588 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002589 * Module: library/certs.c
2590 * Caller:
2591 *
2592 * This module is used for testing (ssl_client/server).
2593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002595
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002596/**
Daniel King34b822c2016-05-15 17:28:08 -03002597 * \def MBEDTLS_CHACHA20_C
2598 *
2599 * Enable the ChaCha20 stream cipher.
2600 *
2601 * Module: library/chacha20.c
2602 */
2603#define MBEDTLS_CHACHA20_C
2604
2605/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002606 * \def MBEDTLS_CHACHAPOLY_C
2607 *
2608 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2609 *
2610 * Module: library/chachapoly.c
2611 *
2612 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2613 */
2614#define MBEDTLS_CHACHAPOLY_C
2615
2616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002618 *
2619 * Enable the generic cipher layer.
2620 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002621 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002622 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002623 *
2624 * Uncomment to enable generic cipher wrappers.
2625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002627
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002628/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002629 * \def MBEDTLS_CMAC_C
2630 *
Simon Butcher327398a2016-10-05 14:09:11 +01002631 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2632 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002633 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002634 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2635 * implementation of the CMAC algorithm is provided by an alternate
2636 * implementation, that alternate implementation may opt to not support
2637 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2638 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002639 * Module: library/cmac.c
2640 *
Simon Butcher69283e52016-10-06 12:49:58 +01002641 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002642 *
2643 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002644//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002645
2646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002648 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002649 * Enable the CTR_DRBG AES-based random generator.
2650 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002651 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002652 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002653 * \note To achieve a 256-bit security strength with CTR_DRBG,
2654 * you must use AES-256 *and* use sufficient entropy.
2655 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002656 *
2657 * Module: library/ctr_drbg.c
2658 * Caller:
2659 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002661 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002662 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002665
2666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002668 *
2669 * Enable the debug functions.
2670 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002671 * Module: library/debug.c
2672 * Caller: library/ssl_cli.c
2673 * library/ssl_srv.c
2674 * library/ssl_tls.c
2675 *
2676 * This module provides debugging functions.
2677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002679
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002680/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002682 *
2683 * Enable the DES block cipher.
2684 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002685 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002686 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002687 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002688 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002689 * This module enables the following ciphersuites (if other requisites are
2690 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2692 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2693 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2694 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2695 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2696 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2697 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2698 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2699 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2700 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002701 *
Paul Bakkercff68422013-09-15 20:43:33 +02002702 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002703 *
2704 * \warning DES is considered a weak cipher and its use constitutes a
2705 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002708
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002709/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002711 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002712 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002713 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002714 * Module: library/dhm.c
2715 * Caller: library/ssl_cli.c
2716 * library/ssl_srv.c
2717 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002718 * This module is used by the following key exchanges:
2719 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002720 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002721 * \warning Using DHE constitutes a security risk as it
2722 * is not possible to validate custom DH parameters.
2723 * If possible, it is recommended users should consider
2724 * preferring other methods of key exchange.
2725 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002726 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002729
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002732 *
2733 * Enable the elliptic curve Diffie-Hellman library.
2734 *
2735 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002736 * Caller: library/ssl_cli.c
2737 * library/ssl_srv.c
2738 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002739 * This module is used by the following key exchanges:
2740 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002741 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002742 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002745
2746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002748 *
2749 * Enable the elliptic curve DSA library.
2750 *
2751 * Module: library/ecdsa.c
2752 * Caller:
2753 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002754 * This module is used by the following key exchanges:
2755 * ECDHE-ECDSA
2756 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002757 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2758 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2759 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002762
2763/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002764 * \def MBEDTLS_ECJPAKE_C
2765 *
2766 * Enable the elliptic curve J-PAKE library.
2767 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002768 * \warning This is currently experimental. EC J-PAKE support is based on the
2769 * Thread v1.0.0 specification; incompatible changes to the specification
2770 * might still happen. For this reason, this is disabled by default.
2771 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002772 * Module: library/ecjpake.c
2773 * Caller:
2774 *
2775 * This module is used by the following key exchanges:
2776 * ECJPAKE
2777 *
2778 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2779 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002780//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002781
2782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002784 *
2785 * Enable the elliptic curve over GF(p) library.
2786 *
2787 * Module: library/ecp.c
2788 * Caller: library/ecdh.c
2789 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002790 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002795
2796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002798 *
2799 * Enable the platform-specific entropy code.
2800 *
2801 * Module: library/entropy.c
2802 * Caller:
2803 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002805 *
2806 * This module provides a generic entropy pool
2807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002809
2810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002812 *
2813 * Enable error code to error string conversion.
2814 *
2815 * Module: library/error.c
2816 * Caller:
2817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002821
2822/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002824 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002825 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002826 *
2827 * Module: library/gcm.c
2828 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002829 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002830 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002831 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2832 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002835
2836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002838 *
2839 * Enable the HAVEGE random generator.
2840 *
Paul Bakker2a844242013-06-24 13:01:53 +02002841 * Warning: the HAVEGE random generator is not suitable for virtualized
2842 * environments
2843 *
2844 * Warning: the HAVEGE random generator is dependent on timing and specific
2845 * processor traits. It is therefore not advised to use HAVEGE as
2846 * your applications primary random generator or primary entropy pool
2847 * input. As a secondary input to your entropy pool, it IS able add
2848 * the (limited) extra entropy it provides.
2849 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002850 * Module: library/havege.c
2851 * Caller:
2852 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002854 *
Paul Bakker2a844242013-06-24 13:01:53 +02002855 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002858
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002859/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002860 * \def MBEDTLS_HKDF_C
2861 *
2862 * Enable the HKDF algorithm (RFC 5869).
2863 *
2864 * Module: library/hkdf.c
2865 * Caller:
2866 *
2867 * Requires: MBEDTLS_MD_C
2868 *
2869 * This module adds support for the Hashed Message Authentication Code
2870 * (HMAC)-based key derivation function (HKDF).
2871 */
2872#define MBEDTLS_HKDF_C
2873
2874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002876 *
2877 * Enable the HMAC_DRBG random generator.
2878 *
2879 * Module: library/hmac_drbg.c
2880 * Caller:
2881 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002883 *
2884 * Uncomment to enable the HMAC_DRBG random number geerator.
2885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002887
2888/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002889 * \def MBEDTLS_NIST_KW_C
2890 *
2891 * Enable the Key Wrapping mode for 128-bit block ciphers,
2892 * as defined in NIST SP 800-38F. Only KW and KWP modes
2893 * are supported. At the moment, only AES is approved by NIST.
2894 *
2895 * Module: library/nist_kw.c
2896 *
2897 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2898 */
2899//#define MBEDTLS_NIST_KW_C
2900
2901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002903 *
2904 * Enable the generic message digest layer.
2905 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002906 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002907 * Caller:
2908 *
2909 * Uncomment to enable generic message digest wrappers.
2910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002912
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002915 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002916 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002917 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002918 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002919 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002920 *
2921 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002922 *
2923 * \warning MD2 is considered a weak message digest and its use constitutes a
2924 * security risk. If possible, we recommend avoiding dependencies on
2925 * it, and considering stronger message digests instead.
2926 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002929
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002930/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002932 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002933 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002934 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002935 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002936 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002937 *
2938 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002939 *
2940 * \warning MD4 is considered a weak message digest and its use constitutes a
2941 * security risk. If possible, we recommend avoiding dependencies on
2942 * it, and considering stronger message digests instead.
2943 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002945//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002946
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002949 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002950 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002951 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002952 * Module: library/md5.c
2953 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002954 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002955 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002956 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002957 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2958 * depending on the handshake parameters. Further, it is used for checking
2959 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2960 * encrypted keys.
2961 *
2962 * \warning MD5 is considered a weak message digest and its use constitutes a
2963 * security risk. If possible, we recommend avoiding dependencies on
2964 * it, and considering stronger message digests instead.
2965 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002968
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002971 *
2972 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002973 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002974 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002975 *
2976 * Module: library/memory_buffer_alloc.c
2977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * Requires: MBEDTLS_PLATFORM_C
2979 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002980 *
2981 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002984
2985/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002987 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002988 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2989 *
Simon Butcherd567a232016-03-09 20:19:21 +00002990 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2991 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002992 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002993 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002994 * \note See also our Knowledge Base article about porting to a new
2995 * environment:
2996 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2997 *
Andres AG788aa4a2016-09-14 14:32:09 +01002998 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002999 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003000 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003001 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003003
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003006 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003007 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003008 *
3009 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003010 * Caller: library/asn1write.c
3011 * library/pkcs5.c
3012 * library/pkparse.c
3013 * library/pkwrite.c
3014 * library/rsa.c
3015 * library/x509.c
3016 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003017 * library/x509_crl.c
3018 * library/x509_crt.c
3019 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003020 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003021 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003022 *
3023 * This modules translates between OIDs and internal values.
3024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003026
3027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003029 *
3030 * Enable VIA Padlock support on x86.
3031 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003032 * Module: library/padlock.c
3033 * Caller: library/aes.c
3034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003036 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003037 * This modules adds support for the VIA PadLock on x86.
3038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003040
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003044 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003045 *
3046 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003047 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003048 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003049 * library/x509_crl.c
3050 * library/x509_crt.c
3051 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003052 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003054 *
Paul Bakkercff68422013-09-15 20:43:33 +02003055 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003058
3059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003061 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003062 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003063 *
3064 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003065 * Caller: library/pkwrite.c
3066 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003067 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003068 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003070 *
3071 * This modules adds support for encoding / writing PEM files.
3072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003074
3075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003077 *
3078 * Enable the generic public (asymetric) key layer.
3079 *
3080 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003081 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003082 * library/ssl_cli.c
3083 * library/ssl_srv.c
3084 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003086 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003087 * Uncomment to enable generic public key wrappers.
3088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003090
3091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003093 *
3094 * Enable the generic public (asymetric) key parser.
3095 *
3096 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003097 * Caller: library/x509_crt.c
3098 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003099 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003101 *
3102 * Uncomment to enable generic public key parse functions.
3103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003105
3106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003108 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02003109 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003110 *
3111 * Module: library/pkwrite.c
3112 * Caller: library/x509write.c
3113 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003114 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003115 *
3116 * Uncomment to enable generic public key write functions.
3117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003119
3120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003122 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003123 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003124 *
3125 * Module: library/pkcs5.c
3126 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003128 *
3129 * This module adds support for the PKCS#5 functions.
3130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003132
3133/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003135 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003136 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003137 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003138 * \deprecated This option is deprecated and will be removed in a future
3139 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003140 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003141 * Module: library/pkcs11.c
3142 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003143 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003145 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003146 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003147 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003150
3151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003153 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003154 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003155 * Adds algorithms for parsing PKCS#8 encrypted private keys
3156 *
3157 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003158 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3161 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003162 *
3163 * This module enables PKCS#12 functions.
3164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003166
3167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003169 *
3170 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003171 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003173 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3174 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003175 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003176 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003177 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3178 * as other module rely on it for a fixed snprintf implementation.
3179 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003180 * Module: library/platform.c
3181 * Caller: Most other .c files
3182 *
3183 * This module enables abstraction of common (libc) functions.
3184 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003185#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003186
3187/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003188 * \def MBEDTLS_POLY1305_C
3189 *
3190 * Enable the Poly1305 MAC algorithm.
3191 *
3192 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003193 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003194 */
3195#define MBEDTLS_POLY1305_C
3196
3197/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003198 * \def MBEDTLS_PSA_CRYPTO_C
3199 *
3200 * Enable the Platform Security Architecture cryptography API.
3201 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003202 * \warning The PSA Crypto API is still beta status. While you're welcome to
3203 * experiment using it, incompatible API changes are still possible, and some
3204 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01003205 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003206 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003207 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003208 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003209 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003210 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003211 *
3212 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003213#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003214
3215/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003216 * \def MBEDTLS_PSA_CRYPTO_SE_C
3217 *
3218 * Enable secure element support in the Platform Security Architecture
3219 * cryptography API.
3220 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003221 * \warning This feature is not yet suitable for production. It is provided
3222 * for API evaluation and testing purposes only.
3223 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003224 * Module: library/psa_crypto_se.c
3225 *
3226 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3227 *
3228 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003229//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003230
3231/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003232 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3233 *
3234 * Enable the Platform Security Architecture persistent key storage.
3235 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003236 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003237 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003238 * Requires: MBEDTLS_PSA_CRYPTO_C,
3239 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3240 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003241 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003242#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003243
3244/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003245 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003246 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003247 * Enable the emulation of the Platform Security Architecture
3248 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003249 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003250 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003251 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003252 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003253 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003254#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003255
3256/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003258 *
3259 * Enable the RIPEMD-160 hash algorithm.
3260 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003261 * Module: library/ripemd160.c
3262 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003263 *
3264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003265#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003266
3267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003268 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003269 *
3270 * Enable the RSA public-key cryptosystem.
3271 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003272 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003273 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003274 * Caller: library/ssl_cli.c
3275 * library/ssl_srv.c
3276 * library/ssl_tls.c
3277 * library/x509.c
3278 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003279 * This module is used by the following key exchanges:
3280 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003281 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003285
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003286/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003288 *
3289 * Enable the SHA1 cryptographic hash algorithm.
3290 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003291 * Module: library/sha1.c
3292 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003293 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003294 * library/ssl_srv.c
3295 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003296 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003297 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003298 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3299 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003300 *
3301 * \warning SHA-1 is considered a weak message digest and its use constitutes
3302 * a security risk. If possible, we recommend avoiding dependencies
3303 * on it, and considering stronger message digests instead.
3304 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003307
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003308/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003310 *
3311 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3312 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003313 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003314 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003315 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003316 * library/ssl_cli.c
3317 * library/ssl_srv.c
3318 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003319 *
3320 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003321 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003324
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003327 *
3328 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3329 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003330 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003331 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003332 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003333 * library/ssl_cli.c
3334 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003335 *
3336 * This module adds support for SHA-384 and SHA-512.
3337 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003339
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003342 *
3343 * Enable simple SSL cache implementation.
3344 *
3345 * Module: library/ssl_cache.c
3346 * Caller:
3347 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003351
3352/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003354 *
3355 * Enable basic implementation of DTLS cookies for hello verification.
3356 *
3357 * Module: library/ssl_cookie.c
3358 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003361
3362/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003363 * \def MBEDTLS_SSL_TICKET_C
3364 *
3365 * Enable an implementation of TLS server-side callbacks for session tickets.
3366 *
3367 * Module: library/ssl_ticket.c
3368 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003369 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003370 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003371 */
3372#define MBEDTLS_SSL_TICKET_C
3373
3374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003376 *
3377 * Enable the SSL/TLS client code.
3378 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003379 * Module: library/ssl_cli.c
3380 * Caller:
3381 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003383 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003384 * This module is required for SSL/TLS client support.
3385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003387
Paul Bakker9a736322012-11-14 12:39:52 +00003388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003390 *
3391 * Enable the SSL/TLS server code.
3392 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003393 * Module: library/ssl_srv.c
3394 * Caller:
3395 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003397 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003398 * This module is required for SSL/TLS server support.
3399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003401
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003402/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003404 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003405 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003406 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003407 * Module: library/ssl_tls.c
3408 * Caller: library/ssl_cli.c
3409 * library/ssl_srv.c
3410 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3412 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003413 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003414 * This module is required for SSL/TLS.
3415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003417
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003420 *
3421 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003422 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003423 * contexts are not shared between threads. If you do intend to use contexts
3424 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003425 * conditions. See also our Knowledge Base article about threading:
3426 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003427 *
3428 * Module: library/threading.c
3429 *
3430 * This allows different threading implementations (self-implemented or
3431 * provided).
3432 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * You will have to enable either MBEDTLS_THREADING_ALT or
3434 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003435 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003436 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003439
3440/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003442 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003443 * Enable the semi-portable timing interface.
3444 *
Simon Butcherd567a232016-03-09 20:19:21 +00003445 * \note The provided implementation only works on POSIX/Unix (including Linux,
3446 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003447 * module and provide your own implementations of the callbacks needed by
3448 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3449 * your own implementation of the whole module by setting
3450 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003451 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003452 * \note See also our Knowledge Base article about porting to a new
3453 * environment:
3454 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3455 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003456 * Module: library/timing.c
3457 * Caller: library/havege.c
3458 *
3459 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003462
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003465 *
3466 * Enable run-time version information.
3467 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003468 * Module: library/version.c
3469 *
3470 * This module provides run-time version information.
3471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003473
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003474/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003476 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003477 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003478 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003479 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003480 * Caller: library/x509_crl.c
3481 * library/x509_crt.c
3482 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003483 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3485 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003486 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003487 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003490
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003492 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003493 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003494 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003495 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003496 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003497 * Caller: library/ssl_cli.c
3498 * library/ssl_srv.c
3499 * library/ssl_tls.c
3500 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003502 *
3503 * This module is required for X.509 certificate parsing.
3504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003506
3507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003509 *
3510 * Enable X.509 CRL parsing.
3511 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003512 * Module: library/x509_crl.c
3513 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003514 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003516 *
3517 * This module is required for X.509 CRL parsing.
3518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520
3521/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 *
3524 * Enable X.509 Certificate Signing Request (CSR) parsing.
3525 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003526 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 * Caller: library/x509_crt_write.c
3528 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003529 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003530 *
3531 * This module is used for reading X.509 certificate request.
3532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003534
3535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003538 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539 *
3540 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003541 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003543 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 * This module is the basis for creating X.509 certificates and CSRs.
3545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547
3548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
3551 * Enable creating X.509 certificates.
3552 *
3553 * Module: library/x509_crt_write.c
3554 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
3557 * This module is required for X.509 certificate creation.
3558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560
3561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003564 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003565 *
3566 * Module: library/x509_csr_write.c
3567 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003569 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003570 * This module is required for X.509 certificate request writing.
3571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003573
3574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003576 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003577 * Enable the XTEA block cipher.
3578 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003579 * Module: library/xtea.c
3580 * Caller:
3581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003583
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003584/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003585
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003586/**
3587 * \name SECTION: Module configuration options
3588 *
3589 * This section allows for the setting of module specific sizes and
3590 * configuration options. The default values are already present in the
3591 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003592 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003593 * Our advice is to enable options and change their values here
3594 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003595 *
3596 * Please check the respective header file for documentation on these
3597 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003598 * \{
3599 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003600
Paul Bakker088c5c52014-04-25 11:11:10 +02003601/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003602//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003604
Paul Bakker088c5c52014-04-25 11:11:10 +02003605/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3607//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3608//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3609//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3610//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003611
Paul Bakker088c5c52014-04-25 11:11:10 +02003612/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3614//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3615//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3616//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003617
Paul Bakker088c5c52014-04-25 11:11:10 +02003618/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
Gilles Peskineb3ca90b2021-06-02 13:27:03 +02003620//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003622
Paul Bakker088c5c52014-04-25 11:11:10 +02003623/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3625//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003626//#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 +01003627
Paul Bakker088c5c52014-04-25 11:11:10 +02003628/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003630
Paul Bakker088c5c52014-04-25 11:11:10 +02003631/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632//#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 +02003633//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3635//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003636//#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 +02003637//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3638//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003639/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003641//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3642//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003643//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3644//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3645//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3648/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003649//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003650//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3651//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003652//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3653//#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 +02003654//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3655//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003656/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003657//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003658//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003659//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3660//#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 +02003661
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003662/**
3663 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003664 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003665 * (see the documentation of that option for context).
3666 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003667 * When you leave this undefined here, the library provides
3668 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3669 * is defined, the default definition is `assert(cond)`,
3670 * otherwise the default definition calls a function
3671 * mbedtls_param_failed(). This function is declared in
3672 * `platform_util.h` for the benefit of the library, but
3673 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003674 *
3675 * When you define this here, this replaces the default
3676 * definition in platform_util.h (which no longer declares the
3677 * function mbedtls_param_failed()) and it is your responsibility
3678 * to make sure this macro expands to something suitable (in
3679 * particular, that all the necessary declarations are visible
3680 * from within the library - you can ensure that by providing
3681 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003682 * If you define this macro to call `assert`, also define
3683 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3684 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003685 *
3686 * Note that you may define this macro to expand to nothing, in
3687 * which case you don't have to worry about declarations or
3688 * definitions. However, you will then be notified about invalid
3689 * parameters only in non-void functions, and void function will
3690 * just silently return early on invalid parameters, which
3691 * partially negates the benefits of enabling
3692 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3693 *
3694 * \param cond The expression that should evaluate to true, but doesn't.
3695 */
3696//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3697
Gilles Peskineed038902020-11-13 21:33:21 +01003698/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003699/**
Gilles Peskineed038902020-11-13 21:33:21 +01003700 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3701 * PSA crypto subsystem.
3702 *
3703 * If this option is unset:
3704 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003705 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003706 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3707 * on unspecified heuristics.
3708 */
3709//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3710
Steven Cooreman863470a2021-02-15 14:03:19 +01003711/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003712 * Restrict the PSA library to supporting a maximum amount of simultaneously
3713 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3714 * volatile key, or a persistent key which is loaded temporarily by the
3715 * library as part of a crypto operation in flight.
3716 *
3717 * If this option is unset, the library will fall back to a default value of
3718 * 32 keys.
3719 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003720//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003721
Paul Bakker088c5c52014-04-25 11:11:10 +02003722/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003723//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3724//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003725
Paul Bakker088c5c52014-04-25 11:11:10 +02003726/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003727
3728/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3729 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003730 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003731 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003732 * This determines the size of both the incoming and outgoing TLS I/O buffers
3733 * in such a way that both are capable of holding the specified amount of
3734 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003735 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003736 * To configure incoming and outgoing I/O buffers separately, use
3737 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3738 * which overwrite the value set by this option.
3739 *
3740 * \note When using a value less than the default of 16KB on the client, it is
3741 * recommended to use the Maximum Fragment Length (MFL) extension to
3742 * inform the server about this limitation. On the server, there
3743 * is no supported, standardized way of informing the client about
3744 * restriction on the maximum size of incoming messages, and unless
3745 * the limitation has been communicated by other means, it is recommended
3746 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3747 * while keeping the default value of 16KB for the incoming buffer.
3748 *
3749 * Uncomment to set the maximum plaintext size of both
3750 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003751 */
3752//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3753
3754/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3755 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003756 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003757 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003758 * This determines the size of the incoming TLS I/O buffer in such a way
3759 * that it is capable of holding the specified amount of plaintext data,
3760 * regardless of the protection mechanism used.
3761 *
3762 * If this option is undefined, it inherits its value from
3763 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3764 *
3765 * \note When using a value less than the default of 16KB on the client, it is
3766 * recommended to use the Maximum Fragment Length (MFL) extension to
3767 * inform the server about this limitation. On the server, there
3768 * is no supported, standardized way of informing the client about
3769 * restriction on the maximum size of incoming messages, and unless
3770 * the limitation has been communicated by other means, it is recommended
3771 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3772 * while keeping the default value of 16KB for the incoming buffer.
3773 *
3774 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3775 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003776 */
3777//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3778
Gilles Peskined3d02902020-03-04 21:35:27 +01003779/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3780 *
3781 * The maximum length of CIDs used for incoming DTLS messages.
3782 *
3783 */
3784//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3785
3786/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3787 *
3788 * The maximum length of CIDs used for outgoing DTLS messages.
3789 *
3790 */
3791//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3792
3793/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3794 *
3795 * This option controls the use of record plaintext padding
3796 * when using the Connection ID extension in DTLS 1.2.
3797 *
3798 * The padding will always be chosen so that the length of the
3799 * padded plaintext is a multiple of the value of this option.
3800 *
3801 * Note: A value of \c 1 means that no padding will be used
3802 * for outgoing records.
3803 *
3804 * Note: On systems lacking division instructions,
3805 * a power of two should be preferred.
3806 *
3807 */
3808//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3809
Hanno Beckerceef8482020-06-02 06:16:00 +01003810/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003811 *
3812 * This option controls the use of record plaintext padding
3813 * in TLS 1.3.
3814 *
3815 * The padding will always be chosen so that the length of the
3816 * padded plaintext is a multiple of the value of this option.
3817 *
3818 * Note: A value of \c 1 means that no padding will be used
3819 * for outgoing records.
3820 *
3821 * Note: On systems lacking division instructions,
3822 * a power of two should be preferred.
3823 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003824//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003825
Angus Grattond8213d02016-05-25 20:56:48 +10003826/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3827 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003828 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003829 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003830 * This determines the size of the outgoing TLS I/O buffer in such a way
3831 * that it is capable of holding the specified amount of plaintext data,
3832 * regardless of the protection mechanism used.
3833 *
3834 * If this option undefined, it inherits its value from
3835 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003836 *
3837 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3838 * the default inward 16384 byte buffer to conform to the TLS specification.
3839 *
3840 * The minimum required outward buffer size is determined by the handshake
3841 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3842 * The specific size requirement depends on the configured ciphers and any
3843 * certificate data which is sent during the handshake.
3844 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003845 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3846 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003847 */
3848//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3849
Hanno Beckere0b150f2018-08-21 15:51:03 +01003850/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3851 *
3852 * Maximum number of heap-allocated bytes for the purpose of
3853 * DTLS handshake message reassembly and future message buffering.
3854 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003855 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003856 * to account for a reassembled handshake message of maximum size,
3857 * together with its reassembly bitmap.
3858 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003859 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003860 * should be sufficient for all practical situations as it allows
3861 * to reassembly a large handshake message (such as a certificate)
3862 * while buffering multiple smaller handshake messages.
3863 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003864 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003865//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003867//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3868//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3869//#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 +02003870
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003871/**
3872 * Complete list of ciphersuites to use, in order of preference.
3873 *
3874 * \warning No dependency checking is done on that field! This option can only
3875 * be used to restrict the set of available ciphersuites. It is your
3876 * responsibility to make sure the needed modules are active.
3877 *
3878 * Use this to save a few hundred bytes of ROM (default ordering of all
3879 * available ciphersuites) and a few to a few hundred bytes of RAM.
3880 *
3881 * The value below is only an example, not the default.
3882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003883//#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 +02003884
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003885/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003887//#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 +01003888
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003889/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003890 * Allow SHA-1 in the default TLS configuration for certificate signing.
3891 * Without this build-time option, SHA-1 support must be activated explicitly
3892 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003893 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003894 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003895 *
3896 * \warning SHA-1 is considered a weak message digest and its use constitutes
3897 * a security risk. If possible, we recommend avoiding dependencies
3898 * on it, and considering stronger message digests instead.
3899 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003900 */
Gilles Peskined3d02902020-03-04 21:35:27 +01003901//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003902
3903/**
3904 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3905 * signature and ciphersuite selection. Without this build-time option, SHA-1
3906 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3907 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3908 * default. At the time of writing, there is no practical attack on the use
3909 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003910 * to preserve compatibility with existing peers, but the general
3911 * warning applies nonetheless:
3912 *
3913 * \warning SHA-1 is considered a weak message digest and its use constitutes
3914 * a security risk. If possible, we recommend avoiding dependencies
3915 * on it, and considering stronger message digests instead.
3916 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003917 */
3918#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003919
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003920/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003921 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003922 * mbedtls_platform_zeroize(). This replaces the default implementation in
3923 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003924 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003925 * mbedtls_platform_zeroize() is a widely used function across the library to
3926 * zero a block of memory. The implementation is expected to be secure in the
3927 * sense that it has been written to prevent the compiler from removing calls
3928 * to mbedtls_platform_zeroize() as part of redundant code elimination
3929 * optimizations. However, it is difficult to guarantee that calls to
3930 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3931 * versions of the C language standards do not provide a secure implementation
3932 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3933 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003934 * example by using directives specific to their compiler, features from newer
3935 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003936 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003937 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003938//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003939
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003940/**
3941 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003942 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003943 * platform_util.c.
3944 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003945 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003946 * library will try to use safer implementations of this function, such as
3947 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003948 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003949 * using the standard gmtime(). In this case, calls from the library to
3950 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003951 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003952 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003953 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3954 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3955 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003956 */
Hanno Becker6a739782018-09-05 15:06:19 +01003957//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003958
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003959/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003960 * Enable the verified implementations of ECDH primitives from Project Everest
3961 * (currently only Curve25519). This feature changes the layout of ECDH
3962 * contexts and therefore is a compatibility break for applications that access
3963 * fields of a mbedtls_ecdh_context structure directly. See also
3964 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003965 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003966//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003967
Simon Butcher30b5f972016-06-08 19:00:23 +01003968/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003969
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003970/* Target and application specific configurations
3971 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003972 * Allow user to override any previous default.
3973 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003974 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003975#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003976#include MBEDTLS_USER_CONFIG_FILE
3977#endif
3978
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003979#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07003980#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003981#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07003982
Jaeden Amero6609aef2019-07-04 20:01:14 +01003983#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003985#endif /* MBEDTLS_CONFIG_H */