blob: f6647f009ab8f6152f448c8b919f426e2b2cf1cc [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
Chris Jones4c5819c2021-03-03 17:45:34 +000051 * library/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
Chris Jones3848e312021-03-11 16:17:59 +0000550 * prototype as declared in library/entropy_poll.h, and accept NULL as first
551 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200552 *
553 * Uncomment to use your own hardware entropy collector.
554 */
555//#define MBEDTLS_ENTROPY_HARDWARE_ALT
556
557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000559 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100560 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000561 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 * Uncomment this macro to use precomputed AES tables stored in ROM.
563 * Comment this macro to generate AES tables in RAM at runtime.
564 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100565 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
566 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100567 * initialization time before the first AES operation can be performed.
568 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
569 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
570 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 *
572 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
573 *
Paul Bakker15566e42011-04-24 21:19:15 +0000574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000576
577/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100578 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200579 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100580 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200581 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100582 * Uncommenting this macro omits 75% of the AES tables from
583 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
584 * by computing their values on the fly during operations
585 * (the tables are entry-wise rotations of one another).
586 *
587 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100588 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100589 * runtime. Specifically, one has to compare 4 accesses within
590 * different tables to 4 accesses with additional arithmetic
591 * operations within the same table. The performance gain/loss
592 * depends on the system and memory details.
593 *
594 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
595 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200596 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100597//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200598
599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200601 *
602 * Use less ROM for the Camellia implementation (saves about 768 bytes).
603 *
604 * Uncomment this macro to use less memory for Camellia.
605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200607
608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200610 *
611 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200614
615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000617 *
618 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000621
622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000624 *
625 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000628
629/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100630 * \def MBEDTLS_CIPHER_MODE_OFB
631 *
632 * Enable Output Feedback mode (OFB) for symmetric ciphers.
633 */
634#define MBEDTLS_CIPHER_MODE_OFB
635
636/**
637 * \def MBEDTLS_CIPHER_MODE_XTS
638 *
639 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
640 */
641#define MBEDTLS_CIPHER_MODE_XTS
642
643/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000645 *
646 * Enable NULL cipher.
647 * Warning: Only do so when you know what you are doing. This allows for
648 * encryption or channels without any security!
649 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000651 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
653 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
654 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
655 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
656 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
657 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
658 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
659 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
660 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
661 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
662 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
663 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
664 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
665 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
666 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
667 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
668 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
669 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
670 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000671 *
672 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000675
676/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100677 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200678 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100679 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
680 * specific padding modes in the cipher layer with cipher modes that support
681 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200682 *
683 * If you disable all padding modes, only full blocks can be used with CBC.
684 *
685 * Enable padding modes in the cipher layer.
686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687#define MBEDTLS_CIPHER_PADDING_PKCS7
688#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
689#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
690#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200691
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200692/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
693 *
694 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
695 * By default, CTR_DRBG uses a 256-bit key.
696 */
697//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
698
Paul Bakker48e93c82013-08-14 12:21:18 +0200699/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000701 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200702 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000703 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000704 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000705 *
706 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
708 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000709 *
710 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100711 *
712 * \warning DES is considered a weak cipher and its use constitutes a
713 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000714 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000716
717/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200719 *
720 * Remove RC4 ciphersuites by default in SSL / TLS.
721 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200723 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200724 * explicitly.
725 *
726 * Uncomment this macro to remove RC4 ciphersuites by default.
727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200728#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200729
730/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000731 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
732 *
733 * Remove 3DES ciphersuites by default in SSL / TLS.
734 * This flag removes the ciphersuites based on 3DES from the default list as
735 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
736 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
737 * them explicitly.
738 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000739 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000740 * a TLS connection using a 3DES based cipher suite (see "On the Practical
741 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
742 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
743 * in your threat model or you are unsure, then you should keep this option
744 * enabled to remove 3DES based cipher suites.
745 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000746 * Comment this macro to keep 3DES in the default ciphersuite list.
747 */
748#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
749
750/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100751 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200752 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100753 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
754 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200755 *
756 * Comment macros to disable the curve and functions for it
757 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200758/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
761#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
762#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
763#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
764#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
765#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
766#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
767#define MBEDTLS_ECP_DP_BP256R1_ENABLED
768#define MBEDTLS_ECP_DP_BP384R1_ENABLED
769#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200770/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200771#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000772#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200773
774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200776 *
777 * Enable specific 'modulo p' routines for each NIST prime.
778 * Depending on the prime and architecture, makes operations 4 to 8 times
779 * faster on the corresponding curve.
780 *
781 * Comment this macro to disable NIST curves optimisation.
782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200784
785/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200786 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
787 *
788 * When this option is disabled, mbedtls_ecp_mul() will make use of an
789 * internal RNG when called with a NULL \c f_rng argument, in order to protect
790 * against some side-channel attacks.
791 *
792 * This protection introduces a dependency of the ECP module on one of the
793 * DRBG modules. For very constrained implementations that don't require this
794 * protection (for example, because you're only doing signature verification,
795 * so not manipulating any secret, or because local/physical side-channel
796 * attacks are outside your threat model), it might be desirable to get rid of
797 * that dependency.
798 *
799 * \warning Enabling this option makes some uses of ECP vulnerable to some
800 * side-channel attacks. Only enable it if you know that's not a problem for
801 * your use case.
802 *
803 * Uncomment this macro to disable some counter-measures in ECP.
804 */
805//#define MBEDTLS_ECP_NO_INTERNAL_RNG
806
807/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200808 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100809 *
810 * Enable "non-blocking" ECC operations that can return early and be resumed.
811 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200812 * This allows various functions to pause by returning
813 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
814 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
815 * order to further progress and eventually complete their operation. This is
816 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
817 * number of ECC operations a function may perform before pausing; see
818 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100819 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200820 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200821 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100822 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200823 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200824 *
Ron Eldor19779c42018-11-05 16:58:13 +0200825 * \note This option only works with the default software implementation of
826 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100827 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
828 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100829 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200830//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100831
832/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100833 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
834 *
835 * Use a backward compatible ECDH context.
836 *
837 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
838 * defined in `ecdh.h`). For most applications, the choice of format makes
839 * no difference, since all library functions can work with either format,
840 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
841
842 * The new format used when this option is disabled is smaller
843 * (56 bytes on a 32-bit platform). In future versions of the library, it
844 * will support alternative implementations of ECDH operations.
845 * The new format is incompatible with applications that access
846 * context fields directly and with restartable ECP operations.
847 *
848 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
849 * want to access ECDH context fields directly. Otherwise you should
850 * comment out this macro definition.
851 *
852 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
853 *
854 * \note This configuration option is experimental. Future versions of the
855 * library may modify the way the ECDH context layout is configured
856 * and may modify the layout of the new context type.
857 */
858#define MBEDTLS_ECDH_LEGACY_CONTEXT
859
860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100862 *
863 * Enable deterministic ECDSA (RFC 6979).
864 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
865 * may result in a compromise of the long-term signing key. This is avoided by
866 * the deterministic variant.
867 *
John Durkop36a82e52020-10-26 09:39:05 -0700868 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100869 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100870 * Comment this macro to disable deterministic ECDSA.
871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100873
874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200876 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200877 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200878 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200879 * This enables the following ciphersuites (if other requisites are
880 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
882 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
883 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
884 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
885 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
886 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
887 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
888 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
889 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
890 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
891 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
892 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200895
896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200899 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200902 *
903 * This enables the following ciphersuites (if other requisites are
904 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
906 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
907 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
908 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
909 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
910 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
911 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
912 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
913 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
914 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
915 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
916 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100917 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100918 * \warning Using DHE constitutes a security risk as it
919 * is not possible to validate custom DH parameters.
920 * If possible, it is recommended users should consider
921 * preferring other methods of key exchange.
922 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100923 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200926
927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200929 *
930 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200933 *
934 * This enables the following ciphersuites (if other requisites are
935 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
937 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
938 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
939 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
940 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
941 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
942 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
943 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200946
947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200949 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200950 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200951 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200952 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
953 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200954 *
955 * This enables the following ciphersuites (if other requisites are
956 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
958 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
959 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
960 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
961 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
962 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
963 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
964 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
965 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
966 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
967 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
968 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200971
972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200974 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200975 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200976 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
978 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200979 *
980 * This enables the following ciphersuites (if other requisites are
981 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
983 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
984 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
985 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
986 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
987 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
988 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
989 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
990 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
991 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
992 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
993 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
994 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
995 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
996 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +0200997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200999
1000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001002 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001003 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1006 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001007 *
1008 * This enables the following ciphersuites (if other requisites are
1009 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1011 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1012 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1013 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1014 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1015 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1016 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1017 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1018 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1019 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1020 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1021 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1022 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001023 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001024 * \warning Using DHE constitutes a security risk as it
1025 * is not possible to validate custom DH parameters.
1026 * If possible, it is recommended users should consider
1027 * preferring other methods of key exchange.
1028 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001029 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001032
1033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001035 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001036 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1039 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001040 *
1041 * This enables the following ciphersuites (if other requisites are
1042 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1044 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1045 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1046 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1047 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1048 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1049 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1050 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1051 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1052 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1053 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1054 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001057
1058/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001060 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001061 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001062 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001064 *
1065 * This enables the following ciphersuites (if other requisites are
1066 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1068 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1069 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1070 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1071 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1072 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1073 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1074 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1075 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1076 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1077 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1078 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001081
1082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001084 *
1085 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1086 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001087 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001088 *
1089 * This enables the following ciphersuites (if other requisites are
1090 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1092 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1093 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1094 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1095 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1096 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1097 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1098 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1099 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1100 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1101 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1102 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001105
1106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001108 *
1109 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1110 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001111 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001112 *
1113 * This enables the following ciphersuites (if other requisites are
1114 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1116 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1117 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1118 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1120 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1121 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1122 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1123 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1124 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1125 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1126 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001129
1130/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001131 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1132 *
1133 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1134 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001135 * \warning This is currently experimental. EC J-PAKE support is based on the
1136 * Thread v1.0.0 specification; incompatible changes to the specification
1137 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001138 *
1139 * Requires: MBEDTLS_ECJPAKE_C
1140 * MBEDTLS_SHA256_C
1141 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1142 *
1143 * This enables the following ciphersuites (if other requisites are
1144 * enabled as well):
1145 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1146 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001147//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001148
1149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001151 *
1152 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1153 * RFC 5915 and RFC 5480.
1154 *
1155 * Currently this means parsing the SpecifiedECDomain choice of EC
1156 * parameters (only known groups are supported, not arbitrary domains, to
1157 * avoid validation issues).
1158 *
1159 * Disable if you only need to support RFC 5915 + 5480 key formats.
1160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001162
1163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001165 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 * Enable a dummy error function to make use of mbedtls_strerror() in
1167 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1168 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1171 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001172 *
1173 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001177
1178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001180 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001181 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001182 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001186
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001189 *
1190 * Enable functions that use the filesystem.
1191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001193
1194/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001196 *
Mateusz Starzyk0fdcc8e2021-01-29 16:46:31 +01001197 * Do not add default entropy sources. These are the platform specific
1198 * or mbedtls_timing_hardclock poll function.
Paul Bakker43655f42011-12-15 20:11:16 +00001199 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001200 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001201 * application.
1202 *
1203 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001206
1207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001209 *
1210 * Do not use built-in platform entropy functions.
1211 * This is useful if your platform does not support
1212 * standards like the /dev/urandom or Windows CryptoAPI.
1213 *
1214 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001217
1218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001220 *
1221 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1222 * default SHA-512 based one (if both are available).
1223 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001225 *
1226 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1227 * if you have performance concerns.
1228 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229 * This option is only useful if both MBEDTLS_SHA256_C and
1230 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001231 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001232//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001233
1234/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001235 * \def MBEDTLS_ENTROPY_NV_SEED
1236 *
1237 * Enable the non-volatile (NV) seed file-based entropy source.
1238 * (Also enables the NV seed read/write functions in the platform layer)
1239 *
1240 * This is crucial (if not required) on systems that do not have a
1241 * cryptographic entropy source (in hardware or kernel) available.
1242 *
1243 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1244 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001245 * \note The read/write functions that are used by the entropy source are
1246 * determined in the platform layer, and can be modified at runtime and/or
1247 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1248 *
1249 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001250 * with regular fopen(), please make sure you make a seedfile with the
1251 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1252 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001253 * and written to or you will get an entropy source error! The default
1254 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1255 * bytes from the file.
1256 *
1257 * \note The entropy collector will write to the seed file before entropy is
1258 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001259 */
1260//#define MBEDTLS_ENTROPY_NV_SEED
1261
Ronald Cron71016a92020-08-28 19:01:50 +02001262/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001263 *
Ronald Cron71016a92020-08-28 19:01:50 +02001264 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001265 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001266 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1267 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001268 *
1269 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001270 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001271 */
Ronald Cron71016a92020-08-28 19:01:50 +02001272//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001273
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001274/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001276 *
1277 * Enable debugging of buffer allocator memory issues. Automatically prints
1278 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1279 * function for 'debug output' of allocated memory.
1280 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001281 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001282 *
1283 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001286
1287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001289 *
1290 * Include backtrace information with each allocated block.
1291 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001293 * GLIBC-compatible backtrace() an backtrace_symbols() support
1294 *
1295 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001298
1299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001301 *
1302 * Support external private RSA keys (eg from a HSM) in the PK layer.
1303 *
1304 * Comment this macro to disable support for external private RSA keys.
1305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001307
1308/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001310 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001311 * Enable support for PKCS#1 v1.5 encoding.
1312 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001314 *
Paul Bakker48377d92013-08-30 12:06:24 +02001315 * This enables support for PKCS#1 v1.5 operations.
1316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001318
1319/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001321 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001322 * Enable support for PKCS#1 v2.1 encoding.
1323 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001325 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001326 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001329
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001330/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1331 *
1332 * Enable support for the experimental PSA crypto driver interface.
1333 *
John Durkop185764f2020-10-12 21:32:12 -07001334 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001335 *
1336 * \warning This interface is experimental and may change or be removed
1337 * without notice.
1338 */
1339//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1340
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001341/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1342 *
1343 * Make the PSA Crypto module use an external random generator provided
1344 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1345 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001346 * \note This random generator must deliver random numbers with cryptographic
1347 * quality and high performance. It must supply unpredictable numbers
1348 * with a uniform distribution. The implementation of this function
1349 * is responsible for ensuring that the random generator is seeded
1350 * with sufficient entropy. If you have a hardware TRNG which is slow
1351 * or delivers non-uniform output, declare it as an entropy source
1352 * with mbedtls_entropy_add_source() instead of enabling this option.
1353 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001354 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001355 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1356 * and define a function called mbedtls_psa_external_get_random()
1357 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001358 * ```
1359 * psa_status_t mbedtls_psa_external_get_random(
1360 * mbedtls_psa_external_random_context_t *context,
1361 * uint8_t *output, size_t output_size, size_t *output_length);
1362 * );
1363 * ```
1364 * The \c context value is initialized to 0 before the first call.
1365 * The function must fill the \c output buffer with \p output_size bytes
1366 * of random data and set \c *output_length to \p output_size.
1367 *
1368 * Requires: MBEDTLS_PSA_CRYPTO_C
1369 *
1370 * \warning If you enable this option, code that uses the PSA cryptography
1371 * interface will not use any of the entropy sources set up for
1372 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1373 * enables.
1374 *
1375 * \note This option is experimental and may be removed without notice.
1376 */
1377//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1378
Paul Bakker9dcc3222011-03-08 14:16:06 +00001379/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001380 * \def MBEDTLS_PSA_CRYPTO_SPM
1381 *
1382 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1383 * Partition Manager) integration which separates the code into two parts: a
1384 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1385 * Environment).
1386 *
1387 * Module: library/psa_crypto.c
1388 * Requires: MBEDTLS_PSA_CRYPTO_C
1389 *
1390 */
1391//#define MBEDTLS_PSA_CRYPTO_SPM
1392
1393/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001394 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001395 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001396 * Enable support for entropy injection at first boot. This feature is
1397 * required on systems that do not have a built-in entropy source (TRNG).
1398 * This feature is currently not supported on systems that have a built-in
1399 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001400 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001401 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001402 *
1403 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001404//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001405
1406/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001408 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001409 * Do not use the Chinese Remainder Theorem
1410 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001411 *
1412 * Uncomment this macro to disable the use of CRT in RSA.
1413 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001415//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001416
1417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001419 *
1420 * Enable the checkup functions (*_self_test).
1421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001422#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001423
1424/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001425 * \def MBEDTLS_SHA256_SMALLER
1426 *
1427 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1428 * lower performance.
1429 *
1430 * The default implementation is meant to be a reasonnable compromise between
1431 * performance and size. This version optimizes more aggressively for size at
1432 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1433 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1434 * 30%.
1435 *
1436 * Uncomment to enable the smaller implementation of SHA256.
1437 */
1438//#define MBEDTLS_SHA256_SMALLER
1439
1440/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001441 * \def MBEDTLS_SHA512_SMALLER
1442 *
1443 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1444 * lower performance.
1445 *
1446 * Uncomment to enable the smaller implementation of SHA512.
1447 */
1448//#define MBEDTLS_SHA512_SMALLER
1449
1450/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001451 * \def MBEDTLS_SHA512_NO_SHA384
1452 *
1453 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1454 * code size on devices that don't use SHA-384.
1455 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001456 * Requires: MBEDTLS_SHA512_C
1457 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001458 * Uncomment to disable SHA-384
1459 */
1460//#define MBEDTLS_SHA512_NO_SHA384
1461
1462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001464 *
1465 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001466 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001467 * with other servers, only debugging of failures is harder.
1468 *
1469 * The advantage of not sending alert messages, is that no information is given
1470 * about reasons for failures thus preventing adversaries of gaining intel.
1471 *
1472 * Enable sending of all alert messages
1473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001475
1476/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001477 * \def MBEDTLS_SSL_RECORD_CHECKING
1478 *
1479 * Enable the function mbedtls_ssl_check_record() which can be used to check
1480 * the validity and authenticity of an incoming record, to verify that it has
1481 * not been seen before. These checks are performed without modifying the
1482 * externally visible state of the SSL context.
1483 *
1484 * See mbedtls_ssl_check_record() for more information.
1485 *
1486 * Uncomment to enable support for record checking.
1487 */
1488#define MBEDTLS_SSL_RECORD_CHECKING
1489
1490/**
1491 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1492 *
1493 * Enable support for the DTLS Connection ID extension
1494 * (version draft-ietf-tls-dtls-connection-id-05,
1495 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1496 * which allows to identify DTLS connections across changes
1497 * in the underlying transport.
1498 *
1499 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1500 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1501 * See the corresponding documentation for more information.
1502 *
1503 * \warning The Connection ID extension is still in draft state.
1504 * We make no stability promises for the availability
1505 * or the shape of the API controlled by this option.
1506 *
1507 * The maximum lengths of outgoing and incoming CIDs can be configured
1508 * through the options
1509 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1510 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1511 *
1512 * Requires: MBEDTLS_SSL_PROTO_DTLS
1513 *
1514 * Uncomment to enable the Connection ID extension.
1515 */
1516//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1517
1518/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001519 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1520 *
1521 * Enable asynchronous external private key operations in SSL. This allows
1522 * you to configure an SSL connection to call an external cryptographic
1523 * module to perform private key operations instead of performing the
1524 * operation inside the library.
1525 *
1526 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001527//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001528
1529/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001530 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1531 *
1532 * Enable serialization of the TLS context structures, through use of the
1533 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1534 *
1535 * This pair of functions allows one side of a connection to serialize the
1536 * context associated with the connection, then free or re-use that context
1537 * while the serialized state is persisted elsewhere, and finally deserialize
1538 * that state to a live context for resuming read/write operations on the
1539 * connection. From a protocol perspective, the state of the connection is
1540 * unaffected, in particular this is entirely transparent to the peer.
1541 *
1542 * Note: this is distinct from TLS session resumption, which is part of the
1543 * protocol and fully visible by the peer. TLS session resumption enables
1544 * establishing new connections associated to a saved session with shorter,
1545 * lighter handshakes, while context serialization is a local optimization in
1546 * handling a single, potentially long-lived connection.
1547 *
1548 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1549 * saved after the handshake to allow for more efficient serialization, so if
1550 * you don't need this feature you'll save RAM by disabling it.
1551 *
1552 * Comment to disable the context serialization APIs.
1553 */
1554#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1555
1556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001558 *
1559 * Enable the debug messages in SSL module for all issues.
1560 * Debug messages have been disabled in some places to prevent timing
1561 * attacks due to (unbalanced) debugging function calls.
1562 *
1563 * If you need all error reporting you should enable this during debugging,
1564 * but remove this for production servers that should log as well.
1565 *
1566 * Uncomment this macro to report all debug messages on errors introducing
1567 * a timing side-channel.
1568 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001573 *
1574 * Enable support for Encrypt-then-MAC, RFC 7366.
1575 *
1576 * This allows peers that both support it to use a more robust protection for
1577 * ciphersuites using CBC, providing deep resistance against timing attacks
1578 * on the padding or underlying cipher.
1579 *
1580 * This only affects CBC ciphersuites, and is useless if none is defined.
1581 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1583 * MBEDTLS_SSL_PROTO_TLS1_1 or
1584 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001585 *
1586 * Comment this macro to disable support for Encrypt-then-MAC
1587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001591 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001592 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1593 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001594 *
1595 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1596 * attacks, but it is recommended to always use it (even if you disable
1597 * renegotiation), since it actually fixes a more fundamental issue in the
1598 * original SSL/TLS design, and has implications beyond Triple Handshake.
1599 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1601 * MBEDTLS_SSL_PROTO_TLS1_1 or
1602 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001603 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001604 * Comment this macro to disable support for Extended Master Secret.
1605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001607
Paul Bakkerd66f0702013-01-31 16:57:45 +01001608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001610 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001611 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1612 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001613 *
1614 * For servers, it is recommended to always enable this, unless you support
1615 * only one version of TLS, or know for sure that none of your clients
1616 * implements a fallback strategy.
1617 *
1618 * For clients, you only need this if you're using a fallback strategy, which
1619 * is not recommended in the first place, unless you absolutely need it to
1620 * interoperate with buggy (version-intolerant) servers.
1621 *
1622 * Comment this macro to disable support for FALLBACK_SCSV
1623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001625
1626/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001627 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1628 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001629 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001630 * giving access to the peer's certificate after completion of the handshake.
1631 *
1632 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1633 * recommended to disable this option for reduced RAM usage.
1634 *
1635 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1636 * defined, but always returns \c NULL.
1637 *
1638 * \note This option has no influence on the protection against the
1639 * triple handshake attack. Even if it is disabled, Mbed TLS will
1640 * still ensure that certificates do not change during renegotiation,
1641 * for exaple by keeping a hash of the peer's certificate.
1642 *
1643 * Comment this macro to disable storing the peer's certificate
1644 * after the handshake.
1645 */
1646#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1647
1648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001650 *
1651 * Enable hooking functions in SSL module for hardware acceleration of
1652 * individual records.
1653 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001654 * \deprecated This option is deprecated and will be removed in a future
1655 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001656 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001657 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001660
1661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001663 *
1664 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1665 *
1666 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1667 * of interoperability issues compared to sending 0-length records.
1668 *
1669 * Comment this macro to disable 1/n-1 record splitting.
1670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001672
1673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001674 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001675 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001676 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001677 *
1678 * The two main uses of renegotiation are (1) refresh keys on long-lived
1679 * connections and (2) client authentication after the initial handshake.
1680 * If you don't need renegotiation, it's probably better to disable it, since
1681 * it has been associated with security issues in the past and is easy to
1682 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001683 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001684 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001685 *
1686 * \note Even if this option is disabled, both client and server are aware
1687 * of the Renegotiation Indication Extension (RFC 5746) used to
1688 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1689 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1690 * configuration of this extension).
1691 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001694
1695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001697 *
1698 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001700 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001701 * \deprecated This option is deprecated and will be removed in a future
1702 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001703 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001704 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001707
1708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001710 *
1711 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001713 *
1714 * Uncomment this macro to respect client's ciphersuite order
1715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001717
1718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001720 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001721 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001722 *
1723 * Comment this macro to disable support for the max_fragment_length extension
1724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001726
1727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001729 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001730 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001731 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 * Requires: MBEDTLS_MD5_C
1733 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001734 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001735 * \deprecated This option is deprecated and will be removed in a future
1736 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001737 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001738 * Comment this macro to disable support for SSL 3.0
1739 */
Janos Follathe2681a42016-03-07 15:57:05 +00001740//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001741
1742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001744 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001745 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001746 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001747 * Requires: MBEDTLS_MD5_C
1748 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001749 *
1750 * Comment this macro to disable support for TLS 1.0
1751 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001753
1754/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001756 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001757 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001758 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 * Requires: MBEDTLS_MD5_C
1760 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001761 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001762 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001765
1766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001768 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001769 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001770 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001772 * (Depends on ciphersuites)
1773 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001774 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001777
1778/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001779 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1780 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001781 * This macro is used to selectively enable experimental parts
1782 * of the code that contribute to the ongoing development of
1783 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1784 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001785 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001786 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1787 * and no feature exposed through this macro is part of the
1788 * public API. In particular, features under the control
1789 * of this macro are experimental and don't come with any
1790 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001791 *
1792 * Uncomment this macro to enable experimental and partial
1793 * functionality specific to TLS 1.3.
1794 */
Hanno Beckere4160602020-05-07 15:11:45 +01001795//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001796
1797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001799 *
1800 * Enable support for DTLS (all available versions).
1801 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1803 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001804 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1806 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001807 *
1808 * Comment this macro to disable support for DTLS
1809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001811
1812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001814 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001815 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001816 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001817 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001820
1821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001823 *
1824 * Enable support for the anti-replay mechanism in DTLS.
1825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * Requires: MBEDTLS_SSL_TLS_C
1827 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001828 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001829 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001830 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001831 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001832 * Comment this to disable anti-replay in DTLS.
1833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001835
1836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001838 *
1839 * Enable support for HelloVerifyRequest on DTLS servers.
1840 *
1841 * This feature is highly recommended to prevent DTLS servers being used as
1842 * amplifiers in DoS attacks against other hosts. It should always be enabled
1843 * unless you know for sure amplification cannot be a problem in the
1844 * environment in which your server operates.
1845 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001846 * \warning Disabling this can ba a security risk! (see above)
1847 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001848 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001849 *
1850 * Comment this to disable support for HelloVerifyRequest.
1851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001853
1854/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001855 * \def MBEDTLS_SSL_DTLS_SRTP
1856 *
Johan Pascal842d6712020-09-23 13:34:40 +02001857 * Enable support for negotation of DTLS-SRTP (RFC 5764)
1858 * through the use_srtp extension.
1859 *
1860 * \note This feature provides the minimum functionality required
1861 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1862 * the associated SRTP packet protection key material.
1863 * In particular, the SRTP packet protection itself, as well as the
1864 * demultiplexing of RTP and DTLS packets at the datagram layer
1865 * (see Section 5 of RFC 5764), are not handled by this feature.
1866 * Instead, after successful completion of a handshake negotiating
1867 * the use of DTLS-SRTP, the extended key exporter API
1868 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1869 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1870 * (this is implemented in the SSL example programs).
1871 * The resulting key should then be passed to an SRTP stack.
1872 *
1873 * Setting this option enables the runtime API
1874 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1875 * through which the supported DTLS-SRTP protection
1876 * profiles can be configured. You must call this API at
1877 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001878 *
1879 * Requires: MBEDTLS_SSL_PROTO_DTLS
1880 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001881 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001882 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001883//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001884
1885/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001886 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1887 *
1888 * Enable server-side support for clients that reconnect from the same port.
1889 *
1890 * Some clients unexpectedly close the connection and try to reconnect using the
1891 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001892 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001893 * flag enables that support.
1894 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001895 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001896 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001897 * Comment this to disable support for clients reusing the source port.
1898 */
1899#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1900
1901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001903 *
1904 * Enable support for a limit of records with bad MAC.
1905 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001906 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001907 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001911
1912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001914 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001915 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001916 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001917 * session store remains the responsibility of the application, though).
1918 * Server-side, you also need to provide callbacks for writing and parsing
1919 * tickets, including authenticated encryption and key management. Example
1920 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001921 *
1922 * Comment this macro to disable support for SSL session tickets
1923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001925
1926/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001927 * \def MBEDTLS_SSL_EXPORT_KEYS
1928 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001929 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001930 * This is required for certain users of TLS, e.g. EAP-TLS.
1931 *
1932 * Comment this macro to disable support for key export
1933 */
1934#define MBEDTLS_SSL_EXPORT_KEYS
1935
1936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001938 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001939 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001940 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001942 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001943 * Comment this macro to disable support for server name indication in SSL
1944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001946
1947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001949 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001950 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001951 *
1952 * Comment this macro to disable support for truncated HMAC in SSL
1953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001955
1956/**
Hanno Beckere89353a2017-11-20 16:36:41 +00001957 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1958 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001959 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
1960 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001961 * only meant for a transitory upgrade period and will be removed in a future
1962 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00001963 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001964 * \warning The old implementation is non-compliant and has a security weakness
1965 * (2^80 brute force attack on the HMAC key used for a single,
1966 * uninterrupted connection). This should only be enabled temporarily
1967 * when (1) the use of truncated HMAC is essential in order to save
1968 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
1969 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00001970 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001971 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00001972 * future version of Mbed TLS.
1973 *
Hanno Beckere89353a2017-11-20 16:36:41 +00001974 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
1975 *
1976 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
1977 */
1978//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1979
1980/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001981 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1982 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001983 * When this option is enabled, the SSL buffer will be resized automatically
1984 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001985 *
1986 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001987 */
1988//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1989
1990/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001991 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1992 *
1993 * Enable testing of the constant-flow nature of some sensitive functions with
1994 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001995 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001996 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001997 * This setting requires compiling with clang -fsanitize=memory. The test
1998 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001999 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002000 * \warning This macro is only used for extended testing; it is not considered
2001 * part of the library's API, so it may change or disappear at any time.
2002 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002003 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002004 */
2005//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2006
2007/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002008 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2009 *
2010 * Enable testing of the constant-flow nature of some sensitive functions with
2011 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002012 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002013 *
2014 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002015 * testing if the tests suites are run with valgrind's memcheck. This can be
2016 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2017 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002018 *
2019 * \warning This macro is only used for extended testing; it is not considered
2020 * part of the library's API, so it may change or disappear at any time.
2021 *
2022 * Uncomment to enable testing of the constant-flow nature of selected code.
2023 */
2024//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2025
2026/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002027 * \def MBEDTLS_TEST_HOOKS
2028 *
2029 * Enable features for invasive testing such as introspection functions and
2030 * hooks for fault injection. This enables additional unit tests.
2031 *
2032 * Merely enabling this feature should not change the behavior of the product.
2033 * It only adds new code, and new branching points where the default behavior
2034 * is the same as when this feature is disabled.
2035 * However, this feature increases the attack surface: there is an added
2036 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2037 * Therefore this feature must never be enabled in production.
2038 *
2039 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2040 * information.
2041 *
2042 * Uncomment to enable invasive tests.
2043 */
2044//#define MBEDTLS_TEST_HOOKS
2045
2046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002048 *
2049 * Provide your own alternate threading implementation.
2050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002052 *
2053 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002056
2057/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002059 *
2060 * Enable the pthread wrapper layer for the threading layer.
2061 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002063 *
2064 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002067
2068/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002069 * \def MBEDTLS_USE_PSA_CRYPTO
2070 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002071 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2072 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002073 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002074 * \note Development of this option is currently in progress, and parts of Mbed
2075 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002076 * will still continue to work as usual, so enabling this option should not
2077 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002078 *
Gilles Peskined3d02902020-03-04 21:35:27 +01002079 * \warning The PSA Crypto API is in beta stage. While you're welcome to
2080 * experiment using it, incompatible API changes are still possible, and some
2081 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002082 *
2083 * \warning This option enables new Mbed TLS APIs that are dependent on the
2084 * PSA Crypto API, so can't come with the same stability guarantees as the
2085 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002086 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002087 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00002088 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002089 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002090 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002091 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002092 */
2093//#define MBEDTLS_USE_PSA_CRYPTO
2094
2095/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002096 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2097 *
John Durkop185764f2020-10-12 21:32:12 -07002098 * This setting allows support for cryptographic mechanisms through the PSA
2099 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002100 *
John Durkop185764f2020-10-12 21:32:12 -07002101 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01002102 * can be found in include/psa/crypto_config.h.
2103 *
2104 * If you enable this option and write your own configuration file, you must
2105 * include mbedtls/config_psa.h in your configuration file. The default
2106 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002107 *
2108 * This feature is still experimental and is not ready for production since
2109 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002110 */
2111//#define MBEDTLS_PSA_CRYPTO_CONFIG
2112
2113/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002115 *
2116 * Allow run-time checking of compile-time enabled features. Thus allowing users
2117 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002119 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002121 *
2122 * Comment this to disable run-time checking and save ROM space
2123 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002125
2126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002127 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002128 *
2129 * If set, the X509 parser will not break-off when parsing an X509 certificate
2130 * and encountering an extension in a v1 or v2 certificate.
2131 *
2132 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002135
2136/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002138 *
2139 * If set, the X509 parser will not break-off when parsing an X509 certificate
2140 * and encountering an unknown critical extension.
2141 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002142 * \warning Depending on your PKI use, enabling this can be a security risk!
2143 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002144 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002145 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002146//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002147
2148/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002149 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2150 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002151 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002152 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2153 * the set of trusted certificates through a callback instead of a linked
2154 * list.
2155 *
2156 * This is useful for example in environments where a large number of trusted
2157 * certificates is present and storing them in a linked list isn't efficient
2158 * enough, or when the set of trusted certificates changes frequently.
2159 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002160 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002161 * `mbedtls_ssl_conf_ca_cb()` for more information.
2162 *
2163 * Uncomment to enable trusted certificate callbacks.
2164 */
2165//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2166
2167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002169 *
2170 * Enable verification of the keyUsage extension (CA and leaf certificates).
2171 *
2172 * Disabling this avoids problems with mis-issued and/or misused
2173 * (intermediate) CA and leaf certificates.
2174 *
2175 * \warning Depending on your PKI use, disabling this can be a security risk!
2176 *
2177 * Comment to skip keyUsage checking for both CA and leaf certificates.
2178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002180
2181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002183 *
2184 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2185 *
2186 * Disabling this avoids problems with mis-issued and/or misused certificates.
2187 *
2188 * \warning Depending on your PKI use, disabling this can be a security risk!
2189 *
2190 * Comment to skip extendedKeyUsage checking for certificates.
2191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002192#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002193
2194/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002196 *
2197 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2198 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2199 *
2200 * Comment this macro to disallow using RSASSA-PSS in certificates.
2201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002203
2204/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002206 *
2207 * If set, the SSL/TLS module uses ZLIB to support compression and
2208 * decompression of packet data.
2209 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002210 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2211 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002212 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002213 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002214 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002215 *
Hanno Beckere494e202018-03-08 13:26:12 +00002216 * \deprecated This feature is deprecated and will be removed
2217 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002218 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002219 * Used in: library/ssl_tls.c
2220 * library/ssl_cli.c
2221 * library/ssl_srv.c
2222 *
2223 * This feature requires zlib library and headers to be present.
2224 *
2225 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002228/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002229
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002230/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002231 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002232 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002233 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002234 * \{
2235 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002236
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002239 *
2240 * Enable AES-NI support on x86-64.
2241 *
2242 * Module: library/aesni.c
2243 * Caller: library/aes.c
2244 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002246 *
2247 * This modules adds support for the AES-NI instructions on x86-64
2248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002250
2251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002253 *
2254 * Enable the AES block cipher.
2255 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002257 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002258 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002259 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002261 * This module enables the following ciphersuites (if other requisites are
2262 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2264 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2265 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2266 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2267 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2268 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2269 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2270 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2271 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2272 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2273 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2274 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2275 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2276 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2277 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2278 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2279 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2280 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2281 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2282 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2283 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2284 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2285 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2286 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2289 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2290 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2291 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2292 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2293 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2294 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2295 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2296 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2297 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2298 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2299 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2300 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2301 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2302 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2303 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2304 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2305 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2306 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2308 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2309 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2310 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2311 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2312 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2313 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2314 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2315 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2316 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2317 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2318 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2319 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2320 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002321 *
Paul Bakkercff68422013-09-15 20:43:33 +02002322 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002325
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002328 *
2329 * Enable the ARCFOUR stream cipher.
2330 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002331 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002332 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002333 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002334 * This module enables the following ciphersuites (if other requisites are
2335 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2339 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2340 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2341 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2342 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2343 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2344 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2345 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002346 *
2347 * \warning ARC4 is considered a weak cipher and its use constitutes a
2348 * security risk. If possible, we recommend avoidng dependencies on
2349 * it, and considering stronger ciphers instead.
2350 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002353
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002356 *
2357 * Enable the generic ASN1 parser.
2358 *
2359 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002360 * Caller: library/x509.c
2361 * library/dhm.c
2362 * library/pkcs12.c
2363 * library/pkcs5.c
2364 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002367
2368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002370 *
2371 * Enable the generic ASN1 writer.
2372 *
2373 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002374 * Caller: library/ecdsa.c
2375 * library/pkwrite.c
2376 * library/x509_create.c
2377 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002378 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002380#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002381
2382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002384 *
2385 * Enable the Base64 module.
2386 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002388 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002389 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002390 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002392#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002393
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002396 *
Paul Bakker9a736322012-11-14 12:39:52 +00002397 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002398 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002399 * Module: library/bignum.c
2400 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002401 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002402 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002403 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002404 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002405 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002406 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002407 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002410
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002413 *
2414 * Enable the Blowfish block cipher.
2415 *
2416 * Module: library/blowfish.c
2417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002419
2420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002422 *
2423 * Enable the Camellia block cipher.
2424 *
Paul Bakker38119b12009-01-10 23:31:23 +00002425 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002426 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002427 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002428 * This module enables the following ciphersuites (if other requisites are
2429 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2431 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2432 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2433 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2434 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2435 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2436 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2437 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2438 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2439 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2440 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2441 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2442 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2443 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2444 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2445 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2446 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2447 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2448 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2449 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2450 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2451 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2452 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2453 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2454 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2455 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2456 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2457 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2458 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2459 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2460 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2461 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2462 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2463 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2464 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2465 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2466 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2467 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2468 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2469 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2470 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2471 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002474
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002475/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002476 * \def MBEDTLS_ARIA_C
2477 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002478 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002479 *
2480 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002481 * Caller: library/cipher.c
2482 *
2483 * This module enables the following ciphersuites (if other requisites are
2484 * enabled as well):
2485 *
2486 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2487 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2488 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2489 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2490 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2491 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2492 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2493 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2494 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2495 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2496 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2497 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2498 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2499 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2500 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2501 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2502 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2503 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2504 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2505 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2506 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2507 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2508 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2509 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2510 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2511 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2512 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2513 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2514 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2515 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2516 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2517 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2518 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2519 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2520 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2521 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2522 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2523 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002524 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002525//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002526
2527/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002529 *
2530 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2531 *
2532 * Module: library/ccm.c
2533 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002535 *
2536 * This module enables the AES-CCM ciphersuites, if other requisites are
2537 * enabled as well.
2538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002540
2541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002543 *
2544 * Enable the test certificates.
2545 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 * Module: library/certs.c
2547 * Caller:
2548 *
2549 * This module is used for testing (ssl_client/server).
2550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002552
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002553/**
Daniel King34b822c2016-05-15 17:28:08 -03002554 * \def MBEDTLS_CHACHA20_C
2555 *
2556 * Enable the ChaCha20 stream cipher.
2557 *
2558 * Module: library/chacha20.c
2559 */
2560#define MBEDTLS_CHACHA20_C
2561
2562/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002563 * \def MBEDTLS_CHACHAPOLY_C
2564 *
2565 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2566 *
2567 * Module: library/chachapoly.c
2568 *
2569 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2570 */
2571#define MBEDTLS_CHACHAPOLY_C
2572
2573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002574 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002575 *
2576 * Enable the generic cipher layer.
2577 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002578 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002579 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002580 *
2581 * Uncomment to enable generic cipher wrappers.
2582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002584
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002585/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002586 * \def MBEDTLS_CMAC_C
2587 *
Simon Butcher327398a2016-10-05 14:09:11 +01002588 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2589 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002590 *
2591 * Module: library/cmac.c
2592 *
Simon Butcher69283e52016-10-06 12:49:58 +01002593 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002594 *
2595 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002596//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002597
2598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002600 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002601 * Enable the CTR_DRBG AES-based random generator.
2602 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002603 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002604 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002605 * \note To achieve a 256-bit security strength with CTR_DRBG,
2606 * you must use AES-256 *and* use sufficient entropy.
2607 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002608 *
2609 * Module: library/ctr_drbg.c
2610 * Caller:
2611 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002613 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002614 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002617
2618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002620 *
2621 * Enable the debug functions.
2622 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002623 * Module: library/debug.c
2624 * Caller: library/ssl_cli.c
2625 * library/ssl_srv.c
2626 * library/ssl_tls.c
2627 *
2628 * This module provides debugging functions.
2629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002631
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002634 *
2635 * Enable the DES block cipher.
2636 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002637 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002638 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002639 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002640 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002641 * This module enables the following ciphersuites (if other requisites are
2642 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2644 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2645 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2646 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2647 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2648 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2649 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2650 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2651 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2652 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002653 *
Paul Bakkercff68422013-09-15 20:43:33 +02002654 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002655 *
2656 * \warning DES is considered a weak cipher and its use constitutes a
2657 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002660
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002663 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002664 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002665 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002666 * Module: library/dhm.c
2667 * Caller: library/ssl_cli.c
2668 * library/ssl_srv.c
2669 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002670 * This module is used by the following key exchanges:
2671 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002672 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002673 * \warning Using DHE constitutes a security risk as it
2674 * is not possible to validate custom DH parameters.
2675 * If possible, it is recommended users should consider
2676 * preferring other methods of key exchange.
2677 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002678 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002679 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002681
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002682/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002684 *
2685 * Enable the elliptic curve Diffie-Hellman library.
2686 *
2687 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002688 * Caller: library/ssl_cli.c
2689 * library/ssl_srv.c
2690 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002691 * This module is used by the following key exchanges:
2692 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002693 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002697
2698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002700 *
2701 * Enable the elliptic curve DSA library.
2702 *
2703 * Module: library/ecdsa.c
2704 * Caller:
2705 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002706 * This module is used by the following key exchanges:
2707 * ECDHE-ECDSA
2708 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002709 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2710 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2711 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002714
2715/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002716 * \def MBEDTLS_ECJPAKE_C
2717 *
2718 * Enable the elliptic curve J-PAKE library.
2719 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002720 * \warning This is currently experimental. EC J-PAKE support is based on the
2721 * Thread v1.0.0 specification; incompatible changes to the specification
2722 * might still happen. For this reason, this is disabled by default.
2723 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002724 * Module: library/ecjpake.c
2725 * Caller:
2726 *
2727 * This module is used by the following key exchanges:
2728 * ECJPAKE
2729 *
2730 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2731 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002732//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002733
2734/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002736 *
2737 * Enable the elliptic curve over GF(p) library.
2738 *
2739 * Module: library/ecp.c
2740 * Caller: library/ecdh.c
2741 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002742 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002743 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002747
2748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002750 *
2751 * Enable the platform-specific entropy code.
2752 *
2753 * Module: library/entropy.c
2754 * Caller:
2755 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002757 *
2758 * This module provides a generic entropy pool
2759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002760#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002761
2762/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002764 *
2765 * Enable error code to error string conversion.
2766 *
2767 * Module: library/error.c
2768 * Caller:
2769 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002773
2774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002776 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002777 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002778 *
2779 * Module: library/gcm.c
2780 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002781 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002782 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002783 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2784 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002787
2788/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002789 * \def MBEDTLS_HKDF_C
2790 *
2791 * Enable the HKDF algorithm (RFC 5869).
2792 *
2793 * Module: library/hkdf.c
2794 * Caller:
2795 *
2796 * Requires: MBEDTLS_MD_C
2797 *
2798 * This module adds support for the Hashed Message Authentication Code
2799 * (HMAC)-based key derivation function (HKDF).
2800 */
2801#define MBEDTLS_HKDF_C
2802
2803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002805 *
2806 * Enable the HMAC_DRBG random generator.
2807 *
2808 * Module: library/hmac_drbg.c
2809 * Caller:
2810 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002812 *
2813 * Uncomment to enable the HMAC_DRBG random number geerator.
2814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002816
2817/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002818 * \def MBEDTLS_NIST_KW_C
2819 *
2820 * Enable the Key Wrapping mode for 128-bit block ciphers,
2821 * as defined in NIST SP 800-38F. Only KW and KWP modes
2822 * are supported. At the moment, only AES is approved by NIST.
2823 *
2824 * Module: library/nist_kw.c
2825 *
2826 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2827 */
2828//#define MBEDTLS_NIST_KW_C
2829
2830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002832 *
2833 * Enable the generic message digest layer.
2834 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002835 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002836 * Caller:
2837 *
2838 * Uncomment to enable generic message digest wrappers.
2839 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002841
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002842/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002844 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002845 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002846 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002847 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002848 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002849 *
2850 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002851 *
2852 * \warning MD2 is considered a weak message digest and its use constitutes a
2853 * security risk. If possible, we recommend avoiding dependencies on
2854 * it, and considering stronger message digests instead.
2855 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002858
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002862 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002863 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002864 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002865 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002866 *
2867 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002868 *
2869 * \warning MD4 is considered a weak message digest and its use constitutes a
2870 * security risk. If possible, we recommend avoiding dependencies on
2871 * it, and considering stronger message digests instead.
2872 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002875
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002878 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002879 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002880 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002881 * Module: library/md5.c
2882 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002883 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002884 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002885 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002886 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2887 * depending on the handshake parameters. Further, it is used for checking
2888 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2889 * encrypted keys.
2890 *
2891 * \warning MD5 is considered a weak message digest and its use constitutes a
2892 * security risk. If possible, we recommend avoiding dependencies on
2893 * it, and considering stronger message digests instead.
2894 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002897
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002900 *
2901 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002902 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002903 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002904 *
2905 * Module: library/memory_buffer_alloc.c
2906 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 * Requires: MBEDTLS_PLATFORM_C
2908 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002909 *
2910 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002913
2914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002916 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002917 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2918 *
Simon Butcherd567a232016-03-09 20:19:21 +00002919 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2920 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002921 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002922 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002923 * \note See also our Knowledge Base article about porting to a new
2924 * environment:
2925 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2926 *
Andres AG788aa4a2016-09-14 14:32:09 +01002927 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002928 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002929 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002932
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002933/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002935 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002936 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002937 *
2938 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002939 * Caller: library/asn1write.c
2940 * library/pkcs5.c
2941 * library/pkparse.c
2942 * library/pkwrite.c
2943 * library/rsa.c
2944 * library/x509.c
2945 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002946 * library/x509_crl.c
2947 * library/x509_crt.c
2948 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002949 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002950 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002951 *
2952 * This modules translates between OIDs and internal values.
2953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002955
2956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002958 *
2959 * Enable VIA Padlock support on x86.
2960 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002961 * Module: library/padlock.c
2962 * Caller: library/aes.c
2963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002965 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002966 * This modules adds support for the VIA PadLock on x86.
2967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002969
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002972 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002973 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002974 *
2975 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002976 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002977 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002978 * library/x509_crl.c
2979 * library/x509_crt.c
2980 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002981 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002983 *
Paul Bakkercff68422013-09-15 20:43:33 +02002984 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002987
2988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002990 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002991 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002992 *
2993 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002994 * Caller: library/pkwrite.c
2995 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002996 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002997 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002999 *
3000 * This modules adds support for encoding / writing PEM files.
3001 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003003
3004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003006 *
3007 * Enable the generic public (asymetric) key layer.
3008 *
3009 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003010 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003011 * library/ssl_cli.c
3012 * library/ssl_srv.c
3013 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003015 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003016 * Uncomment to enable generic public key wrappers.
3017 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003019
3020/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003022 *
3023 * Enable the generic public (asymetric) key parser.
3024 *
3025 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003026 * Caller: library/x509_crt.c
3027 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003028 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003030 *
3031 * Uncomment to enable generic public key parse functions.
3032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003034
3035/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003037 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02003038 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003039 *
3040 * Module: library/pkwrite.c
3041 * Caller: library/x509write.c
3042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003044 *
3045 * Uncomment to enable generic public key write functions.
3046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003048
3049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003051 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003052 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003053 *
3054 * Module: library/pkcs5.c
3055 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003057 *
3058 * This module adds support for the PKCS#5 functions.
3059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003061
3062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003064 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003065 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003066 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003067 * \deprecated This option is deprecated and will be removed in a future
3068 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003069 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003070 * Module: library/pkcs11.c
3071 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003074 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003075 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003076 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003079
3080/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003082 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003083 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003084 * Adds algorithms for parsing PKCS#8 encrypted private keys
3085 *
3086 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003087 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003088 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3090 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003091 *
3092 * This module enables PKCS#12 functions.
3093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003095
3096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003098 *
3099 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003100 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3103 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003104 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003105 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003106 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3107 * as other module rely on it for a fixed snprintf implementation.
3108 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003109 * Module: library/platform.c
3110 * Caller: Most other .c files
3111 *
3112 * This module enables abstraction of common (libc) functions.
3113 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003114#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003115
3116/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003117 * \def MBEDTLS_POLY1305_C
3118 *
3119 * Enable the Poly1305 MAC algorithm.
3120 *
3121 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003122 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003123 */
3124#define MBEDTLS_POLY1305_C
3125
3126/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003127 * \def MBEDTLS_PSA_CRYPTO_C
3128 *
3129 * Enable the Platform Security Architecture cryptography API.
3130 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003131 * \warning The PSA Crypto API is still beta status. While you're welcome to
3132 * experiment using it, incompatible API changes are still possible, and some
3133 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01003134 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003135 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003136 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003137 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003138 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003139 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003140 *
3141 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003142#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003143
3144/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003145 * \def MBEDTLS_PSA_CRYPTO_SE_C
3146 *
3147 * Enable secure element support in the Platform Security Architecture
3148 * cryptography API.
3149 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003150 * \warning This feature is not yet suitable for production. It is provided
3151 * for API evaluation and testing purposes only.
3152 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003153 * Module: library/psa_crypto_se.c
3154 *
3155 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3156 *
3157 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003158//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003159
3160/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003161 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3162 *
3163 * Enable the Platform Security Architecture persistent key storage.
3164 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003165 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003166 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003167 * Requires: MBEDTLS_PSA_CRYPTO_C,
3168 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3169 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003170 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003171#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003172
3173/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003174 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003175 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003176 * Enable the emulation of the Platform Security Architecture
3177 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003178 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003179 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003180 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003181 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003182 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003183#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003184
3185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003187 *
3188 * Enable the RIPEMD-160 hash algorithm.
3189 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003190 * Module: library/ripemd160.c
3191 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003192 *
3193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003195
3196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003198 *
3199 * Enable the RSA public-key cryptosystem.
3200 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003201 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003202 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003203 * Caller: library/ssl_cli.c
3204 * library/ssl_srv.c
3205 * library/ssl_tls.c
3206 * library/x509.c
3207 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003208 * This module is used by the following key exchanges:
3209 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003214
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003217 *
3218 * Enable the SHA1 cryptographic hash algorithm.
3219 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003220 * Module: library/sha1.c
3221 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003222 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003223 * library/ssl_srv.c
3224 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003225 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003226 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003227 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3228 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003229 *
3230 * \warning SHA-1 is considered a weak message digest and its use constitutes
3231 * a security risk. If possible, we recommend avoiding dependencies
3232 * on it, and considering stronger message digests instead.
3233 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003236
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003239 *
3240 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3241 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003242 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003243 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003244 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003245 * library/ssl_cli.c
3246 * library/ssl_srv.c
3247 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003248 *
3249 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003250 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003253
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003256 *
3257 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3258 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003259 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003260 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003261 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003262 * library/ssl_cli.c
3263 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003264 *
3265 * This module adds support for SHA-384 and SHA-512.
3266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003267#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003268
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003271 *
3272 * Enable simple SSL cache implementation.
3273 *
3274 * Module: library/ssl_cache.c
3275 * Caller:
3276 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003279#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003280
3281/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003283 *
3284 * Enable basic implementation of DTLS cookies for hello verification.
3285 *
3286 * Module: library/ssl_cookie.c
3287 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003290
3291/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003292 * \def MBEDTLS_SSL_TICKET_C
3293 *
3294 * Enable an implementation of TLS server-side callbacks for session tickets.
3295 *
3296 * Module: library/ssl_ticket.c
3297 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003298 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003299 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003300 */
3301#define MBEDTLS_SSL_TICKET_C
3302
3303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003305 *
3306 * Enable the SSL/TLS client code.
3307 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003308 * Module: library/ssl_cli.c
3309 * Caller:
3310 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003312 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003313 * This module is required for SSL/TLS client support.
3314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003316
Paul Bakker9a736322012-11-14 12:39:52 +00003317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003319 *
3320 * Enable the SSL/TLS server code.
3321 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003322 * Module: library/ssl_srv.c
3323 * Caller:
3324 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003326 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003327 * This module is required for SSL/TLS server support.
3328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003330
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003331/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003333 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003334 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003335 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003336 * Module: library/ssl_tls.c
3337 * Caller: library/ssl_cli.c
3338 * library/ssl_srv.c
3339 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3341 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003342 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003343 * This module is required for SSL/TLS.
3344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003346
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003349 *
3350 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003351 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003352 * contexts are not shared between threads. If you do intend to use contexts
3353 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003354 * conditions. See also our Knowledge Base article about threading:
3355 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003356 *
3357 * Module: library/threading.c
3358 *
3359 * This allows different threading implementations (self-implemented or
3360 * provided).
3361 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 * You will have to enable either MBEDTLS_THREADING_ALT or
3363 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003364 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003365 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003368
3369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003371 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003372 * Enable the semi-portable timing interface.
3373 *
Simon Butcherd567a232016-03-09 20:19:21 +00003374 * \note The provided implementation only works on POSIX/Unix (including Linux,
3375 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003376 * module and provide your own implementations of the callbacks needed by
3377 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3378 * your own implementation of the whole module by setting
3379 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003380 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003381 * \note See also our Knowledge Base article about porting to a new
3382 * environment:
3383 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3384 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003385 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003388
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003389/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003391 *
3392 * Enable run-time version information.
3393 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003394 * Module: library/version.c
3395 *
3396 * This module provides run-time version information.
3397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003399
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003402 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003403 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003404 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003405 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003406 * Caller: library/x509_crl.c
3407 * library/x509_crt.c
3408 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003409 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3411 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003412 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003413 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003416
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003419 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003420 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003421 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003422 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003423 * Caller: library/ssl_cli.c
3424 * library/ssl_srv.c
3425 * library/ssl_tls.c
3426 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003428 *
3429 * This module is required for X.509 certificate parsing.
3430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003432
3433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003435 *
3436 * Enable X.509 CRL parsing.
3437 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003438 * Module: library/x509_crl.c
3439 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003440 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003442 *
3443 * This module is required for X.509 CRL parsing.
3444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003446
3447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003449 *
3450 * Enable X.509 Certificate Signing Request (CSR) parsing.
3451 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003452 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003453 * Caller: library/x509_crt_write.c
3454 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003456 *
3457 * This module is used for reading X.509 certificate request.
3458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003460
3461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003463 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003464 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003465 *
3466 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003467 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003469 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003470 * This module is the basis for creating X.509 certificates and CSRs.
3471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003473
3474/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003476 *
3477 * Enable creating X.509 certificates.
3478 *
3479 * Module: library/x509_crt_write.c
3480 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003482 *
3483 * This module is required for X.509 certificate creation.
3484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003486
3487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003489 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003490 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003491 *
3492 * Module: library/x509_csr_write.c
3493 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003496 * This module is required for X.509 certificate request writing.
3497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003499
3500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003502 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003503 * Enable the XTEA block cipher.
3504 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003505 * Module: library/xtea.c
3506 * Caller:
3507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003509
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003510/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003511
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003512/**
3513 * \name SECTION: Module configuration options
3514 *
3515 * This section allows for the setting of module specific sizes and
3516 * configuration options. The default values are already present in the
3517 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003518 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003519 * Our advice is to enable options and change their values here
3520 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003521 *
3522 * Please check the respective header file for documentation on these
3523 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003524 * \{
3525 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003526
Paul Bakker088c5c52014-04-25 11:11:10 +02003527/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003528//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003529//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003530
Paul Bakker088c5c52014-04-25 11:11:10 +02003531/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3533//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3534//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3535//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3536//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003537
Paul Bakker088c5c52014-04-25 11:11:10 +02003538/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3540//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3541//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3542//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003543
Paul Bakker088c5c52014-04-25 11:11:10 +02003544/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3546//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3547//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003548
Paul Bakker088c5c52014-04-25 11:11:10 +02003549/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3551//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003552//#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 +01003553
Paul Bakker088c5c52014-04-25 11:11:10 +02003554/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003556
Paul Bakker088c5c52014-04-25 11:11:10 +02003557/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558//#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 +02003559//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3561//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003562//#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 +02003563//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3564//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003565/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003567//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3568//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003569//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3570//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3571//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3574/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003575//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3577//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003578//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3579//#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 +02003580//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3581//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003582/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003584//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003585//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3586//#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 +02003587
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003588/**
3589 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003590 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003591 * (see the documentation of that option for context).
3592 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003593 * When you leave this undefined here, the library provides
3594 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3595 * is defined, the default definition is `assert(cond)`,
3596 * otherwise the default definition calls a function
3597 * mbedtls_param_failed(). This function is declared in
3598 * `platform_util.h` for the benefit of the library, but
3599 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003600 *
3601 * When you define this here, this replaces the default
3602 * definition in platform_util.h (which no longer declares the
3603 * function mbedtls_param_failed()) and it is your responsibility
3604 * to make sure this macro expands to something suitable (in
3605 * particular, that all the necessary declarations are visible
3606 * from within the library - you can ensure that by providing
3607 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003608 * If you define this macro to call `assert`, also define
3609 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3610 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003611 *
3612 * Note that you may define this macro to expand to nothing, in
3613 * which case you don't have to worry about declarations or
3614 * definitions. However, you will then be notified about invalid
3615 * parameters only in non-void functions, and void function will
3616 * just silently return early on invalid parameters, which
3617 * partially negates the benefits of enabling
3618 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3619 *
3620 * \param cond The expression that should evaluate to true, but doesn't.
3621 */
3622//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3623
Gilles Peskineed038902020-11-13 21:33:21 +01003624/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003625/**
Gilles Peskineed038902020-11-13 21:33:21 +01003626 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3627 * PSA crypto subsystem.
3628 *
3629 * If this option is unset:
3630 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003631 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003632 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3633 * on unspecified heuristics.
3634 */
3635//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3636
Paul Bakker088c5c52014-04-25 11:11:10 +02003637/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3639//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003640
Paul Bakker088c5c52014-04-25 11:11:10 +02003641/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003642
3643/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3644 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003645 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003646 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003647 * This determines the size of both the incoming and outgoing TLS I/O buffers
3648 * in such a way that both are capable of holding the specified amount of
3649 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003650 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003651 * To configure incoming and outgoing I/O buffers separately, use
3652 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3653 * which overwrite the value set by this option.
3654 *
3655 * \note When using a value less than the default of 16KB on the client, it is
3656 * recommended to use the Maximum Fragment Length (MFL) extension to
3657 * inform the server about this limitation. On the server, there
3658 * is no supported, standardized way of informing the client about
3659 * restriction on the maximum size of incoming messages, and unless
3660 * the limitation has been communicated by other means, it is recommended
3661 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3662 * while keeping the default value of 16KB for the incoming buffer.
3663 *
3664 * Uncomment to set the maximum plaintext size of both
3665 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003666 */
3667//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3668
3669/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3670 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003671 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003672 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003673 * This determines the size of the incoming TLS I/O buffer in such a way
3674 * that it is capable of holding the specified amount of plaintext data,
3675 * regardless of the protection mechanism used.
3676 *
3677 * If this option is undefined, it inherits its value from
3678 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3679 *
3680 * \note When using a value less than the default of 16KB on the client, it is
3681 * recommended to use the Maximum Fragment Length (MFL) extension to
3682 * inform the server about this limitation. On the server, there
3683 * is no supported, standardized way of informing the client about
3684 * restriction on the maximum size of incoming messages, and unless
3685 * the limitation has been communicated by other means, it is recommended
3686 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3687 * while keeping the default value of 16KB for the incoming buffer.
3688 *
3689 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3690 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003691 */
3692//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3693
Gilles Peskined3d02902020-03-04 21:35:27 +01003694/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3695 *
3696 * The maximum length of CIDs used for incoming DTLS messages.
3697 *
3698 */
3699//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3700
3701/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3702 *
3703 * The maximum length of CIDs used for outgoing DTLS messages.
3704 *
3705 */
3706//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3707
3708/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3709 *
3710 * This option controls the use of record plaintext padding
3711 * when using the Connection ID extension in DTLS 1.2.
3712 *
3713 * The padding will always be chosen so that the length of the
3714 * padded plaintext is a multiple of the value of this option.
3715 *
3716 * Note: A value of \c 1 means that no padding will be used
3717 * for outgoing records.
3718 *
3719 * Note: On systems lacking division instructions,
3720 * a power of two should be preferred.
3721 *
3722 */
3723//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3724
Hanno Beckerceef8482020-06-02 06:16:00 +01003725/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003726 *
3727 * This option controls the use of record plaintext padding
3728 * in TLS 1.3.
3729 *
3730 * The padding will always be chosen so that the length of the
3731 * padded plaintext is a multiple of the value of this option.
3732 *
3733 * Note: A value of \c 1 means that no padding will be used
3734 * for outgoing records.
3735 *
3736 * Note: On systems lacking division instructions,
3737 * a power of two should be preferred.
3738 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003739//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003740
Angus Grattond8213d02016-05-25 20:56:48 +10003741/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3742 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003743 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003744 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003745 * This determines the size of the outgoing TLS I/O buffer in such a way
3746 * that it is capable of holding the specified amount of plaintext data,
3747 * regardless of the protection mechanism used.
3748 *
3749 * If this option undefined, it inherits its value from
3750 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003751 *
3752 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3753 * the default inward 16384 byte buffer to conform to the TLS specification.
3754 *
3755 * The minimum required outward buffer size is determined by the handshake
3756 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3757 * The specific size requirement depends on the configured ciphers and any
3758 * certificate data which is sent during the handshake.
3759 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003760 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3761 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003762 */
3763//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3764
Hanno Beckere0b150f2018-08-21 15:51:03 +01003765/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3766 *
3767 * Maximum number of heap-allocated bytes for the purpose of
3768 * DTLS handshake message reassembly and future message buffering.
3769 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003770 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003771 * to account for a reassembled handshake message of maximum size,
3772 * together with its reassembly bitmap.
3773 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003774 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003775 * should be sufficient for all practical situations as it allows
3776 * to reassembly a large handshake message (such as a certificate)
3777 * while buffering multiple smaller handshake messages.
3778 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003779 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003780//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3783//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3784//#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 +02003785
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003786/**
3787 * Complete list of ciphersuites to use, in order of preference.
3788 *
3789 * \warning No dependency checking is done on that field! This option can only
3790 * be used to restrict the set of available ciphersuites. It is your
3791 * responsibility to make sure the needed modules are active.
3792 *
3793 * Use this to save a few hundred bytes of ROM (default ordering of all
3794 * available ciphersuites) and a few to a few hundred bytes of RAM.
3795 *
3796 * The value below is only an example, not the default.
3797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798//#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 +02003799
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003800/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003801//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003802//#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 +01003803
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003804/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003805 * Allow SHA-1 in the default TLS configuration for certificate signing.
3806 * Without this build-time option, SHA-1 support must be activated explicitly
3807 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003808 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003809 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003810 *
3811 * \warning SHA-1 is considered a weak message digest and its use constitutes
3812 * a security risk. If possible, we recommend avoiding dependencies
3813 * on it, and considering stronger message digests instead.
3814 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003815 */
Gilles Peskined3d02902020-03-04 21:35:27 +01003816//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003817
3818/**
3819 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3820 * signature and ciphersuite selection. Without this build-time option, SHA-1
3821 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3822 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3823 * default. At the time of writing, there is no practical attack on the use
3824 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003825 * to preserve compatibility with existing peers, but the general
3826 * warning applies nonetheless:
3827 *
3828 * \warning SHA-1 is considered a weak message digest and its use constitutes
3829 * a security risk. If possible, we recommend avoiding dependencies
3830 * on it, and considering stronger message digests instead.
3831 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003832 */
3833#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003834
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003835/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003836 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003837 * mbedtls_platform_zeroize(). This replaces the default implementation in
3838 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003839 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003840 * mbedtls_platform_zeroize() is a widely used function across the library to
3841 * zero a block of memory. The implementation is expected to be secure in the
3842 * sense that it has been written to prevent the compiler from removing calls
3843 * to mbedtls_platform_zeroize() as part of redundant code elimination
3844 * optimizations. However, it is difficult to guarantee that calls to
3845 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3846 * versions of the C language standards do not provide a secure implementation
3847 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3848 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003849 * example by using directives specific to their compiler, features from newer
3850 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003851 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003852 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003853//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003854
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003855/**
3856 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003857 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003858 * platform_util.c.
3859 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003860 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003861 * library will try to use safer implementations of this function, such as
3862 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003863 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003864 * using the standard gmtime(). In this case, calls from the library to
3865 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003866 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003867 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003868 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3869 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3870 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003871 */
Hanno Becker6a739782018-09-05 15:06:19 +01003872//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003873
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003874/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003875 * Enable the verified implementations of ECDH primitives from Project Everest
3876 * (currently only Curve25519). This feature changes the layout of ECDH
3877 * contexts and therefore is a compatibility break for applications that access
3878 * fields of a mbedtls_ecdh_context structure directly. See also
3879 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003880 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003881//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003882
Simon Butcher30b5f972016-06-08 19:00:23 +01003883/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003884
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003885/* Target and application specific configurations
3886 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003887 * Allow user to override any previous default.
3888 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003889 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003890#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003891#include MBEDTLS_USER_CONFIG_FILE
3892#endif
3893
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003894#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07003895#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003896#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07003897
Jaeden Amero6609aef2019-07-04 20:01:14 +01003898#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003899
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003900#endif /* MBEDTLS_CONFIG_H */