blob: 3792c9b7d232a2da702ede810de0b77dff467a54 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file config.h
3 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#ifndef MBEDTLS_CONFIG_H
28#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakkercce9d772011-11-18 14:26:47 +000030#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000031#define _CRT_SECURE_NO_DEPRECATE 1
32#endif
33
Paul Bakkerf3b86c12011-01-27 15:24:17 +000034/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000035 * \name SECTION: System support
36 *
37 * This section sets system specific settings.
38 * \{
39 */
40
Paul Bakkerf3b86c12011-01-27 15:24:17 +000041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020044 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000045 *
46 * Requires support for asm() in compiler.
47 *
48 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010049 * library/aria.c
Paul Bakker68041ec2009-04-19 21:17:55 +000050 * library/timing.c
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000051 * include/mbedtls/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000052 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010053 * Required by:
Gilles Peskinee5038c62023-03-16 17:49:44 +010054 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010055 * MBEDTLS_PADLOCK_C
56 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020057 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000060
Paul Bakkerf3b86c12011-01-27 15:24:17 +000061/**
Gilles Peskineed942f82017-06-08 15:19:20 +020062 * \def MBEDTLS_NO_UDBL_DIVISION
63 *
64 * The platform lacks support for double-width integer division (64-bit
65 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
66 *
67 * Used in:
68 * include/mbedtls/bignum.h
69 * library/bignum.c
70 *
71 * The bignum code uses double-width division to speed up some operations.
72 * Double-width division is often implemented in software that needs to
73 * be linked with the program. The presence of a double-width integer
74 * type is usually detected automatically through preprocessor macros,
75 * but the automatic detection cannot know whether the code needs to
76 * and can be linked with an implementation of division for that type.
77 * By default division is assumed to be usable if the type is present.
78 * Uncomment this option to prevent the use of double-width division.
79 *
80 * Note that division for the native integer type is always required.
81 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010082 * platform, but it need not support multiplication or division. In some
83 * cases it is also desirable to disable some double-width operations. For
84 * example, if double-width division is implemented in software, disabling
85 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020086 */
87//#define MBEDTLS_NO_UDBL_DIVISION
88
89/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020090 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
91 *
92 * The platform lacks support for 32x32 -> 64-bit multiplication.
93 *
94 * Used in:
95 * library/poly1305.c
96 *
97 * Some parts of the library may use multiplication of two unsigned 32-bit
98 * operands with a 64-bit result in order to speed up computations. On some
99 * platforms, this is not available in hardware and has to be implemented in
100 * software, usually in a library provided by the toolchain.
101 *
102 * Sometimes it is not desirable to have to link to that library. This option
103 * removes the dependency of that library on platforms that lack a hardware
104 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
105 *
106 * Note that depending on the compiler, this may decrease performance compared
107 * to using the library function provided by the toolchain.
108 */
109//#define MBEDTLS_NO_64BIT_MULTIPLICATION
110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000113 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000114 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000115 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000116 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200119
120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200122 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200123 * System has time.h and time().
124 * The time does not need to be correct, only time differences are used,
125 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200126 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100127 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
128 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
129 * MBEDTLS_PLATFORM_STD_TIME.
130 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -0400131 * Comment if your system does not support time functions.
132 *
133 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
134 * interface - timing.c will include time.h on suitable platforms
135 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
136 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100139
140/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200141 * \def MBEDTLS_HAVE_TIME_DATE
142 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100143 * System has time.h, time(), and an implementation for
144 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100145 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * the date should be correct). This is used to verify the validity period of
147 * X.509 certificates.
148 *
149 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100150 *
Hanno Becker6a739782018-09-05 15:06:19 +0100151 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100152 * behaves similarly to the gmtime_r() function from the C standard. Refer to
153 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100154 *
155 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * mbedtls_platform_gmtime_r() at compile-time by using the macro
157 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200158 */
159#define MBEDTLS_HAVE_TIME_DATE
160
161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100163 *
164 * Enable the memory allocation layer.
165 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200166 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100167 * This allows different allocators (self-implemented or provided) to be
168 * provided to the platform abstraction layer.
169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
172 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000173 * free() function pointer at runtime.
174 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000177 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100178 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100180 *
181 * Enable this layer to allow use of alternative memory allocators.
182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100184
185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200187 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200188 * Do not assign standard functions in the platform layer (e.g. calloc() to
189 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200190 *
191 * This makes sure there are no linking errors on platforms that do not support
192 * these functions. You will HAVE to provide alternatives, either at runtime
193 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
195 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200196 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200198 *
199 * Uncomment to prevent default assignment of standard functions in the
200 * platform layer.
201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200203
204/**
Janos Follathc351d182016-03-21 08:43:59 +0000205 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100206 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100207 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
208 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100209 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
211 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100212 * alternative printf function pointer.
213 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100215 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200216 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
217 * it will be enabled automatically by check_config.h
218 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200219 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000221 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100222 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
223 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100224 * Uncomment a macro to enable alternate implementation of specific base
225 * platform function
226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100228//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229//#define MBEDTLS_PLATFORM_FPRINTF_ALT
230//#define MBEDTLS_PLATFORM_PRINTF_ALT
231//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200232//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100233//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100234//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100235
236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100238 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000239 * Mark deprecated functions and features so that they generate a warning if
240 * used. Functionality deprecated in one version will usually be removed in the
241 * next version. You can enable this to help you prepare the transition to a
242 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 *
244 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100246 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000247 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250
251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Remove deprecated functions and features so that they generate an error if
255 * used. Functionality deprecated in one version will usually be removed in the
256 * next version. You can enable this to help you prepare the transition to a
257 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100258 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000259 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100262
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500263/**
264 * \def MBEDTLS_CHECK_PARAMS
265 *
266 * This configuration option controls whether the library validates more of
267 * the parameters passed to it.
268 *
269 * When this flag is not defined, the library only attempts to validate an
270 * input parameter if: (1) they may come from the outside world (such as the
271 * network, the filesystem, etc.) or (2) not validating them could result in
272 * internal memory errors such as overflowing a buffer controlled by the
273 * library. On the other hand, it doesn't attempt to validate parameters whose
274 * values are fully controlled by the application (such as pointers).
275 *
276 * When this flag is defined, the library additionally attempts to validate
277 * parameters that are fully controlled by the application, and should always
278 * be valid if the application code is fully correct and trusted.
279 *
280 * For example, when a function accepts as input a pointer to a buffer that may
281 * contain untrusted data, and its documentation mentions that this pointer
282 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200283 * - The pointer is checked to be non-NULL only if this option is enabled.
284 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500285 *
286 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200287 * is invalid:
288 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
289 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
290 * will immediately return. If the function returns an Mbed TLS error code,
291 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500292 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200293 * When defining this flag, you also need to arrange a definition for
294 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
295 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
296 * function mbedtls_param_failed(), but the library does not define this
297 * function. If you do not make any other arrangements, you must provide
298 * the function mbedtls_param_failed() in your application.
299 * See `platform_util.h` for its prototype.
300 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100301 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200302 * You can still supply an alternative definition of
303 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
304 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
305 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
306 * the library will call the macro that you defined and will not supply
307 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
308 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
309 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500310 *
311 * Uncomment to enable validation of application-controlled parameters.
312 */
313//#define MBEDTLS_CHECK_PARAMS
314
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200315/**
316 * \def MBEDTLS_CHECK_PARAMS_ASSERT
317 *
318 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
319 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
320 *
321 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
322 * calling a function mbedtls_param_failed(). See the documentation of
323 * #MBEDTLS_CHECK_PARAMS for details.
324 *
325 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
326 */
327//#define MBEDTLS_CHECK_PARAMS_ASSERT
328
Andrzej Kurek73afe272022-01-24 10:31:06 -0500329/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000330
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000331/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000332 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000333 *
334 * This section sets support for features that are or are not needed
335 * within the modules that are enabled.
336 * \{
337 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000338
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000339/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100341 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200342 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200343 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100344 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100346 *
347 * You will need to provide a header "timing_alt.h" and an implementation at
348 * compile time.
349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100351
352/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100353 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200354 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100355 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100356 * alternate core implementation of a symmetric crypto, an arithmetic or hash
357 * module (e.g. platform specific assembly optimized implementations). Keep
358 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200359 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200360 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000364 * provide the "struct mbedtls_aes_context" definition and omit the base
365 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200366 * "aes.h" to include the new function definitions.
367 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200368 * Uncomment a macro to enable alternate implementation of the corresponding
369 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100370 *
371 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
372 * use constitutes a security risk. If possible, we recommend
373 * avoiding dependencies on them, and considering stronger message
374 * digests and ciphers instead.
375 *
Paul Bakker90995b52013-06-24 19:20:35 +0200376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377//#define MBEDTLS_AES_ALT
378//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000379//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_BLOWFISH_ALT
381//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200382//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300383//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200384//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200385//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000387//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000388//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100389//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300390//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391//#define MBEDTLS_MD2_ALT
392//#define MBEDTLS_MD4_ALT
393//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300394//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000396//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200397//#define MBEDTLS_SHA1_ALT
398//#define MBEDTLS_SHA256_ALT
399//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000400//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000401
Janos Follathb0697532016-08-18 12:38:46 +0100402/*
Shaun Case0e7791f2021-12-20 21:14:10 -0800403 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100404 * implemented with two .c files:
405 * - ecp.c
406 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000407 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
408 * macros as described above. The only difference is that you have to make sure
409 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100410 */
411//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200412
413/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100414 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100416 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
417 * alternate core implementation of symmetric crypto or hash function. Keep in
418 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200419 *
420 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200421 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
424 * no longer provide the mbedtls_sha1_process() function, but it will still provide
425 * the other function (using your mbedtls_sha1_process() function) and the definition
426 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200427 * with this definition.
428 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100429 * \note Because of a signature change, the core AES encryption and decryption routines are
430 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
431 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100432 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100433 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100434 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +0200435 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100436 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
437 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200438 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200439 * Uncomment a macro to enable alternate implementation of the corresponding
440 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100441 *
442 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
443 * constitutes a security risk. If possible, we recommend avoiding
444 * dependencies on them, and considering stronger message digests
445 * and ciphers instead.
446 *
Janos Follath1231d212019-01-07 15:01:32 +0000447 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
448 * enabled, then the deterministic ECDH signature functions pass the
449 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
450 * alternative implementations should use the RNG only for generating
451 * the ephemeral key and nothing else. If this is not possible, then
452 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
453 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
454 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
455 * desirable).
456 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200458//#define MBEDTLS_MD2_PROCESS_ALT
459//#define MBEDTLS_MD4_PROCESS_ALT
460//#define MBEDTLS_MD5_PROCESS_ALT
461//#define MBEDTLS_RIPEMD160_PROCESS_ALT
462//#define MBEDTLS_SHA1_PROCESS_ALT
463//#define MBEDTLS_SHA256_PROCESS_ALT
464//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200465//#define MBEDTLS_DES_SETKEY_ALT
466//#define MBEDTLS_DES_CRYPT_ECB_ALT
467//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200468//#define MBEDTLS_AES_SETKEY_ENC_ALT
469//#define MBEDTLS_AES_SETKEY_DEC_ALT
470//#define MBEDTLS_AES_ENCRYPT_ALT
471//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300472//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300473//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300474//#define MBEDTLS_ECDSA_VERIFY_ALT
475//#define MBEDTLS_ECDSA_SIGN_ALT
476//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200477
478/**
Janos Follathc44ab972016-11-18 16:38:23 +0000479 * \def MBEDTLS_ECP_INTERNAL_ALT
480 *
481 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100482 *
483 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100484 * alternative core implementation of elliptic curve arithmetic. Keep in mind
485 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100486 *
487 * This partially replaces one function. The header file from mbed TLS is still
488 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
489 * is still present and it is used for group structures not supported by the
490 * alternative.
491 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100492 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100493 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100494 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
495 * able to fallback to curves not supported by the alternative implementation.
496 *
Janos Follathc44ab972016-11-18 16:38:23 +0000497 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
498 * and implementing the following functions:
499 * unsigned char mbedtls_internal_ecp_grp_capable(
500 * const mbedtls_ecp_group *grp )
501 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500502 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000503 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
504 * replacement functions implement arithmetic for the given group and 0
505 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500506 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000507 * called before and after each point operation and provide an opportunity to
508 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100509 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100510 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
511 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
512 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
513 * for the operation is supported by your implementation (i.e. your
514 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
515 * group is not supported by your implementation, then the original mbed TLS
516 * implementation of ecp_double_jac() is used instead, unless this fallback
517 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
518 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
519 *
520 * The function prototypes and the definition of mbedtls_ecp_group and
521 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
522 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
523 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100524 *
525 * Uncomment a macro to enable alternate implementation of the corresponding
526 * function.
527 */
528/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000529//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100530/* Turn off software fallback for curves not supported in hardware */
531//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100532/* Support for Weierstrass curves with Jacobi representation */
533//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
534//#define MBEDTLS_ECP_ADD_MIXED_ALT
535//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
536//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
537//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
538/* Support for curves with Montgomery arithmetic */
539//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
540//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
541//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
542
543/**
Simon Butcherab5df402016-06-11 02:31:21 +0100544 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100545 *
Simon Butcherab5df402016-06-11 02:31:21 +0100546 * Enables testing and use of mbed TLS without any configured entropy sources.
547 * This permits use of the library on platforms before an entropy source has
548 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
549 * MBEDTLS_ENTROPY_NV_SEED switches).
550 *
551 * WARNING! This switch MUST be disabled in production builds, and is suitable
552 * only for development.
553 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100554 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100555 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
556 *
Janos Follath53de7842016-06-08 15:29:18 +0100557 */
Simon Butcherab5df402016-06-11 02:31:21 +0100558//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100559
560/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200561 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200562 *
563 * Uncomment this macro to let mbed TLS use your own implementation of a
564 * hardware entropy collector.
565 *
566 * Your function must be called \c mbedtls_hardware_poll(), have the same
567 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
568 *
569 * Uncomment to use your own hardware entropy collector.
570 */
571//#define MBEDTLS_ENTROPY_HARDWARE_ALT
572
573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000575 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100576 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000577 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100578 * Uncomment this macro to use precomputed AES tables stored in ROM.
579 * Comment this macro to generate AES tables in RAM at runtime.
580 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100581 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
582 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100583 * initialization time before the first AES operation can be performed.
584 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
585 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
586 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100587 *
588 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
589 *
Paul Bakker15566e42011-04-24 21:19:15 +0000590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000592
593/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100594 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200595 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100596 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200597 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100598 * Uncommenting this macro omits 75% of the AES tables from
599 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
600 * by computing their values on the fly during operations
601 * (the tables are entry-wise rotations of one another).
602 *
603 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100604 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100605 * runtime. Specifically, one has to compare 4 accesses within
606 * different tables to 4 accesses with additional arithmetic
607 * operations within the same table. The performance gain/loss
608 * depends on the system and memory details.
609 *
610 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
611 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200612 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100613//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200614
615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200617 *
618 * Use less ROM for the Camellia implementation (saves about 768 bytes).
619 *
620 * Uncomment this macro to use less memory for Camellia.
621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200622//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200623
624/**
Gilles Peskine8472a102021-09-23 18:07:36 +0200625 * \def MBEDTLS_CHECK_RETURN_WARNING
626 *
627 * If this macro is defined, emit a compile-time warning if application code
628 * calls a function without checking its return value, but the return value
629 * should generally be checked in portable applications.
630 *
631 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
632 * implemented. Otherwise this option has no effect.
633 *
634 * Uncomment to get warnings on using fallible functions without checking
635 * their return value.
636 *
637 * \note This feature is a work in progress.
638 * Warnings will be added to more functions in the future.
639 *
640 * \note A few functions are considered critical, and ignoring the return
641 * value of these functions will trigger a warning even if this
642 * macro is not defined. To completely disable return value check
643 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
644 */
645//#define MBEDTLS_CHECK_RETURN_WARNING
646
647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200649 *
650 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200653
654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000656 *
657 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000660
661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000663 *
664 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200666#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000667
668/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100669 * \def MBEDTLS_CIPHER_MODE_OFB
670 *
671 * Enable Output Feedback mode (OFB) for symmetric ciphers.
672 */
673#define MBEDTLS_CIPHER_MODE_OFB
674
675/**
676 * \def MBEDTLS_CIPHER_MODE_XTS
677 *
678 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
679 */
680#define MBEDTLS_CIPHER_MODE_XTS
681
682/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000684 *
685 * Enable NULL cipher.
686 * Warning: Only do so when you know what you are doing. This allows for
687 * encryption or channels without any security!
688 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000690 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
692 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
693 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
694 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
695 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
696 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
697 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
698 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
699 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
700 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
701 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
702 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
703 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
704 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
705 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
706 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
707 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
708 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
709 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000710 *
711 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000714
715/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100716 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200717 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100718 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
719 * specific padding modes in the cipher layer with cipher modes that support
720 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200721 *
722 * If you disable all padding modes, only full blocks can be used with CBC.
723 *
724 * Enable padding modes in the cipher layer.
725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726#define MBEDTLS_CIPHER_PADDING_PKCS7
727#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
728#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
729#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200730
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200731/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
732 *
733 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
734 * By default, CTR_DRBG uses a 256-bit key.
735 */
736//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
737
Paul Bakker48e93c82013-08-14 12:21:18 +0200738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000740 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200741 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000742 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000743 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000744 *
745 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
747 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000748 *
749 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100750 *
751 * \warning DES is considered a weak cipher and its use constitutes a
752 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000755
756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200758 *
759 * Remove RC4 ciphersuites by default in SSL / TLS.
760 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200762 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200763 * explicitly.
764 *
765 * Uncomment this macro to remove RC4 ciphersuites by default.
766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200768
769/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000770 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
771 *
772 * Remove 3DES ciphersuites by default in SSL / TLS.
773 * This flag removes the ciphersuites based on 3DES from the default list as
774 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
775 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
776 * them explicitly.
777 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000778 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000779 * a TLS connection using a 3DES based cipher suite (see "On the Practical
780 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
781 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
782 * in your threat model or you are unsure, then you should keep this option
783 * enabled to remove 3DES based cipher suites.
784 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000785 * Comment this macro to keep 3DES in the default ciphersuite list.
786 */
787#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
788
789/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100790 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200791 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100792 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
793 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200794 *
795 * Comment macros to disable the curve and functions for it
796 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200797/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
799#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
800#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
801#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
802#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
803#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
804#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
805#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
806#define MBEDTLS_ECP_DP_BP256R1_ENABLED
807#define MBEDTLS_ECP_DP_BP384R1_ENABLED
808#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200809/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200810#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000811#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200812
813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200815 *
816 * Enable specific 'modulo p' routines for each NIST prime.
817 * Depending on the prime and architecture, makes operations 4 to 8 times
818 * faster on the corresponding curve.
819 *
820 * Comment this macro to disable NIST curves optimisation.
821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200823
824/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200825 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
826 *
827 * When this option is disabled, mbedtls_ecp_mul() will make use of an
828 * internal RNG when called with a NULL \c f_rng argument, in order to protect
829 * against some side-channel attacks.
830 *
831 * This protection introduces a dependency of the ECP module on one of the
832 * DRBG modules. For very constrained implementations that don't require this
833 * protection (for example, because you're only doing signature verification,
834 * so not manipulating any secret, or because local/physical side-channel
835 * attacks are outside your threat model), it might be desirable to get rid of
836 * that dependency.
837 *
838 * \warning Enabling this option makes some uses of ECP vulnerable to some
839 * side-channel attacks. Only enable it if you know that's not a problem for
840 * your use case.
841 *
842 * Uncomment this macro to disable some counter-measures in ECP.
843 */
844//#define MBEDTLS_ECP_NO_INTERNAL_RNG
845
846/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200847 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100848 *
849 * Enable "non-blocking" ECC operations that can return early and be resumed.
850 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200851 * This allows various functions to pause by returning
852 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
853 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
854 * order to further progress and eventually complete their operation. This is
855 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
856 * number of ECC operations a function may perform before pausing; see
857 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100858 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200859 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200860 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100861 *
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100862 * This option:
863 * - Adds xxx_restartable() variants of existing operations in the
864 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100865 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
866 * linear combination (muladd);
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100867 * - ECDSA: signature generation & verification;
868 * - PK: signature generation & verification;
869 * - X509: certificate chain verification.
870 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
871 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
872 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
873 * computations restartable:
Tom Cosgrove601e8392023-03-07 11:43:12 +0000874 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100875 * curves;
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100876 * - verification of the server's key exchange signature;
877 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb884f7e2022-12-09 09:53:55 +0100878 * - generation of the client's signature if client authentication is used,
879 * with an ECC key/certificate.
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100880 *
881 * \note In the cases above, the usual SSL/TLS functions, such as
882 * mbedtls_ssl_handshake(), can now return
883 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200884 *
Ron Eldor19779c42018-11-05 16:58:13 +0200885 * \note This option only works with the default software implementation of
886 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100887 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT,
888 * MBEDTLS_ECDH_LEGACY_CONTEXT, and MBEDTLS_USE_PSA_CRYPTO.
889 *
Manuel Pégourié-Gonnard3dc7f232022-12-06 13:20:06 +0100890 * Requires: MBEDTLS_ECP_C
891 *
Manuel Pégourié-Gonnard875d1eb2022-12-06 10:42:44 +0100892 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100893 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200894//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100895
896/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100897 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
898 *
899 * Use a backward compatible ECDH context.
900 *
901 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
902 * defined in `ecdh.h`). For most applications, the choice of format makes
903 * no difference, since all library functions can work with either format,
904 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
905
906 * The new format used when this option is disabled is smaller
907 * (56 bytes on a 32-bit platform). In future versions of the library, it
908 * will support alternative implementations of ECDH operations.
909 * The new format is incompatible with applications that access
910 * context fields directly and with restartable ECP operations.
911 *
912 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
913 * want to access ECDH context fields directly. Otherwise you should
914 * comment out this macro definition.
915 *
916 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
917 *
918 * \note This configuration option is experimental. Future versions of the
919 * library may modify the way the ECDH context layout is configured
920 * and may modify the layout of the new context type.
921 */
922#define MBEDTLS_ECDH_LEGACY_CONTEXT
923
924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100926 *
927 * Enable deterministic ECDSA (RFC 6979).
928 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
929 * may result in a compromise of the long-term signing key. This is avoided by
930 * the deterministic variant.
931 *
John Durkop36a82e52020-10-26 09:39:05 -0700932 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100933 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100934 * Comment this macro to disable deterministic ECDSA.
935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100937
938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200940 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200941 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200942 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200943 * This enables the following ciphersuites (if other requisites are
944 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
946 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
947 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
948 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
949 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
950 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
951 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
952 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
953 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
954 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
955 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
956 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200959
960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200962 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200963 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200964 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200966 *
967 * This enables the following ciphersuites (if other requisites are
968 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
970 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
971 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
972 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
973 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
974 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
975 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
976 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
977 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
978 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
979 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
980 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100981 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100982 * \warning Using DHE constitutes a security risk as it
983 * is not possible to validate custom DH parameters.
984 * If possible, it is recommended users should consider
985 * preferring other methods of key exchange.
986 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100987 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200988 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200990
991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200993 *
994 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200997 *
998 * This enables the following ciphersuites (if other requisites are
999 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1001 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1002 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1003 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1004 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1005 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1006 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
1007 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +02001010
1011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001013 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001014 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +02001015 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1017 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001018 *
1019 * This enables the following ciphersuites (if other requisites are
1020 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1022 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1023 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1024 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
1025 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
1026 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1027 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1028 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1029 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
1030 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
1031 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
1032 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001035
1036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001038 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001039 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1042 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001043 *
1044 * This enables the following ciphersuites (if other requisites are
1045 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1047 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1048 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1049 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
1050 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
1051 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
1052 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1053 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1054 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1055 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1056 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1057 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1058 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
1059 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
1060 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +02001061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001063
1064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001066 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001067 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001068 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1070 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001071 *
1072 * This enables the following ciphersuites (if other requisites are
1073 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1075 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1076 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1077 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1078 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1079 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1080 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1081 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1082 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1083 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1084 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1085 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1086 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001087 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001088 * \warning Using DHE constitutes a security risk as it
1089 * is not possible to validate custom DH parameters.
1090 * If possible, it is recommended users should consider
1091 * preferring other methods of key exchange.
1092 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001093 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001096
1097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001099 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001100 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1103 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001104 *
1105 * This enables the following ciphersuites (if other requisites are
1106 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1108 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1109 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1110 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1111 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1112 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1113 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1114 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1115 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1116 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1117 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1118 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001121
1122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001124 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001125 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001126 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001128 *
1129 * This enables the following ciphersuites (if other requisites are
1130 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1132 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1135 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1137 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1140 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1141 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1142 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001145
1146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001148 *
1149 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1150 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001151 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001152 *
1153 * This enables the following ciphersuites (if other requisites are
1154 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1156 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1157 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1158 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1159 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1160 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1161 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1162 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1163 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1164 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1165 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1166 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001169
1170/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001172 *
1173 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1174 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001175 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001176 *
1177 * This enables the following ciphersuites (if other requisites are
1178 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1180 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1184 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1185 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1186 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1187 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1188 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1189 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1190 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001193
1194/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001195 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1196 *
1197 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1198 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001199 * \warning This is currently experimental. EC J-PAKE support is based on the
1200 * Thread v1.0.0 specification; incompatible changes to the specification
1201 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001202 *
1203 * Requires: MBEDTLS_ECJPAKE_C
1204 * MBEDTLS_SHA256_C
1205 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1206 *
1207 * This enables the following ciphersuites (if other requisites are
1208 * enabled as well):
1209 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1210 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001211//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001212
1213/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001215 *
1216 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1217 * RFC 5915 and RFC 5480.
1218 *
1219 * Currently this means parsing the SpecifiedECDomain choice of EC
1220 * parameters (only known groups are supported, not arbitrary domains, to
1221 * avoid validation issues).
1222 *
1223 * Disable if you only need to support RFC 5915 + 5480 key formats.
1224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001226
1227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001229 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230 * Enable a dummy error function to make use of mbedtls_strerror() in
1231 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1232 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1235 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001236 *
1237 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001238 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001241
1242/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001244 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001245 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001246 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001249#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001250
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001253 *
1254 * Enable functions that use the filesystem.
1255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001256#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001257
1258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001260 *
1261 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001263 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001264 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001265 * application.
1266 *
1267 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001270
1271/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001273 *
1274 * Do not use built-in platform entropy functions.
1275 * This is useful if your platform does not support
1276 * standards like the /dev/urandom or Windows CryptoAPI.
1277 *
1278 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001279 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001280//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001281
1282/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001284 *
1285 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1286 * default SHA-512 based one (if both are available).
1287 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001289 *
1290 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1291 * if you have performance concerns.
1292 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293 * This option is only useful if both MBEDTLS_SHA256_C and
1294 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001297
1298/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001299 * \def MBEDTLS_ENTROPY_NV_SEED
1300 *
1301 * Enable the non-volatile (NV) seed file-based entropy source.
1302 * (Also enables the NV seed read/write functions in the platform layer)
1303 *
1304 * This is crucial (if not required) on systems that do not have a
1305 * cryptographic entropy source (in hardware or kernel) available.
1306 *
1307 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1308 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001309 * \note The read/write functions that are used by the entropy source are
1310 * determined in the platform layer, and can be modified at runtime and/or
1311 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1312 *
1313 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001314 * with regular fopen(), please make sure you make a seedfile with the
1315 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1316 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001317 * and written to or you will get an entropy source error! The default
1318 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1319 * bytes from the file.
1320 *
1321 * \note The entropy collector will write to the seed file before entropy is
1322 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001323 */
1324//#define MBEDTLS_ENTROPY_NV_SEED
1325
Ronald Cron71016a92020-08-28 19:01:50 +02001326/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001327 *
Ronald Cron71016a92020-08-28 19:01:50 +02001328 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001329 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001330 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1331 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001332 *
1333 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001334 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001335 */
Ronald Cron71016a92020-08-28 19:01:50 +02001336//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001337
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001338/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001340 *
1341 * Enable debugging of buffer allocator memory issues. Automatically prints
1342 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1343 * function for 'debug output' of allocated memory.
1344 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001346 *
1347 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001350
1351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001353 *
1354 * Include backtrace information with each allocated block.
1355 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrove5205c972022-07-28 06:12:08 +01001357 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001358 *
1359 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001360 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001362
1363/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001365 *
1366 * Support external private RSA keys (eg from a HSM) in the PK layer.
1367 *
1368 * Comment this macro to disable support for external private RSA keys.
1369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001371
1372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001374 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001375 * Enable support for PKCS#1 v1.5 encoding.
1376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001378 *
Paul Bakker48377d92013-08-30 12:06:24 +02001379 * This enables support for PKCS#1 v1.5 operations.
1380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001382
1383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001385 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001386 * Enable support for PKCS#1 v2.1 encoding.
1387 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001389 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001390 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001393
Steven Cooreman6801f082021-02-19 17:21:22 +01001394/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1395 *
1396 * Enable support for platform built-in keys. If you enable this feature,
1397 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1398 * See the documentation of that function for more information.
1399 *
1400 * Built-in keys are typically derived from a hardware unique key or
1401 * stored in a secure element.
1402 *
1403 * Requires: MBEDTLS_PSA_CRYPTO_C.
1404 *
1405 * \warning This interface is experimental and may change or be removed
1406 * without notice.
1407 */
1408//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1409
Ronald Cron3768ac12021-01-26 16:58:00 +01001410/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1411 *
1412 * Enable support for PSA crypto client.
1413 *
1414 * \note This option allows to include the code necessary for a PSA
1415 * crypto client when the PSA crypto implementation is not included in
1416 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1417 * code to set and get PSA key attributes.
1418 * The development of PSA drivers partially relying on the library to
1419 * fulfill the hardware gaps is another possible usage of this option.
1420 *
1421 * \warning This interface is experimental and may change or be removed
1422 * without notice.
1423 */
1424//#define MBEDTLS_PSA_CRYPTO_CLIENT
1425
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001426/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1427 *
1428 * Enable support for the experimental PSA crypto driver interface.
1429 *
John Durkop185764f2020-10-12 21:32:12 -07001430 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001431 *
1432 * \warning This interface is experimental and may change or be removed
1433 * without notice.
1434 */
1435//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1436
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001437/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1438 *
1439 * Make the PSA Crypto module use an external random generator provided
1440 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1441 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001442 * \note This random generator must deliver random numbers with cryptographic
1443 * quality and high performance. It must supply unpredictable numbers
1444 * with a uniform distribution. The implementation of this function
1445 * is responsible for ensuring that the random generator is seeded
1446 * with sufficient entropy. If you have a hardware TRNG which is slow
1447 * or delivers non-uniform output, declare it as an entropy source
1448 * with mbedtls_entropy_add_source() instead of enabling this option.
1449 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001450 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001451 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1452 * and define a function called mbedtls_psa_external_get_random()
1453 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001454 * ```
1455 * psa_status_t mbedtls_psa_external_get_random(
1456 * mbedtls_psa_external_random_context_t *context,
1457 * uint8_t *output, size_t output_size, size_t *output_length);
1458 * );
1459 * ```
1460 * The \c context value is initialized to 0 before the first call.
1461 * The function must fill the \c output buffer with \p output_size bytes
1462 * of random data and set \c *output_length to \p output_size.
1463 *
1464 * Requires: MBEDTLS_PSA_CRYPTO_C
1465 *
1466 * \warning If you enable this option, code that uses the PSA cryptography
1467 * interface will not use any of the entropy sources set up for
1468 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1469 * enables.
1470 *
1471 * \note This option is experimental and may be removed without notice.
1472 */
1473//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1474
Paul Bakker9dcc3222011-03-08 14:16:06 +00001475/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001476 * \def MBEDTLS_PSA_CRYPTO_SPM
1477 *
1478 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1479 * Partition Manager) integration which separates the code into two parts: a
1480 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1481 * Environment).
1482 *
1483 * Module: library/psa_crypto.c
1484 * Requires: MBEDTLS_PSA_CRYPTO_C
1485 *
1486 */
1487//#define MBEDTLS_PSA_CRYPTO_SPM
1488
1489/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001490 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001491 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001492 * Enable support for entropy injection at first boot. This feature is
1493 * required on systems that do not have a built-in entropy source (TRNG).
1494 * This feature is currently not supported on systems that have a built-in
1495 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001496 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001497 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001498 *
1499 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001500//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001501
1502/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001504 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001505 * Do not use the Chinese Remainder Theorem
1506 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001507 *
1508 * Uncomment this macro to disable the use of CRT in RSA.
1509 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001512
1513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001515 *
1516 * Enable the checkup functions (*_self_test).
1517 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001518#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001519
1520/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001521 * \def MBEDTLS_SHA256_SMALLER
1522 *
1523 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1524 * lower performance.
1525 *
Adam Wolfef30d902019-09-10 09:53:08 -05001526 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001527 * performance and size. This version optimizes more aggressively for size at
1528 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1529 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1530 * 30%.
1531 *
1532 * Uncomment to enable the smaller implementation of SHA256.
1533 */
1534//#define MBEDTLS_SHA256_SMALLER
1535
1536/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001537 * \def MBEDTLS_SHA512_SMALLER
1538 *
1539 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1540 * lower performance.
1541 *
1542 * Uncomment to enable the smaller implementation of SHA512.
1543 */
1544//#define MBEDTLS_SHA512_SMALLER
1545
1546/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001547 * \def MBEDTLS_SHA512_NO_SHA384
1548 *
1549 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1550 * code size on devices that don't use SHA-384.
1551 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001552 * Requires: MBEDTLS_SHA512_C
1553 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001554 * Uncomment to disable SHA-384
1555 */
1556//#define MBEDTLS_SHA512_NO_SHA384
1557
1558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001560 *
1561 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001562 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001563 * with other servers, only debugging of failures is harder.
1564 *
1565 * The advantage of not sending alert messages, is that no information is given
1566 * about reasons for failures thus preventing adversaries of gaining intel.
1567 *
1568 * Enable sending of all alert messages
1569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001571
1572/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001573 * \def MBEDTLS_SSL_RECORD_CHECKING
1574 *
1575 * Enable the function mbedtls_ssl_check_record() which can be used to check
1576 * the validity and authenticity of an incoming record, to verify that it has
1577 * not been seen before. These checks are performed without modifying the
1578 * externally visible state of the SSL context.
1579 *
1580 * See mbedtls_ssl_check_record() for more information.
1581 *
1582 * Uncomment to enable support for record checking.
1583 */
1584#define MBEDTLS_SSL_RECORD_CHECKING
1585
1586/**
1587 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1588 *
1589 * Enable support for the DTLS Connection ID extension
1590 * (version draft-ietf-tls-dtls-connection-id-05,
1591 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1592 * which allows to identify DTLS connections across changes
1593 * in the underlying transport.
1594 *
1595 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1596 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1597 * See the corresponding documentation for more information.
1598 *
1599 * \warning The Connection ID extension is still in draft state.
1600 * We make no stability promises for the availability
1601 * or the shape of the API controlled by this option.
1602 *
1603 * The maximum lengths of outgoing and incoming CIDs can be configured
1604 * through the options
1605 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1606 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1607 *
1608 * Requires: MBEDTLS_SSL_PROTO_DTLS
1609 *
1610 * Uncomment to enable the Connection ID extension.
1611 */
1612//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1613
1614/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001615 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1616 *
1617 * Enable asynchronous external private key operations in SSL. This allows
1618 * you to configure an SSL connection to call an external cryptographic
1619 * module to perform private key operations instead of performing the
1620 * operation inside the library.
1621 *
1622 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001623//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001624
1625/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001626 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1627 *
1628 * Enable serialization of the TLS context structures, through use of the
1629 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1630 *
1631 * This pair of functions allows one side of a connection to serialize the
1632 * context associated with the connection, then free or re-use that context
1633 * while the serialized state is persisted elsewhere, and finally deserialize
1634 * that state to a live context for resuming read/write operations on the
1635 * connection. From a protocol perspective, the state of the connection is
1636 * unaffected, in particular this is entirely transparent to the peer.
1637 *
1638 * Note: this is distinct from TLS session resumption, which is part of the
1639 * protocol and fully visible by the peer. TLS session resumption enables
1640 * establishing new connections associated to a saved session with shorter,
1641 * lighter handshakes, while context serialization is a local optimization in
1642 * handling a single, potentially long-lived connection.
1643 *
1644 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1645 * saved after the handshake to allow for more efficient serialization, so if
1646 * you don't need this feature you'll save RAM by disabling it.
1647 *
Przemek Stekiel864b43d2022-10-05 11:47:29 +02001648 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1649 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001650 * Comment to disable the context serialization APIs.
1651 */
1652#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1653
1654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001656 *
1657 * Enable the debug messages in SSL module for all issues.
1658 * Debug messages have been disabled in some places to prevent timing
1659 * attacks due to (unbalanced) debugging function calls.
1660 *
1661 * If you need all error reporting you should enable this during debugging,
1662 * but remove this for production servers that should log as well.
1663 *
1664 * Uncomment this macro to report all debug messages on errors introducing
1665 * a timing side-channel.
1666 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001671 *
1672 * Enable support for Encrypt-then-MAC, RFC 7366.
1673 *
1674 * This allows peers that both support it to use a more robust protection for
1675 * ciphersuites using CBC, providing deep resistance against timing attacks
1676 * on the padding or underlying cipher.
1677 *
1678 * This only affects CBC ciphersuites, and is useless if none is defined.
1679 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1681 * MBEDTLS_SSL_PROTO_TLS1_1 or
1682 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001683 *
1684 * Comment this macro to disable support for Encrypt-then-MAC
1685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001688/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001689 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001690 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1691 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001692 *
Shaun Case0e7791f2021-12-20 21:14:10 -08001693 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001694 * attacks, but it is recommended to always use it (even if you disable
1695 * renegotiation), since it actually fixes a more fundamental issue in the
1696 * original SSL/TLS design, and has implications beyond Triple Handshake.
1697 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1699 * MBEDTLS_SSL_PROTO_TLS1_1 or
1700 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001701 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001702 * Comment this macro to disable support for Extended Master Secret.
1703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001705
Paul Bakkerd66f0702013-01-31 16:57:45 +01001706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001708 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001709 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1710 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001711 *
1712 * For servers, it is recommended to always enable this, unless you support
1713 * only one version of TLS, or know for sure that none of your clients
1714 * implements a fallback strategy.
1715 *
1716 * For clients, you only need this if you're using a fallback strategy, which
1717 * is not recommended in the first place, unless you absolutely need it to
1718 * interoperate with buggy (version-intolerant) servers.
1719 *
1720 * Comment this macro to disable support for FALLBACK_SCSV
1721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001723
1724/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001725 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1726 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001727 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001728 * giving access to the peer's certificate after completion of the handshake.
1729 *
1730 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1731 * recommended to disable this option for reduced RAM usage.
1732 *
1733 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1734 * defined, but always returns \c NULL.
1735 *
1736 * \note This option has no influence on the protection against the
1737 * triple handshake attack. Even if it is disabled, Mbed TLS will
1738 * still ensure that certificates do not change during renegotiation,
Shaun Case0e7791f2021-12-20 21:14:10 -08001739 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001740 *
1741 * Comment this macro to disable storing the peer's certificate
1742 * after the handshake.
1743 */
1744#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1745
1746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001747 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001748 *
1749 * Enable hooking functions in SSL module for hardware acceleration of
1750 * individual records.
1751 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001752 * \deprecated This option is deprecated and will be removed in a future
1753 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001754 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001755 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001758
1759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001761 *
1762 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1763 *
1764 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1765 * of interoperability issues compared to sending 0-length records.
1766 *
1767 * Comment this macro to disable 1/n-1 record splitting.
1768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001770
1771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001772 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001773 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001774 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001775 *
1776 * The two main uses of renegotiation are (1) refresh keys on long-lived
1777 * connections and (2) client authentication after the initial handshake.
1778 * If you don't need renegotiation, it's probably better to disable it, since
1779 * it has been associated with security issues in the past and is easy to
1780 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001781 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001782 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001783 *
1784 * \note Even if this option is disabled, both client and server are aware
1785 * of the Renegotiation Indication Extension (RFC 5746) used to
1786 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1787 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1788 * configuration of this extension).
1789 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001792
1793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001795 *
1796 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001798 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001799 * \deprecated This option is deprecated and will be removed in a future
1800 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001801 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001802 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001805
1806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001808 *
1809 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001811 *
1812 * Uncomment this macro to respect client's ciphersuite order
1813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001815
1816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001819 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001820 *
1821 * Comment this macro to disable support for the max_fragment_length extension
1822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001824
1825/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001827 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001828 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001829 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 * Requires: MBEDTLS_MD5_C
1831 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001832 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001833 * \deprecated This option is deprecated and will be removed in a future
1834 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001835 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001836 * Comment this macro to disable support for SSL 3.0
1837 */
Janos Follathe2681a42016-03-07 15:57:05 +00001838//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001839
1840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001842 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001843 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 * Requires: MBEDTLS_MD5_C
1846 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001847 *
1848 * Comment this macro to disable support for TLS 1.0
1849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001850#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001851
1852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001854 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001855 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001856 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857 * Requires: MBEDTLS_MD5_C
1858 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001859 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001860 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001863
1864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001866 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001867 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001868 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001870 * (Depends on ciphersuites)
1871 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001872 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001875
1876/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001877 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1878 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001879 * This macro is used to selectively enable experimental parts
1880 * of the code that contribute to the ongoing development of
1881 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1882 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001883 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001884 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1885 * and no feature exposed through this macro is part of the
1886 * public API. In particular, features under the control
1887 * of this macro are experimental and don't come with any
1888 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001889 *
1890 * Uncomment this macro to enable experimental and partial
1891 * functionality specific to TLS 1.3.
1892 */
Hanno Beckere4160602020-05-07 15:11:45 +01001893//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001894
1895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001897 *
1898 * Enable support for DTLS (all available versions).
1899 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1901 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001902 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1904 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001905 *
1906 * Comment this macro to disable support for DTLS
1907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001909
1910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001912 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001913 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001914 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001915 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001918
1919/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001921 *
1922 * Enable support for the anti-replay mechanism in DTLS.
1923 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 * Requires: MBEDTLS_SSL_TLS_C
1925 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001926 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001927 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001928 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001929 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001930 * Comment this to disable anti-replay in DTLS.
1931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001933
1934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001936 *
1937 * Enable support for HelloVerifyRequest on DTLS servers.
1938 *
1939 * This feature is highly recommended to prevent DTLS servers being used as
1940 * amplifiers in DoS attacks against other hosts. It should always be enabled
1941 * unless you know for sure amplification cannot be a problem in the
1942 * environment in which your server operates.
1943 *
Andrzej Kurek293e4522022-04-13 14:28:52 -04001944 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001945 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001946 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001947 *
1948 * Comment this to disable support for HelloVerifyRequest.
1949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001951
1952/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001953 * \def MBEDTLS_SSL_DTLS_SRTP
1954 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02001955 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001956 * through the use_srtp extension.
1957 *
1958 * \note This feature provides the minimum functionality required
1959 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1960 * the associated SRTP packet protection key material.
1961 * In particular, the SRTP packet protection itself, as well as the
1962 * demultiplexing of RTP and DTLS packets at the datagram layer
1963 * (see Section 5 of RFC 5764), are not handled by this feature.
1964 * Instead, after successful completion of a handshake negotiating
1965 * the use of DTLS-SRTP, the extended key exporter API
1966 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1967 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1968 * (this is implemented in the SSL example programs).
1969 * The resulting key should then be passed to an SRTP stack.
1970 *
1971 * Setting this option enables the runtime API
1972 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1973 * through which the supported DTLS-SRTP protection
1974 * profiles can be configured. You must call this API at
1975 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001976 *
1977 * Requires: MBEDTLS_SSL_PROTO_DTLS
1978 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001979 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001980 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001981//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001982
1983/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001984 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1985 *
1986 * Enable server-side support for clients that reconnect from the same port.
1987 *
1988 * Some clients unexpectedly close the connection and try to reconnect using the
1989 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001990 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001991 * flag enables that support.
1992 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001993 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001994 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001995 * Comment this to disable support for clients reusing the source port.
1996 */
1997#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1998
1999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002001 *
2002 * Enable support for a limit of records with bad MAC.
2003 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002004 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002005 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002009
2010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002012 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002013 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01002014 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02002015 * session store remains the responsibility of the application, though).
2016 * Server-side, you also need to provide callbacks for writing and parsing
2017 * tickets, including authenticated encryption and key management. Example
2018 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02002019 *
2020 * Comment this macro to disable support for SSL session tickets
2021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02002023
2024/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002025 * \def MBEDTLS_SSL_EXPORT_KEYS
2026 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002027 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002028 * This is required for certain users of TLS, e.g. EAP-TLS.
2029 *
2030 * Comment this macro to disable support for key export
2031 */
2032#define MBEDTLS_SSL_EXPORT_KEYS
2033
2034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002036 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002037 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02002038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00002040 *
Paul Bakker0be444a2013-08-27 21:55:01 +02002041 * Comment this macro to disable support for server name indication in SSL
2042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002044
2045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002048 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02002049 *
2050 * Comment this macro to disable support for truncated HMAC in SSL
2051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002052#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02002053
2054/**
Hanno Beckere89353a2017-11-20 16:36:41 +00002055 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2056 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002057 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
2058 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002059 * only meant for a transitory upgrade period and will be removed in a future
2060 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00002061 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00002062 * \warning The old implementation is non-compliant and has a security weakness
2063 * (2^80 brute force attack on the HMAC key used for a single,
2064 * uninterrupted connection). This should only be enabled temporarily
2065 * when (1) the use of truncated HMAC is essential in order to save
2066 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
2067 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00002068 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01002069 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00002070 * future version of Mbed TLS.
2071 *
Hanno Beckere89353a2017-11-20 16:36:41 +00002072 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
2073 *
2074 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
2075 */
2076//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
2077
2078/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002079 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2080 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002081 * When this option is enabled, the SSL buffer will be resized automatically
2082 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002083 *
2084 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002085 */
2086//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2087
2088/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002089 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2090 *
2091 * Enable testing of the constant-flow nature of some sensitive functions with
2092 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002093 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002094 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002095 * This setting requires compiling with clang -fsanitize=memory. The test
2096 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002097 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002098 * \warning This macro is only used for extended testing; it is not considered
2099 * part of the library's API, so it may change or disappear at any time.
2100 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002101 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002102 */
2103//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2104
2105/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002106 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2107 *
2108 * Enable testing of the constant-flow nature of some sensitive functions with
2109 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002110 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002111 *
2112 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002113 * testing if the tests suites are run with valgrind's memcheck. This can be
2114 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2115 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002116 *
2117 * \warning This macro is only used for extended testing; it is not considered
2118 * part of the library's API, so it may change or disappear at any time.
2119 *
2120 * Uncomment to enable testing of the constant-flow nature of selected code.
2121 */
2122//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2123
2124/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002125 * \def MBEDTLS_TEST_HOOKS
2126 *
2127 * Enable features for invasive testing such as introspection functions and
2128 * hooks for fault injection. This enables additional unit tests.
2129 *
2130 * Merely enabling this feature should not change the behavior of the product.
2131 * It only adds new code, and new branching points where the default behavior
2132 * is the same as when this feature is disabled.
2133 * However, this feature increases the attack surface: there is an added
2134 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2135 * Therefore this feature must never be enabled in production.
2136 *
2137 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2138 * information.
2139 *
2140 * Uncomment to enable invasive tests.
2141 */
2142//#define MBEDTLS_TEST_HOOKS
2143
2144/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002146 *
2147 * Provide your own alternate threading implementation.
2148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002150 *
2151 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002154
2155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002157 *
2158 * Enable the pthread wrapper layer for the threading layer.
2159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002161 *
2162 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002164//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002165
2166/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002167 * \def MBEDTLS_USE_PSA_CRYPTO
2168 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002169 * Make the X.509 and TLS library use PSA for cryptographic operations, and
2170 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002171 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002172 * \note Development of this option is currently in progress, and parts of Mbed
2173 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002174 * will still continue to work as usual, so enabling this option should not
2175 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002176 *
Manuel Pégourié-Gonnard00b72fc2021-09-20 13:21:25 +02002177 * \note See docs/use-psa-crypto.md for a complete description of what this
2178 * option currently does, and of parts that are not affected by it so far.
2179 *
Manuel Pégourié-Gonnardb52b91d2021-09-21 11:30:52 +02002180 * \warning This option enables new Mbed TLS APIs which are currently
2181 * considered experimental and may change in incompatible ways at any time.
2182 * That is, the APIs enabled by this option are not covered by the usual
2183 * promises of API stability.
Hanno Becker51560b62018-11-19 09:46:26 +00002184 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002185 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002186 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002187 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002188 */
2189//#define MBEDTLS_USE_PSA_CRYPTO
2190
2191/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002192 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2193 *
John Durkop185764f2020-10-12 21:32:12 -07002194 * This setting allows support for cryptographic mechanisms through the PSA
2195 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002196 *
Gilles Peskine33665c42022-04-13 23:22:49 +02002197 * When this option is disabled, the PSA API exposes the cryptographic
2198 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2199 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine52834352022-03-16 17:03:55 +01002200 *
2201 * When this option is enabled, the PSA API exposes the cryptographic
2202 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2203 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2204 * automatically enabled if required (i.e. if no PSA driver provides the
2205 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
Gilles Peskine82909762022-04-26 18:10:11 +02002206 * in config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002207 *
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002208 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine8a557752022-04-14 12:44:01 +02002209 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01002210 *
Gilles Peskine58858b72020-11-09 15:26:09 +01002211 * If you enable this option and write your own configuration file, you must
2212 * include mbedtls/config_psa.h in your configuration file. The default
2213 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07002214 *
2215 * This feature is still experimental and is not ready for production since
2216 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002217 */
2218//#define MBEDTLS_PSA_CRYPTO_CONFIG
2219
2220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002222 *
2223 * Allow run-time checking of compile-time enabled features. Thus allowing users
2224 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002226 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002228 *
2229 * Comment this to disable run-time checking and save ROM space
2230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002232
2233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002234 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002235 *
2236 * If set, the X509 parser will not break-off when parsing an X509 certificate
2237 * and encountering an extension in a v1 or v2 certificate.
2238 *
2239 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02002242
2243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002245 *
2246 * If set, the X509 parser will not break-off when parsing an X509 certificate
2247 * and encountering an unknown critical extension.
2248 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002249 * \warning Depending on your PKI use, enabling this can be a security risk!
2250 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002251 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002254
2255/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002256 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2257 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002258 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002259 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2260 * the set of trusted certificates through a callback instead of a linked
2261 * list.
2262 *
2263 * This is useful for example in environments where a large number of trusted
2264 * certificates is present and storing them in a linked list isn't efficient
2265 * enough, or when the set of trusted certificates changes frequently.
2266 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002267 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002268 * `mbedtls_ssl_conf_ca_cb()` for more information.
2269 *
2270 * Uncomment to enable trusted certificate callbacks.
2271 */
2272//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2273
2274/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002276 *
2277 * Enable verification of the keyUsage extension (CA and leaf certificates).
2278 *
2279 * Disabling this avoids problems with mis-issued and/or misused
2280 * (intermediate) CA and leaf certificates.
2281 *
2282 * \warning Depending on your PKI use, disabling this can be a security risk!
2283 *
2284 * Comment to skip keyUsage checking for both CA and leaf certificates.
2285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002287
2288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002290 *
2291 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2292 *
2293 * Disabling this avoids problems with mis-issued and/or misused certificates.
2294 *
2295 * \warning Depending on your PKI use, disabling this can be a security risk!
2296 *
2297 * Comment to skip extendedKeyUsage checking for certificates.
2298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002300
2301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002303 *
2304 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2305 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2306 *
2307 * Comment this macro to disallow using RSASSA-PSS in certificates.
2308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002310
2311/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002313 *
2314 * If set, the SSL/TLS module uses ZLIB to support compression and
2315 * decompression of packet data.
2316 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002317 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2318 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002319 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002320 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002321 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002322 *
Hanno Beckere494e202018-03-08 13:26:12 +00002323 * \deprecated This feature is deprecated and will be removed
2324 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002325 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002326 * Used in: library/ssl_tls.c
2327 * library/ssl_cli.c
2328 * library/ssl_srv.c
2329 *
2330 * This feature requires zlib library and headers to be present.
2331 *
2332 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334//#define MBEDTLS_ZLIB_SUPPORT
Andrzej Kurek73afe272022-01-24 10:31:06 -05002335/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002336
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002337/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002338 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002339 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002340 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002341 * \{
2342 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002343
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002344/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002346 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002347 * Enable AES-NI support on x86-64 or x86-32.
2348 *
2349 * \note AESNI is only supported with certain compilers and target options:
2350 * - Visual Studio 2013: supported.
2351 * - GCC, x86-64, target not explicitly supporting AESNI:
2352 * requires MBEDTLS_HAVE_ASM.
2353 * - GCC, x86-32, target not explicitly supporting AESNI:
2354 * not supported.
2355 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2356 * For this assembly-less implementation, you must currently compile
2357 * `library/aesni.c` and `library/aes.c` with machine options to enable
2358 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2359 * `clang -maes -mpclmul`.
2360 * - Non-x86 targets: this option is silently ignored.
2361 * - Other compilers: this option is silently ignored.
2362 *
2363 * \note
2364 * Above, "GCC" includes compatible compilers such as Clang.
2365 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002366 *
2367 * Module: library/aesni.c
2368 * Caller: library/aes.c
2369 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002370 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002371 *
Gilles Peskinee5038c62023-03-16 17:49:44 +01002372 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002375
2376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002378 *
2379 * Enable the AES block cipher.
2380 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002381 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002382 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002383 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002384 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002385 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002386 * This module enables the following ciphersuites (if other requisites are
2387 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2389 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2390 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2391 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2392 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2394 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2395 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2396 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2398 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2399 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2400 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2401 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2402 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2403 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2404 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2405 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2406 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2407 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2408 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2409 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2410 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2411 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2412 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2413 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2414 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2415 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2416 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2417 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2418 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2419 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2420 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2421 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2422 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2423 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2424 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2425 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2426 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2427 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2428 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2429 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2430 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2431 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2432 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2433 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2434 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2435 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2436 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2437 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2438 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2439 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2440 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2441 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2442 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2443 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2444 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2445 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002446 *
Paul Bakkercff68422013-09-15 20:43:33 +02002447 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002450
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002453 *
2454 * Enable the ARCFOUR stream cipher.
2455 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002456 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002457 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002458 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002459 * This module enables the following ciphersuites (if other requisites are
2460 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2462 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2463 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2464 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2465 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2466 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2467 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2468 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2469 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2470 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002471 *
2472 * \warning ARC4 is considered a weak cipher and its use constitutes a
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00002473 * security risk. If possible, we recommend avoiding dependencies on
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002474 * it, and considering stronger ciphers instead.
2475 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002478
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002481 *
2482 * Enable the generic ASN1 parser.
2483 *
2484 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002485 * Caller: library/x509.c
2486 * library/dhm.c
2487 * library/pkcs12.c
2488 * library/pkcs5.c
2489 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002492
2493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002495 *
2496 * Enable the generic ASN1 writer.
2497 *
2498 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002499 * Caller: library/ecdsa.c
2500 * library/pkwrite.c
2501 * library/x509_create.c
2502 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002503 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002506
2507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002509 *
2510 * Enable the Base64 module.
2511 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002512 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002513 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002514 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002515 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002518
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002521 *
Paul Bakker9a736322012-11-14 12:39:52 +00002522 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002523 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002524 * Module: library/bignum.c
2525 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002526 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002527 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002529 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002531 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002532 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002538 *
2539 * Enable the Blowfish block cipher.
2540 *
2541 * Module: library/blowfish.c
2542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002544
2545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002547 *
2548 * Enable the Camellia block cipher.
2549 *
Paul Bakker38119b12009-01-10 23:31:23 +00002550 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002551 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002552 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002553 * This module enables the following ciphersuites (if other requisites are
2554 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2556 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2557 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2558 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2559 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2560 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2561 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2562 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2563 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2564 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2565 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2566 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2567 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2568 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2569 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2570 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2571 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2572 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2573 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2574 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2575 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2576 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2577 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2578 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2579 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2580 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2581 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2582 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2583 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2584 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2585 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2586 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2587 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2588 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2589 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2590 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2591 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2592 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2593 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2594 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2595 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2596 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002599
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002600/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002601 * \def MBEDTLS_ARIA_C
2602 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002603 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002604 *
2605 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002606 * Caller: library/cipher.c
2607 *
2608 * This module enables the following ciphersuites (if other requisites are
2609 * enabled as well):
2610 *
2611 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2612 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2613 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2614 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2615 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2616 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2617 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2618 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2619 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2620 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2621 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2622 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2623 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2624 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2625 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2626 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2627 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2628 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2629 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2630 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2631 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2632 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2633 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2634 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2635 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2636 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2637 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2638 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2639 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2640 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2641 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2642 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2643 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2644 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2645 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2646 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2647 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2648 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002649 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002650//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002651
2652/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002654 *
2655 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2656 *
2657 * Module: library/ccm.c
2658 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002660 *
2661 * This module enables the AES-CCM ciphersuites, if other requisites are
2662 * enabled as well.
2663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002665
2666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002668 *
2669 * Enable the test certificates.
2670 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002671 * Module: library/certs.c
2672 * Caller:
2673 *
2674 * This module is used for testing (ssl_client/server).
2675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002677
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678/**
Daniel King34b822c2016-05-15 17:28:08 -03002679 * \def MBEDTLS_CHACHA20_C
2680 *
2681 * Enable the ChaCha20 stream cipher.
2682 *
2683 * Module: library/chacha20.c
2684 */
2685#define MBEDTLS_CHACHA20_C
2686
2687/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002688 * \def MBEDTLS_CHACHAPOLY_C
2689 *
2690 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2691 *
2692 * Module: library/chachapoly.c
2693 *
2694 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2695 */
2696#define MBEDTLS_CHACHAPOLY_C
2697
2698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002700 *
2701 * Enable the generic cipher layer.
2702 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002703 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002704 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002705 *
2706 * Uncomment to enable generic cipher wrappers.
2707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002709
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002710/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002711 * \def MBEDTLS_CMAC_C
2712 *
Simon Butcher327398a2016-10-05 14:09:11 +01002713 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2714 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002715 *
Steven Cooreman5d342bf2021-04-26 11:24:44 +02002716 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2717 * implementation of the CMAC algorithm is provided by an alternate
2718 * implementation, that alternate implementation may opt to not support
2719 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2720 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002721 * Module: library/cmac.c
2722 *
Simon Butcher69283e52016-10-06 12:49:58 +01002723 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002724 *
2725 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002726//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002727
2728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002730 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002731 * Enable the CTR_DRBG AES-based random generator.
2732 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002733 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002734 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002735 * \note To achieve a 256-bit security strength with CTR_DRBG,
2736 * you must use AES-256 *and* use sufficient entropy.
2737 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002738 *
2739 * Module: library/ctr_drbg.c
2740 * Caller:
2741 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002742 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002743 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002744 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002747
2748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002750 *
2751 * Enable the debug functions.
2752 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002753 * Module: library/debug.c
2754 * Caller: library/ssl_cli.c
2755 * library/ssl_srv.c
2756 * library/ssl_tls.c
2757 *
2758 * This module provides debugging functions.
2759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002760#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002761
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002762/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002764 *
2765 * Enable the DES block cipher.
2766 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002767 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002768 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002769 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002770 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002771 * This module enables the following ciphersuites (if other requisites are
2772 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2774 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2775 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2776 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2777 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2778 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2779 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2780 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2781 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2782 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002783 *
Paul Bakkercff68422013-09-15 20:43:33 +02002784 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002785 *
Dave Rodgmanb43d5e72023-02-02 10:47:58 +00002786 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002787 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002790
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002793 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002794 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002795 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002796 * Module: library/dhm.c
2797 * Caller: library/ssl_cli.c
2798 * library/ssl_srv.c
2799 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002800 * This module is used by the following key exchanges:
2801 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002802 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002803 * \warning Using DHE constitutes a security risk as it
2804 * is not possible to validate custom DH parameters.
2805 * If possible, it is recommended users should consider
2806 * preferring other methods of key exchange.
2807 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002808 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002811
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002814 *
2815 * Enable the elliptic curve Diffie-Hellman library.
2816 *
2817 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002818 * Caller: library/ssl_cli.c
2819 * library/ssl_srv.c
2820 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002821 * This module is used by the following key exchanges:
2822 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002823 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002827
2828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002830 *
2831 * Enable the elliptic curve DSA library.
2832 *
2833 * Module: library/ecdsa.c
2834 * Caller:
2835 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002836 * This module is used by the following key exchanges:
2837 * ECDHE-ECDSA
2838 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002839 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2840 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2841 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002842 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002844
2845/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002846 * \def MBEDTLS_ECJPAKE_C
2847 *
2848 * Enable the elliptic curve J-PAKE library.
2849 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002850 * \warning This is currently experimental. EC J-PAKE support is based on the
2851 * Thread v1.0.0 specification; incompatible changes to the specification
2852 * might still happen. For this reason, this is disabled by default.
2853 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002854 * Module: library/ecjpake.c
2855 * Caller:
2856 *
2857 * This module is used by the following key exchanges:
2858 * ECJPAKE
2859 *
2860 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2861 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002862//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002863
2864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002866 *
2867 * Enable the elliptic curve over GF(p) library.
2868 *
2869 * Module: library/ecp.c
2870 * Caller: library/ecdh.c
2871 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002872 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002873 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002877
2878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002880 *
2881 * Enable the platform-specific entropy code.
2882 *
2883 * Module: library/entropy.c
2884 * Caller:
2885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002887 *
2888 * This module provides a generic entropy pool
2889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002891
2892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002894 *
2895 * Enable error code to error string conversion.
2896 *
2897 * Module: library/error.c
2898 * Caller:
2899 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002903
2904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002906 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002907 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002908 *
2909 * Module: library/gcm.c
2910 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002911 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002912 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002913 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2914 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002917
2918/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002920 *
2921 * Enable the HAVEGE random generator.
2922 *
Paul Bakker2a844242013-06-24 13:01:53 +02002923 * Warning: the HAVEGE random generator is not suitable for virtualized
2924 * environments
2925 *
2926 * Warning: the HAVEGE random generator is dependent on timing and specific
2927 * processor traits. It is therefore not advised to use HAVEGE as
2928 * your applications primary random generator or primary entropy pool
2929 * input. As a secondary input to your entropy pool, it IS able add
2930 * the (limited) extra entropy it provides.
2931 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002932 * Module: library/havege.c
2933 * Caller:
2934 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002936 *
Paul Bakker2a844242013-06-24 13:01:53 +02002937 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002940
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002941/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002942 * \def MBEDTLS_HKDF_C
2943 *
2944 * Enable the HKDF algorithm (RFC 5869).
2945 *
2946 * Module: library/hkdf.c
2947 * Caller:
2948 *
2949 * Requires: MBEDTLS_MD_C
2950 *
2951 * This module adds support for the Hashed Message Authentication Code
2952 * (HMAC)-based key derivation function (HKDF).
2953 */
2954#define MBEDTLS_HKDF_C
2955
2956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002958 *
2959 * Enable the HMAC_DRBG random generator.
2960 *
2961 * Module: library/hmac_drbg.c
2962 * Caller:
2963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002965 *
Tom Cosgrove2b150752022-05-26 11:55:43 +01002966 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002969
2970/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002971 * \def MBEDTLS_NIST_KW_C
2972 *
2973 * Enable the Key Wrapping mode for 128-bit block ciphers,
2974 * as defined in NIST SP 800-38F. Only KW and KWP modes
2975 * are supported. At the moment, only AES is approved by NIST.
2976 *
2977 * Module: library/nist_kw.c
2978 *
2979 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2980 */
2981//#define MBEDTLS_NIST_KW_C
2982
2983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002985 *
2986 * Enable the generic message digest layer.
2987 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002988 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002989 * Caller:
2990 *
2991 * Uncomment to enable generic message digest wrappers.
2992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002994
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002997 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002998 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002999 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003000 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003001 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00003002 *
3003 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003004 *
3005 * \warning MD2 is considered a weak message digest and its use constitutes a
3006 * security risk. If possible, we recommend avoiding dependencies on
3007 * it, and considering stronger message digests instead.
3008 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003011
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003012/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003014 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003015 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003016 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003017 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003018 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00003019 *
3020 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003021 *
3022 * \warning MD4 is considered a weak message digest and its use constitutes a
3023 * security risk. If possible, we recommend avoiding dependencies on
3024 * it, and considering stronger message digests instead.
3025 *
Paul Bakker6506aff2009-07-28 20:52:02 +00003026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003028
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003031 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003032 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003033 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003034 * Module: library/md5.c
3035 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003036 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01003037 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003038 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003039 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
3040 * depending on the handshake parameters. Further, it is used for checking
3041 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
3042 * encrypted keys.
3043 *
3044 * \warning MD5 is considered a weak message digest and its use constitutes a
3045 * security risk. If possible, we recommend avoiding dependencies on
3046 * it, and considering stronger message digests instead.
3047 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003048 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003050
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003051/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003053 *
3054 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003055 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003056 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02003057 *
3058 * Module: library/memory_buffer_alloc.c
3059 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060 * Requires: MBEDTLS_PLATFORM_C
3061 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02003062 *
3063 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02003064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02003066
3067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003069 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003070 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
3071 *
Simon Butcherd567a232016-03-09 20:19:21 +00003072 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
3073 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003074 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003075 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003076 * \note See also our Knowledge Base article about porting to a new
3077 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003078 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003079 *
Andres AG788aa4a2016-09-14 14:32:09 +01003080 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003081 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003082 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003085
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003088 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003089 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02003090 *
3091 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003092 * Caller: library/asn1write.c
3093 * library/pkcs5.c
3094 * library/pkparse.c
3095 * library/pkwrite.c
3096 * library/rsa.c
3097 * library/x509.c
3098 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003099 * library/x509_crl.c
3100 * library/x509_crt.c
3101 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003102 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003103 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003104 *
3105 * This modules translates between OIDs and internal values.
3106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003108
3109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003111 *
3112 * Enable VIA Padlock support on x86.
3113 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003114 * Module: library/padlock.c
3115 * Caller: library/aes.c
3116 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003118 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003119 * This modules adds support for the VIA PadLock on x86.
3120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003122
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003125 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003126 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003127 *
3128 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003129 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003130 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003131 * library/x509_crl.c
3132 * library/x509_crt.c
3133 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003134 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003136 *
Paul Bakkercff68422013-09-15 20:43:33 +02003137 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003140
3141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003143 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003144 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003145 *
3146 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003147 * Caller: library/pkwrite.c
3148 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003149 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003150 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003152 *
3153 * This modules adds support for encoding / writing PEM files.
3154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003156
3157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003159 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003160 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003161 *
3162 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003163 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003164 * library/ssl_cli.c
3165 * library/ssl_srv.c
3166 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003168 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003169 * Uncomment to enable generic public key wrappers.
3170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003172
3173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003175 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003176 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003177 *
3178 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003179 * Caller: library/x509_crt.c
3180 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003181 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003183 *
3184 * Uncomment to enable generic public key parse functions.
3185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003187
3188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003190 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003191 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003192 *
3193 * Module: library/pkwrite.c
3194 * Caller: library/x509write.c
3195 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003197 *
3198 * Uncomment to enable generic public key write functions.
3199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003201
3202/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003204 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003205 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003206 *
3207 * Module: library/pkcs5.c
3208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003210 *
3211 * This module adds support for the PKCS#5 functions.
3212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003214
3215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003217 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01003218 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00003219 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00003220 * \deprecated This option is deprecated and will be removed in a future
3221 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00003222 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02003223 * Module: library/pkcs11.c
3224 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00003225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003227 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00003228 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00003229 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00003230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003232
3233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003235 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003236 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003237 * Adds algorithms for parsing PKCS#8 encrypted private keys
3238 *
3239 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003240 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003241 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3243 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003244 *
3245 * This module enables PKCS#12 functions.
3246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003248
3249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003251 *
3252 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003253 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003254 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3256 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003257 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003258 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003259 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3260 * as other module rely on it for a fixed snprintf implementation.
3261 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003262 * Module: library/platform.c
3263 * Caller: Most other .c files
3264 *
3265 * This module enables abstraction of common (libc) functions.
3266 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003267#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003268
3269/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003270 * \def MBEDTLS_POLY1305_C
3271 *
3272 * Enable the Poly1305 MAC algorithm.
3273 *
3274 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003275 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003276 */
3277#define MBEDTLS_POLY1305_C
3278
3279/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003280 * \def MBEDTLS_PSA_CRYPTO_C
3281 *
3282 * Enable the Platform Security Architecture cryptography API.
3283 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003284 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003285 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003286 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003287 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003288 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003289 *
3290 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003291#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003292
3293/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003294 * \def MBEDTLS_PSA_CRYPTO_SE_C
3295 *
3296 * Enable secure element support in the Platform Security Architecture
3297 * cryptography API.
3298 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02003299 * \warning This feature is not yet suitable for production. It is provided
3300 * for API evaluation and testing purposes only.
3301 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003302 * Module: library/psa_crypto_se.c
3303 *
3304 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3305 *
3306 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003307//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003308
3309/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003310 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3311 *
3312 * Enable the Platform Security Architecture persistent key storage.
3313 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003314 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003315 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003316 * Requires: MBEDTLS_PSA_CRYPTO_C,
3317 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3318 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003319 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003320#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003321
3322/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003323 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003324 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003325 * Enable the emulation of the Platform Security Architecture
3326 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003327 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003328 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003329 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003330 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003331 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003332#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003333
3334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003336 *
3337 * Enable the RIPEMD-160 hash algorithm.
3338 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003339 * Module: library/ripemd160.c
3340 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003341 *
3342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003344
3345/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003347 *
3348 * Enable the RSA public-key cryptosystem.
3349 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003350 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003351 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003352 * Caller: library/ssl_cli.c
3353 * library/ssl_srv.c
3354 * library/ssl_tls.c
3355 * library/x509.c
3356 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003357 * This module is used by the following key exchanges:
3358 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003359 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003363
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003364/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003366 *
3367 * Enable the SHA1 cryptographic hash algorithm.
3368 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003369 * Module: library/sha1.c
3370 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003371 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003372 * library/ssl_srv.c
3373 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003374 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003375 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003376 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3377 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003378 *
3379 * \warning SHA-1 is considered a weak message digest and its use constitutes
3380 * a security risk. If possible, we recommend avoiding dependencies
3381 * on it, and considering stronger message digests instead.
3382 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003385
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003388 *
3389 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3390 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003391 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003392 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003393 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003394 * library/ssl_cli.c
3395 * library/ssl_srv.c
3396 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003397 *
3398 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003399 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003402
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003405 *
3406 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3407 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003408 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003409 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003410 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003411 * library/ssl_cli.c
3412 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003413 *
3414 * This module adds support for SHA-384 and SHA-512.
3415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003417
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003420 *
3421 * Enable simple SSL cache implementation.
3422 *
3423 * Module: library/ssl_cache.c
3424 * Caller:
3425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003429
3430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003432 *
3433 * Enable basic implementation of DTLS cookies for hello verification.
3434 *
3435 * Module: library/ssl_cookie.c
3436 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003439
3440/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003441 * \def MBEDTLS_SSL_TICKET_C
3442 *
3443 * Enable an implementation of TLS server-side callbacks for session tickets.
3444 *
3445 * Module: library/ssl_ticket.c
3446 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003447 *
Przemek Stekiel97d57402022-10-10 14:08:51 +02003448 * Requires: MBEDTLS_CIPHER_C &&
3449 * ( MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C )
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003450 */
3451#define MBEDTLS_SSL_TICKET_C
3452
3453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003455 *
3456 * Enable the SSL/TLS client code.
3457 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 * Module: library/ssl_cli.c
3459 * Caller:
3460 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003462 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003463 * This module is required for SSL/TLS client support.
3464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003466
Paul Bakker9a736322012-11-14 12:39:52 +00003467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003469 *
3470 * Enable the SSL/TLS server code.
3471 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003472 * Module: library/ssl_srv.c
3473 * Caller:
3474 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003476 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003477 * This module is required for SSL/TLS server support.
3478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003480
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003483 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003484 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003485 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003486 * Module: library/ssl_tls.c
3487 * Caller: library/ssl_cli.c
3488 * library/ssl_srv.c
3489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3491 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003492 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003493 * This module is required for SSL/TLS.
3494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003496
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003499 *
3500 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003501 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003502 * contexts are not shared between threads. If you do intend to use contexts
3503 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003504 * conditions. See also our Knowledge Base article about threading:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003505 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003506 *
3507 * Module: library/threading.c
3508 *
3509 * This allows different threading implementations (self-implemented or
3510 * provided).
3511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * You will have to enable either MBEDTLS_THREADING_ALT or
3513 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003514 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003515 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003518
3519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003521 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003522 * Enable the semi-portable timing interface.
3523 *
Simon Butcherd567a232016-03-09 20:19:21 +00003524 * \note The provided implementation only works on POSIX/Unix (including Linux,
3525 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003526 * module and provide your own implementations of the callbacks needed by
3527 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3528 * your own implementation of the whole module by setting
3529 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003530 *
Andrzej Kurek263d8f72022-04-08 08:34:41 -04003531 * \note The timing module will include time.h on suitable platforms
3532 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3533 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3534 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003535 * \note See also our Knowledge Base article about porting to a new
3536 * environment:
Dave Rodgman4e7892e2022-10-12 16:47:08 +01003537 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003538 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003539 * Module: library/timing.c
3540 * Caller: library/havege.c
3541 *
3542 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003545
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003548 *
3549 * Enable run-time version information.
3550 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003551 * Module: library/version.c
3552 *
3553 * This module provides run-time version information.
3554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003556
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003559 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003560 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003561 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003563 * Caller: library/x509_crl.c
3564 * library/x509_crt.c
3565 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3568 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003569 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003573
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003576 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003578 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003579 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003580 * Caller: library/ssl_cli.c
3581 * library/ssl_srv.c
3582 * library/ssl_tls.c
3583 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003585 *
3586 * This module is required for X.509 certificate parsing.
3587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589
3590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003592 *
3593 * Enable X.509 CRL parsing.
3594 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003595 * Module: library/x509_crl.c
3596 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599 *
3600 * This module is required for X.509 CRL parsing.
3601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603
3604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003606 *
3607 * Enable X.509 Certificate Signing Request (CSR) parsing.
3608 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003609 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003610 * Caller: library/x509_crt_write.c
3611 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003613 *
3614 * This module is used for reading X.509 certificate request.
3615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617
3618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003621 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 *
3623 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003624 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003626 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003627 * This module is the basis for creating X.509 certificates and CSRs.
3628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003630
3631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003633 *
3634 * Enable creating X.509 certificates.
3635 *
3636 * Module: library/x509_crt_write.c
3637 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003639 *
3640 * This module is required for X.509 certificate creation.
3641 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003642#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003643
3644/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003645 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003646 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003647 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003648 *
3649 * Module: library/x509_csr_write.c
3650 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003652 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003653 * This module is required for X.509 certificate request writing.
3654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003656
3657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003659 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003660 * Enable the XTEA block cipher.
3661 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003662 * Module: library/xtea.c
3663 * Caller:
3664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003665#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003666
Andrzej Kurek73afe272022-01-24 10:31:06 -05003667/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003668
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003669/**
Gilles Peskine86198d72022-04-11 17:04:38 +02003670 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003671 *
Gilles Peskine72665262022-04-13 23:05:10 +02003672 * This section contains Mbed TLS build settings that are not associated
3673 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003674 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003675 * \{
3676 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003677
Gilles Peskine781f7342022-03-16 17:03:19 +01003678/**
3679 * \def MBEDTLS_CONFIG_FILE
3680 *
3681 * If defined, this is a header which will be included instead of
Gilles Peskine82909762022-04-26 18:10:11 +02003682 * `"mbedtls/config.h"`.
Gilles Peskine781f7342022-03-16 17:03:19 +01003683 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskine238f9762022-04-26 18:13:01 +02003684 * Unlike other configuration options, this one must be defined on the
3685 * compiler command line: a definition in `config.h` would have no effect.
Gilles Peskine781f7342022-03-16 17:03:19 +01003686 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003687 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003688 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003689 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003690 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003691 * The value of this symbol is typically a path in double quotes, either
3692 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003693 */
Gilles Peskine82909762022-04-26 18:10:11 +02003694//#define MBEDTLS_CONFIG_FILE "mbedtls/config.h"
Gilles Peskine781f7342022-03-16 17:03:19 +01003695
3696/**
3697 * \def MBEDTLS_USER_CONFIG_FILE
3698 *
3699 * If defined, this is a header which will be included after
Gilles Peskine82909762022-04-26 18:10:11 +02003700 * `"mbedtls/config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003701 * This allows you to modify the default configuration, including the ability
3702 * to undefine options that are enabled by default.
Gilles Peskine781f7342022-03-16 17:03:19 +01003703 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003704 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine781f7342022-03-16 17:03:19 +01003705 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003706 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine781f7342022-03-16 17:03:19 +01003707 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003708 * The value of this symbol is typically a path in double quotes, either
3709 * absolute or relative to a directory on the include search path.
Gilles Peskine781f7342022-03-16 17:03:19 +01003710 */
3711//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3712
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003713/**
3714 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3715 *
3716 * If defined, this is a header which will be included instead of
3717 * `"psa/crypto_config.h"`.
3718 * This header file specifies which cryptographic mechanisms are available
3719 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3720 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3721 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003722 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003723 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003724 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003725 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003726 * The value of this symbol is typically a path in double quotes, either
3727 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003728 */
3729//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3730
3731/**
3732 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3733 *
3734 * If defined, this is a header which will be included after
3735 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskine99e075b2022-04-13 23:22:20 +02003736 * This allows you to modify the default configuration, including the ability
3737 * to undefine options that are enabled by default.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003738 *
Gilles Peskined742baa2022-04-11 16:42:37 +02003739 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003740 * non-standard feature of the C language, so this feature is only available
Gilles Peskined742baa2022-04-11 16:42:37 +02003741 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003742 *
Gilles Peskine29e89bb2022-04-14 12:44:16 +02003743 * The value of this symbol is typically a path in double quotes, either
3744 * absolute or relative to a directory on the include search path.
Gilles Peskine7e2a91f2022-03-16 17:10:48 +01003745 */
3746//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3747
Gilles Peskine86198d72022-04-11 17:04:38 +02003748/** \} name SECTION: General configuration options */
3749
3750/**
3751 * \name SECTION: Module configuration options
3752 *
3753 * This section allows for the setting of module specific sizes and
3754 * configuration options. The default values are already present in the
3755 * relevant header files and should suffice for the regular use cases.
3756 *
3757 * Our advice is to enable options and change their values here
3758 * only if you have a good reason and know the consequences.
Gilles Peskine86198d72022-04-11 17:04:38 +02003759 * \{
3760 */
Gilles Peskine25496d02022-04-13 23:21:16 +02003761/* The Doxygen documentation here is used when a user comments out a
3762 * setting and runs doxygen themselves. On the other hand, when we typeset
3763 * the full documentation including disabled settings, the documentation
3764 * in specific modules' header files is used if present. When editing this
3765 * file, make sure that each option is documented in exactly one place,
3766 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3767 * comment in the specific module. */
Gilles Peskine86198d72022-04-11 17:04:38 +02003768
Paul Bakker088c5c52014-04-25 11:11:10 +02003769/* MPI / BIGNUM options */
Andrzej Kurek6e9385b2023-02-24 07:44:57 -05003770//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003771//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003772
Paul Bakker088c5c52014-04-25 11:11:10 +02003773/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003774//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3775//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3776//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3777//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3778//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003779
Paul Bakker088c5c52014-04-25 11:11:10 +02003780/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3782//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3783//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3784//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003785
Paul Bakker088c5c52014-04-25 11:11:10 +02003786/* ECP options */
Gilles Peskine33c92f02021-06-02 23:34:02 +02003787//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups. Normally determined automatically from the configured curves. */
Gilles Peskineb3ca90b2021-06-02 13:27:03 +02003788//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003789//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003790
Paul Bakker088c5c52014-04-25 11:11:10 +02003791/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003792//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3793//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003794//#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 +01003795
Paul Bakker088c5c52014-04-25 11:11:10 +02003796/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003798
Paul Bakker088c5c52014-04-25 11:11:10 +02003799/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800//#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. */
Andrzej Kurekc83d49e2023-07-14 09:58:17 -04003801
3802/* An overview of how the value of mbedtls_calloc is determined:
3803 *
3804 * if !MBEDTLS_PLATFORM_MEMORY
3805 * mbedtls_calloc = calloc
3806 * if MBEDTLS_PLATFORM_MEMORY
3807 * if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
3808 * mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
3809 * if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
3810 * Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
3811 * How is MBEDTLS_PLATFORM_STD_CALLOC handled?
3812 * if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
3813 * MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
3814 * MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
3815 * if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
3816 * if MBEDTLS_PLATFORM_STD_CALLOC is present:
3817 * User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
3818 * if !MBEDTLS_PLATFORM_STD_CALLOC:
3819 * MBEDTLS_PLATFORM_STD_CALLOC = calloc
3820 *
3821 * At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
3822 * if !MBEDTLS_PLATFORM_STD_CALLOC
3823 * MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
3824 *
3825 * mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
3826 *
3827 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
3828 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
3829 * MBEDTLS_PLATFORM_STD_CALLOC and MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used, dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
3830 */
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003831/** \def MBEDTLS_PLATFORM_STD_CALLOC
3832 *
Andrzej Kurekc83d49e2023-07-14 09:58:17 -04003833 * Default allocator to use, can be undefined. See the description above for details.
Andrzej Kurekba168592023-07-14 09:56:02 -04003834 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003835 * The size of the buffer is the product of the two parameters.
Andrzej Kurekba168592023-07-14 09:56:02 -04003836 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003837 * If the product is 0, the function may either return NULL or a valid pointer to an array of size 0 which is a valid input to the deallocation function.
Andrzej Kurekba168592023-07-14 09:56:02 -04003838 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003839 */
3840//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
3841/** \def MBEDTLS_PLATFORM_STD_FREE
3842 *
3843 * Default free to use, can be undefined.
3844 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekba168592023-07-14 09:56:02 -04003845 * A non-null parameter will always be a pointer previously returned by #MBEDTLS_PLATFORM_STD_CALLOC and not yet freed.
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003846 */
3847//#define MBEDTLS_PLATFORM_STD_FREE free
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003849//#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 +02003850//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3851//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003852/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003854//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3855//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003856//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3857//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3858//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003859
Andrzej Kurekba168592023-07-14 09:56:02 -04003860/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003861/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurekdc11cd12023-07-14 09:47:05 -04003862//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3863//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_FREE for requirements. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003865//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3866//#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 +02003867//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3868//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003869/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003870//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003871//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003872//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3873//#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 +02003874
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003875/**
3876 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003877 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003878 * (see the documentation of that option for context).
3879 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003880 * When you leave this undefined here, the library provides
3881 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3882 * is defined, the default definition is `assert(cond)`,
3883 * otherwise the default definition calls a function
3884 * mbedtls_param_failed(). This function is declared in
3885 * `platform_util.h` for the benefit of the library, but
3886 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003887 *
3888 * When you define this here, this replaces the default
3889 * definition in platform_util.h (which no longer declares the
3890 * function mbedtls_param_failed()) and it is your responsibility
3891 * to make sure this macro expands to something suitable (in
3892 * particular, that all the necessary declarations are visible
3893 * from within the library - you can ensure that by providing
3894 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003895 * If you define this macro to call `assert`, also define
3896 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3897 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003898 *
3899 * Note that you may define this macro to expand to nothing, in
3900 * which case you don't have to worry about declarations or
3901 * definitions. However, you will then be notified about invalid
3902 * parameters only in non-void functions, and void function will
3903 * just silently return early on invalid parameters, which
3904 * partially negates the benefits of enabling
3905 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3906 *
3907 * \param cond The expression that should evaluate to true, but doesn't.
3908 */
3909//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3910
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003911/** \def MBEDTLS_CHECK_RETURN
3912 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003913 * This macro is used at the beginning of the declaration of a function
3914 * to indicate that its return value should be checked. It should
3915 * instruct the compiler to emit a warning or an error if the function
3916 * is called without checking its return value.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003917 *
Gilles Peskineee0a4432021-09-23 17:28:59 +02003918 * There is a default implementation for popular compilers in platform_util.h.
3919 * You can override the default implementation by defining your own here.
3920 *
3921 * If the implementation here is empty, this will effectively disable the
3922 * checking of functions' return values.
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003923 */
Gilles Peskine91108092021-09-30 18:53:36 +02003924//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Mateusz Starzyk1ef29fc2021-08-06 13:56:54 +02003925
Gilles Peskinec2779322021-09-30 18:56:17 +02003926/** \def MBEDTLS_IGNORE_RETURN
3927 *
3928 * This macro requires one argument, which should be a C function call.
3929 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3930 * warning is suppressed.
3931 */
3932//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3933
Gilles Peskineed038902020-11-13 21:33:21 +01003934/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003935/**
Gilles Peskineed038902020-11-13 21:33:21 +01003936 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3937 * PSA crypto subsystem.
3938 *
3939 * If this option is unset:
3940 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003941 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003942 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3943 * on unspecified heuristics.
3944 */
3945//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3946
Steven Cooreman863470a2021-02-15 14:03:19 +01003947/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003948 * Restrict the PSA library to supporting a maximum amount of simultaneously
3949 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3950 * volatile key, or a persistent key which is loaded temporarily by the
3951 * library as part of a crypto operation in flight.
3952 *
3953 * If this option is unset, the library will fall back to a default value of
3954 * 32 keys.
3955 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003956//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003957
Paul Bakker088c5c52014-04-25 11:11:10 +02003958/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3960//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003961
Paul Bakker088c5c52014-04-25 11:11:10 +02003962/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003963
3964/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3965 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003966 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003967 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003968 * This determines the size of both the incoming and outgoing TLS I/O buffers
3969 * in such a way that both are capable of holding the specified amount of
3970 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003971 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003972 * To configure incoming and outgoing I/O buffers separately, use
3973 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3974 * which overwrite the value set by this option.
3975 *
3976 * \note When using a value less than the default of 16KB on the client, it is
3977 * recommended to use the Maximum Fragment Length (MFL) extension to
3978 * inform the server about this limitation. On the server, there
3979 * is no supported, standardized way of informing the client about
3980 * restriction on the maximum size of incoming messages, and unless
3981 * the limitation has been communicated by other means, it is recommended
3982 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3983 * while keeping the default value of 16KB for the incoming buffer.
3984 *
3985 * Uncomment to set the maximum plaintext size of both
3986 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003987 */
3988//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3989
3990/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3991 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003992 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003993 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003994 * This determines the size of the incoming TLS I/O buffer in such a way
3995 * that it is capable of holding the specified amount of plaintext data,
3996 * regardless of the protection mechanism used.
3997 *
3998 * If this option is undefined, it inherits its value from
3999 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
4000 *
4001 * \note When using a value less than the default of 16KB on the client, it is
4002 * recommended to use the Maximum Fragment Length (MFL) extension to
4003 * inform the server about this limitation. On the server, there
4004 * is no supported, standardized way of informing the client about
4005 * restriction on the maximum size of incoming messages, and unless
4006 * the limitation has been communicated by other means, it is recommended
4007 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4008 * while keeping the default value of 16KB for the incoming buffer.
4009 *
4010 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
4011 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004012 */
4013//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4014
Gilles Peskined3d02902020-03-04 21:35:27 +01004015/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4016 *
4017 * The maximum length of CIDs used for incoming DTLS messages.
4018 *
4019 */
4020//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4021
4022/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4023 *
4024 * The maximum length of CIDs used for outgoing DTLS messages.
4025 *
4026 */
4027//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4028
4029/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
4030 *
4031 * This option controls the use of record plaintext padding
4032 * when using the Connection ID extension in DTLS 1.2.
4033 *
4034 * The padding will always be chosen so that the length of the
4035 * padded plaintext is a multiple of the value of this option.
4036 *
4037 * Note: A value of \c 1 means that no padding will be used
4038 * for outgoing records.
4039 *
4040 * Note: On systems lacking division instructions,
4041 * a power of two should be preferred.
4042 *
4043 */
4044//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
4045
Hanno Beckerceef8482020-06-02 06:16:00 +01004046/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01004047 *
4048 * This option controls the use of record plaintext padding
4049 * in TLS 1.3.
4050 *
4051 * The padding will always be chosen so that the length of the
4052 * padded plaintext is a multiple of the value of this option.
4053 *
4054 * Note: A value of \c 1 means that no padding will be used
4055 * for outgoing records.
4056 *
4057 * Note: On systems lacking division instructions,
4058 * a power of two should be preferred.
4059 */
Hanno Beckerceef8482020-06-02 06:16:00 +01004060//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01004061
Angus Grattond8213d02016-05-25 20:56:48 +10004062/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4063 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004064 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004065 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004066 * This determines the size of the outgoing TLS I/O buffer in such a way
4067 * that it is capable of holding the specified amount of plaintext data,
4068 * regardless of the protection mechanism used.
4069 *
4070 * If this option undefined, it inherits its value from
4071 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10004072 *
4073 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4074 * the default inward 16384 byte buffer to conform to the TLS specification.
4075 *
4076 * The minimum required outward buffer size is determined by the handshake
4077 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4078 * The specific size requirement depends on the configured ciphers and any
4079 * certificate data which is sent during the handshake.
4080 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004081 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
4082 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004083 */
4084//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4085
Hanno Beckere0b150f2018-08-21 15:51:03 +01004086/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4087 *
4088 * Maximum number of heap-allocated bytes for the purpose of
4089 * DTLS handshake message reassembly and future message buffering.
4090 *
Yuto Takano5b4caf22021-08-10 11:26:15 +01004091 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004092 * to account for a reassembled handshake message of maximum size,
4093 * together with its reassembly bitmap.
4094 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004095 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004096 * should be sufficient for all practical situations as it allows
4097 * to reassembly a large handshake message (such as a certificate)
4098 * while buffering multiple smaller handshake messages.
4099 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004100 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004101//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004103//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
4104//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
4105//#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 +02004106
Gilles Peskine065a1c82021-04-24 13:35:41 +02004107/** \def MBEDTLS_TLS_EXT_CID
4108 *
4109 * At the time of writing, the CID extension has not been assigned its
4110 * final value. Set this configuration option to make Mbed TLS use a
4111 * different value.
4112 *
4113 * A future minor revision of Mbed TLS may change the default value of
4114 * this option to match evolving standards and usage.
4115 */
4116//#define MBEDTLS_TLS_EXT_CID 254
4117
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004118/**
4119 * Complete list of ciphersuites to use, in order of preference.
4120 *
4121 * \warning No dependency checking is done on that field! This option can only
4122 * be used to restrict the set of available ciphersuites. It is your
4123 * responsibility to make sure the needed modules are active.
4124 *
4125 * Use this to save a few hundred bytes of ROM (default ordering of all
4126 * available ciphersuites) and a few to a few hundred bytes of RAM.
4127 *
4128 * The value below is only an example, not the default.
4129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004130//#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 +02004131
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004132/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004133//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004134//#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 +01004135
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004136/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004137 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
4138 * signature and ciphersuite selection. Without this build-time option, SHA-1
4139 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
4140 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
4141 * default. At the time of writing, there is no practical attack on the use
4142 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01004143 * to preserve compatibility with existing peers, but the general
4144 * warning applies nonetheless:
4145 *
4146 * \warning SHA-1 is considered a weak message digest and its use constitutes
4147 * a security risk. If possible, we recommend avoiding dependencies
4148 * on it, and considering stronger message digests instead.
4149 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02004150 */
Mateusz Starzyk7d135392021-08-27 15:36:47 +02004151//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02004152
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004153/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004154 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004155 * mbedtls_platform_zeroize(). This replaces the default implementation in
4156 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00004157 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004158 * mbedtls_platform_zeroize() is a widely used function across the library to
4159 * zero a block of memory. The implementation is expected to be secure in the
4160 * sense that it has been written to prevent the compiler from removing calls
4161 * to mbedtls_platform_zeroize() as part of redundant code elimination
4162 * optimizations. However, it is difficult to guarantee that calls to
4163 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
4164 * versions of the C language standards do not provide a secure implementation
4165 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
4166 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05004167 * example by using directives specific to their compiler, features from newer
4168 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004169 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004170 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05004171//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01004172
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004173/**
4174 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01004175 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004176 * platform_util.c.
4177 *
Hanno Becker921b76d2018-09-05 16:21:36 +01004178 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004179 * library will try to use safer implementations of this function, such as
4180 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01004181 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004182 * using the standard gmtime(). In this case, calls from the library to
4183 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01004184 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004185 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01004186 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
4187 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
4188 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004189 */
Hanno Becker6a739782018-09-05 15:06:19 +01004190//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01004191
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00004192/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00004193 * Enable the verified implementations of ECDH primitives from Project Everest
4194 * (currently only Curve25519). This feature changes the layout of ECDH
4195 * contexts and therefore is a compatibility break for applications that access
4196 * fields of a mbedtls_ecdh_context structure directly. See also
4197 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004198 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00004199//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01004200
Gilles Peskine1341e212022-04-13 23:04:48 +02004201/** \} name SECTION: Module configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02004202
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004203/* Target and application specific configurations
4204 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004205 * Allow user to override any previous default.
4206 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004207 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01004208#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02004209#include MBEDTLS_USER_CONFIG_FILE
4210#endif
4211
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004212#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07004213#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01004214#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07004215
Jaeden Amero6609aef2019-07-04 20:01:14 +01004216#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01004217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004218#endif /* MBEDTLS_CONFIG_H */