blob: 46941e27f52f07e97e092e0adb31c7792babd9f3 [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 *
430 * \note If you use the AES_xxx_ALT macros, then is is recommended to also set
431 * 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 *
Janos Follathc44ab972016-11-18 16:38:23 +0000487 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
488 * and implementing the following functions:
489 * unsigned char mbedtls_internal_ecp_grp_capable(
490 * const mbedtls_ecp_group *grp )
491 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500492 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000493 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
494 * replacement functions implement arithmetic for the given group and 0
495 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500496 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000497 * called before and after each point operation and provide an opportunity to
498 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100499 *
Janos Follathc44ab972016-11-18 16:38:23 +0000500 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
Janos Follath4d9c69d2016-11-01 13:27:03 +0000501 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
Janos Follathc44ab972016-11-18 16:38:23 +0000502 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
503 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
504 * receives it as an argument). If the group is not supported then the original
Janos Follathee782bc2016-11-07 15:41:26 +0000505 * implementation is used. The other functions and the definition of
506 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
Janos Follathc44ab972016-11-18 16:38:23 +0000507 * implementation of mbedtls_internal_ecp_double_jac and
508 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
Janos Follathb0697532016-08-18 12:38:46 +0100509 *
510 * Uncomment a macro to enable alternate implementation of the corresponding
511 * function.
512 */
513/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000514//#define MBEDTLS_ECP_INTERNAL_ALT
Janos Follathb0697532016-08-18 12:38:46 +0100515/* Support for Weierstrass curves with Jacobi representation */
516//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
517//#define MBEDTLS_ECP_ADD_MIXED_ALT
518//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
519//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
520//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
521/* Support for curves with Montgomery arithmetic */
522//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
523//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
524//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
525
526/**
Simon Butcherab5df402016-06-11 02:31:21 +0100527 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100528 *
Simon Butcherab5df402016-06-11 02:31:21 +0100529 * Enables testing and use of mbed TLS without any configured entropy sources.
530 * This permits use of the library on platforms before an entropy source has
531 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
532 * MBEDTLS_ENTROPY_NV_SEED switches).
533 *
534 * WARNING! This switch MUST be disabled in production builds, and is suitable
535 * only for development.
536 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100537 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100538 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
539 *
Janos Follath53de7842016-06-08 15:29:18 +0100540 */
Simon Butcherab5df402016-06-11 02:31:21 +0100541//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100542
543/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200544 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200545 *
546 * Uncomment this macro to let mbed TLS use your own implementation of a
547 * hardware entropy collector.
548 *
549 * Your function must be called \c mbedtls_hardware_poll(), have the same
550 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
551 *
552 * Uncomment to use your own hardware entropy collector.
553 */
554//#define MBEDTLS_ENTROPY_HARDWARE_ALT
555
556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000558 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100559 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000560 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100561 * Uncomment this macro to use precomputed AES tables stored in ROM.
562 * Comment this macro to generate AES tables in RAM at runtime.
563 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100564 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
565 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100566 * initialization time before the first AES operation can be performed.
567 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
568 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
569 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100570 *
571 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
572 *
Paul Bakker15566e42011-04-24 21:19:15 +0000573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000575
576/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100577 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200578 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100579 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100581 * Uncommenting this macro omits 75% of the AES tables from
582 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
583 * by computing their values on the fly during operations
584 * (the tables are entry-wise rotations of one another).
585 *
586 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100587 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100588 * runtime. Specifically, one has to compare 4 accesses within
589 * different tables to 4 accesses with additional arithmetic
590 * operations within the same table. The performance gain/loss
591 * depends on the system and memory details.
592 *
593 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
594 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200595 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100596//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200597
598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200600 *
601 * Use less ROM for the Camellia implementation (saves about 768 bytes).
602 *
603 * Uncomment this macro to use less memory for Camellia.
604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200606
607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200609 *
610 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200613
614/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000616 *
617 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000620
621/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200622 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000623 *
624 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000627
628/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100629 * \def MBEDTLS_CIPHER_MODE_OFB
630 *
631 * Enable Output Feedback mode (OFB) for symmetric ciphers.
632 */
633#define MBEDTLS_CIPHER_MODE_OFB
634
635/**
636 * \def MBEDTLS_CIPHER_MODE_XTS
637 *
638 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
639 */
640#define MBEDTLS_CIPHER_MODE_XTS
641
642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000644 *
645 * Enable NULL cipher.
646 * Warning: Only do so when you know what you are doing. This allows for
647 * encryption or channels without any security!
648 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000650 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
652 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
653 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
654 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
655 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
656 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
657 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
658 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
659 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
660 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
661 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
662 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
663 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
664 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
665 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
666 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
667 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
668 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
669 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000670 *
671 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000674
675/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100676 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200677 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100678 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
679 * specific padding modes in the cipher layer with cipher modes that support
680 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200681 *
682 * If you disable all padding modes, only full blocks can be used with CBC.
683 *
684 * Enable padding modes in the cipher layer.
685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686#define MBEDTLS_CIPHER_PADDING_PKCS7
687#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
688#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
689#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200690
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200691/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
692 *
693 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
694 * By default, CTR_DRBG uses a 256-bit key.
695 */
696//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
697
Paul Bakker48e93c82013-08-14 12:21:18 +0200698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000700 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200701 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000702 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000703 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000704 *
705 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
707 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000708 *
709 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100710 *
711 * \warning DES is considered a weak cipher and its use constitutes a
712 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000713 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000715
716/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200718 *
719 * Remove RC4 ciphersuites by default in SSL / TLS.
720 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200722 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200723 * explicitly.
724 *
725 * Uncomment this macro to remove RC4 ciphersuites by default.
726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200727#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200728
729/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000730 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
731 *
732 * Remove 3DES ciphersuites by default in SSL / TLS.
733 * This flag removes the ciphersuites based on 3DES from the default list as
734 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
735 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
736 * them explicitly.
737 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000738 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000739 * a TLS connection using a 3DES based cipher suite (see "On the Practical
740 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
741 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
742 * in your threat model or you are unsure, then you should keep this option
743 * enabled to remove 3DES based cipher suites.
744 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000745 * Comment this macro to keep 3DES in the default ciphersuite list.
746 */
747#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
748
749/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100750 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200751 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100752 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
753 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200754 *
755 * Comment macros to disable the curve and functions for it
756 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200757/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
759#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
761#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
762#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
763#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
764#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
765#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
766#define MBEDTLS_ECP_DP_BP256R1_ENABLED
767#define MBEDTLS_ECP_DP_BP384R1_ENABLED
768#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200769/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200770#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000771#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200772
773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200775 *
776 * Enable specific 'modulo p' routines for each NIST prime.
777 * Depending on the prime and architecture, makes operations 4 to 8 times
778 * faster on the corresponding curve.
779 *
780 * Comment this macro to disable NIST curves optimisation.
781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200783
784/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200785 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
786 *
787 * When this option is disabled, mbedtls_ecp_mul() will make use of an
788 * internal RNG when called with a NULL \c f_rng argument, in order to protect
789 * against some side-channel attacks.
790 *
791 * This protection introduces a dependency of the ECP module on one of the
792 * DRBG modules. For very constrained implementations that don't require this
793 * protection (for example, because you're only doing signature verification,
794 * so not manipulating any secret, or because local/physical side-channel
795 * attacks are outside your threat model), it might be desirable to get rid of
796 * that dependency.
797 *
798 * \warning Enabling this option makes some uses of ECP vulnerable to some
799 * side-channel attacks. Only enable it if you know that's not a problem for
800 * your use case.
801 *
802 * Uncomment this macro to disable some counter-measures in ECP.
803 */
804//#define MBEDTLS_ECP_NO_INTERNAL_RNG
805
806/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200807 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100808 *
809 * Enable "non-blocking" ECC operations that can return early and be resumed.
810 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200811 * This allows various functions to pause by returning
812 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
813 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
814 * order to further progress and eventually complete their operation. This is
815 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
816 * number of ECC operations a function may perform before pausing; see
817 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100818 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200819 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200820 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100821 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200822 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200823 *
Ron Eldor19779c42018-11-05 16:58:13 +0200824 * \note This option only works with the default software implementation of
825 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100826 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
827 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100828 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200829//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100830
831/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100832 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
833 *
834 * Use a backward compatible ECDH context.
835 *
836 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
837 * defined in `ecdh.h`). For most applications, the choice of format makes
838 * no difference, since all library functions can work with either format,
839 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
840
841 * The new format used when this option is disabled is smaller
842 * (56 bytes on a 32-bit platform). In future versions of the library, it
843 * will support alternative implementations of ECDH operations.
844 * The new format is incompatible with applications that access
845 * context fields directly and with restartable ECP operations.
846 *
847 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
848 * want to access ECDH context fields directly. Otherwise you should
849 * comment out this macro definition.
850 *
851 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
852 *
853 * \note This configuration option is experimental. Future versions of the
854 * library may modify the way the ECDH context layout is configured
855 * and may modify the layout of the new context type.
856 */
857#define MBEDTLS_ECDH_LEGACY_CONTEXT
858
859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100861 *
862 * Enable deterministic ECDSA (RFC 6979).
863 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
864 * may result in a compromise of the long-term signing key. This is avoided by
865 * the deterministic variant.
866 *
John Durkop36a82e52020-10-26 09:39:05 -0700867 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100868 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100869 * Comment this macro to disable deterministic ECDSA.
870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100872
873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200875 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200876 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200877 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200878 * This enables the following ciphersuites (if other requisites are
879 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
881 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
882 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
883 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
884 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
885 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
886 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
887 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
888 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
889 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
890 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
891 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200894
895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200898 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
902 * This enables the following ciphersuites (if other requisites are
903 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
905 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
906 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
907 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
908 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
909 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
910 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
911 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
912 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
913 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
914 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
915 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100916 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100917 * \warning Using DHE constitutes a security risk as it
918 * is not possible to validate custom DH parameters.
919 * If possible, it is recommended users should consider
920 * preferring other methods of key exchange.
921 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100922 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200925
926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200928 *
929 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
930 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200932 *
933 * This enables the following ciphersuites (if other requisites are
934 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
936 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
937 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
938 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
939 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
940 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
941 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
942 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200945
946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200948 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200949 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200950 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
952 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200953 *
954 * This enables the following ciphersuites (if other requisites are
955 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
957 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
958 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
959 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
960 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
961 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
962 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
963 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
964 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
965 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
966 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
967 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200970
971/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200973 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200974 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200975 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
977 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200978 *
979 * This enables the following ciphersuites (if other requisites are
980 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
982 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
983 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
984 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
985 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
986 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
987 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
988 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
989 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
990 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
991 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
992 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
993 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
994 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
995 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +0200996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001001 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001002 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1005 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001006 *
1007 * This enables the following ciphersuites (if other requisites are
1008 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1010 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1011 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1012 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1013 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1014 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1015 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1016 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1017 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1018 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1019 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1020 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1021 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001022 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001023 * \warning Using DHE constitutes a security risk as it
1024 * is not possible to validate custom DH parameters.
1025 * If possible, it is recommended users should consider
1026 * preferring other methods of key exchange.
1027 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001028 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001031
1032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001034 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001035 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001036 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1038 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001039 *
1040 * This enables the following ciphersuites (if other requisites are
1041 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1043 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1044 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1045 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1046 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1047 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1048 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1049 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1050 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1051 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1052 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1053 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001056
1057/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001059 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001060 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001061 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001063 *
1064 * This enables the following ciphersuites (if other requisites are
1065 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1067 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1068 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1069 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1070 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1071 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1072 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1073 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1074 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1075 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1076 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1077 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001080
1081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001083 *
1084 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1085 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001086 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001087 *
1088 * This enables the following ciphersuites (if other requisites are
1089 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1091 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1092 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1093 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1094 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1095 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1096 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1097 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1098 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1099 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1100 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1101 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001104
1105/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001107 *
1108 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1109 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001110 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001111 *
1112 * This enables the following ciphersuites (if other requisites are
1113 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1115 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1116 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1117 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1118 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1120 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1121 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1122 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1123 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1124 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1125 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001128
1129/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001130 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1131 *
1132 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1133 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001134 * \warning This is currently experimental. EC J-PAKE support is based on the
1135 * Thread v1.0.0 specification; incompatible changes to the specification
1136 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001137 *
1138 * Requires: MBEDTLS_ECJPAKE_C
1139 * MBEDTLS_SHA256_C
1140 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1141 *
1142 * This enables the following ciphersuites (if other requisites are
1143 * enabled as well):
1144 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1145 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001146//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001147
1148/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001150 *
1151 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1152 * RFC 5915 and RFC 5480.
1153 *
1154 * Currently this means parsing the SpecifiedECDomain choice of EC
1155 * parameters (only known groups are supported, not arbitrary domains, to
1156 * avoid validation issues).
1157 *
1158 * Disable if you only need to support RFC 5915 + 5480 key formats.
1159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001161
1162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001164 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 * Enable a dummy error function to make use of mbedtls_strerror() in
1166 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1167 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1170 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001171 *
1172 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001176
1177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001179 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001180 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001181 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001185
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001188 *
1189 * Enable functions that use the filesystem.
1190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001192
1193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001195 *
Mateusz Starzyk0fdcc8e2021-01-29 16:46:31 +01001196 * Do not add default entropy sources. These are the platform specific
1197 * or mbedtls_timing_hardclock poll function.
Paul Bakker43655f42011-12-15 20:11:16 +00001198 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001199 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001200 * application.
1201 *
1202 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001205
1206/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001208 *
1209 * Do not use built-in platform entropy functions.
1210 * This is useful if your platform does not support
1211 * standards like the /dev/urandom or Windows CryptoAPI.
1212 *
1213 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001216
1217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001219 *
1220 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1221 * default SHA-512 based one (if both are available).
1222 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001223 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001224 *
1225 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1226 * if you have performance concerns.
1227 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228 * This option is only useful if both MBEDTLS_SHA256_C and
1229 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001232
1233/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001234 * \def MBEDTLS_ENTROPY_NV_SEED
1235 *
1236 * Enable the non-volatile (NV) seed file-based entropy source.
1237 * (Also enables the NV seed read/write functions in the platform layer)
1238 *
1239 * This is crucial (if not required) on systems that do not have a
1240 * cryptographic entropy source (in hardware or kernel) available.
1241 *
1242 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1243 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001244 * \note The read/write functions that are used by the entropy source are
1245 * determined in the platform layer, and can be modified at runtime and/or
1246 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1247 *
1248 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001249 * with regular fopen(), please make sure you make a seedfile with the
1250 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1251 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001252 * and written to or you will get an entropy source error! The default
1253 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1254 * bytes from the file.
1255 *
1256 * \note The entropy collector will write to the seed file before entropy is
1257 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001258 */
1259//#define MBEDTLS_ENTROPY_NV_SEED
1260
Ronald Cron71016a92020-08-28 19:01:50 +02001261/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001262 *
Ronald Cron71016a92020-08-28 19:01:50 +02001263 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001264 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001265 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1266 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001267 *
1268 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001269 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001270 */
Ronald Cron71016a92020-08-28 19:01:50 +02001271//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001272
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001275 *
1276 * Enable debugging of buffer allocator memory issues. Automatically prints
1277 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1278 * function for 'debug output' of allocated memory.
1279 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001280 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001281 *
1282 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001285
1286/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001288 *
1289 * Include backtrace information with each allocated block.
1290 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001292 * GLIBC-compatible backtrace() an backtrace_symbols() support
1293 *
1294 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001297
1298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001300 *
1301 * Support external private RSA keys (eg from a HSM) in the PK layer.
1302 *
1303 * Comment this macro to disable support for external private RSA keys.
1304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001306
1307/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001309 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001310 * Enable support for PKCS#1 v1.5 encoding.
1311 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001313 *
Paul Bakker48377d92013-08-30 12:06:24 +02001314 * This enables support for PKCS#1 v1.5 operations.
1315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001317
1318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001320 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001321 * Enable support for PKCS#1 v2.1 encoding.
1322 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001324 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001325 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001328
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001329/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1330 *
1331 * Enable support for the experimental PSA crypto driver interface.
1332 *
John Durkop185764f2020-10-12 21:32:12 -07001333 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001334 *
1335 * \warning This interface is experimental and may change or be removed
1336 * without notice.
1337 */
1338//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1339
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001340/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1341 *
1342 * Make the PSA Crypto module use an external random generator provided
1343 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1344 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001345 * \note This random generator must deliver random numbers with cryptographic
1346 * quality and high performance. It must supply unpredictable numbers
1347 * with a uniform distribution. The implementation of this function
1348 * is responsible for ensuring that the random generator is seeded
1349 * with sufficient entropy. If you have a hardware TRNG which is slow
1350 * or delivers non-uniform output, declare it as an entropy source
1351 * with mbedtls_entropy_add_source() instead of enabling this option.
1352 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001353 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001354 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1355 * and define a function called mbedtls_psa_external_get_random()
1356 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001357 * ```
1358 * psa_status_t mbedtls_psa_external_get_random(
1359 * mbedtls_psa_external_random_context_t *context,
1360 * uint8_t *output, size_t output_size, size_t *output_length);
1361 * );
1362 * ```
1363 * The \c context value is initialized to 0 before the first call.
1364 * The function must fill the \c output buffer with \p output_size bytes
1365 * of random data and set \c *output_length to \p output_size.
1366 *
1367 * Requires: MBEDTLS_PSA_CRYPTO_C
1368 *
1369 * \warning If you enable this option, code that uses the PSA cryptography
1370 * interface will not use any of the entropy sources set up for
1371 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1372 * enables.
1373 *
1374 * \note This option is experimental and may be removed without notice.
1375 */
1376//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1377
Paul Bakker9dcc3222011-03-08 14:16:06 +00001378/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001379 * \def MBEDTLS_PSA_CRYPTO_SPM
1380 *
1381 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1382 * Partition Manager) integration which separates the code into two parts: a
1383 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1384 * Environment).
1385 *
1386 * Module: library/psa_crypto.c
1387 * Requires: MBEDTLS_PSA_CRYPTO_C
1388 *
1389 */
1390//#define MBEDTLS_PSA_CRYPTO_SPM
1391
1392/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001393 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001394 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001395 * Enable support for entropy injection at first boot. This feature is
1396 * required on systems that do not have a built-in entropy source (TRNG).
1397 * This feature is currently not supported on systems that have a built-in
1398 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001399 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001400 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001401 *
1402 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001403//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001404
1405/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001406 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001407 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001408 * Do not use the Chinese Remainder Theorem
1409 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001410 *
1411 * Uncomment this macro to disable the use of CRT in RSA.
1412 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001415
1416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001418 *
1419 * Enable the checkup functions (*_self_test).
1420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001422
1423/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001424 * \def MBEDTLS_SHA256_SMALLER
1425 *
1426 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1427 * lower performance.
1428 *
1429 * The default implementation is meant to be a reasonnable compromise between
1430 * performance and size. This version optimizes more aggressively for size at
1431 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1432 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1433 * 30%.
1434 *
1435 * Uncomment to enable the smaller implementation of SHA256.
1436 */
1437//#define MBEDTLS_SHA256_SMALLER
1438
1439/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001440 * \def MBEDTLS_SHA512_SMALLER
1441 *
1442 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1443 * lower performance.
1444 *
1445 * Uncomment to enable the smaller implementation of SHA512.
1446 */
1447//#define MBEDTLS_SHA512_SMALLER
1448
1449/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001450 * \def MBEDTLS_SHA512_NO_SHA384
1451 *
1452 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1453 * code size on devices that don't use SHA-384.
1454 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001455 * Requires: MBEDTLS_SHA512_C
1456 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001457 * Uncomment to disable SHA-384
1458 */
1459//#define MBEDTLS_SHA512_NO_SHA384
1460
1461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001463 *
1464 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001465 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001466 * with other servers, only debugging of failures is harder.
1467 *
1468 * The advantage of not sending alert messages, is that no information is given
1469 * about reasons for failures thus preventing adversaries of gaining intel.
1470 *
1471 * Enable sending of all alert messages
1472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001474
1475/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001476 * \def MBEDTLS_SSL_RECORD_CHECKING
1477 *
1478 * Enable the function mbedtls_ssl_check_record() which can be used to check
1479 * the validity and authenticity of an incoming record, to verify that it has
1480 * not been seen before. These checks are performed without modifying the
1481 * externally visible state of the SSL context.
1482 *
1483 * See mbedtls_ssl_check_record() for more information.
1484 *
1485 * Uncomment to enable support for record checking.
1486 */
1487#define MBEDTLS_SSL_RECORD_CHECKING
1488
1489/**
1490 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1491 *
1492 * Enable support for the DTLS Connection ID extension
1493 * (version draft-ietf-tls-dtls-connection-id-05,
1494 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1495 * which allows to identify DTLS connections across changes
1496 * in the underlying transport.
1497 *
1498 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1499 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1500 * See the corresponding documentation for more information.
1501 *
1502 * \warning The Connection ID extension is still in draft state.
1503 * We make no stability promises for the availability
1504 * or the shape of the API controlled by this option.
1505 *
1506 * The maximum lengths of outgoing and incoming CIDs can be configured
1507 * through the options
1508 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1509 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1510 *
1511 * Requires: MBEDTLS_SSL_PROTO_DTLS
1512 *
1513 * Uncomment to enable the Connection ID extension.
1514 */
1515//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1516
1517/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001518 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1519 *
1520 * Enable asynchronous external private key operations in SSL. This allows
1521 * you to configure an SSL connection to call an external cryptographic
1522 * module to perform private key operations instead of performing the
1523 * operation inside the library.
1524 *
1525 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001526//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001527
1528/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001529 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1530 *
1531 * Enable serialization of the TLS context structures, through use of the
1532 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1533 *
1534 * This pair of functions allows one side of a connection to serialize the
1535 * context associated with the connection, then free or re-use that context
1536 * while the serialized state is persisted elsewhere, and finally deserialize
1537 * that state to a live context for resuming read/write operations on the
1538 * connection. From a protocol perspective, the state of the connection is
1539 * unaffected, in particular this is entirely transparent to the peer.
1540 *
1541 * Note: this is distinct from TLS session resumption, which is part of the
1542 * protocol and fully visible by the peer. TLS session resumption enables
1543 * establishing new connections associated to a saved session with shorter,
1544 * lighter handshakes, while context serialization is a local optimization in
1545 * handling a single, potentially long-lived connection.
1546 *
1547 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1548 * saved after the handshake to allow for more efficient serialization, so if
1549 * you don't need this feature you'll save RAM by disabling it.
1550 *
1551 * Comment to disable the context serialization APIs.
1552 */
1553#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1554
1555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001557 *
1558 * Enable the debug messages in SSL module for all issues.
1559 * Debug messages have been disabled in some places to prevent timing
1560 * attacks due to (unbalanced) debugging function calls.
1561 *
1562 * If you need all error reporting you should enable this during debugging,
1563 * but remove this for production servers that should log as well.
1564 *
1565 * Uncomment this macro to report all debug messages on errors introducing
1566 * a timing side-channel.
1567 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001572 *
1573 * Enable support for Encrypt-then-MAC, RFC 7366.
1574 *
1575 * This allows peers that both support it to use a more robust protection for
1576 * ciphersuites using CBC, providing deep resistance against timing attacks
1577 * on the padding or underlying cipher.
1578 *
1579 * This only affects CBC ciphersuites, and is useless if none is defined.
1580 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1582 * MBEDTLS_SSL_PROTO_TLS1_1 or
1583 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001584 *
1585 * Comment this macro to disable support for Encrypt-then-MAC
1586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001588
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001590 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001591 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1592 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001593 *
1594 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1595 * attacks, but it is recommended to always use it (even if you disable
1596 * renegotiation), since it actually fixes a more fundamental issue in the
1597 * original SSL/TLS design, and has implications beyond Triple Handshake.
1598 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1600 * MBEDTLS_SSL_PROTO_TLS1_1 or
1601 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001602 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001603 * Comment this macro to disable support for Extended Master Secret.
1604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001606
Paul Bakkerd66f0702013-01-31 16:57:45 +01001607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001609 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001610 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1611 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001612 *
1613 * For servers, it is recommended to always enable this, unless you support
1614 * only one version of TLS, or know for sure that none of your clients
1615 * implements a fallback strategy.
1616 *
1617 * For clients, you only need this if you're using a fallback strategy, which
1618 * is not recommended in the first place, unless you absolutely need it to
1619 * interoperate with buggy (version-intolerant) servers.
1620 *
1621 * Comment this macro to disable support for FALLBACK_SCSV
1622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001624
1625/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001626 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1627 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001628 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001629 * giving access to the peer's certificate after completion of the handshake.
1630 *
1631 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1632 * recommended to disable this option for reduced RAM usage.
1633 *
1634 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1635 * defined, but always returns \c NULL.
1636 *
1637 * \note This option has no influence on the protection against the
1638 * triple handshake attack. Even if it is disabled, Mbed TLS will
1639 * still ensure that certificates do not change during renegotiation,
1640 * for exaple by keeping a hash of the peer's certificate.
1641 *
1642 * Comment this macro to disable storing the peer's certificate
1643 * after the handshake.
1644 */
1645#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1646
1647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001649 *
1650 * Enable hooking functions in SSL module for hardware acceleration of
1651 * individual records.
1652 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001653 * \deprecated This option is deprecated and will be removed in a future
1654 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001655 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001656 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001659
1660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001662 *
1663 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1664 *
1665 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1666 * of interoperability issues compared to sending 0-length records.
1667 *
1668 * Comment this macro to disable 1/n-1 record splitting.
1669 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001671
1672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001674 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001675 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001676 *
1677 * The two main uses of renegotiation are (1) refresh keys on long-lived
1678 * connections and (2) client authentication after the initial handshake.
1679 * If you don't need renegotiation, it's probably better to disable it, since
1680 * it has been associated with security issues in the past and is easy to
1681 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001682 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001683 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001684 *
1685 * \note Even if this option is disabled, both client and server are aware
1686 * of the Renegotiation Indication Extension (RFC 5746) used to
1687 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1688 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1689 * configuration of this extension).
1690 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001693
1694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001695 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001696 *
1697 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001699 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001700 * \deprecated This option is deprecated and will be removed in a future
1701 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001702 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001703 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001709 *
1710 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001712 *
1713 * Uncomment this macro to respect client's ciphersuite order
1714 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001716
1717/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001719 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001720 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001721 *
1722 * Comment this macro to disable support for the max_fragment_length extension
1723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001725
1726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001728 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001729 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001730 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 * Requires: MBEDTLS_MD5_C
1732 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001733 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001734 * \deprecated This option is deprecated and will be removed in a future
1735 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001736 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001737 * Comment this macro to disable support for SSL 3.0
1738 */
Janos Follathe2681a42016-03-07 15:57:05 +00001739//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001740
1741/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001743 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001744 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001745 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 * Requires: MBEDTLS_MD5_C
1747 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001748 *
1749 * Comment this macro to disable support for TLS 1.0
1750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001752
1753/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001755 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001756 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001757 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 * Requires: MBEDTLS_MD5_C
1759 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001760 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001761 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001762 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001764
1765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001767 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001768 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001769 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001771 * (Depends on ciphersuites)
1772 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001773 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001776
1777/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001778 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1779 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001780 * This macro is used to selectively enable experimental parts
1781 * of the code that contribute to the ongoing development of
1782 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1783 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001784 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001785 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1786 * and no feature exposed through this macro is part of the
1787 * public API. In particular, features under the control
1788 * of this macro are experimental and don't come with any
1789 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001790 *
1791 * Uncomment this macro to enable experimental and partial
1792 * functionality specific to TLS 1.3.
1793 */
Hanno Beckere4160602020-05-07 15:11:45 +01001794//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001795
1796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001798 *
1799 * Enable support for DTLS (all available versions).
1800 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1802 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001803 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1805 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001806 *
1807 * Comment this macro to disable support for DTLS
1808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001810
1811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001813 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001814 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001815 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001816 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001819
1820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001822 *
1823 * Enable support for the anti-replay mechanism in DTLS.
1824 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 * Requires: MBEDTLS_SSL_TLS_C
1826 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001827 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001828 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001829 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001830 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001831 * Comment this to disable anti-replay in DTLS.
1832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001834
1835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001837 *
1838 * Enable support for HelloVerifyRequest on DTLS servers.
1839 *
1840 * This feature is highly recommended to prevent DTLS servers being used as
1841 * amplifiers in DoS attacks against other hosts. It should always be enabled
1842 * unless you know for sure amplification cannot be a problem in the
1843 * environment in which your server operates.
1844 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001845 * \warning Disabling this can ba a security risk! (see above)
1846 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001847 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001848 *
1849 * Comment this to disable support for HelloVerifyRequest.
1850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001852
1853/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001854 * \def MBEDTLS_SSL_DTLS_SRTP
1855 *
Johan Pascal842d6712020-09-23 13:34:40 +02001856 * Enable support for negotation of DTLS-SRTP (RFC 5764)
1857 * through the use_srtp extension.
1858 *
1859 * \note This feature provides the minimum functionality required
1860 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1861 * the associated SRTP packet protection key material.
1862 * In particular, the SRTP packet protection itself, as well as the
1863 * demultiplexing of RTP and DTLS packets at the datagram layer
1864 * (see Section 5 of RFC 5764), are not handled by this feature.
1865 * Instead, after successful completion of a handshake negotiating
1866 * the use of DTLS-SRTP, the extended key exporter API
1867 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1868 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1869 * (this is implemented in the SSL example programs).
1870 * The resulting key should then be passed to an SRTP stack.
1871 *
1872 * Setting this option enables the runtime API
1873 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1874 * through which the supported DTLS-SRTP protection
1875 * profiles can be configured. You must call this API at
1876 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001877 *
1878 * Requires: MBEDTLS_SSL_PROTO_DTLS
1879 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001880 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001881 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001882//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001883
1884/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001885 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1886 *
1887 * Enable server-side support for clients that reconnect from the same port.
1888 *
1889 * Some clients unexpectedly close the connection and try to reconnect using the
1890 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001891 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001892 * flag enables that support.
1893 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001894 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001895 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001896 * Comment this to disable support for clients reusing the source port.
1897 */
1898#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001902 *
1903 * Enable support for a limit of records with bad MAC.
1904 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001905 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001906 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001910
1911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001913 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001914 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001915 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001916 * session store remains the responsibility of the application, though).
1917 * Server-side, you also need to provide callbacks for writing and parsing
1918 * tickets, including authenticated encryption and key management. Example
1919 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001920 *
1921 * Comment this macro to disable support for SSL session tickets
1922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001924
1925/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001926 * \def MBEDTLS_SSL_EXPORT_KEYS
1927 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001928 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001929 * This is required for certain users of TLS, e.g. EAP-TLS.
1930 *
1931 * Comment this macro to disable support for key export
1932 */
1933#define MBEDTLS_SSL_EXPORT_KEYS
1934
1935/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001937 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001938 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001939 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001941 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001942 * Comment this macro to disable support for server name indication in SSL
1943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001945
1946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001948 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001949 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001950 *
1951 * Comment this macro to disable support for truncated HMAC in SSL
1952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001954
1955/**
Hanno Beckere89353a2017-11-20 16:36:41 +00001956 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1957 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001958 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
1959 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001960 * only meant for a transitory upgrade period and will be removed in a future
1961 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00001962 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001963 * \warning The old implementation is non-compliant and has a security weakness
1964 * (2^80 brute force attack on the HMAC key used for a single,
1965 * uninterrupted connection). This should only be enabled temporarily
1966 * when (1) the use of truncated HMAC is essential in order to save
1967 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
1968 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00001969 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001970 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00001971 * future version of Mbed TLS.
1972 *
Hanno Beckere89353a2017-11-20 16:36:41 +00001973 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
1974 *
1975 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
1976 */
1977//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1978
1979/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001980 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1981 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001982 * When this option is enabled, the SSL buffer will be resized automatically
1983 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001984 *
1985 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001986 */
1987//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1988
1989/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001990 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1991 *
1992 * Enable testing of the constant-flow nature of some sensitive functions with
1993 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001994 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001995 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001996 * This setting requires compiling with clang -fsanitize=memory. The test
1997 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001998 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001999 * \warning This macro is only used for extended testing; it is not considered
2000 * part of the library's API, so it may change or disappear at any time.
2001 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002002 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002003 */
2004//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2005
2006/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002007 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2008 *
2009 * Enable testing of the constant-flow nature of some sensitive functions with
2010 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002011 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002012 *
2013 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002014 * testing if the tests suites are run with valgrind's memcheck. This can be
2015 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2016 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002017 *
2018 * \warning This macro is only used for extended testing; it is not considered
2019 * part of the library's API, so it may change or disappear at any time.
2020 *
2021 * Uncomment to enable testing of the constant-flow nature of selected code.
2022 */
2023//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2024
2025/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002026 * \def MBEDTLS_TEST_HOOKS
2027 *
2028 * Enable features for invasive testing such as introspection functions and
2029 * hooks for fault injection. This enables additional unit tests.
2030 *
2031 * Merely enabling this feature should not change the behavior of the product.
2032 * It only adds new code, and new branching points where the default behavior
2033 * is the same as when this feature is disabled.
2034 * However, this feature increases the attack surface: there is an added
2035 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2036 * Therefore this feature must never be enabled in production.
2037 *
2038 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2039 * information.
2040 *
2041 * Uncomment to enable invasive tests.
2042 */
2043//#define MBEDTLS_TEST_HOOKS
2044
2045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002047 *
2048 * Provide your own alternate threading implementation.
2049 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002051 *
2052 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002055
2056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002058 *
2059 * Enable the pthread wrapper layer for the threading layer.
2060 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002062 *
2063 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002066
2067/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002068 * \def MBEDTLS_USE_PSA_CRYPTO
2069 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002070 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2071 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002072 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002073 * \note Development of this option is currently in progress, and parts of Mbed
2074 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002075 * will still continue to work as usual, so enabling this option should not
2076 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002077 *
Gilles Peskined3d02902020-03-04 21:35:27 +01002078 * \warning The PSA Crypto API is in beta stage. While you're welcome to
2079 * experiment using it, incompatible API changes are still possible, and some
2080 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002081 *
2082 * \warning This option enables new Mbed TLS APIs that are dependent on the
2083 * PSA Crypto API, so can't come with the same stability guarantees as the
2084 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002085 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002086 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00002087 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002088 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002089 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002090 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002091 */
2092//#define MBEDTLS_USE_PSA_CRYPTO
2093
2094/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002095 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2096 *
John Durkop185764f2020-10-12 21:32:12 -07002097 * This setting allows support for cryptographic mechanisms through the PSA
2098 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002099 *
John Durkop185764f2020-10-12 21:32:12 -07002100 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01002101 * can be found in include/psa/crypto_config.h.
2102 *
2103 * If you enable this option and write your own configuration file, you must
2104 * include mbedtls/config_psa.h in your configuration file. The default
2105 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002106 *
2107 * This feature is still experimental and is not ready for production since
2108 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002109 */
2110//#define MBEDTLS_PSA_CRYPTO_CONFIG
2111
2112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002114 *
2115 * Allow run-time checking of compile-time enabled features. Thus allowing users
2116 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002118 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002120 *
2121 * Comment this to disable run-time checking and save ROM space
2122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002124
2125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002127 *
2128 * If set, the X509 parser will not break-off when parsing an X509 certificate
2129 * and encountering an extension in a v1 or v2 certificate.
2130 *
2131 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002134
2135/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002137 *
2138 * If set, the X509 parser will not break-off when parsing an X509 certificate
2139 * and encountering an unknown critical extension.
2140 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002141 * \warning Depending on your PKI use, enabling this can be a security risk!
2142 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002143 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002146
2147/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002148 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2149 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002150 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002151 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2152 * the set of trusted certificates through a callback instead of a linked
2153 * list.
2154 *
2155 * This is useful for example in environments where a large number of trusted
2156 * certificates is present and storing them in a linked list isn't efficient
2157 * enough, or when the set of trusted certificates changes frequently.
2158 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002159 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002160 * `mbedtls_ssl_conf_ca_cb()` for more information.
2161 *
2162 * Uncomment to enable trusted certificate callbacks.
2163 */
2164//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2165
2166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002168 *
2169 * Enable verification of the keyUsage extension (CA and leaf certificates).
2170 *
2171 * Disabling this avoids problems with mis-issued and/or misused
2172 * (intermediate) CA and leaf certificates.
2173 *
2174 * \warning Depending on your PKI use, disabling this can be a security risk!
2175 *
2176 * Comment to skip keyUsage checking for both CA and leaf certificates.
2177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002179
2180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002182 *
2183 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2184 *
2185 * Disabling this avoids problems with mis-issued and/or misused certificates.
2186 *
2187 * \warning Depending on your PKI use, disabling this can be a security risk!
2188 *
2189 * Comment to skip extendedKeyUsage checking for certificates.
2190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002192
2193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002195 *
2196 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2197 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2198 *
2199 * Comment this macro to disallow using RSASSA-PSS in certificates.
2200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002202
2203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002205 *
2206 * If set, the SSL/TLS module uses ZLIB to support compression and
2207 * decompression of packet data.
2208 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002209 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2210 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002211 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002212 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002213 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002214 *
Hanno Beckere494e202018-03-08 13:26:12 +00002215 * \deprecated This feature is deprecated and will be removed
2216 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002217 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002218 * Used in: library/ssl_tls.c
2219 * library/ssl_cli.c
2220 * library/ssl_srv.c
2221 *
2222 * This feature requires zlib library and headers to be present.
2223 *
2224 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002227/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002228
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002229/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002230 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002231 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002232 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002233 * \{
2234 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002235
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002238 *
2239 * Enable AES-NI support on x86-64.
2240 *
2241 * Module: library/aesni.c
2242 * Caller: library/aes.c
2243 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002245 *
2246 * This modules adds support for the AES-NI instructions on x86-64
2247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002249
2250/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002252 *
2253 * Enable the AES block cipher.
2254 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002255 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002256 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002257 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002258 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002259 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002260 * This module enables the following ciphersuites (if other requisites are
2261 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2263 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2264 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2265 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2266 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2267 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2268 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2269 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2270 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2271 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2272 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2273 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2274 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2275 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2276 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2277 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2278 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2279 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2280 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2281 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2282 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2283 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2284 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2285 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2286 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2287 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2288 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2291 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2292 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2293 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2294 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2295 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2296 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2297 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2298 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2299 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2300 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2301 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2302 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2303 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2304 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2305 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2306 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2308 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2309 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2310 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2311 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2312 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2313 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2314 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2315 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2316 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2317 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2318 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2319 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002320 *
Paul Bakkercff68422013-09-15 20:43:33 +02002321 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002324
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002327 *
2328 * Enable the ARCFOUR stream cipher.
2329 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002330 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002331 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002332 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002333 * This module enables the following ciphersuites (if other requisites are
2334 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2336 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2337 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2338 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2339 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2340 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2341 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2342 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2343 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2344 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002345 *
2346 * \warning ARC4 is considered a weak cipher and its use constitutes a
2347 * security risk. If possible, we recommend avoidng dependencies on
2348 * it, and considering stronger ciphers instead.
2349 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002355 *
2356 * Enable the generic ASN1 parser.
2357 *
2358 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002359 * Caller: library/x509.c
2360 * library/dhm.c
2361 * library/pkcs12.c
2362 * library/pkcs5.c
2363 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002366
2367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002369 *
2370 * Enable the generic ASN1 writer.
2371 *
2372 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002373 * Caller: library/ecdsa.c
2374 * library/pkwrite.c
2375 * library/x509_create.c
2376 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002377 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002380
2381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002383 *
2384 * Enable the Base64 module.
2385 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002386 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002387 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002389 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002392
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002393/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002394 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002395 *
Paul Bakker9a736322012-11-14 12:39:52 +00002396 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002397 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002398 * Module: library/bignum.c
2399 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002400 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002401 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002403 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002404 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002405 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002406 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002409
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002411 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002412 *
2413 * Enable the Blowfish block cipher.
2414 *
2415 * Module: library/blowfish.c
2416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002417#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002418
2419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002421 *
2422 * Enable the Camellia block cipher.
2423 *
Paul Bakker38119b12009-01-10 23:31:23 +00002424 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002425 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002426 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002427 * This module enables the following ciphersuites (if other requisites are
2428 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2430 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2431 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2432 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2433 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2434 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2435 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2436 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2437 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2438 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2439 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2440 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2441 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2442 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2443 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2444 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2445 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2446 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2447 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2448 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2449 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2450 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2451 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2452 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2453 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2454 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2455 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2456 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2457 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2458 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2459 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2460 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2461 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2462 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2463 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2464 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2465 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2466 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2467 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2468 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2469 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2470 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002473
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002474/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002475 * \def MBEDTLS_ARIA_C
2476 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002477 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002478 *
2479 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002480 * Caller: library/cipher.c
2481 *
2482 * This module enables the following ciphersuites (if other requisites are
2483 * enabled as well):
2484 *
2485 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2486 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2487 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2488 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2489 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2490 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2491 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2492 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2493 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2494 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2495 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2496 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2497 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2498 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2499 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2500 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2501 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2502 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2503 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2504 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2505 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2506 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2507 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2508 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2509 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2510 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2511 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2512 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2513 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2514 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2515 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2516 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2517 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2518 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2519 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2520 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2521 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2522 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002523 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002524//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002525
2526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002528 *
2529 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2530 *
2531 * Module: library/ccm.c
2532 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002534 *
2535 * This module enables the AES-CCM ciphersuites, if other requisites are
2536 * enabled as well.
2537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002539
2540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002542 *
2543 * Enable the test certificates.
2544 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002545 * Module: library/certs.c
2546 * Caller:
2547 *
2548 * This module is used for testing (ssl_client/server).
2549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002551
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002552/**
Daniel King34b822c2016-05-15 17:28:08 -03002553 * \def MBEDTLS_CHACHA20_C
2554 *
2555 * Enable the ChaCha20 stream cipher.
2556 *
2557 * Module: library/chacha20.c
2558 */
2559#define MBEDTLS_CHACHA20_C
2560
2561/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002562 * \def MBEDTLS_CHACHAPOLY_C
2563 *
2564 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2565 *
2566 * Module: library/chachapoly.c
2567 *
2568 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2569 */
2570#define MBEDTLS_CHACHAPOLY_C
2571
2572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002574 *
2575 * Enable the generic cipher layer.
2576 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002577 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002578 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002579 *
2580 * Uncomment to enable generic cipher wrappers.
2581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002583
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002584/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002585 * \def MBEDTLS_CMAC_C
2586 *
Simon Butcher327398a2016-10-05 14:09:11 +01002587 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2588 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002589 *
2590 * Module: library/cmac.c
2591 *
Simon Butcher69283e52016-10-06 12:49:58 +01002592 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002593 *
2594 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002595//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002596
2597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002599 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002600 * Enable the CTR_DRBG AES-based random generator.
2601 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002602 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002603 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002604 * \note To achieve a 256-bit security strength with CTR_DRBG,
2605 * you must use AES-256 *and* use sufficient entropy.
2606 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002607 *
2608 * Module: library/ctr_drbg.c
2609 * Caller:
2610 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002612 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002613 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002616
2617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002619 *
2620 * Enable the debug functions.
2621 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002622 * Module: library/debug.c
2623 * Caller: library/ssl_cli.c
2624 * library/ssl_srv.c
2625 * library/ssl_tls.c
2626 *
2627 * This module provides debugging functions.
2628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002630
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002633 *
2634 * Enable the DES block cipher.
2635 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002636 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002637 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002638 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002639 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002640 * This module enables the following ciphersuites (if other requisites are
2641 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2643 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2644 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2645 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2646 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2647 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2648 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2649 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2650 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2651 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002652 *
Paul Bakkercff68422013-09-15 20:43:33 +02002653 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002654 *
2655 * \warning DES is considered a weak cipher and its use constitutes a
2656 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002659
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002662 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002663 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002664 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002665 * Module: library/dhm.c
2666 * Caller: library/ssl_cli.c
2667 * library/ssl_srv.c
2668 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002669 * This module is used by the following key exchanges:
2670 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002671 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002672 * \warning Using DHE constitutes a security risk as it
2673 * is not possible to validate custom DH parameters.
2674 * If possible, it is recommended users should consider
2675 * preferring other methods of key exchange.
2676 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002677 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002680
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002683 *
2684 * Enable the elliptic curve Diffie-Hellman library.
2685 *
2686 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002687 * Caller: library/ssl_cli.c
2688 * library/ssl_srv.c
2689 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002690 * This module is used by the following key exchanges:
2691 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002692 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002696
2697/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002699 *
2700 * Enable the elliptic curve DSA library.
2701 *
2702 * Module: library/ecdsa.c
2703 * Caller:
2704 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002705 * This module is used by the following key exchanges:
2706 * ECDHE-ECDSA
2707 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002708 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2709 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2710 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002713
2714/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002715 * \def MBEDTLS_ECJPAKE_C
2716 *
2717 * Enable the elliptic curve J-PAKE library.
2718 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002719 * \warning This is currently experimental. EC J-PAKE support is based on the
2720 * Thread v1.0.0 specification; incompatible changes to the specification
2721 * might still happen. For this reason, this is disabled by default.
2722 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002723 * Module: library/ecjpake.c
2724 * Caller:
2725 *
2726 * This module is used by the following key exchanges:
2727 * ECJPAKE
2728 *
2729 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2730 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002731//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002732
2733/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002735 *
2736 * Enable the elliptic curve over GF(p) library.
2737 *
2738 * Module: library/ecp.c
2739 * Caller: library/ecdh.c
2740 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002741 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002742 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002746
2747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002749 *
2750 * Enable the platform-specific entropy code.
2751 *
2752 * Module: library/entropy.c
2753 * Caller:
2754 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002756 *
2757 * This module provides a generic entropy pool
2758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002760
2761/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002762 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002763 *
2764 * Enable error code to error string conversion.
2765 *
2766 * Module: library/error.c
2767 * Caller:
2768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002772
2773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002775 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002776 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002777 *
2778 * Module: library/gcm.c
2779 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002780 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002781 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002782 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2783 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002786
2787/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002788 * \def MBEDTLS_HKDF_C
2789 *
2790 * Enable the HKDF algorithm (RFC 5869).
2791 *
2792 * Module: library/hkdf.c
2793 * Caller:
2794 *
2795 * Requires: MBEDTLS_MD_C
2796 *
2797 * This module adds support for the Hashed Message Authentication Code
2798 * (HMAC)-based key derivation function (HKDF).
2799 */
2800#define MBEDTLS_HKDF_C
2801
2802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002804 *
2805 * Enable the HMAC_DRBG random generator.
2806 *
2807 * Module: library/hmac_drbg.c
2808 * Caller:
2809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002811 *
2812 * Uncomment to enable the HMAC_DRBG random number geerator.
2813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002815
2816/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002817 * \def MBEDTLS_NIST_KW_C
2818 *
2819 * Enable the Key Wrapping mode for 128-bit block ciphers,
2820 * as defined in NIST SP 800-38F. Only KW and KWP modes
2821 * are supported. At the moment, only AES is approved by NIST.
2822 *
2823 * Module: library/nist_kw.c
2824 *
2825 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2826 */
2827//#define MBEDTLS_NIST_KW_C
2828
2829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002831 *
2832 * Enable the generic message digest layer.
2833 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002834 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002835 * Caller:
2836 *
2837 * Uncomment to enable generic message digest wrappers.
2838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002840
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002841/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002843 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002844 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002845 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002846 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002847 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002848 *
2849 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002850 *
2851 * \warning MD2 is considered a weak message digest and its use constitutes a
2852 * security risk. If possible, we recommend avoiding dependencies on
2853 * it, and considering stronger message digests instead.
2854 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002857
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002860 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002861 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002862 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002863 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002864 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002865 *
2866 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002867 *
2868 * \warning MD4 is considered a weak message digest and its use constitutes a
2869 * security risk. If possible, we recommend avoiding dependencies on
2870 * it, and considering stronger message digests instead.
2871 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002874
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002877 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002878 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002879 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002880 * Module: library/md5.c
2881 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002882 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002883 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002884 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002885 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2886 * depending on the handshake parameters. Further, it is used for checking
2887 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2888 * encrypted keys.
2889 *
2890 * \warning MD5 is considered a weak message digest and its use constitutes a
2891 * security risk. If possible, we recommend avoiding dependencies on
2892 * it, and considering stronger message digests instead.
2893 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002896
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002899 *
2900 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002901 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002902 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002903 *
2904 * Module: library/memory_buffer_alloc.c
2905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * Requires: MBEDTLS_PLATFORM_C
2907 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002908 *
2909 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002912
2913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002915 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002916 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2917 *
Simon Butcherd567a232016-03-09 20:19:21 +00002918 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2919 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002920 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002921 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002922 * \note See also our Knowledge Base article about porting to a new
2923 * environment:
2924 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2925 *
Andres AG788aa4a2016-09-14 14:32:09 +01002926 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002927 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002928 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002931
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002934 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002935 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002936 *
2937 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002938 * Caller: library/asn1write.c
2939 * library/pkcs5.c
2940 * library/pkparse.c
2941 * library/pkwrite.c
2942 * library/rsa.c
2943 * library/x509.c
2944 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002945 * library/x509_crl.c
2946 * library/x509_crt.c
2947 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002948 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002949 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002950 *
2951 * This modules translates between OIDs and internal values.
2952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002954
2955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002957 *
2958 * Enable VIA Padlock support on x86.
2959 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002960 * Module: library/padlock.c
2961 * Caller: library/aes.c
2962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002964 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002965 * This modules adds support for the VIA PadLock on x86.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PADLOCK_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_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002971 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002972 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002973 *
2974 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002975 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002976 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002977 * library/x509_crl.c
2978 * library/x509_crt.c
2979 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002980 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002982 *
Paul Bakkercff68422013-09-15 20:43:33 +02002983 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002986
2987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002989 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002990 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002991 *
2992 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002993 * Caller: library/pkwrite.c
2994 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002995 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002996 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002998 *
2999 * This modules adds support for encoding / writing PEM files.
3000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003002
3003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003005 *
3006 * Enable the generic public (asymetric) key layer.
3007 *
3008 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003009 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003010 * library/ssl_cli.c
3011 * library/ssl_srv.c
3012 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003014 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003015 * Uncomment to enable generic public key wrappers.
3016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003018
3019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003021 *
3022 * Enable the generic public (asymetric) key parser.
3023 *
3024 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003025 * Caller: library/x509_crt.c
3026 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003027 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003029 *
3030 * Uncomment to enable generic public key parse functions.
3031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003033
3034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003036 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02003037 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003038 *
3039 * Module: library/pkwrite.c
3040 * Caller: library/x509write.c
3041 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003043 *
3044 * Uncomment to enable generic public key write functions.
3045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003047
3048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003050 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003051 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003052 *
3053 * Module: library/pkcs5.c
3054 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003056 *
3057 * This module adds support for the PKCS#5 functions.
3058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003060
3061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003063 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003064 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003065 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003066 * \deprecated This option is deprecated and will be removed in a future
3067 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003068 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003069 * Module: library/pkcs11.c
3070 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003071 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003073 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003074 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003075 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003078
3079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003081 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003082 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003083 * Adds algorithms for parsing PKCS#8 encrypted private keys
3084 *
3085 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003086 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003087 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3089 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003090 *
3091 * This module enables PKCS#12 functions.
3092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003094
3095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003097 *
3098 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003099 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3102 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003103 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003104 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003105 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3106 * as other module rely on it for a fixed snprintf implementation.
3107 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003108 * Module: library/platform.c
3109 * Caller: Most other .c files
3110 *
3111 * This module enables abstraction of common (libc) functions.
3112 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003113#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003114
3115/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003116 * \def MBEDTLS_POLY1305_C
3117 *
3118 * Enable the Poly1305 MAC algorithm.
3119 *
3120 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003121 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003122 */
3123#define MBEDTLS_POLY1305_C
3124
3125/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003126 * \def MBEDTLS_PSA_CRYPTO_C
3127 *
3128 * Enable the Platform Security Architecture cryptography API.
3129 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003130 * \warning The PSA Crypto API is still beta status. While you're welcome to
3131 * experiment using it, incompatible API changes are still possible, and some
3132 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01003133 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003134 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003135 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003136 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003137 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003138 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003139 *
3140 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003141#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003142
3143/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003144 * \def MBEDTLS_PSA_CRYPTO_SE_C
3145 *
3146 * Enable secure element support in the Platform Security Architecture
3147 * cryptography API.
3148 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003149 * \warning This feature is not yet suitable for production. It is provided
3150 * for API evaluation and testing purposes only.
3151 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003152 * Module: library/psa_crypto_se.c
3153 *
3154 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3155 *
3156 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003157//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003158
3159/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003160 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3161 *
3162 * Enable the Platform Security Architecture persistent key storage.
3163 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003164 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003165 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003166 * Requires: MBEDTLS_PSA_CRYPTO_C,
3167 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3168 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003169 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003170#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003171
3172/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003173 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003174 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003175 * Enable the emulation of the Platform Security Architecture
3176 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003177 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003178 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003179 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003180 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003181 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003182#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003183
3184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003186 *
3187 * Enable the RIPEMD-160 hash algorithm.
3188 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003189 * Module: library/ripemd160.c
3190 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003191 *
3192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003194
3195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003197 *
3198 * Enable the RSA public-key cryptosystem.
3199 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003201 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003202 * Caller: library/ssl_cli.c
3203 * library/ssl_srv.c
3204 * library/ssl_tls.c
3205 * library/x509.c
3206 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003207 * This module is used by the following key exchanges:
3208 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003209 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003210 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003211 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003213
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003214/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003216 *
3217 * Enable the SHA1 cryptographic hash algorithm.
3218 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003219 * Module: library/sha1.c
3220 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003221 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003222 * library/ssl_srv.c
3223 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003224 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003225 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003226 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3227 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003228 *
3229 * \warning SHA-1 is considered a weak message digest and its use constitutes
3230 * a security risk. If possible, we recommend avoiding dependencies
3231 * on it, and considering stronger message digests instead.
3232 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003235
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003238 *
3239 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3240 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003241 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003242 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003243 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003244 * library/ssl_cli.c
3245 * library/ssl_srv.c
3246 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003247 *
3248 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003249 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003251#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003252
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003255 *
3256 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3257 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003258 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003259 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003260 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003261 * library/ssl_cli.c
3262 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003263 *
3264 * This module adds support for SHA-384 and SHA-512.
3265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003267
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003270 *
3271 * Enable simple SSL cache implementation.
3272 *
3273 * Module: library/ssl_cache.c
3274 * Caller:
3275 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003276 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003278#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003279
3280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003281 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003282 *
3283 * Enable basic implementation of DTLS cookies for hello verification.
3284 *
3285 * Module: library/ssl_cookie.c
3286 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003289
3290/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003291 * \def MBEDTLS_SSL_TICKET_C
3292 *
3293 * Enable an implementation of TLS server-side callbacks for session tickets.
3294 *
3295 * Module: library/ssl_ticket.c
3296 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003297 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003298 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003299 */
3300#define MBEDTLS_SSL_TICKET_C
3301
3302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003304 *
3305 * Enable the SSL/TLS client code.
3306 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003307 * Module: library/ssl_cli.c
3308 * Caller:
3309 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003311 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003312 * This module is required for SSL/TLS client support.
3313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003315
Paul Bakker9a736322012-11-14 12:39:52 +00003316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003318 *
3319 * Enable the SSL/TLS server code.
3320 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003321 * Module: library/ssl_srv.c
3322 * Caller:
3323 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003325 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003326 * This module is required for SSL/TLS server support.
3327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003329
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003330/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003332 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003333 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003334 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003335 * Module: library/ssl_tls.c
3336 * Caller: library/ssl_cli.c
3337 * library/ssl_srv.c
3338 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3340 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003341 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003342 * This module is required for SSL/TLS.
3343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003345
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003346/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003348 *
3349 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003350 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003351 * contexts are not shared between threads. If you do intend to use contexts
3352 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003353 * conditions. See also our Knowledge Base article about threading:
3354 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003355 *
3356 * Module: library/threading.c
3357 *
3358 * This allows different threading implementations (self-implemented or
3359 * provided).
3360 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * You will have to enable either MBEDTLS_THREADING_ALT or
3362 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003363 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003364 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003367
3368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003370 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003371 * Enable the semi-portable timing interface.
3372 *
Simon Butcherd567a232016-03-09 20:19:21 +00003373 * \note The provided implementation only works on POSIX/Unix (including Linux,
3374 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003375 * module and provide your own implementations of the callbacks needed by
3376 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3377 * your own implementation of the whole module by setting
3378 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003379 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003380 * \note See also our Knowledge Base article about porting to a new
3381 * environment:
3382 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3383 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003384 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003387
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003390 *
3391 * Enable run-time version information.
3392 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003393 * Module: library/version.c
3394 *
3395 * This module provides run-time version information.
3396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003398
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003401 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003402 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003403 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003404 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003405 * Caller: library/x509_crl.c
3406 * library/x509_crt.c
3407 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003408 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3410 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003411 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003412 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003415
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003418 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003419 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003420 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003421 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003422 * Caller: library/ssl_cli.c
3423 * library/ssl_srv.c
3424 * library/ssl_tls.c
3425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003427 *
3428 * This module is required for X.509 certificate parsing.
3429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003431
3432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003434 *
3435 * Enable X.509 CRL parsing.
3436 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003437 * Module: library/x509_crl.c
3438 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003439 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003441 *
3442 * This module is required for X.509 CRL parsing.
3443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003445
3446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003448 *
3449 * Enable X.509 Certificate Signing Request (CSR) parsing.
3450 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003451 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003452 * Caller: library/x509_crt_write.c
3453 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003455 *
3456 * This module is used for reading X.509 certificate request.
3457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003459
3460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003462 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003463 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003464 *
3465 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003466 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003468 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003469 * This module is the basis for creating X.509 certificates and CSRs.
3470 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003471#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003472
3473/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003475 *
3476 * Enable creating X.509 certificates.
3477 *
3478 * Module: library/x509_crt_write.c
3479 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003481 *
3482 * This module is required for X.509 certificate creation.
3483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003485
3486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003488 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003489 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003490 *
3491 * Module: library/x509_csr_write.c
3492 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003494 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003495 * This module is required for X.509 certificate request writing.
3496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003498
3499/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003500 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003501 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003502 * Enable the XTEA block cipher.
3503 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003504 * Module: library/xtea.c
3505 * Caller:
3506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003508
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003509/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003510
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003511/**
3512 * \name SECTION: Module configuration options
3513 *
3514 * This section allows for the setting of module specific sizes and
3515 * configuration options. The default values are already present in the
3516 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003517 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003518 * Our advice is to enable options and change their values here
3519 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003520 *
3521 * Please check the respective header file for documentation on these
3522 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003523 * \{
3524 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003525
Paul Bakker088c5c52014-04-25 11:11:10 +02003526/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003527//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003528//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003529
Paul Bakker088c5c52014-04-25 11:11:10 +02003530/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003531//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3532//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3533//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3534//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3535//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003536
Paul Bakker088c5c52014-04-25 11:11:10 +02003537/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3539//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3540//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3541//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003542
Paul Bakker088c5c52014-04-25 11:11:10 +02003543/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3545//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3546//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003547
Paul Bakker088c5c52014-04-25 11:11:10 +02003548/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3550//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003551//#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 +01003552
Paul Bakker088c5c52014-04-25 11:11:10 +02003553/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003555
Paul Bakker088c5c52014-04-25 11:11:10 +02003556/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557//#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 +02003558//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3560//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003561//#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 +02003562//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3563//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003564/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003566//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3567//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003568//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3569//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3570//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3573/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003574//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3576//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003577//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3578//#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 +02003579//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3580//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003581/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003583//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003584//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3585//#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 +02003586
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003587/**
3588 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003589 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003590 * (see the documentation of that option for context).
3591 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003592 * When you leave this undefined here, the library provides
3593 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3594 * is defined, the default definition is `assert(cond)`,
3595 * otherwise the default definition calls a function
3596 * mbedtls_param_failed(). This function is declared in
3597 * `platform_util.h` for the benefit of the library, but
3598 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003599 *
3600 * When you define this here, this replaces the default
3601 * definition in platform_util.h (which no longer declares the
3602 * function mbedtls_param_failed()) and it is your responsibility
3603 * to make sure this macro expands to something suitable (in
3604 * particular, that all the necessary declarations are visible
3605 * from within the library - you can ensure that by providing
3606 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003607 * If you define this macro to call `assert`, also define
3608 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3609 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003610 *
3611 * Note that you may define this macro to expand to nothing, in
3612 * which case you don't have to worry about declarations or
3613 * definitions. However, you will then be notified about invalid
3614 * parameters only in non-void functions, and void function will
3615 * just silently return early on invalid parameters, which
3616 * partially negates the benefits of enabling
3617 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3618 *
3619 * \param cond The expression that should evaluate to true, but doesn't.
3620 */
3621//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3622
Gilles Peskineed038902020-11-13 21:33:21 +01003623/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003624/**
Gilles Peskineed038902020-11-13 21:33:21 +01003625 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3626 * PSA crypto subsystem.
3627 *
3628 * If this option is unset:
3629 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003630 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003631 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3632 * on unspecified heuristics.
3633 */
3634//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3635
Paul Bakker088c5c52014-04-25 11:11:10 +02003636/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003637//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3638//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003639
Paul Bakker088c5c52014-04-25 11:11:10 +02003640/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003641
3642/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3643 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003644 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003645 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003646 * This determines the size of both the incoming and outgoing TLS I/O buffers
3647 * in such a way that both are capable of holding the specified amount of
3648 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003649 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003650 * To configure incoming and outgoing I/O buffers separately, use
3651 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3652 * which overwrite the value set by this option.
3653 *
3654 * \note When using a value less than the default of 16KB on the client, it is
3655 * recommended to use the Maximum Fragment Length (MFL) extension to
3656 * inform the server about this limitation. On the server, there
3657 * is no supported, standardized way of informing the client about
3658 * restriction on the maximum size of incoming messages, and unless
3659 * the limitation has been communicated by other means, it is recommended
3660 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3661 * while keeping the default value of 16KB for the incoming buffer.
3662 *
3663 * Uncomment to set the maximum plaintext size of both
3664 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003665 */
3666//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3667
3668/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3669 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003670 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003671 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003672 * This determines the size of the incoming TLS I/O buffer in such a way
3673 * that it is capable of holding the specified amount of plaintext data,
3674 * regardless of the protection mechanism used.
3675 *
3676 * If this option is undefined, it inherits its value from
3677 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3678 *
3679 * \note When using a value less than the default of 16KB on the client, it is
3680 * recommended to use the Maximum Fragment Length (MFL) extension to
3681 * inform the server about this limitation. On the server, there
3682 * is no supported, standardized way of informing the client about
3683 * restriction on the maximum size of incoming messages, and unless
3684 * the limitation has been communicated by other means, it is recommended
3685 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3686 * while keeping the default value of 16KB for the incoming buffer.
3687 *
3688 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3689 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003690 */
3691//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3692
Gilles Peskined3d02902020-03-04 21:35:27 +01003693/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3694 *
3695 * The maximum length of CIDs used for incoming DTLS messages.
3696 *
3697 */
3698//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3699
3700/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3701 *
3702 * The maximum length of CIDs used for outgoing DTLS messages.
3703 *
3704 */
3705//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3706
3707/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3708 *
3709 * This option controls the use of record plaintext padding
3710 * when using the Connection ID extension in DTLS 1.2.
3711 *
3712 * The padding will always be chosen so that the length of the
3713 * padded plaintext is a multiple of the value of this option.
3714 *
3715 * Note: A value of \c 1 means that no padding will be used
3716 * for outgoing records.
3717 *
3718 * Note: On systems lacking division instructions,
3719 * a power of two should be preferred.
3720 *
3721 */
3722//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3723
Hanno Beckerceef8482020-06-02 06:16:00 +01003724/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003725 *
3726 * This option controls the use of record plaintext padding
3727 * in TLS 1.3.
3728 *
3729 * The padding will always be chosen so that the length of the
3730 * padded plaintext is a multiple of the value of this option.
3731 *
3732 * Note: A value of \c 1 means that no padding will be used
3733 * for outgoing records.
3734 *
3735 * Note: On systems lacking division instructions,
3736 * a power of two should be preferred.
3737 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003738//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003739
Angus Grattond8213d02016-05-25 20:56:48 +10003740/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3741 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003742 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003743 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003744 * This determines the size of the outgoing TLS I/O buffer in such a way
3745 * that it is capable of holding the specified amount of plaintext data,
3746 * regardless of the protection mechanism used.
3747 *
3748 * If this option undefined, it inherits its value from
3749 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003750 *
3751 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3752 * the default inward 16384 byte buffer to conform to the TLS specification.
3753 *
3754 * The minimum required outward buffer size is determined by the handshake
3755 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3756 * The specific size requirement depends on the configured ciphers and any
3757 * certificate data which is sent during the handshake.
3758 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003759 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3760 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003761 */
3762//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3763
Hanno Beckere0b150f2018-08-21 15:51:03 +01003764/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3765 *
3766 * Maximum number of heap-allocated bytes for the purpose of
3767 * DTLS handshake message reassembly and future message buffering.
3768 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003769 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003770 * to account for a reassembled handshake message of maximum size,
3771 * together with its reassembly bitmap.
3772 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003773 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003774 * should be sufficient for all practical situations as it allows
3775 * to reassembly a large handshake message (such as a certificate)
3776 * while buffering multiple smaller handshake messages.
3777 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003778 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003779//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3782//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3783//#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 +02003784
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003785/**
3786 * Complete list of ciphersuites to use, in order of preference.
3787 *
3788 * \warning No dependency checking is done on that field! This option can only
3789 * be used to restrict the set of available ciphersuites. It is your
3790 * responsibility to make sure the needed modules are active.
3791 *
3792 * Use this to save a few hundred bytes of ROM (default ordering of all
3793 * available ciphersuites) and a few to a few hundred bytes of RAM.
3794 *
3795 * The value below is only an example, not the default.
3796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797//#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 +02003798
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003799/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003801//#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 +01003802
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003803/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003804 * Allow SHA-1 in the default TLS configuration for certificate signing.
3805 * Without this build-time option, SHA-1 support must be activated explicitly
3806 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003807 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003808 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003809 *
3810 * \warning SHA-1 is considered a weak message digest and its use constitutes
3811 * a security risk. If possible, we recommend avoiding dependencies
3812 * on it, and considering stronger message digests instead.
3813 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003814 */
Gilles Peskined3d02902020-03-04 21:35:27 +01003815//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003816
3817/**
3818 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3819 * signature and ciphersuite selection. Without this build-time option, SHA-1
3820 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3821 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3822 * default. At the time of writing, there is no practical attack on the use
3823 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003824 * to preserve compatibility with existing peers, but the general
3825 * warning applies nonetheless:
3826 *
3827 * \warning SHA-1 is considered a weak message digest and its use constitutes
3828 * a security risk. If possible, we recommend avoiding dependencies
3829 * on it, and considering stronger message digests instead.
3830 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003831 */
3832#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003833
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003834/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003835 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003836 * mbedtls_platform_zeroize(). This replaces the default implementation in
3837 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003838 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003839 * mbedtls_platform_zeroize() is a widely used function across the library to
3840 * zero a block of memory. The implementation is expected to be secure in the
3841 * sense that it has been written to prevent the compiler from removing calls
3842 * to mbedtls_platform_zeroize() as part of redundant code elimination
3843 * optimizations. However, it is difficult to guarantee that calls to
3844 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3845 * versions of the C language standards do not provide a secure implementation
3846 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3847 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003848 * example by using directives specific to their compiler, features from newer
3849 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003850 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003851 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003852//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003853
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003854/**
3855 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003856 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003857 * platform_util.c.
3858 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003859 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003860 * library will try to use safer implementations of this function, such as
3861 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003862 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003863 * using the standard gmtime(). In this case, calls from the library to
3864 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003865 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003866 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003867 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3868 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3869 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003870 */
Hanno Becker6a739782018-09-05 15:06:19 +01003871//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003872
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003873/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003874 * Enable the verified implementations of ECDH primitives from Project Everest
3875 * (currently only Curve25519). This feature changes the layout of ECDH
3876 * contexts and therefore is a compatibility break for applications that access
3877 * fields of a mbedtls_ecdh_context structure directly. See also
3878 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003879 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003880//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003881
Simon Butcher30b5f972016-06-08 19:00:23 +01003882/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003883
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003884/* Target and application specific configurations
3885 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003886 * Allow user to override any previous default.
3887 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003888 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003889#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003890#include MBEDTLS_USER_CONFIG_FILE
3891#endif
3892
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003893#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07003894#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003895#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07003896
Jaeden Amero6609aef2019-07-04 20:01:14 +01003897#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003898
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003899#endif /* MBEDTLS_CONFIG_H */