blob: cbe3c7211b0acfc4e9f504750e9afb96543ac828 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file config.h
3 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#ifndef MBEDTLS_CONFIG_H
28#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakkercce9d772011-11-18 14:26:47 +000030#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000031#define _CRT_SECURE_NO_DEPRECATE 1
32#endif
33
Paul Bakkerf3b86c12011-01-27 15:24:17 +000034/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000035 * \name SECTION: System support
36 *
37 * This section sets system specific settings.
38 * \{
39 */
40
Paul Bakkerf3b86c12011-01-27 15:24:17 +000041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020044 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000045 *
46 * Requires support for asm() in compiler.
47 *
48 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010049 * library/aria.c
Paul Bakker68041ec2009-04-19 21:17:55 +000050 * library/timing.c
Chris Jones4c5819c2021-03-03 17:45:34 +000051 * library/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000052 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010053 * Required by:
54 * MBEDTLS_AESNI_C
55 * MBEDTLS_PADLOCK_C
56 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020057 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000060
Paul Bakkerf3b86c12011-01-27 15:24:17 +000061/**
Gilles Peskineed942f82017-06-08 15:19:20 +020062 * \def MBEDTLS_NO_UDBL_DIVISION
63 *
64 * The platform lacks support for double-width integer division (64-bit
65 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
66 *
67 * Used in:
68 * include/mbedtls/bignum.h
69 * library/bignum.c
70 *
71 * The bignum code uses double-width division to speed up some operations.
72 * Double-width division is often implemented in software that needs to
73 * be linked with the program. The presence of a double-width integer
74 * type is usually detected automatically through preprocessor macros,
75 * but the automatic detection cannot know whether the code needs to
76 * and can be linked with an implementation of division for that type.
77 * By default division is assumed to be usable if the type is present.
78 * Uncomment this option to prevent the use of double-width division.
79 *
80 * Note that division for the native integer type is always required.
81 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010082 * platform, but it need not support multiplication or division. In some
83 * cases it is also desirable to disable some double-width operations. For
84 * example, if double-width division is implemented in software, disabling
85 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020086 */
87//#define MBEDTLS_NO_UDBL_DIVISION
88
89/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020090 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
91 *
92 * The platform lacks support for 32x32 -> 64-bit multiplication.
93 *
94 * Used in:
95 * library/poly1305.c
96 *
97 * Some parts of the library may use multiplication of two unsigned 32-bit
98 * operands with a 64-bit result in order to speed up computations. On some
99 * platforms, this is not available in hardware and has to be implemented in
100 * software, usually in a library provided by the toolchain.
101 *
102 * Sometimes it is not desirable to have to link to that library. This option
103 * removes the dependency of that library on platforms that lack a hardware
104 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
105 *
106 * Note that depending on the compiler, this may decrease performance compared
107 * to using the library function provided by the toolchain.
108 */
109//#define MBEDTLS_NO_64BIT_MULTIPLICATION
110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000113 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000114 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000115 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000116 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200119
120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200122 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200123 * System has time.h and time().
124 * The time does not need to be correct, only time differences are used,
125 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200126 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100127 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
128 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
129 * MBEDTLS_PLATFORM_STD_TIME.
130 *
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 * Comment if your system does not support time functions
132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100134
135/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200136 * \def MBEDTLS_HAVE_TIME_DATE
137 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100138 * System has time.h, time(), and an implementation for
139 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100140 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200141 * the date should be correct). This is used to verify the validity period of
142 * X.509 certificates.
143 *
144 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100145 *
Hanno Becker6a739782018-09-05 15:06:19 +0100146 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100147 * behaves similarly to the gmtime_r() function from the C standard. Refer to
148 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100149 *
150 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100151 * mbedtls_platform_gmtime_r() at compile-time by using the macro
152 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200153 */
154#define MBEDTLS_HAVE_TIME_DATE
155
156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 *
159 * Enable the memory allocation layer.
160 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200161 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100162 * This allows different allocators (self-implemented or provided) to be
163 * provided to the platform abstraction layer.
164 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200166 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
167 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * free() function pointer at runtime.
169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000172 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100175 *
176 * Enable this layer to allow use of alternative memory allocators.
177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179
180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200182 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200183 * Do not assign standard functions in the platform layer (e.g. calloc() to
184 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200185 *
186 * This makes sure there are no linking errors on platforms that do not support
187 * these functions. You will HAVE to provide alternatives, either at runtime
188 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
190 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200193 *
194 * Uncomment to prevent default assignment of standard functions in the
195 * platform layer.
196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200198
199/**
Janos Follathc351d182016-03-21 08:43:59 +0000200 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100201 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100202 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
203 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100204 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
206 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 * alternative printf function pointer.
208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200211 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
212 * it will be enabled automatically by check_config.h
213 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200214 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000216 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100217 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
218 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100219 * Uncomment a macro to enable alternate implementation of specific base
220 * platform function
221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100223//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224//#define MBEDTLS_PLATFORM_FPRINTF_ALT
225//#define MBEDTLS_PLATFORM_PRINTF_ALT
226//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200227//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100228//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100229//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100230
231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100233 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000234 * Mark deprecated functions and features so that they generate a warning if
235 * used. Functionality deprecated in one version will usually be removed in the
236 * next version. You can enable this to help you prepare the transition to a
237 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100238 *
239 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100241 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000242 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245
246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000249 * Remove deprecated functions and features so that they generate an error if
250 * used. Functionality deprecated in one version will usually be removed in the
251 * next version. You can enable this to help you prepare the transition to a
252 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100257
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200258/* \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000259
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000260/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000261 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000262 *
263 * This section sets support for features that are or are not needed
264 * within the modules that are enabled.
265 * \{
266 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000267
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200269 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100270 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200271 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200272 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100273 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200274 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100275 *
276 * You will need to provide a header "timing_alt.h" and an implementation at
277 * compile time.
278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200279//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100280
281/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100282 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200283 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100284 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100285 * alternate core implementation of a symmetric crypto, an arithmetic or hash
286 * module (e.g. platform specific assembly optimized implementations). Keep
287 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200288 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200289 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200291 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000293 * provide the "struct mbedtls_aes_context" definition and omit the base
294 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200295 * "aes.h" to include the new function definitions.
296 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200297 * Uncomment a macro to enable alternate implementation of the corresponding
298 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100299 *
300 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
301 * use constitutes a security risk. If possible, we recommend
302 * avoiding dependencies on them, and considering stronger message
303 * digests and ciphers instead.
304 *
Paul Bakker90995b52013-06-24 19:20:35 +0200305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306//#define MBEDTLS_AES_ALT
307//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000308//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309//#define MBEDTLS_BLOWFISH_ALT
310//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200311//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300312//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200313//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200314//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000316//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000317//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100318//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300319//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_MD2_ALT
321//#define MBEDTLS_MD4_ALT
322//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300323//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000325//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326//#define MBEDTLS_SHA1_ALT
327//#define MBEDTLS_SHA256_ALT
328//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000329//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000330
Janos Follathb0697532016-08-18 12:38:46 +0100331/*
332 * When replacing the elliptic curve module, pleace consider, that it is
333 * implemented with two .c files:
334 * - ecp.c
335 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000336 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
337 * macros as described above. The only difference is that you have to make sure
338 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100339 */
340//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200341
342/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100343 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200344 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100345 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
346 * alternate core implementation of symmetric crypto or hash function. Keep in
347 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200348 *
349 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200351 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
353 * no longer provide the mbedtls_sha1_process() function, but it will still provide
354 * the other function (using your mbedtls_sha1_process() function) and the definition
355 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200356 * with this definition.
357 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200358 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100359 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
360 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200361 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 * Uncomment a macro to enable alternate implementation of the corresponding
363 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100364 *
365 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
366 * constitutes a security risk. If possible, we recommend avoiding
367 * dependencies on them, and considering stronger message digests
368 * and ciphers instead.
369 *
Janos Follath1231d212019-01-07 15:01:32 +0000370 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
371 * enabled, then the deterministic ECDH signature functions pass the
372 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
373 * alternative implementations should use the RNG only for generating
374 * the ephemeral key and nothing else. If this is not possible, then
375 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200376 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000377 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379//#define MBEDTLS_MD2_PROCESS_ALT
380//#define MBEDTLS_MD4_PROCESS_ALT
381//#define MBEDTLS_MD5_PROCESS_ALT
382//#define MBEDTLS_RIPEMD160_PROCESS_ALT
383//#define MBEDTLS_SHA1_PROCESS_ALT
384//#define MBEDTLS_SHA256_PROCESS_ALT
385//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200386//#define MBEDTLS_DES_SETKEY_ALT
387//#define MBEDTLS_DES_CRYPT_ECB_ALT
388//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200389//#define MBEDTLS_AES_SETKEY_ENC_ALT
390//#define MBEDTLS_AES_SETKEY_DEC_ALT
391//#define MBEDTLS_AES_ENCRYPT_ALT
392//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300393//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300394//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300395//#define MBEDTLS_ECDSA_VERIFY_ALT
396//#define MBEDTLS_ECDSA_SIGN_ALT
397//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200398
399/**
Janos Follathc44ab972016-11-18 16:38:23 +0000400 * \def MBEDTLS_ECP_INTERNAL_ALT
401 *
402 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100403 *
404 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100405 * alternative core implementation of elliptic curve arithmetic. Keep in mind
406 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100407 *
408 * This partially replaces one function. The header file from mbed TLS is still
409 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
410 * is still present and it is used for group structures not supported by the
411 * alternative.
412 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100413 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100414 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100415 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
416 * able to fallback to curves not supported by the alternative implementation.
417 *
Janos Follathc44ab972016-11-18 16:38:23 +0000418 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
419 * and implementing the following functions:
420 * unsigned char mbedtls_internal_ecp_grp_capable(
421 * const mbedtls_ecp_group *grp )
422 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500423 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000424 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
425 * replacement functions implement arithmetic for the given group and 0
426 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500427 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000428 * called before and after each point operation and provide an opportunity to
429 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100430 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100431 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
432 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
433 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
434 * for the operation is supported by your implementation (i.e. your
435 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
436 * group is not supported by your implementation, then the original mbed TLS
437 * implementation of ecp_double_jac() is used instead, unless this fallback
438 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
439 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
440 *
441 * The function prototypes and the definition of mbedtls_ecp_group and
442 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
443 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
444 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100445 *
446 * Uncomment a macro to enable alternate implementation of the corresponding
447 * function.
448 */
449/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000450//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100451/* Turn off software fallback for curves not supported in hardware */
452//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100453/* Support for Weierstrass curves with Jacobi representation */
454//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
455//#define MBEDTLS_ECP_ADD_MIXED_ALT
456//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
457//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
458//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
459/* Support for curves with Montgomery arithmetic */
460//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
461//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
462//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
463
464/**
Simon Butcherab5df402016-06-11 02:31:21 +0100465 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100466 *
Simon Butcherab5df402016-06-11 02:31:21 +0100467 * Enables testing and use of mbed TLS without any configured entropy sources.
468 * This permits use of the library on platforms before an entropy source has
469 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
470 * MBEDTLS_ENTROPY_NV_SEED switches).
471 *
472 * WARNING! This switch MUST be disabled in production builds, and is suitable
473 * only for development.
474 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100475 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100476 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
477 *
Janos Follath53de7842016-06-08 15:29:18 +0100478 */
Simon Butcherab5df402016-06-11 02:31:21 +0100479//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100480
481/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200482 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200483 *
484 * Uncomment this macro to let mbed TLS use your own implementation of a
485 * hardware entropy collector.
486 *
487 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000488 * prototype as declared in library/entropy_poll.h, and accept NULL as first
489 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200490 *
491 * Uncomment to use your own hardware entropy collector.
492 */
493//#define MBEDTLS_ENTROPY_HARDWARE_ALT
494
495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000497 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100498 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000499 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100500 * Uncomment this macro to use precomputed AES tables stored in ROM.
501 * Comment this macro to generate AES tables in RAM at runtime.
502 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100503 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
504 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100505 * initialization time before the first AES operation can be performed.
506 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
507 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
508 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100509 *
510 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
511 *
Paul Bakker15566e42011-04-24 21:19:15 +0000512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000514
515/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100516 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200517 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100518 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200519 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100520 * Uncommenting this macro omits 75% of the AES tables from
521 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
522 * by computing their values on the fly during operations
523 * (the tables are entry-wise rotations of one another).
524 *
525 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100526 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100527 * runtime. Specifically, one has to compare 4 accesses within
528 * different tables to 4 accesses with additional arithmetic
529 * operations within the same table. The performance gain/loss
530 * depends on the system and memory details.
531 *
532 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
533 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200534 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100535//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200536
537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200539 *
540 * Use less ROM for the Camellia implementation (saves about 768 bytes).
541 *
542 * Uncomment this macro to use less memory for Camellia.
543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200545
546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200548 *
549 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200552
553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000555 *
556 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000559
560/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000562 *
563 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000566
567/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100568 * \def MBEDTLS_CIPHER_MODE_OFB
569 *
570 * Enable Output Feedback mode (OFB) for symmetric ciphers.
571 */
572#define MBEDTLS_CIPHER_MODE_OFB
573
574/**
575 * \def MBEDTLS_CIPHER_MODE_XTS
576 *
577 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
578 */
579#define MBEDTLS_CIPHER_MODE_XTS
580
581/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000583 *
584 * Enable NULL cipher.
585 * Warning: Only do so when you know what you are doing. This allows for
586 * encryption or channels without any security!
587 *
Ronald Croncee42702021-04-26 11:34:44 +0200588 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
590 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
591 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
592 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
593 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
594 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
595 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
596 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
597 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
598 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
599 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
600 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
601 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
602 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
603 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
604 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
605 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
606 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
607 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000608 *
609 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000612
613/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100614 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200615 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100616 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
617 * specific padding modes in the cipher layer with cipher modes that support
618 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200619 *
620 * If you disable all padding modes, only full blocks can be used with CBC.
621 *
622 * Enable padding modes in the cipher layer.
623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#define MBEDTLS_CIPHER_PADDING_PKCS7
625#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
626#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
627#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200628
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200629/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
630 *
631 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
632 * By default, CTR_DRBG uses a 256-bit key.
633 */
634//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
635
Paul Bakker48e93c82013-08-14 12:21:18 +0200636/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000637 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
638 *
639 * Remove 3DES ciphersuites by default in SSL / TLS.
640 * This flag removes the ciphersuites based on 3DES from the default list as
641 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
642 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
643 * them explicitly.
644 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000645 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000646 * a TLS connection using a 3DES based cipher suite (see "On the Practical
647 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
648 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
649 * in your threat model or you are unsure, then you should keep this option
650 * enabled to remove 3DES based cipher suites.
651 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000652 * Comment this macro to keep 3DES in the default ciphersuite list.
653 */
654#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
655
656/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100657 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200658 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100659 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
660 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200661 *
662 * Comment macros to disable the curve and functions for it
663 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200664/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
666#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
667#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
668#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
669#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
670#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
671#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
672#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
673#define MBEDTLS_ECP_DP_BP256R1_ENABLED
674#define MBEDTLS_ECP_DP_BP384R1_ENABLED
675#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200676/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200677#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000678#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200679
680/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200682 *
683 * Enable specific 'modulo p' routines for each NIST prime.
684 * Depending on the prime and architecture, makes operations 4 to 8 times
685 * faster on the corresponding curve.
686 *
687 * Comment this macro to disable NIST curves optimisation.
688 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200690
691/**
Manuel Pégourié-Gonnard1a3f9ed2020-05-19 12:38:31 +0200692 * \def MBEDTLS_ECP_NO_INTERNAL_RNG
693 *
694 * When this option is disabled, mbedtls_ecp_mul() will make use of an
695 * internal RNG when called with a NULL \c f_rng argument, in order to protect
696 * against some side-channel attacks.
697 *
698 * This protection introduces a dependency of the ECP module on one of the
699 * DRBG modules. For very constrained implementations that don't require this
700 * protection (for example, because you're only doing signature verification,
701 * so not manipulating any secret, or because local/physical side-channel
702 * attacks are outside your threat model), it might be desirable to get rid of
703 * that dependency.
704 *
705 * \warning Enabling this option makes some uses of ECP vulnerable to some
706 * side-channel attacks. Only enable it if you know that's not a problem for
707 * your use case.
708 *
709 * Uncomment this macro to disable some counter-measures in ECP.
710 */
711//#define MBEDTLS_ECP_NO_INTERNAL_RNG
712
713/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200714 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100715 *
716 * Enable "non-blocking" ECC operations that can return early and be resumed.
717 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200718 * This allows various functions to pause by returning
719 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
720 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
721 * order to further progress and eventually complete their operation. This is
722 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
723 * number of ECC operations a function may perform before pausing; see
724 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100725 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200726 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200727 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100728 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200729 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200730 *
Ron Eldor19779c42018-11-05 16:58:13 +0200731 * \note This option only works with the default software implementation of
732 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100733 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
734 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100735 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200736//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100737
738/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100739 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
740 *
741 * Use a backward compatible ECDH context.
742 *
743 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
744 * defined in `ecdh.h`). For most applications, the choice of format makes
745 * no difference, since all library functions can work with either format,
746 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
747
748 * The new format used when this option is disabled is smaller
749 * (56 bytes on a 32-bit platform). In future versions of the library, it
750 * will support alternative implementations of ECDH operations.
751 * The new format is incompatible with applications that access
752 * context fields directly and with restartable ECP operations.
753 *
754 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
755 * want to access ECDH context fields directly. Otherwise you should
756 * comment out this macro definition.
757 *
758 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
759 *
760 * \note This configuration option is experimental. Future versions of the
761 * library may modify the way the ECDH context layout is configured
762 * and may modify the layout of the new context type.
763 */
764#define MBEDTLS_ECDH_LEGACY_CONTEXT
765
766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100768 *
769 * Enable deterministic ECDSA (RFC 6979).
770 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
771 * may result in a compromise of the long-term signing key. This is avoided by
772 * the deterministic variant.
773 *
John Durkop36a82e52020-10-26 09:39:05 -0700774 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100775 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100776 * Comment this macro to disable deterministic ECDSA.
777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100779
780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200782 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200783 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200784 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 * This enables the following ciphersuites (if other requisites are
786 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
788 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
789 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
790 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
791 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
792 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
793 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
794 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
795 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
796 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
797 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200800
801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200804 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
808 * This enables the following ciphersuites (if other requisites are
809 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
811 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
812 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
813 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
814 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
815 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
816 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
817 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
818 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
819 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
820 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100821 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100822 * \warning Using DHE constitutes a security risk as it
823 * is not possible to validate custom DH parameters.
824 * If possible, it is recommended users should consider
825 * preferring other methods of key exchange.
826 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100827 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200830
831/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200833 *
834 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
835 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200837 *
838 * This enables the following ciphersuites (if other requisites are
839 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
841 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
842 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
843 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
844 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
845 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
846 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200849
850/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200852 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200853 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200854 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
856 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200857 *
858 * This enables the following ciphersuites (if other requisites are
859 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
861 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
862 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
863 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
864 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
865 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
866 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
867 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
868 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
869 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
870 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200873
874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200876 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200877 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200878 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
880 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881 *
882 * This enables the following ciphersuites (if other requisites are
883 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
885 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
886 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
887 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
888 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
889 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
890 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
891 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
892 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
893 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
894 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
895 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
896 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899
900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200902 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200903 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200904 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
906 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907 *
908 * This enables the following ciphersuites (if other requisites are
909 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
911 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
912 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
913 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
914 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
915 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
916 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
917 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
918 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
919 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
920 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
921 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
922 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100923 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100924 * \warning Using DHE constitutes a security risk as it
925 * is not possible to validate custom DH parameters.
926 * If possible, it is recommended users should consider
927 * preferring other methods of key exchange.
928 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100929 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200932
933/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200935 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200936 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200937 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
939 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200940 *
941 * This enables the following ciphersuites (if other requisites are
942 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
944 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
945 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
946 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
947 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
948 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
949 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
950 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
951 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
952 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
953 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200956
957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200959 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200960 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200963 *
964 * This enables the following ciphersuites (if other requisites are
965 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
967 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
968 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
969 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
970 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
971 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
972 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
973 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
974 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
975 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
976 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200979
980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100982 *
983 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
984 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200985 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100986 *
987 * This enables the following ciphersuites (if other requisites are
988 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
990 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
991 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
992 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
993 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
994 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
995 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
996 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
997 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
998 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
999 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001002
1003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001005 *
1006 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1007 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +02001008 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001009 *
1010 * This enables the following ciphersuites (if other requisites are
1011 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1013 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1014 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1015 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1016 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1017 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1018 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1019 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1020 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1021 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1022 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001025
1026/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001027 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1028 *
1029 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1030 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001031 * \warning This is currently experimental. EC J-PAKE support is based on the
1032 * Thread v1.0.0 specification; incompatible changes to the specification
1033 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001034 *
1035 * Requires: MBEDTLS_ECJPAKE_C
1036 * MBEDTLS_SHA256_C
1037 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1038 *
1039 * This enables the following ciphersuites (if other requisites are
1040 * enabled as well):
1041 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1042 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001043//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001044
1045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001047 *
1048 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1049 * RFC 5915 and RFC 5480.
1050 *
1051 * Currently this means parsing the SpecifiedECDomain choice of EC
1052 * parameters (only known groups are supported, not arbitrary domains, to
1053 * avoid validation issues).
1054 *
1055 * Disable if you only need to support RFC 5915 + 5480 key formats.
1056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001058
1059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001061 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * Enable a dummy error function to make use of mbedtls_strerror() in
1063 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1064 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001065 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1067 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001068 *
1069 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001073
1074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001076 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001077 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001078 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001082
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001085 *
1086 * Enable functions that use the filesystem.
1087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001089
1090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001092 *
Mateusz Starzyk0fdcc8e2021-01-29 16:46:31 +01001093 * Do not add default entropy sources. These are the platform specific
1094 * or mbedtls_timing_hardclock poll function.
Paul Bakker43655f42011-12-15 20:11:16 +00001095 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001096 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001097 * application.
1098 *
1099 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001102
1103/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001105 *
1106 * Do not use built-in platform entropy functions.
1107 * This is useful if your platform does not support
1108 * standards like the /dev/urandom or Windows CryptoAPI.
1109 *
1110 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001113
1114/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001116 *
1117 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1118 * default SHA-512 based one (if both are available).
1119 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001121 *
1122 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1123 * if you have performance concerns.
1124 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125 * This option is only useful if both MBEDTLS_SHA256_C and
1126 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001129
1130/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001131 * \def MBEDTLS_ENTROPY_NV_SEED
1132 *
1133 * Enable the non-volatile (NV) seed file-based entropy source.
1134 * (Also enables the NV seed read/write functions in the platform layer)
1135 *
1136 * This is crucial (if not required) on systems that do not have a
1137 * cryptographic entropy source (in hardware or kernel) available.
1138 *
1139 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1140 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001141 * \note The read/write functions that are used by the entropy source are
1142 * determined in the platform layer, and can be modified at runtime and/or
1143 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1144 *
1145 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001146 * with regular fopen(), please make sure you make a seedfile with the
1147 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1148 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001149 * and written to or you will get an entropy source error! The default
1150 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1151 * bytes from the file.
1152 *
1153 * \note The entropy collector will write to the seed file before entropy is
1154 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001155 */
1156//#define MBEDTLS_ENTROPY_NV_SEED
1157
Ronald Cron71016a92020-08-28 19:01:50 +02001158/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001159 *
Ronald Cron71016a92020-08-28 19:01:50 +02001160 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001161 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001162 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1163 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001164 *
1165 * Note that this option is meant for internal use only and may be removed
Ronald Cron77c89f52020-11-10 17:45:56 +01001166 * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001167 */
Ronald Cron71016a92020-08-28 19:01:50 +02001168//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001169
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001170/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001172 *
1173 * Enable debugging of buffer allocator memory issues. Automatically prints
1174 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1175 * function for 'debug output' of allocated memory.
1176 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001178 *
1179 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001182
1183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001185 *
1186 * Include backtrace information with each allocated block.
1187 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001189 * GLIBC-compatible backtrace() an backtrace_symbols() support
1190 *
1191 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001194
1195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001197 *
1198 * Support external private RSA keys (eg from a HSM) in the PK layer.
1199 *
1200 * Comment this macro to disable support for external private RSA keys.
1201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001203
1204/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001206 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001207 * Enable support for PKCS#1 v1.5 encoding.
1208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001210 *
Paul Bakker48377d92013-08-30 12:06:24 +02001211 * This enables support for PKCS#1 v1.5 operations.
1212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001214
1215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001217 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001218 * Enable support for PKCS#1 v2.1 encoding.
1219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001221 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001222 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001224#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001225
Steven Cooreman6801f082021-02-19 17:21:22 +01001226/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1227 *
1228 * Enable support for platform built-in keys. If you enable this feature,
1229 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1230 * See the documentation of that function for more information.
1231 *
1232 * Built-in keys are typically derived from a hardware unique key or
1233 * stored in a secure element.
1234 *
1235 * Requires: MBEDTLS_PSA_CRYPTO_C.
1236 *
1237 * \warning This interface is experimental and may change or be removed
1238 * without notice.
1239 */
1240//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1241
Ronald Cron3768ac12021-01-26 16:58:00 +01001242/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1243 *
1244 * Enable support for PSA crypto client.
1245 *
1246 * \note This option allows to include the code necessary for a PSA
1247 * crypto client when the PSA crypto implementation is not included in
1248 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1249 * code to set and get PSA key attributes.
1250 * The development of PSA drivers partially relying on the library to
1251 * fulfill the hardware gaps is another possible usage of this option.
1252 *
1253 * \warning This interface is experimental and may change or be removed
1254 * without notice.
1255 */
1256//#define MBEDTLS_PSA_CRYPTO_CLIENT
1257
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001258/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1259 *
1260 * Enable support for the experimental PSA crypto driver interface.
1261 *
John Durkop185764f2020-10-12 21:32:12 -07001262 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001263 *
1264 * \warning This interface is experimental and may change or be removed
1265 * without notice.
1266 */
1267//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1268
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001269/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1270 *
1271 * Make the PSA Crypto module use an external random generator provided
1272 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1273 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001274 * \note This random generator must deliver random numbers with cryptographic
1275 * quality and high performance. It must supply unpredictable numbers
1276 * with a uniform distribution. The implementation of this function
1277 * is responsible for ensuring that the random generator is seeded
1278 * with sufficient entropy. If you have a hardware TRNG which is slow
1279 * or delivers non-uniform output, declare it as an entropy source
1280 * with mbedtls_entropy_add_source() instead of enabling this option.
1281 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001282 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001283 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1284 * and define a function called mbedtls_psa_external_get_random()
1285 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001286 * ```
1287 * psa_status_t mbedtls_psa_external_get_random(
1288 * mbedtls_psa_external_random_context_t *context,
1289 * uint8_t *output, size_t output_size, size_t *output_length);
1290 * );
1291 * ```
1292 * The \c context value is initialized to 0 before the first call.
1293 * The function must fill the \c output buffer with \p output_size bytes
1294 * of random data and set \c *output_length to \p output_size.
1295 *
1296 * Requires: MBEDTLS_PSA_CRYPTO_C
1297 *
1298 * \warning If you enable this option, code that uses the PSA cryptography
1299 * interface will not use any of the entropy sources set up for
1300 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1301 * enables.
1302 *
1303 * \note This option is experimental and may be removed without notice.
1304 */
1305//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1306
Paul Bakker9dcc3222011-03-08 14:16:06 +00001307/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001308 * \def MBEDTLS_PSA_CRYPTO_SPM
1309 *
1310 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1311 * Partition Manager) integration which separates the code into two parts: a
1312 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1313 * Environment).
1314 *
1315 * Module: library/psa_crypto.c
1316 * Requires: MBEDTLS_PSA_CRYPTO_C
1317 *
1318 */
1319//#define MBEDTLS_PSA_CRYPTO_SPM
1320
1321/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001322 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001323 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001324 * Enable support for entropy injection at first boot. This feature is
1325 * required on systems that do not have a built-in entropy source (TRNG).
1326 * This feature is currently not supported on systems that have a built-in
1327 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001328 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001329 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001330 *
1331 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001332//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001333
1334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001336 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001337 * Do not use the Chinese Remainder Theorem
1338 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001339 *
1340 * Uncomment this macro to disable the use of CRT in RSA.
1341 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001344
1345/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001347 *
1348 * Enable the checkup functions (*_self_test).
1349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001351
1352/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001353 * \def MBEDTLS_SHA256_SMALLER
1354 *
1355 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1356 * lower performance.
1357 *
1358 * The default implementation is meant to be a reasonnable compromise between
1359 * performance and size. This version optimizes more aggressively for size at
1360 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1361 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1362 * 30%.
1363 *
1364 * Uncomment to enable the smaller implementation of SHA256.
1365 */
1366//#define MBEDTLS_SHA256_SMALLER
1367
1368/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001369 * \def MBEDTLS_SHA512_SMALLER
1370 *
1371 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1372 * lower performance.
1373 *
1374 * Uncomment to enable the smaller implementation of SHA512.
1375 */
1376//#define MBEDTLS_SHA512_SMALLER
1377
1378/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001379 * \def MBEDTLS_SHA512_NO_SHA384
1380 *
1381 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1382 * code size on devices that don't use SHA-384.
1383 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001384 * Requires: MBEDTLS_SHA512_C
1385 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001386 * Uncomment to disable SHA-384
1387 */
1388//#define MBEDTLS_SHA512_NO_SHA384
1389
1390/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001392 *
1393 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001394 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001395 * with other servers, only debugging of failures is harder.
1396 *
1397 * The advantage of not sending alert messages, is that no information is given
1398 * about reasons for failures thus preventing adversaries of gaining intel.
1399 *
1400 * Enable sending of all alert messages
1401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001402#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001403
1404/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001405 * \def MBEDTLS_SSL_RECORD_CHECKING
1406 *
1407 * Enable the function mbedtls_ssl_check_record() which can be used to check
1408 * the validity and authenticity of an incoming record, to verify that it has
1409 * not been seen before. These checks are performed without modifying the
1410 * externally visible state of the SSL context.
1411 *
1412 * See mbedtls_ssl_check_record() for more information.
1413 *
1414 * Uncomment to enable support for record checking.
1415 */
1416#define MBEDTLS_SSL_RECORD_CHECKING
1417
1418/**
1419 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1420 *
1421 * Enable support for the DTLS Connection ID extension
1422 * (version draft-ietf-tls-dtls-connection-id-05,
1423 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1424 * which allows to identify DTLS connections across changes
1425 * in the underlying transport.
1426 *
1427 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1428 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1429 * See the corresponding documentation for more information.
1430 *
1431 * \warning The Connection ID extension is still in draft state.
1432 * We make no stability promises for the availability
1433 * or the shape of the API controlled by this option.
1434 *
1435 * The maximum lengths of outgoing and incoming CIDs can be configured
1436 * through the options
1437 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1438 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1439 *
1440 * Requires: MBEDTLS_SSL_PROTO_DTLS
1441 *
1442 * Uncomment to enable the Connection ID extension.
1443 */
1444//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1445
1446/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001447 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1448 *
1449 * Enable asynchronous external private key operations in SSL. This allows
1450 * you to configure an SSL connection to call an external cryptographic
1451 * module to perform private key operations instead of performing the
1452 * operation inside the library.
1453 *
1454 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001455//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001456
1457/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001458 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1459 *
1460 * Enable serialization of the TLS context structures, through use of the
1461 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1462 *
1463 * This pair of functions allows one side of a connection to serialize the
1464 * context associated with the connection, then free or re-use that context
1465 * while the serialized state is persisted elsewhere, and finally deserialize
1466 * that state to a live context for resuming read/write operations on the
1467 * connection. From a protocol perspective, the state of the connection is
1468 * unaffected, in particular this is entirely transparent to the peer.
1469 *
1470 * Note: this is distinct from TLS session resumption, which is part of the
1471 * protocol and fully visible by the peer. TLS session resumption enables
1472 * establishing new connections associated to a saved session with shorter,
1473 * lighter handshakes, while context serialization is a local optimization in
1474 * handling a single, potentially long-lived connection.
1475 *
1476 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1477 * saved after the handshake to allow for more efficient serialization, so if
1478 * you don't need this feature you'll save RAM by disabling it.
1479 *
1480 * Comment to disable the context serialization APIs.
1481 */
1482#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1483
1484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001486 *
1487 * Enable the debug messages in SSL module for all issues.
1488 * Debug messages have been disabled in some places to prevent timing
1489 * attacks due to (unbalanced) debugging function calls.
1490 *
1491 * If you need all error reporting you should enable this during debugging,
1492 * but remove this for production servers that should log as well.
1493 *
1494 * Uncomment this macro to report all debug messages on errors introducing
1495 * a timing side-channel.
1496 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001501 *
1502 * Enable support for Encrypt-then-MAC, RFC 7366.
1503 *
1504 * This allows peers that both support it to use a more robust protection for
1505 * ciphersuites using CBC, providing deep resistance against timing attacks
1506 * on the padding or underlying cipher.
1507 *
1508 * This only affects CBC ciphersuites, and is useless if none is defined.
1509 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1511 * MBEDTLS_SSL_PROTO_TLS1_1 or
1512 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001513 *
1514 * Comment this macro to disable support for Encrypt-then-MAC
1515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001517
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001518/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001519 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001520 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1521 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001522 *
1523 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1524 * attacks, but it is recommended to always use it (even if you disable
1525 * renegotiation), since it actually fixes a more fundamental issue in the
1526 * original SSL/TLS design, and has implications beyond Triple Handshake.
1527 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1529 * MBEDTLS_SSL_PROTO_TLS1_1 or
1530 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001531 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001532 * Comment this macro to disable support for Extended Master Secret.
1533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001535
Paul Bakkerd66f0702013-01-31 16:57:45 +01001536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001538 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001539 * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV)
1540 * for Preventing Protocol Downgrade Attacks.
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001541 *
1542 * For servers, it is recommended to always enable this, unless you support
1543 * only one version of TLS, or know for sure that none of your clients
1544 * implements a fallback strategy.
1545 *
1546 * For clients, you only need this if you're using a fallback strategy, which
1547 * is not recommended in the first place, unless you absolutely need it to
1548 * interoperate with buggy (version-intolerant) servers.
1549 *
1550 * Comment this macro to disable support for FALLBACK_SCSV
1551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001553
1554/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001555 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1556 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001557 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001558 * giving access to the peer's certificate after completion of the handshake.
1559 *
1560 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1561 * recommended to disable this option for reduced RAM usage.
1562 *
1563 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1564 * defined, but always returns \c NULL.
1565 *
1566 * \note This option has no influence on the protection against the
1567 * triple handshake attack. Even if it is disabled, Mbed TLS will
1568 * still ensure that certificates do not change during renegotiation,
1569 * for exaple by keeping a hash of the peer's certificate.
1570 *
1571 * Comment this macro to disable storing the peer's certificate
1572 * after the handshake.
1573 */
1574#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1575
1576/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001578 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001579 * Enable 1/n-1 record splitting for CBC mode in TLS 1.0.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001580 *
1581 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1582 * of interoperability issues compared to sending 0-length records.
1583 *
1584 * Comment this macro to disable 1/n-1 record splitting.
1585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001587
1588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001590 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001591 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001592 *
1593 * The two main uses of renegotiation are (1) refresh keys on long-lived
1594 * connections and (2) client authentication after the initial handshake.
1595 * If you don't need renegotiation, it's probably better to disable it, since
1596 * it has been associated with security issues in the past and is easy to
1597 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001598 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001599 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001600 *
1601 * \note Even if this option is disabled, both client and server are aware
1602 * of the Renegotiation Indication Extension (RFC 5746) used to
1603 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1604 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1605 * configuration of this extension).
1606 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001609
1610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001611 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001612 *
1613 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001615 *
1616 * Uncomment this macro to respect client's ciphersuite order
1617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001619
1620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001622 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001623 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001624 *
1625 * Comment this macro to disable support for the max_fragment_length extension
1626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001628
1629/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001630 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001631 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001632 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001633 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634 * Requires: MBEDTLS_MD5_C
1635 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001636 *
1637 * Comment this macro to disable support for TLS 1.0
1638 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001640
1641/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001643 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001644 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001645 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646 * Requires: MBEDTLS_MD5_C
1647 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001648 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001649 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001652
1653/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001655 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001656 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001657 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001659 * (Depends on ciphersuites)
1660 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001661 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001664
1665/**
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001666 * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
1667 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001668 * This macro is used to selectively enable experimental parts
1669 * of the code that contribute to the ongoing development of
1670 * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide
1671 * no other purpose.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001672 *
Hanno Becker3c358d42020-05-20 13:54:41 +01001673 * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS,
1674 * and no feature exposed through this macro is part of the
1675 * public API. In particular, features under the control
1676 * of this macro are experimental and don't come with any
1677 * stability guarantees.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001678 *
1679 * Uncomment this macro to enable experimental and partial
1680 * functionality specific to TLS 1.3.
1681 */
Hanno Beckere4160602020-05-07 15:11:45 +01001682//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001683
1684/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001685 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001686 *
1687 * Enable support for DTLS (all available versions).
1688 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1690 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001691 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1693 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001694 *
1695 * Comment this macro to disable support for DTLS
1696 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001698
1699/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001701 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001702 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001703 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001704 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001707
1708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001710 *
1711 * Enable support for the anti-replay mechanism in DTLS.
1712 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713 * Requires: MBEDTLS_SSL_TLS_C
1714 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001715 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001716 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001717 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001718 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001719 * Comment this to disable anti-replay in DTLS.
1720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001722
1723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001725 *
1726 * Enable support for HelloVerifyRequest on DTLS servers.
1727 *
1728 * This feature is highly recommended to prevent DTLS servers being used as
1729 * amplifiers in DoS attacks against other hosts. It should always be enabled
1730 * unless you know for sure amplification cannot be a problem in the
1731 * environment in which your server operates.
1732 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001733 * \warning Disabling this can ba a security risk! (see above)
1734 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001735 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001736 *
1737 * Comment this to disable support for HelloVerifyRequest.
1738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001740
1741/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001742 * \def MBEDTLS_SSL_DTLS_SRTP
1743 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001744 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001745 * through the use_srtp extension.
1746 *
1747 * \note This feature provides the minimum functionality required
1748 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1749 * the associated SRTP packet protection key material.
1750 * In particular, the SRTP packet protection itself, as well as the
1751 * demultiplexing of RTP and DTLS packets at the datagram layer
1752 * (see Section 5 of RFC 5764), are not handled by this feature.
1753 * Instead, after successful completion of a handshake negotiating
1754 * the use of DTLS-SRTP, the extended key exporter API
1755 * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement
1756 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1757 * (this is implemented in the SSL example programs).
1758 * The resulting key should then be passed to an SRTP stack.
1759 *
1760 * Setting this option enables the runtime API
1761 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1762 * through which the supported DTLS-SRTP protection
1763 * profiles can be configured. You must call this API at
1764 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001765 *
1766 * Requires: MBEDTLS_SSL_PROTO_DTLS
1767 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001768 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001769 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001770//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001771
1772/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001773 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1774 *
1775 * Enable server-side support for clients that reconnect from the same port.
1776 *
1777 * Some clients unexpectedly close the connection and try to reconnect using the
1778 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001779 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001780 * flag enables that support.
1781 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001782 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001783 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001784 * Comment this to disable support for clients reusing the source port.
1785 */
1786#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1787
1788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001790 *
1791 * Enable support for a limit of records with bad MAC.
1792 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001793 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001794 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001798
1799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001801 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001802 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001803 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001804 * session store remains the responsibility of the application, though).
1805 * Server-side, you also need to provide callbacks for writing and parsing
1806 * tickets, including authenticated encryption and key management. Example
1807 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001808 *
1809 * Comment this macro to disable support for SSL session tickets
1810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001812
1813/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001814 * \def MBEDTLS_SSL_EXPORT_KEYS
1815 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001816 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001817 * This is required for certain users of TLS, e.g. EAP-TLS.
1818 *
1819 * Comment this macro to disable support for key export
1820 */
1821#define MBEDTLS_SSL_EXPORT_KEYS
1822
1823/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001826 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001827 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001829 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001830 * Comment this macro to disable support for server name indication in SSL
1831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001833
1834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001837 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001838 *
1839 * Comment this macro to disable support for truncated HMAC in SSL
1840 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001842
1843/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001844 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1845 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001846 * When this option is enabled, the SSL buffer will be resized automatically
1847 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001848 *
1849 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001850 */
1851//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1852
1853/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001854 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1855 *
1856 * Enable testing of the constant-flow nature of some sensitive functions with
1857 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001858 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001859 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001860 * This setting requires compiling with clang -fsanitize=memory. The test
1861 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001862 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001863 * \warning This macro is only used for extended testing; it is not considered
1864 * part of the library's API, so it may change or disappear at any time.
1865 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001866 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001867 */
1868//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1869
1870/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001871 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1872 *
1873 * Enable testing of the constant-flow nature of some sensitive functions with
1874 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001875 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001876 *
1877 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001878 * testing if the tests suites are run with valgrind's memcheck. This can be
1879 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1880 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001881 *
1882 * \warning This macro is only used for extended testing; it is not considered
1883 * part of the library's API, so it may change or disappear at any time.
1884 *
1885 * Uncomment to enable testing of the constant-flow nature of selected code.
1886 */
1887//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1888
1889/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001890 * \def MBEDTLS_TEST_HOOKS
1891 *
1892 * Enable features for invasive testing such as introspection functions and
1893 * hooks for fault injection. This enables additional unit tests.
1894 *
1895 * Merely enabling this feature should not change the behavior of the product.
1896 * It only adds new code, and new branching points where the default behavior
1897 * is the same as when this feature is disabled.
1898 * However, this feature increases the attack surface: there is an added
1899 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1900 * Therefore this feature must never be enabled in production.
1901 *
1902 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1903 * information.
1904 *
1905 * Uncomment to enable invasive tests.
1906 */
1907//#define MBEDTLS_TEST_HOOKS
1908
1909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001911 *
1912 * Provide your own alternate threading implementation.
1913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001915 *
1916 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001919
1920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001922 *
1923 * Enable the pthread wrapper layer for the threading layer.
1924 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001926 *
1927 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001930
1931/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001932 * \def MBEDTLS_USE_PSA_CRYPTO
1933 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001934 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1935 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001936 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001937 * \note Development of this option is currently in progress, and parts of Mbed
1938 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001939 * will still continue to work as usual, so enabling this option should not
1940 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001941 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001942 * \warning The PSA Crypto API is in beta stage. While you're welcome to
1943 * experiment using it, incompatible API changes are still possible, and some
1944 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001945 *
1946 * \warning This option enables new Mbed TLS APIs that are dependent on the
1947 * PSA Crypto API, so can't come with the same stability guarantees as the
1948 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001949 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001950 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00001951 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001952 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001953 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001954 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001955 */
1956//#define MBEDTLS_USE_PSA_CRYPTO
1957
1958/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001959 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1960 *
John Durkop185764f2020-10-12 21:32:12 -07001961 * This setting allows support for cryptographic mechanisms through the PSA
1962 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001963 *
John Durkop185764f2020-10-12 21:32:12 -07001964 * Uncomment this to enable use of PSA Crypto configuration settings which
Gilles Peskine58858b72020-11-09 15:26:09 +01001965 * can be found in include/psa/crypto_config.h.
1966 *
1967 * If you enable this option and write your own configuration file, you must
1968 * include mbedtls/config_psa.h in your configuration file. The default
1969 * provided mbedtls/config.h contains the necessary inclusion.
John Durkop185764f2020-10-12 21:32:12 -07001970 *
1971 * This feature is still experimental and is not ready for production since
1972 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001973 */
1974//#define MBEDTLS_PSA_CRYPTO_CONFIG
1975
1976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001978 *
1979 * Allow run-time checking of compile-time enabled features. Thus allowing users
1980 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001982 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001984 *
1985 * Comment this to disable run-time checking and save ROM space
1986 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001988
1989/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001991 *
1992 * If set, the X509 parser will not break-off when parsing an X509 certificate
1993 * and encountering an extension in a v1 or v2 certificate.
1994 *
1995 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001998
1999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00002001 *
2002 * If set, the X509 parser will not break-off when parsing an X509 certificate
2003 * and encountering an unknown critical extension.
2004 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01002005 * \warning Depending on your PKI use, enabling this can be a security risk!
2006 *
Paul Bakker5c721f92011-07-27 16:51:09 +00002007 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00002008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00002010
2011/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002012 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2013 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002014 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002015 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2016 * the set of trusted certificates through a callback instead of a linked
2017 * list.
2018 *
2019 * This is useful for example in environments where a large number of trusted
2020 * certificates is present and storing them in a linked list isn't efficient
2021 * enough, or when the set of trusted certificates changes frequently.
2022 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002023 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002024 * `mbedtls_ssl_conf_ca_cb()` for more information.
2025 *
2026 * Uncomment to enable trusted certificate callbacks.
2027 */
2028//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2029
2030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002032 *
2033 * Enable verification of the keyUsage extension (CA and leaf certificates).
2034 *
2035 * Disabling this avoids problems with mis-issued and/or misused
2036 * (intermediate) CA and leaf certificates.
2037 *
2038 * \warning Depending on your PKI use, disabling this can be a security risk!
2039 *
2040 * Comment to skip keyUsage checking for both CA and leaf certificates.
2041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02002043
2044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002045 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002046 *
2047 * Enable verification of the extendedKeyUsage extension (leaf certificates).
2048 *
2049 * Disabling this avoids problems with mis-issued and/or misused certificates.
2050 *
2051 * \warning Depending on your PKI use, disabling this can be a security risk!
2052 *
2053 * Comment to skip extendedKeyUsage checking for certificates.
2054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02002056
2057/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002058 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002059 *
Chris Jones2c745862020-12-16 11:41:06 +00002060 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002061 *
Chris Jones2c745862020-12-16 11:41:06 +00002062 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002063 * and other functions/constants only used by these functions, thus reducing
2064 * the code footprint by several KB.
2065 */
Chris Jones2c745862020-12-16 11:41:06 +00002066//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002067
2068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002070 *
2071 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2072 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2073 *
2074 * Comment this macro to disallow using RSASSA-PSS in certificates.
2075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002077/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002078
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002079/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002080 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002081 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002082 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002083 * \{
2084 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002085
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002088 *
2089 * Enable AES-NI support on x86-64.
2090 *
2091 * Module: library/aesni.c
2092 * Caller: library/aes.c
2093 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002095 *
2096 * This modules adds support for the AES-NI instructions on x86-64
2097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002099
2100/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002102 *
2103 * Enable the AES block cipher.
2104 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002105 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002106 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002107 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002108 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002109 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002110 * This module enables the following ciphersuites (if other requisites are
2111 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2113 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2114 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2115 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2116 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2117 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2118 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2120 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2122 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2124 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2125 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2126 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2127 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2128 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2129 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2130 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2131 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2132 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2134 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2135 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2137 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2138 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2141 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2142 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2143 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2144 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2145 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2146 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2147 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2148 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2149 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2150 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2152 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2153 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2154 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2155 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2156 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2157 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2158 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2159 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2160 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2161 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2162 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2164 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2165 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2166 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2167 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2168 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2169 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002170 *
Paul Bakkercff68422013-09-15 20:43:33 +02002171 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002174
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002177 *
2178 * Enable the ARCFOUR stream cipher.
2179 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002180 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002181 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002182 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002183 * This module enables the following ciphersuites (if other requisites are
2184 * enabled as well):
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002185 *
2186 * \warning ARC4 is considered a weak cipher and its use constitutes a
2187 * security risk. If possible, we recommend avoidng dependencies on
2188 * it, and considering stronger ciphers instead.
2189 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002192
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002195 *
2196 * Enable the generic ASN1 parser.
2197 *
2198 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002199 * Caller: library/x509.c
2200 * library/dhm.c
2201 * library/pkcs12.c
2202 * library/pkcs5.c
2203 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002206
2207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002209 *
2210 * Enable the generic ASN1 writer.
2211 *
2212 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002213 * Caller: library/ecdsa.c
2214 * library/pkwrite.c
2215 * library/x509_create.c
2216 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002217 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002218 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002220
2221/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002223 *
2224 * Enable the Base64 module.
2225 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002226 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002227 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002228 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002229 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002232
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002234 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002235 *
Paul Bakker9a736322012-11-14 12:39:52 +00002236 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002237 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002238 * Module: library/bignum.c
2239 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002240 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002241 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002242 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002243 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002244 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002245 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002246 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002249
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002250/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002252 *
2253 * Enable the Blowfish block cipher.
2254 *
2255 * Module: library/blowfish.c
2256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002258
2259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002261 *
2262 * Enable the Camellia block cipher.
2263 *
Paul Bakker38119b12009-01-10 23:31:23 +00002264 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002265 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002266 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002267 * This module enables the following ciphersuites (if other requisites are
2268 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2270 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2271 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2272 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2273 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2274 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2275 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2276 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2277 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2278 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2279 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2281 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2282 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2283 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2284 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2285 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2289 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2290 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2291 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2292 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2293 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2294 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2297 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2298 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2299 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2300 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2301 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2303 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2304 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2305 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2308 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2309 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2310 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002313
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002314/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002315 * \def MBEDTLS_ARIA_C
2316 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002317 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002318 *
2319 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002320 * Caller: library/cipher.c
2321 *
2322 * This module enables the following ciphersuites (if other requisites are
2323 * enabled as well):
2324 *
2325 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2326 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2327 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2328 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2329 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2351 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2353 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2355 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002363 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002364#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002365
2366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002368 *
2369 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2370 *
2371 * Module: library/ccm.c
2372 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002374 *
2375 * This module enables the AES-CCM ciphersuites, if other requisites are
2376 * enabled as well.
2377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002379
2380/**
Daniel King34b822c2016-05-15 17:28:08 -03002381 * \def MBEDTLS_CHACHA20_C
2382 *
2383 * Enable the ChaCha20 stream cipher.
2384 *
2385 * Module: library/chacha20.c
2386 */
2387#define MBEDTLS_CHACHA20_C
2388
2389/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002390 * \def MBEDTLS_CHACHAPOLY_C
2391 *
2392 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2393 *
2394 * Module: library/chachapoly.c
2395 *
2396 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2397 */
2398#define MBEDTLS_CHACHAPOLY_C
2399
2400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002402 *
2403 * Enable the generic cipher layer.
2404 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002405 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002406 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002407 *
2408 * Uncomment to enable generic cipher wrappers.
2409 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002411
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002412/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002413 * \def MBEDTLS_CMAC_C
2414 *
Simon Butcher327398a2016-10-05 14:09:11 +01002415 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2416 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002417 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002418 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2419 * implementation of the CMAC algorithm is provided by an alternate
2420 * implementation, that alternate implementation may opt to not support
2421 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2422 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002423 * Module: library/cmac.c
2424 *
Simon Butcher69283e52016-10-06 12:49:58 +01002425 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002426 *
2427 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002428#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002429
2430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002432 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002433 * Enable the CTR_DRBG AES-based random generator.
2434 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002435 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002436 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002437 * \note To achieve a 256-bit security strength with CTR_DRBG,
2438 * you must use AES-256 *and* use sufficient entropy.
2439 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002440 *
2441 * Module: library/ctr_drbg.c
2442 * Caller:
2443 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002445 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002446 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002449
2450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002452 *
2453 * Enable the debug functions.
2454 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002455 * Module: library/debug.c
2456 * Caller: library/ssl_cli.c
2457 * library/ssl_srv.c
2458 * library/ssl_tls.c
2459 *
2460 * This module provides debugging functions.
2461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002463
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002466 *
2467 * Enable the DES block cipher.
2468 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002469 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002470 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002471 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002472 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002473 * This module enables the following ciphersuites (if other requisites are
2474 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2476 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2477 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2478 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2479 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2480 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2481 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2482 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2483 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2484 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002485 *
Paul Bakkercff68422013-09-15 20:43:33 +02002486 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002487 *
2488 * \warning DES is considered a weak cipher and its use constitutes a
2489 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002492
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002495 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002496 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002497 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 * Module: library/dhm.c
2499 * Caller: library/ssl_cli.c
2500 * library/ssl_srv.c
2501 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002502 * This module is used by the following key exchanges:
2503 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002504 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002505 * \warning Using DHE constitutes a security risk as it
2506 * is not possible to validate custom DH parameters.
2507 * If possible, it is recommended users should consider
2508 * preferring other methods of key exchange.
2509 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002510 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002513
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002516 *
2517 * Enable the elliptic curve Diffie-Hellman library.
2518 *
2519 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002520 * Caller: library/ssl_cli.c
2521 * library/ssl_srv.c
2522 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002523 * This module is used by the following key exchanges:
2524 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002525 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002529
2530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002532 *
2533 * Enable the elliptic curve DSA library.
2534 *
2535 * Module: library/ecdsa.c
2536 * Caller:
2537 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002538 * This module is used by the following key exchanges:
2539 * ECDHE-ECDSA
2540 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002541 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2542 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2543 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002546
2547/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002548 * \def MBEDTLS_ECJPAKE_C
2549 *
2550 * Enable the elliptic curve J-PAKE library.
2551 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002552 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2553 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002554 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002555 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002556 * Module: library/ecjpake.c
2557 * Caller:
2558 *
2559 * This module is used by the following key exchanges:
2560 * ECJPAKE
2561 *
2562 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2563 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002564#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002565
2566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002568 *
2569 * Enable the elliptic curve over GF(p) library.
2570 *
2571 * Module: library/ecp.c
2572 * Caller: library/ecdh.c
2573 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002574 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002575 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002579
2580/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002582 *
2583 * Enable the platform-specific entropy code.
2584 *
2585 * Module: library/entropy.c
2586 * Caller:
2587 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002589 *
2590 * This module provides a generic entropy pool
2591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002593
2594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002596 *
2597 * Enable error code to error string conversion.
2598 *
2599 * Module: library/error.c
2600 * Caller:
2601 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002605
2606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002608 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002609 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002610 *
2611 * Module: library/gcm.c
2612 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002613 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002614 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002615 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2616 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002619
2620/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002621 * \def MBEDTLS_HKDF_C
2622 *
2623 * Enable the HKDF algorithm (RFC 5869).
2624 *
2625 * Module: library/hkdf.c
2626 * Caller:
2627 *
2628 * Requires: MBEDTLS_MD_C
2629 *
2630 * This module adds support for the Hashed Message Authentication Code
2631 * (HMAC)-based key derivation function (HKDF).
2632 */
2633#define MBEDTLS_HKDF_C
2634
2635/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002637 *
2638 * Enable the HMAC_DRBG random generator.
2639 *
2640 * Module: library/hmac_drbg.c
2641 * Caller:
2642 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002644 *
2645 * Uncomment to enable the HMAC_DRBG random number geerator.
2646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002648
2649/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002650 * \def MBEDTLS_NIST_KW_C
2651 *
2652 * Enable the Key Wrapping mode for 128-bit block ciphers,
2653 * as defined in NIST SP 800-38F. Only KW and KWP modes
2654 * are supported. At the moment, only AES is approved by NIST.
2655 *
2656 * Module: library/nist_kw.c
2657 *
2658 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2659 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002660#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002661
2662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002664 *
2665 * Enable the generic message digest layer.
2666 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002667 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002668 * Caller:
2669 *
2670 * Uncomment to enable generic message digest wrappers.
2671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002673
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002676 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002677 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002679 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002680 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002681 *
2682 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002683 *
2684 * \warning MD2 is considered a weak message digest and its use constitutes a
2685 * security risk. If possible, we recommend avoiding dependencies on
2686 * it, and considering stronger message digests instead.
2687 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002688 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002690
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002691/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002693 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002694 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002695 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002696 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002697 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002698 *
2699 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002700 *
2701 * \warning MD4 is considered a weak message digest and its use constitutes a
2702 * security risk. If possible, we recommend avoiding dependencies on
2703 * it, and considering stronger message digests instead.
2704 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002706//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002707
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002710 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002711 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002712 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002713 * Module: library/md5.c
2714 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002715 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002716 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002717 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002718 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2719 * depending on the handshake parameters. Further, it is used for checking
2720 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2721 * encrypted keys.
2722 *
2723 * \warning MD5 is considered a weak message digest and its use constitutes a
2724 * security risk. If possible, we recommend avoiding dependencies on
2725 * it, and considering stronger message digests instead.
2726 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002729
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002732 *
2733 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002734 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002735 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002736 *
2737 * Module: library/memory_buffer_alloc.c
2738 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739 * Requires: MBEDTLS_PLATFORM_C
2740 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002741 *
2742 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002745
2746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002748 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002749 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2750 *
Simon Butcherd567a232016-03-09 20:19:21 +00002751 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2752 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002753 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002754 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002755 * \note See also our Knowledge Base article about porting to a new
2756 * environment:
2757 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2758 *
Andres AG788aa4a2016-09-14 14:32:09 +01002759 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002760 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002761 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002762 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002764
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002767 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002768 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002769 *
2770 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002771 * Caller: library/asn1write.c
2772 * library/pkcs5.c
2773 * library/pkparse.c
2774 * library/pkwrite.c
2775 * library/rsa.c
2776 * library/x509.c
2777 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002778 * library/x509_crl.c
2779 * library/x509_crt.c
2780 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002781 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002782 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002783 *
2784 * This modules translates between OIDs and internal values.
2785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002787
2788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002790 *
2791 * Enable VIA Padlock support on x86.
2792 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002793 * Module: library/padlock.c
2794 * Caller: library/aes.c
2795 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002797 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002798 * This modules adds support for the VIA PadLock on x86.
2799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002800#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002801
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002804 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002805 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002806 *
2807 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002808 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002809 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002810 * library/x509_crl.c
2811 * library/x509_crt.c
2812 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002813 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002815 *
Paul Bakkercff68422013-09-15 20:43:33 +02002816 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002819
2820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002822 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002823 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002824 *
2825 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002826 * Caller: library/pkwrite.c
2827 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002828 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002829 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002831 *
2832 * This modules adds support for encoding / writing PEM files.
2833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002835
2836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002838 *
2839 * Enable the generic public (asymetric) key layer.
2840 *
2841 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002842 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002843 * library/ssl_cli.c
2844 * library/ssl_srv.c
2845 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002847 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002848 * Uncomment to enable generic public key wrappers.
2849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002851
2852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002854 *
2855 * Enable the generic public (asymetric) key parser.
2856 *
2857 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002858 * Caller: library/x509_crt.c
2859 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002860 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002862 *
2863 * Uncomment to enable generic public key parse functions.
2864 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002866
2867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002869 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002870 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002871 *
2872 * Module: library/pkwrite.c
2873 * Caller: library/x509write.c
2874 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002876 *
2877 * Uncomment to enable generic public key write functions.
2878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002880
2881/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002883 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002884 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002885 *
2886 * Module: library/pkcs5.c
2887 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002889 *
2890 * This module adds support for the PKCS#5 functions.
2891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002893
2894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002896 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002897 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002898 * Adds algorithms for parsing PKCS#8 encrypted private keys
2899 *
2900 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002901 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002902 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2904 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002905 *
2906 * This module enables PKCS#12 functions.
2907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002909
2910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002912 *
2913 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002914 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2917 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002918 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002919 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002920 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2921 * as other module rely on it for a fixed snprintf implementation.
2922 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002923 * Module: library/platform.c
2924 * Caller: Most other .c files
2925 *
2926 * This module enables abstraction of common (libc) functions.
2927 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002928#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002929
2930/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002931 * \def MBEDTLS_POLY1305_C
2932 *
2933 * Enable the Poly1305 MAC algorithm.
2934 *
2935 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002936 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002937 */
2938#define MBEDTLS_POLY1305_C
2939
2940/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002941 * \def MBEDTLS_PSA_CRYPTO_C
2942 *
2943 * Enable the Platform Security Architecture cryptography API.
2944 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002945 * \warning The PSA Crypto API is still beta status. While you're welcome to
2946 * experiment using it, incompatible API changes are still possible, and some
2947 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01002948 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002949 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002950 *
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002951 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002952 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002953 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002954 *
2955 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002956#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002957
2958/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002959 * \def MBEDTLS_PSA_CRYPTO_SE_C
2960 *
2961 * Enable secure element support in the Platform Security Architecture
2962 * cryptography API.
2963 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02002964 * \warning This feature is not yet suitable for production. It is provided
2965 * for API evaluation and testing purposes only.
2966 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002967 * Module: library/psa_crypto_se.c
2968 *
2969 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2970 *
2971 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002972//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002973
2974/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002975 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2976 *
2977 * Enable the Platform Security Architecture persistent key storage.
2978 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002979 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002980 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002981 * Requires: MBEDTLS_PSA_CRYPTO_C,
2982 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2983 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002984 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002985#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002986
2987/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002988 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002989 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002990 * Enable the emulation of the Platform Security Architecture
2991 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002992 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002993 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002994 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002995 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002996 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002997#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002998
2999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003001 *
3002 * Enable the RIPEMD-160 hash algorithm.
3003 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003004 * Module: library/ripemd160.c
3005 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003006 *
3007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003009
3010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003012 *
3013 * Enable the RSA public-key cryptosystem.
3014 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003015 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003016 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003017 * Caller: library/ssl_cli.c
3018 * library/ssl_srv.c
3019 * library/ssl_tls.c
3020 * library/x509.c
3021 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003022 * This module is used by the following key exchanges:
3023 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003024 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#define MBEDTLS_RSA_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_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003031 *
3032 * Enable the SHA1 cryptographic hash algorithm.
3033 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003034 * Module: library/sha1.c
3035 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003036 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003037 * library/ssl_srv.c
3038 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003039 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003040 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003041 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3042 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003043 *
3044 * \warning SHA-1 is considered a weak message digest and its use constitutes
3045 * a security risk. If possible, we recommend avoiding dependencies
3046 * on 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_SHA1_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_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003053 *
3054 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3055 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003056 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003057 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003058 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003059 * library/ssl_cli.c
3060 * library/ssl_srv.c
3061 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003062 *
3063 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003064 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003067
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003070 *
3071 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3072 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003073 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003074 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003075 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003076 * library/ssl_cli.c
3077 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 *
3079 * This module adds support for SHA-384 and SHA-512.
3080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003082
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003085 *
3086 * Enable simple SSL cache implementation.
3087 *
3088 * Module: library/ssl_cache.c
3089 * Caller:
3090 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003094
3095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003097 *
3098 * Enable basic implementation of DTLS cookies for hello verification.
3099 *
3100 * Module: library/ssl_cookie.c
3101 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003104
3105/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003106 * \def MBEDTLS_SSL_TICKET_C
3107 *
3108 * Enable an implementation of TLS server-side callbacks for session tickets.
3109 *
3110 * Module: library/ssl_ticket.c
3111 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003112 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003113 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003114 */
3115#define MBEDTLS_SSL_TICKET_C
3116
3117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003119 *
3120 * Enable the SSL/TLS client code.
3121 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003122 * Module: library/ssl_cli.c
3123 * Caller:
3124 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003126 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003127 * This module is required for SSL/TLS client support.
3128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003130
Paul Bakker9a736322012-11-14 12:39:52 +00003131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133 *
3134 * Enable the SSL/TLS server code.
3135 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003136 * Module: library/ssl_srv.c
3137 * Caller:
3138 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003140 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003141 * This module is required for SSL/TLS server support.
3142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003144
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003145/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003147 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003148 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003149 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003150 * Module: library/ssl_tls.c
3151 * Caller: library/ssl_cli.c
3152 * library/ssl_srv.c
3153 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3155 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003156 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003157 * This module is required for SSL/TLS.
3158 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003160
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003162 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003163 *
3164 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003165 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003166 * contexts are not shared between threads. If you do intend to use contexts
3167 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003168 * conditions. See also our Knowledge Base article about threading:
3169 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003170 *
3171 * Module: library/threading.c
3172 *
3173 * This allows different threading implementations (self-implemented or
3174 * provided).
3175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176 * You will have to enable either MBEDTLS_THREADING_ALT or
3177 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003178 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003179 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003182
3183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003185 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003186 * Enable the semi-portable timing interface.
3187 *
Simon Butcherd567a232016-03-09 20:19:21 +00003188 * \note The provided implementation only works on POSIX/Unix (including Linux,
3189 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003190 * module and provide your own implementations of the callbacks needed by
3191 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3192 * your own implementation of the whole module by setting
3193 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003194 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003195 * \note See also our Knowledge Base article about porting to a new
3196 * environment:
3197 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3198 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003199 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003202
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003205 *
3206 * Enable run-time version information.
3207 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003208 * Module: library/version.c
3209 *
3210 * This module provides run-time version information.
3211 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003213
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003214/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003215 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003216 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003217 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003218 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003219 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003220 * Caller: library/x509_crl.c
3221 * library/x509_crt.c
3222 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003223 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3225 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003226 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003227 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003230
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003232 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003233 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003234 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003235 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003236 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003237 * Caller: library/ssl_cli.c
3238 * library/ssl_srv.c
3239 * library/ssl_tls.c
3240 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003242 *
3243 * This module is required for X.509 certificate parsing.
3244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003246
3247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003249 *
3250 * Enable X.509 CRL parsing.
3251 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003252 * Module: library/x509_crl.c
3253 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003254 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003256 *
3257 * This module is required for X.509 CRL parsing.
3258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003260
3261/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003263 *
3264 * Enable X.509 Certificate Signing Request (CSR) parsing.
3265 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003266 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003267 * Caller: library/x509_crt_write.c
3268 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003270 *
3271 * This module is used for reading X.509 certificate request.
3272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003274
3275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003276 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003277 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003278 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003279 *
3280 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003281 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003283 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003284 * This module is the basis for creating X.509 certificates and CSRs.
3285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003287
3288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003290 *
3291 * Enable creating X.509 certificates.
3292 *
3293 * Module: library/x509_crt_write.c
3294 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003296 *
3297 * This module is required for X.509 certificate creation.
3298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003300
3301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003303 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003304 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003305 *
3306 * Module: library/x509_csr_write.c
3307 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003308 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003309 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003310 * This module is required for X.509 certificate request writing.
3311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003313
3314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003316 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003317 * Enable the XTEA block cipher.
3318 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003319 * Module: library/xtea.c
3320 * Caller:
3321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003323
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003324/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003325
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003326/**
3327 * \name SECTION: Module configuration options
3328 *
3329 * This section allows for the setting of module specific sizes and
3330 * configuration options. The default values are already present in the
3331 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003332 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003333 * Our advice is to enable options and change their values here
3334 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003335 *
3336 * Please check the respective header file for documentation on these
3337 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003338 * \{
3339 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003340
Paul Bakker088c5c52014-04-25 11:11:10 +02003341/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003342//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003344
Paul Bakker088c5c52014-04-25 11:11:10 +02003345/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3347//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3348//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3349//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3350//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003351
Paul Bakker088c5c52014-04-25 11:11:10 +02003352/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3354//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3355//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3356//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003357
Paul Bakker088c5c52014-04-25 11:11:10 +02003358/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3360//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3361//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003362
Paul Bakker088c5c52014-04-25 11:11:10 +02003363/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003364//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3365//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003366//#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 +01003367
Paul Bakker088c5c52014-04-25 11:11:10 +02003368/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003370
Paul Bakker088c5c52014-04-25 11:11:10 +02003371/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372//#define MBEDTLS_PLATFORM_STD_MEM_HDR <stdlib.h> /**< Header to include if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS is defined. Don't define if no header is needed. */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003373//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3375//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003376//#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 +02003377//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3378//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003379/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003381//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3382//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003383//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3384//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3385//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3388/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003389//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3391//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003392//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3393//#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 +02003394//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3395//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003396/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003398//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003399//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3400//#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 +02003401
Gilles Peskineed038902020-11-13 21:33:21 +01003402/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003403/**
Gilles Peskineed038902020-11-13 21:33:21 +01003404 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3405 * PSA crypto subsystem.
3406 *
3407 * If this option is unset:
3408 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003409 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003410 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3411 * on unspecified heuristics.
3412 */
3413//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3414
Steven Cooreman863470a2021-02-15 14:03:19 +01003415/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003416 * Restrict the PSA library to supporting a maximum amount of simultaneously
3417 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3418 * volatile key, or a persistent key which is loaded temporarily by the
3419 * library as part of a crypto operation in flight.
3420 *
3421 * If this option is unset, the library will fall back to a default value of
3422 * 32 keys.
3423 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003424//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003425
Paul Bakker088c5c52014-04-25 11:11:10 +02003426/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3428//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003429
Paul Bakker088c5c52014-04-25 11:11:10 +02003430/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003431
3432/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3433 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003434 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003435 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003436 * This determines the size of both the incoming and outgoing TLS I/O buffers
3437 * in such a way that both are capable of holding the specified amount of
3438 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003439 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003440 * To configure incoming and outgoing I/O buffers separately, use
3441 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3442 * which overwrite the value set by this option.
3443 *
3444 * \note When using a value less than the default of 16KB on the client, it is
3445 * recommended to use the Maximum Fragment Length (MFL) extension to
3446 * inform the server about this limitation. On the server, there
3447 * is no supported, standardized way of informing the client about
3448 * restriction on the maximum size of incoming messages, and unless
3449 * the limitation has been communicated by other means, it is recommended
3450 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3451 * while keeping the default value of 16KB for the incoming buffer.
3452 *
3453 * Uncomment to set the maximum plaintext size of both
3454 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003455 */
3456//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3457
3458/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3459 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003460 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003461 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003462 * This determines the size of the incoming TLS I/O buffer in such a way
3463 * that it is capable of holding the specified amount of plaintext data,
3464 * regardless of the protection mechanism used.
3465 *
3466 * If this option is undefined, it inherits its value from
3467 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3468 *
3469 * \note When using a value less than the default of 16KB on the client, it is
3470 * recommended to use the Maximum Fragment Length (MFL) extension to
3471 * inform the server about this limitation. On the server, there
3472 * is no supported, standardized way of informing the client about
3473 * restriction on the maximum size of incoming messages, and unless
3474 * the limitation has been communicated by other means, it is recommended
3475 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3476 * while keeping the default value of 16KB for the incoming buffer.
3477 *
3478 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3479 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003480 */
3481//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3482
Gilles Peskined3d02902020-03-04 21:35:27 +01003483/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3484 *
3485 * The maximum length of CIDs used for incoming DTLS messages.
3486 *
3487 */
3488//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3489
3490/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3491 *
3492 * The maximum length of CIDs used for outgoing DTLS messages.
3493 *
3494 */
3495//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3496
3497/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3498 *
3499 * This option controls the use of record plaintext padding
3500 * when using the Connection ID extension in DTLS 1.2.
3501 *
3502 * The padding will always be chosen so that the length of the
3503 * padded plaintext is a multiple of the value of this option.
3504 *
3505 * Note: A value of \c 1 means that no padding will be used
3506 * for outgoing records.
3507 *
3508 * Note: On systems lacking division instructions,
3509 * a power of two should be preferred.
3510 *
3511 */
3512//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3513
Hanno Beckerceef8482020-06-02 06:16:00 +01003514/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY
Hanno Becker13996922020-05-28 16:15:19 +01003515 *
3516 * This option controls the use of record plaintext padding
3517 * in TLS 1.3.
3518 *
3519 * The padding will always be chosen so that the length of the
3520 * padded plaintext is a multiple of the value of this option.
3521 *
3522 * Note: A value of \c 1 means that no padding will be used
3523 * for outgoing records.
3524 *
3525 * Note: On systems lacking division instructions,
3526 * a power of two should be preferred.
3527 */
Hanno Beckerceef8482020-06-02 06:16:00 +01003528//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +01003529
Angus Grattond8213d02016-05-25 20:56:48 +10003530/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3531 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003532 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003533 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003534 * This determines the size of the outgoing TLS I/O buffer in such a way
3535 * that it is capable of holding the specified amount of plaintext data,
3536 * regardless of the protection mechanism used.
3537 *
3538 * If this option undefined, it inherits its value from
3539 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003540 *
3541 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3542 * the default inward 16384 byte buffer to conform to the TLS specification.
3543 *
3544 * The minimum required outward buffer size is determined by the handshake
3545 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3546 * The specific size requirement depends on the configured ciphers and any
3547 * certificate data which is sent during the handshake.
3548 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003549 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3550 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003551 */
3552//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3553
Hanno Beckere0b150f2018-08-21 15:51:03 +01003554/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3555 *
3556 * Maximum number of heap-allocated bytes for the purpose of
3557 * DTLS handshake message reassembly and future message buffering.
3558 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003559 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003560 * to account for a reassembled handshake message of maximum size,
3561 * together with its reassembly bitmap.
3562 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003563 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003564 * should be sufficient for all practical situations as it allows
3565 * to reassembly a large handshake message (such as a certificate)
3566 * while buffering multiple smaller handshake messages.
3567 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003568 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003569//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3572//#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 +02003573
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003574/**
3575 * Complete list of ciphersuites to use, in order of preference.
3576 *
3577 * \warning No dependency checking is done on that field! This option can only
3578 * be used to restrict the set of available ciphersuites. It is your
3579 * responsibility to make sure the needed modules are active.
3580 *
3581 * Use this to save a few hundred bytes of ROM (default ordering of all
3582 * available ciphersuites) and a few to a few hundred bytes of RAM.
3583 *
3584 * The value below is only an example, not the default.
3585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586//#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 +02003587
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003588/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003590//#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 +01003591
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003592/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003593 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3594 * signature and ciphersuite selection. Without this build-time option, SHA-1
3595 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3596 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3597 * default. At the time of writing, there is no practical attack on the use
3598 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003599 * to preserve compatibility with existing peers, but the general
3600 * warning applies nonetheless:
3601 *
3602 * \warning SHA-1 is considered a weak message digest and its use constitutes
3603 * a security risk. If possible, we recommend avoiding dependencies
3604 * on it, and considering stronger message digests instead.
3605 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003606 */
3607#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003608
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003609/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003610 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003611 * mbedtls_platform_zeroize(). This replaces the default implementation in
3612 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003613 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003614 * mbedtls_platform_zeroize() is a widely used function across the library to
3615 * zero a block of memory. The implementation is expected to be secure in the
3616 * sense that it has been written to prevent the compiler from removing calls
3617 * to mbedtls_platform_zeroize() as part of redundant code elimination
3618 * optimizations. However, it is difficult to guarantee that calls to
3619 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3620 * versions of the C language standards do not provide a secure implementation
3621 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3622 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003623 * example by using directives specific to their compiler, features from newer
3624 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003625 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003626 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003627//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003628
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003629/**
3630 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003631 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003632 * platform_util.c.
3633 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003634 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003635 * library will try to use safer implementations of this function, such as
3636 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003637 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003638 * using the standard gmtime(). In this case, calls from the library to
3639 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003640 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003641 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003642 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3643 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3644 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003645 */
Hanno Becker6a739782018-09-05 15:06:19 +01003646//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003647
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003648/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003649 * Enable the verified implementations of ECDH primitives from Project Everest
3650 * (currently only Curve25519). This feature changes the layout of ECDH
3651 * contexts and therefore is a compatibility break for applications that access
3652 * fields of a mbedtls_ecdh_context structure directly. See also
3653 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003654 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003655//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003656
Simon Butcher30b5f972016-06-08 19:00:23 +01003657/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003658
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003659/* Target and application specific configurations
3660 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003661 * Allow user to override any previous default.
3662 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003663 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003664#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003665#include MBEDTLS_USER_CONFIG_FILE
3666#endif
3667
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003668#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
John Durkop6e33dbe2020-09-17 21:15:13 -07003669#include "mbedtls/config_psa.h"
Gilles Peskinea26b3e52020-11-09 15:19:32 +01003670#endif
John Durkop6e33dbe2020-09-17 21:15:13 -07003671
Jaeden Amero6609aef2019-07-04 20:01:14 +01003672#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674#endif /* MBEDTLS_CONFIG_H */