blob: e24366021da998fc391a94abfde8b255d1067206 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
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
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010051 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000052 * library/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000053 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010054 * Required by:
55 * MBEDTLS_AESNI_C
56 * MBEDTLS_PADLOCK_C
57 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020058 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000061
Paul Bakkerf3b86c12011-01-27 15:24:17 +000062/**
Gilles Peskineed942f82017-06-08 15:19:20 +020063 * \def MBEDTLS_NO_UDBL_DIVISION
64 *
65 * The platform lacks support for double-width integer division (64-bit
66 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
67 *
68 * Used in:
69 * include/mbedtls/bignum.h
70 * library/bignum.c
71 *
72 * The bignum code uses double-width division to speed up some operations.
73 * Double-width division is often implemented in software that needs to
74 * be linked with the program. The presence of a double-width integer
75 * type is usually detected automatically through preprocessor macros,
76 * but the automatic detection cannot know whether the code needs to
77 * and can be linked with an implementation of division for that type.
78 * By default division is assumed to be usable if the type is present.
79 * Uncomment this option to prevent the use of double-width division.
80 *
81 * Note that division for the native integer type is always required.
82 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010083 * platform, but it need not support multiplication or division. In some
84 * cases it is also desirable to disable some double-width operations. For
85 * example, if double-width division is implemented in software, disabling
86 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020087 */
88//#define MBEDTLS_NO_UDBL_DIVISION
89
90/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020091 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
92 *
93 * The platform lacks support for 32x32 -> 64-bit multiplication.
94 *
95 * Used in:
96 * library/poly1305.c
97 *
98 * Some parts of the library may use multiplication of two unsigned 32-bit
99 * operands with a 64-bit result in order to speed up computations. On some
100 * platforms, this is not available in hardware and has to be implemented in
101 * software, usually in a library provided by the toolchain.
102 *
103 * Sometimes it is not desirable to have to link to that library. This option
104 * removes the dependency of that library on platforms that lack a hardware
105 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
106 *
107 * Note that depending on the compiler, this may decrease performance compared
108 * to using the library function provided by the toolchain.
109 */
110//#define MBEDTLS_NO_64BIT_MULTIPLICATION
111
112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000114 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000115 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000116 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200120
121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200123 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200124 * System has time.h and time().
125 * The time does not need to be correct, only time differences are used,
126 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100128 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
129 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
130 * MBEDTLS_PLATFORM_STD_TIME.
131 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400132 * Comment if your system does not support time functions.
133 *
134 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
135 * interface - timing.c will include time.h on suitable platforms
136 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
137 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100140
141/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200142 * \def MBEDTLS_HAVE_TIME_DATE
143 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100144 * System has time.h, time(), and an implementation for
145 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100146 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200147 * the date should be correct). This is used to verify the validity period of
148 * X.509 certificates.
149 *
150 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100151 *
Hanno Becker6a739782018-09-05 15:06:19 +0100152 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100153 * behaves similarly to the gmtime_r() function from the C standard. Refer to
154 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100155 *
156 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100157 * mbedtls_platform_gmtime_r() at compile-time by using the macro
158 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200159 */
160#define MBEDTLS_HAVE_TIME_DATE
161
162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200163 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100164 *
165 * Enable the memory allocation layer.
166 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 * This allows different allocators (self-implemented or provided) to be
169 * provided to the platform abstraction layer.
170 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200172 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
173 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000174 * free() function pointer at runtime.
175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200177 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100181 *
182 * Enable this layer to allow use of alternative memory allocators.
183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100185
186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200188 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200189 * Do not assign standard functions in the platform layer (e.g. calloc() to
190 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
192 * This makes sure there are no linking errors on platforms that do not support
193 * these functions. You will HAVE to provide alternatives, either at runtime
194 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
196 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200197 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200199 *
200 * Uncomment to prevent default assignment of standard functions in the
201 * platform layer.
202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200204
205/**
Janos Follathc351d182016-03-21 08:43:59 +0000206 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100208 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
209 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
212 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100213 * alternative printf function pointer.
214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100216 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200217 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
218 * it will be enabled automatically by check_config.h
219 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200220 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000222 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100223 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
224 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100225 * Uncomment a macro to enable alternate implementation of specific base
226 * platform function
227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200228//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100229//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200230//#define MBEDTLS_PLATFORM_FPRINTF_ALT
231//#define MBEDTLS_PLATFORM_PRINTF_ALT
232//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200233//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100234//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100235//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100236
237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100239 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000240 * Mark deprecated functions and features so that they generate a warning if
241 * used. Functionality deprecated in one version will usually be removed in the
242 * next version. You can enable this to help you prepare the transition to a
243 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100244 *
245 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100247 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000248 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100251
252/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100254 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000255 * Remove deprecated functions and features so that they generate an error if
256 * used. Functionality deprecated in one version will usually be removed in the
257 * next version. You can enable this to help you prepare the transition to a
258 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100259 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000260 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100263
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100264/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000265
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000266/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000267 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000268 *
269 * This section sets support for features that are or are not needed
270 * within the modules that are enabled.
271 * \{
272 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000273
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000274/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100276 *
TRodziewiczd8540832021-06-10 15:16:50 +0200277 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200278 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100279 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100281 *
282 * You will need to provide a header "timing_alt.h" and an implementation at
283 * compile time.
284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100286
287/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100288 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200289 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100290 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100291 * alternate core implementation of a symmetric crypto, an arithmetic or hash
292 * module (e.g. platform specific assembly optimized implementations). Keep
293 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200294 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200295 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200297 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000299 * provide the "struct mbedtls_aes_context" definition and omit the base
300 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200301 * "aes.h" to include the new function definitions.
302 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200303 * Uncomment a macro to enable alternate implementation of the corresponding
304 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100305 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200306 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100307 * use constitutes a security risk. If possible, we recommend
308 * avoiding dependencies on them, and considering stronger message
309 * digests and ciphers instead.
310 *
Paul Bakker90995b52013-06-24 19:20:35 +0200311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000313//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200315//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300316//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200317//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200318//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000320//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000321//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100322//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300323//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300325//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000327//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_SHA1_ALT
329//#define MBEDTLS_SHA256_ALT
330//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000331
Janos Follathb0697532016-08-18 12:38:46 +0100332/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800333 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100334 * implemented with two .c files:
335 * - ecp.c
336 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000337 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
338 * macros as described above. The only difference is that you have to make sure
339 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100340 */
341//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200342
343/**
TRodziewicz75628d52021-06-18 12:56:27 +0200344 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200345 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100346 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
347 * alternate core implementation of symmetric crypto or hash function. Keep in
348 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200349 *
350 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200352 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
354 * no longer provide the mbedtls_sha1_process() function, but it will still provide
355 * the other function (using your mbedtls_sha1_process() function) and the definition
356 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 * with this definition.
358 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200359 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100360 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
361 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200362 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 * Uncomment a macro to enable alternate implementation of the corresponding
364 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100365 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200366 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100367 * constitutes a security risk. If possible, we recommend avoiding
368 * dependencies on them, and considering stronger message digests
369 * and ciphers instead.
370 *
Janos Follath1231d212019-01-07 15:01:32 +0000371 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
372 * enabled, then the deterministic ECDH signature functions pass the
373 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
374 * alternative implementations should use the RNG only for generating
375 * the ephemeral key and nothing else. If this is not possible, then
376 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200377 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000378 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_MD5_PROCESS_ALT
381//#define MBEDTLS_RIPEMD160_PROCESS_ALT
382//#define MBEDTLS_SHA1_PROCESS_ALT
383//#define MBEDTLS_SHA256_PROCESS_ALT
384//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200385//#define MBEDTLS_DES_SETKEY_ALT
386//#define MBEDTLS_DES_CRYPT_ECB_ALT
387//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200388//#define MBEDTLS_AES_SETKEY_ENC_ALT
389//#define MBEDTLS_AES_SETKEY_DEC_ALT
390//#define MBEDTLS_AES_ENCRYPT_ALT
391//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300392//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300393//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300394//#define MBEDTLS_ECDSA_VERIFY_ALT
395//#define MBEDTLS_ECDSA_SIGN_ALT
396//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200397
398/**
Janos Follathc44ab972016-11-18 16:38:23 +0000399 * \def MBEDTLS_ECP_INTERNAL_ALT
400 *
401 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100402 *
403 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100404 * alternative core implementation of elliptic curve arithmetic. Keep in mind
405 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100406 *
407 * This partially replaces one function. The header file from mbed TLS is still
408 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
409 * is still present and it is used for group structures not supported by the
410 * alternative.
411 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100412 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100413 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100414 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
415 * able to fallback to curves not supported by the alternative implementation.
416 *
Janos Follathc44ab972016-11-18 16:38:23 +0000417 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
418 * and implementing the following functions:
419 * unsigned char mbedtls_internal_ecp_grp_capable(
420 * const mbedtls_ecp_group *grp )
421 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500422 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000423 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
424 * replacement functions implement arithmetic for the given group and 0
425 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500426 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000427 * called before and after each point operation and provide an opportunity to
428 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100429 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100430 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
431 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
432 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
433 * for the operation is supported by your implementation (i.e. your
434 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
435 * group is not supported by your implementation, then the original mbed TLS
436 * implementation of ecp_double_jac() is used instead, unless this fallback
437 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
438 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
439 *
440 * The function prototypes and the definition of mbedtls_ecp_group and
441 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
442 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
443 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100444 *
445 * Uncomment a macro to enable alternate implementation of the corresponding
446 * function.
447 */
448/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000449//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100450/* Turn off software fallback for curves not supported in hardware */
451//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100452/* Support for Weierstrass curves with Jacobi representation */
453//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
454//#define MBEDTLS_ECP_ADD_MIXED_ALT
455//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
456//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
457//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
458/* Support for curves with Montgomery arithmetic */
459//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
460//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
461//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
462
463/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200464 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200465 *
466 * Uncomment this macro to let mbed TLS use your own implementation of a
467 * hardware entropy collector.
468 *
469 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000470 * prototype as declared in library/entropy_poll.h, and accept NULL as first
471 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200472 *
473 * Uncomment to use your own hardware entropy collector.
474 */
475//#define MBEDTLS_ENTROPY_HARDWARE_ALT
476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000479 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100480 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000481 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100482 * Uncomment this macro to use precomputed AES tables stored in ROM.
483 * Comment this macro to generate AES tables in RAM at runtime.
484 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100485 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
486 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100487 * initialization time before the first AES operation can be performed.
488 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
489 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
490 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100491 *
492 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
493 *
Paul Bakker15566e42011-04-24 21:19:15 +0000494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200495//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000496
497/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100498 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200499 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100500 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200501 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100502 * Uncommenting this macro omits 75% of the AES tables from
503 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
504 * by computing their values on the fly during operations
505 * (the tables are entry-wise rotations of one another).
506 *
507 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100508 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100509 * runtime. Specifically, one has to compare 4 accesses within
510 * different tables to 4 accesses with additional arithmetic
511 * operations within the same table. The performance gain/loss
512 * depends on the system and memory details.
513 *
514 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
515 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200516 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100517//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200518
519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200521 *
522 * Use less ROM for the Camellia implementation (saves about 768 bytes).
523 *
524 * Uncomment this macro to use less memory for Camellia.
525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200527
528/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200529 * \def MBEDTLS_CHECK_RETURN_WARNING
530 *
531 * If this macro is defined, emit a compile-time warning if application code
532 * calls a function without checking its return value, but the return value
533 * should generally be checked in portable applications.
534 *
535 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
536 * implemented. Otherwise this option has no effect.
537 *
538 * Uncomment to get warnings on using fallible functions without checking
539 * their return value.
540 *
541 * \note This feature is a work in progress.
542 * Warnings will be added to more functions in the future.
543 *
544 * \note A few functions are considered critical, and ignoring the return
545 * value of these functions will trigger a warning even if this
546 * macro is not defined. To completely disable return value check
547 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
548 */
549//#define MBEDTLS_CHECK_RETURN_WARNING
550
551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200553 *
554 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200557
558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000560 *
561 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000564
565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000567 *
568 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000571
572/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100573 * \def MBEDTLS_CIPHER_MODE_OFB
574 *
575 * Enable Output Feedback mode (OFB) for symmetric ciphers.
576 */
577#define MBEDTLS_CIPHER_MODE_OFB
578
579/**
580 * \def MBEDTLS_CIPHER_MODE_XTS
581 *
582 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
583 */
584#define MBEDTLS_CIPHER_MODE_XTS
585
586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000588 *
589 * Enable NULL cipher.
590 * Warning: Only do so when you know what you are doing. This allows for
591 * encryption or channels without any security!
592 *
Ronald Croncee42702021-04-26 11:34:44 +0200593 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
595 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
596 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
597 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
598 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
599 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
600 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
601 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
602 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
603 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
604 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
605 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
606 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
607 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
608 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
609 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
610 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
611 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
612 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000613 *
614 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000617
618/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100619 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200620 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100621 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
622 * specific padding modes in the cipher layer with cipher modes that support
623 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200624 *
625 * If you disable all padding modes, only full blocks can be used with CBC.
626 *
627 * Enable padding modes in the cipher layer.
628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629#define MBEDTLS_CIPHER_PADDING_PKCS7
630#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
631#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
632#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200633
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200634/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
635 *
636 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
637 * By default, CTR_DRBG uses a 256-bit key.
638 */
639//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
640
Paul Bakker48e93c82013-08-14 12:21:18 +0200641/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100642 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200643 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100644 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
645 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200646 *
647 * Comment macros to disable the curve and functions for it
648 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200649/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
651#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
654#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
655#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
656#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
657#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
658#define MBEDTLS_ECP_DP_BP256R1_ENABLED
659#define MBEDTLS_ECP_DP_BP384R1_ENABLED
660#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200661/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200662#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000663#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200664
665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200666 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200667 *
668 * Enable specific 'modulo p' routines for each NIST prime.
669 * Depending on the prime and architecture, makes operations 4 to 8 times
670 * faster on the corresponding curve.
671 *
672 * Comment this macro to disable NIST curves optimisation.
673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200675
676/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200677 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100678 *
679 * Enable "non-blocking" ECC operations that can return early and be resumed.
680 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200681 * This allows various functions to pause by returning
682 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
683 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
684 * order to further progress and eventually complete their operation. This is
685 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
686 * number of ECC operations a function may perform before pausing; see
687 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100688 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200689 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200690 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100691 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200692 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200693 *
Ron Eldor19779c42018-11-05 16:58:13 +0200694 * \note This option only works with the default software implementation of
695 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100696 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100697 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200698//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100699
700/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100702 *
703 * Enable deterministic ECDSA (RFC 6979).
704 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
705 * may result in a compromise of the long-term signing key. This is avoided by
706 * the deterministic variant.
707 *
John Durkop36a82e52020-10-26 09:39:05 -0700708 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100709 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100710 * Comment this macro to disable deterministic ECDSA.
711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100713
714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200716 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200717 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200718 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200719 * This enables the following ciphersuites (if other requisites are
720 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
722 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
723 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
724 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
725 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
726 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
727 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
728 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
729 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
730 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200731 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200732#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200733
734/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200736 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200737 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200738 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200740 *
741 * This enables the following ciphersuites (if other requisites are
742 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200743 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
744 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
745 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
746 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
747 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
748 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
749 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
750 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
751 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
752 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100753 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100754 * \warning Using DHE constitutes a security risk as it
755 * is not possible to validate custom DH parameters.
756 * If possible, it is recommended users should consider
757 * preferring other methods of key exchange.
758 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100759 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200762
763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200765 *
766 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
767 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200769 *
770 * This enables the following ciphersuites (if other requisites are
771 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
773 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
774 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
775 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
776 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
777 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200780
781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200783 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200784 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200785 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
787 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200788 *
789 * This enables the following ciphersuites (if other requisites are
790 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
792 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
793 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
794 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
795 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
796 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
797 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
798 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
799 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
800 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803
804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200807 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
810 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
812 * This enables the following ciphersuites (if other requisites are
813 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
815 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
816 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
817 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
818 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
819 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
820 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
821 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
822 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
823 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
824 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
825 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200828
829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200832 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
835 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
837 * This enables the following ciphersuites (if other requisites are
838 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
840 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
841 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
842 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
843 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
844 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
845 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
846 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
847 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
848 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
849 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
850 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100851 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100852 * \warning Using DHE constitutes a security risk as it
853 * is not possible to validate custom DH parameters.
854 * If possible, it is recommended users should consider
855 * preferring other methods of key exchange.
856 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100857 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860
861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200864 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
867 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
869 * This enables the following ciphersuites (if other requisites are
870 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
872 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
873 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
874 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
875 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
876 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
877 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
878 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
879 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
880 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883
884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200886 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200887 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200888 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200890 *
891 * This enables the following ciphersuites (if other requisites are
892 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
894 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
895 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
896 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
897 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
898 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
899 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
900 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
901 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
902 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200905
906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100908 *
909 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
910 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200911 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100912 *
913 * This enables the following ciphersuites (if other requisites are
914 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
916 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
917 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
918 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
919 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
920 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
921 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
922 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
923 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
924 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100925 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100927
928/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100930 *
931 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
932 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200933 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100934 *
935 * This enables the following ciphersuites (if other requisites are
936 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
938 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
939 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
940 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
941 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
942 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
943 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
944 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
945 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
946 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100949
950/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200951 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
952 *
953 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
954 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200955 * \warning This is currently experimental. EC J-PAKE support is based on the
956 * Thread v1.0.0 specification; incompatible changes to the specification
957 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200958 *
959 * Requires: MBEDTLS_ECJPAKE_C
960 * MBEDTLS_SHA256_C
961 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
962 *
963 * This enables the following ciphersuites (if other requisites are
964 * enabled as well):
965 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
966 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200967//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200968
969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100971 *
972 * Enhance support for reading EC keys using variants of SEC1 not allowed by
973 * RFC 5915 and RFC 5480.
974 *
975 * Currently this means parsing the SpecifiedECDomain choice of EC
976 * parameters (only known groups are supported, not arbitrary domains, to
977 * avoid validation issues).
978 *
979 * Disable if you only need to support RFC 5915 + 5480 key formats.
980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100982
983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100985 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * Enable a dummy error function to make use of mbedtls_strerror() in
987 * third party libraries easier when MBEDTLS_ERROR_C is disabled
988 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200989 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
991 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100992 *
993 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100995 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100997
998/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001000 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001001 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001002 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001006
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001009 *
1010 * Enable functions that use the filesystem.
1011 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001013
1014/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001016 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001017 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001018 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001019 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001020 * application.
1021 *
1022 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001025
1026/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001028 *
1029 * Do not use built-in platform entropy functions.
1030 * This is useful if your platform does not support
1031 * standards like the /dev/urandom or Windows CryptoAPI.
1032 *
1033 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001036
1037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001039 *
1040 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1041 * default SHA-512 based one (if both are available).
1042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001044 *
1045 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1046 * if you have performance concerns.
1047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * This option is only useful if both MBEDTLS_SHA256_C and
1049 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001052
1053/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001054 * \def MBEDTLS_ENTROPY_NV_SEED
1055 *
1056 * Enable the non-volatile (NV) seed file-based entropy source.
1057 * (Also enables the NV seed read/write functions in the platform layer)
1058 *
1059 * This is crucial (if not required) on systems that do not have a
1060 * cryptographic entropy source (in hardware or kernel) available.
1061 *
1062 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1063 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001064 * \note The read/write functions that are used by the entropy source are
1065 * determined in the platform layer, and can be modified at runtime and/or
1066 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1067 *
1068 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001069 * with regular fopen(), please make sure you make a seedfile with the
1070 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1071 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001072 * and written to or you will get an entropy source error! The default
1073 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1074 * bytes from the file.
1075 *
1076 * \note The entropy collector will write to the seed file before entropy is
1077 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001078 */
1079//#define MBEDTLS_ENTROPY_NV_SEED
1080
Ronald Cron71016a92020-08-28 19:01:50 +02001081/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001082 *
Ronald Cron71016a92020-08-28 19:01:50 +02001083 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001084 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001085 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1086 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001087 *
1088 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001089 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001090 */
Ronald Cron71016a92020-08-28 19:01:50 +02001091//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001092
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001095 *
1096 * Enable debugging of buffer allocator memory issues. Automatically prints
1097 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1098 * function for 'debug output' of allocated memory.
1099 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001101 *
1102 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001105
1106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001108 *
1109 * Include backtrace information with each allocated block.
1110 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001112 * GLIBC-compatible backtrace() an backtrace_symbols() support
1113 *
1114 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001117
1118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001120 *
1121 * Support external private RSA keys (eg from a HSM) in the PK layer.
1122 *
1123 * Comment this macro to disable support for external private RSA keys.
1124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001126
1127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001129 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001130 * Enable support for PKCS#1 v1.5 encoding.
1131 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02001132 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001133 *
Paul Bakker48377d92013-08-30 12:06:24 +02001134 * This enables support for PKCS#1 v1.5 operations.
1135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001137
1138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001140 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001141 * Enable support for PKCS#1 v2.1 encoding.
1142 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001144 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001145 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001148
Steven Cooreman6801f082021-02-19 17:21:22 +01001149/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1150 *
1151 * Enable support for platform built-in keys. If you enable this feature,
1152 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1153 * See the documentation of that function for more information.
1154 *
1155 * Built-in keys are typically derived from a hardware unique key or
1156 * stored in a secure element.
1157 *
1158 * Requires: MBEDTLS_PSA_CRYPTO_C.
1159 *
1160 * \warning This interface is experimental and may change or be removed
1161 * without notice.
1162 */
1163//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1164
Ronald Cron3768ac12021-01-26 16:58:00 +01001165/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1166 *
1167 * Enable support for PSA crypto client.
1168 *
1169 * \note This option allows to include the code necessary for a PSA
1170 * crypto client when the PSA crypto implementation is not included in
1171 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1172 * code to set and get PSA key attributes.
1173 * The development of PSA drivers partially relying on the library to
1174 * fulfill the hardware gaps is another possible usage of this option.
1175 *
1176 * \warning This interface is experimental and may change or be removed
1177 * without notice.
1178 */
1179//#define MBEDTLS_PSA_CRYPTO_CLIENT
1180
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001181/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1182 *
1183 * Enable support for the experimental PSA crypto driver interface.
1184 *
John Durkop185764f2020-10-12 21:32:12 -07001185 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001186 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001187 * \warning This interface is experimental. We intend to maintain backward
1188 * compatibility with application code that relies on drivers,
1189 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001190 */
1191//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1192
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001193/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1194 *
1195 * Make the PSA Crypto module use an external random generator provided
1196 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1197 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001198 * \note This random generator must deliver random numbers with cryptographic
1199 * quality and high performance. It must supply unpredictable numbers
1200 * with a uniform distribution. The implementation of this function
1201 * is responsible for ensuring that the random generator is seeded
1202 * with sufficient entropy. If you have a hardware TRNG which is slow
1203 * or delivers non-uniform output, declare it as an entropy source
1204 * with mbedtls_entropy_add_source() instead of enabling this option.
1205 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001206 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001207 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1208 * and define a function called mbedtls_psa_external_get_random()
1209 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001210 * ```
1211 * psa_status_t mbedtls_psa_external_get_random(
1212 * mbedtls_psa_external_random_context_t *context,
1213 * uint8_t *output, size_t output_size, size_t *output_length);
1214 * );
1215 * ```
1216 * The \c context value is initialized to 0 before the first call.
1217 * The function must fill the \c output buffer with \p output_size bytes
1218 * of random data and set \c *output_length to \p output_size.
1219 *
1220 * Requires: MBEDTLS_PSA_CRYPTO_C
1221 *
1222 * \warning If you enable this option, code that uses the PSA cryptography
1223 * interface will not use any of the entropy sources set up for
1224 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1225 * enables.
1226 *
1227 * \note This option is experimental and may be removed without notice.
1228 */
1229//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1230
Paul Bakker9dcc3222011-03-08 14:16:06 +00001231/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001232 * \def MBEDTLS_PSA_CRYPTO_SPM
1233 *
1234 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1235 * Partition Manager) integration which separates the code into two parts: a
1236 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1237 * Environment).
1238 *
1239 * Module: library/psa_crypto.c
1240 * Requires: MBEDTLS_PSA_CRYPTO_C
1241 *
1242 */
1243//#define MBEDTLS_PSA_CRYPTO_SPM
1244
1245/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001246 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001247 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001248 * Enable support for entropy injection at first boot. This feature is
1249 * required on systems that do not have a built-in entropy source (TRNG).
1250 * This feature is currently not supported on systems that have a built-in
1251 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001252 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001253 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001254 *
1255 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001256//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001257
1258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001260 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001261 * Do not use the Chinese Remainder Theorem
1262 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001263 *
1264 * Uncomment this macro to disable the use of CRT in RSA.
1265 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001267//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001268
1269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001271 *
1272 * Enable the checkup functions (*_self_test).
1273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001275
1276/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001277 * \def MBEDTLS_SHA256_SMALLER
1278 *
1279 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1280 * lower performance.
1281 *
Adam Wolf039080f2019-09-10 09:53:08 -05001282 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001283 * performance and size. This version optimizes more aggressively for size at
1284 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1285 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1286 * 30%.
1287 *
1288 * Uncomment to enable the smaller implementation of SHA256.
1289 */
1290//#define MBEDTLS_SHA256_SMALLER
1291
1292/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001293 * \def MBEDTLS_SHA512_SMALLER
1294 *
1295 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1296 * lower performance.
1297 *
1298 * Uncomment to enable the smaller implementation of SHA512.
1299 */
1300//#define MBEDTLS_SHA512_SMALLER
1301
1302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001304 *
1305 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001306 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001307 * with other servers, only debugging of failures is harder.
1308 *
1309 * The advantage of not sending alert messages, is that no information is given
1310 * about reasons for failures thus preventing adversaries of gaining intel.
1311 *
1312 * Enable sending of all alert messages
1313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001315
1316/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001317 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1318 *
1319 * Enable support for the DTLS Connection ID extension
1320 * (version draft-ietf-tls-dtls-connection-id-05,
1321 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1322 * which allows to identify DTLS connections across changes
1323 * in the underlying transport.
1324 *
1325 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001326 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1327 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1328 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001329 *
1330 * \warning The Connection ID extension is still in draft state.
1331 * We make no stability promises for the availability
1332 * or the shape of the API controlled by this option.
1333 *
1334 * The maximum lengths of outgoing and incoming CIDs can be configured
1335 * through the options
1336 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1337 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1338 *
1339 * Requires: MBEDTLS_SSL_PROTO_DTLS
1340 *
1341 * Uncomment to enable the Connection ID extension.
1342 */
1343//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1344
1345/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001346 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1347 *
1348 * Enable asynchronous external private key operations in SSL. This allows
1349 * you to configure an SSL connection to call an external cryptographic
1350 * module to perform private key operations instead of performing the
1351 * operation inside the library.
1352 *
1353 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001354//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001355
1356/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001357 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1358 *
1359 * Enable serialization of the TLS context structures, through use of the
1360 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1361 *
1362 * This pair of functions allows one side of a connection to serialize the
1363 * context associated with the connection, then free or re-use that context
1364 * while the serialized state is persisted elsewhere, and finally deserialize
1365 * that state to a live context for resuming read/write operations on the
1366 * connection. From a protocol perspective, the state of the connection is
1367 * unaffected, in particular this is entirely transparent to the peer.
1368 *
1369 * Note: this is distinct from TLS session resumption, which is part of the
1370 * protocol and fully visible by the peer. TLS session resumption enables
1371 * establishing new connections associated to a saved session with shorter,
1372 * lighter handshakes, while context serialization is a local optimization in
1373 * handling a single, potentially long-lived connection.
1374 *
1375 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1376 * saved after the handshake to allow for more efficient serialization, so if
1377 * you don't need this feature you'll save RAM by disabling it.
1378 *
1379 * Comment to disable the context serialization APIs.
1380 */
1381#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1382
1383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001385 *
1386 * Enable the debug messages in SSL module for all issues.
1387 * Debug messages have been disabled in some places to prevent timing
1388 * attacks due to (unbalanced) debugging function calls.
1389 *
1390 * If you need all error reporting you should enable this during debugging,
1391 * but remove this for production servers that should log as well.
1392 *
1393 * Uncomment this macro to report all debug messages on errors introducing
1394 * a timing side-channel.
1395 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001399/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001400 *
1401 * Enable support for Encrypt-then-MAC, RFC 7366.
1402 *
1403 * This allows peers that both support it to use a more robust protection for
1404 * ciphersuites using CBC, providing deep resistance against timing attacks
1405 * on the padding or underlying cipher.
1406 *
1407 * This only affects CBC ciphersuites, and is useless if none is defined.
1408 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001409 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001410 *
1411 * Comment this macro to disable support for Encrypt-then-MAC
1412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001415/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001416 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001417 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1418 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001419 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001420 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001421 * attacks, but it is recommended to always use it (even if you disable
1422 * renegotiation), since it actually fixes a more fundamental issue in the
1423 * original SSL/TLS design, and has implications beyond Triple Handshake.
1424 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001425 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001426 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001427 * Comment this macro to disable support for Extended Master Secret.
1428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001429#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001430
Paul Bakkerd66f0702013-01-31 16:57:45 +01001431/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001432 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1433 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001434 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001435 * giving access to the peer's certificate after completion of the handshake.
1436 *
1437 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1438 * recommended to disable this option for reduced RAM usage.
1439 *
1440 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1441 * defined, but always returns \c NULL.
1442 *
1443 * \note This option has no influence on the protection against the
1444 * triple handshake attack. Even if it is disabled, Mbed TLS will
1445 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001446 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001447 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001448 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1449 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001450 * Comment this macro to disable storing the peer's certificate
1451 * after the handshake.
1452 */
1453#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1454
1455/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001457 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001458 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001459 *
1460 * The two main uses of renegotiation are (1) refresh keys on long-lived
1461 * connections and (2) client authentication after the initial handshake.
1462 * If you don't need renegotiation, it's probably better to disable it, since
1463 * it has been associated with security issues in the past and is easy to
1464 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001465 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001466 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001467 *
1468 * \note Even if this option is disabled, both client and server are aware
1469 * of the Renegotiation Indication Extension (RFC 5746) used to
1470 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1471 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1472 * configuration of this extension).
1473 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001476
1477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001478 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001479 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001480 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001481 *
1482 * Comment this macro to disable support for the max_fragment_length extension
1483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001485
1486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001488 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001489 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001490 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001492 * (Depends on ciphersuites)
1493 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001494 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001497
1498/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001499 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001500 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001501 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001502 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001503 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1504 * pre-shared keys are not supported.
1505 * See docs/architecture/tls13-support.md for a description of the TLS
1506 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001507 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001508 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1509 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001510 * Uncomment this macro to enable the support for TLS 1.3.
1511 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001512 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001513//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001514
1515/**
Ronald Cronab65c522021-11-24 10:47:20 +01001516 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1517 *
1518 * Enable TLS 1.3 middlebox compatibility mode.
1519 *
1520 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1521 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1522 * expecting TLS 1.2 traffic.
1523 *
1524 * Turning on the compatibility mode comes at the cost of a few added bytes
1525 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1526 * that don't use it. Therefore, unless transmission bandwidth is critical and
1527 * you know that middlebox compatibility issues won't occur, it is therefore
1528 * recommended to set this option.
1529 *
1530 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001531 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1532 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001533 *
1534 */
1535//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1536
1537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001539 *
1540 * Enable support for DTLS (all available versions).
1541 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001542 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001543 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001544 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001545 *
1546 * Comment this macro to disable support for DTLS
1547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001549
1550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001552 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001553 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001554 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001555 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001558
1559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001561 *
1562 * Enable support for the anti-replay mechanism in DTLS.
1563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 * Requires: MBEDTLS_SSL_TLS_C
1565 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001566 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001567 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001568 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001569 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001570 * Comment this to disable anti-replay in DTLS.
1571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001573
1574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001576 *
1577 * Enable support for HelloVerifyRequest on DTLS servers.
1578 *
1579 * This feature is highly recommended to prevent DTLS servers being used as
1580 * amplifiers in DoS attacks against other hosts. It should always be enabled
1581 * unless you know for sure amplification cannot be a problem in the
1582 * environment in which your server operates.
1583 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001584 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001585 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001586 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001587 *
1588 * Comment this to disable support for HelloVerifyRequest.
1589 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001591
1592/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001593 * \def MBEDTLS_SSL_DTLS_SRTP
1594 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001595 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001596 * through the use_srtp extension.
1597 *
1598 * \note This feature provides the minimum functionality required
1599 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1600 * the associated SRTP packet protection key material.
1601 * In particular, the SRTP packet protection itself, as well as the
1602 * demultiplexing of RTP and DTLS packets at the datagram layer
1603 * (see Section 5 of RFC 5764), are not handled by this feature.
1604 * Instead, after successful completion of a handshake negotiating
1605 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001606 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001607 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1608 * (this is implemented in the SSL example programs).
1609 * The resulting key should then be passed to an SRTP stack.
1610 *
1611 * Setting this option enables the runtime API
1612 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1613 * through which the supported DTLS-SRTP protection
1614 * profiles can be configured. You must call this API at
1615 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001616 *
1617 * Requires: MBEDTLS_SSL_PROTO_DTLS
1618 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001619 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001620 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001621//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001622
1623/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001624 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1625 *
1626 * Enable server-side support for clients that reconnect from the same port.
1627 *
1628 * Some clients unexpectedly close the connection and try to reconnect using the
1629 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001630 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001631 * flag enables that support.
1632 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001633 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001634 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001635 * Comment this to disable support for clients reusing the source port.
1636 */
1637#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1638
1639/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001641 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001642 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001643 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001644 * session store remains the responsibility of the application, though).
1645 * Server-side, you also need to provide callbacks for writing and parsing
1646 * tickets, including authenticated encryption and key management. Example
1647 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001648 *
1649 * Comment this macro to disable support for SSL session tickets
1650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001652
1653/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001655 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001656 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001657 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001659 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001660 * Comment this macro to disable support for server name indication in SSL
1661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001663
1664/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001665 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1666 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001667 * When this option is enabled, the SSL buffer will be resized automatically
1668 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001669 *
1670 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001671 */
1672//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1673
1674/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001675 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1676 *
1677 * Enable testing of the constant-flow nature of some sensitive functions with
1678 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001679 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001680 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001681 * This setting requires compiling with clang -fsanitize=memory. The test
1682 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001683 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001684 * \warning This macro is only used for extended testing; it is not considered
1685 * part of the library's API, so it may change or disappear at any time.
1686 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001687 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001688 */
1689//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1690
1691/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001692 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1693 *
1694 * Enable testing of the constant-flow nature of some sensitive functions with
1695 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001696 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001697 *
1698 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001699 * testing if the tests suites are run with valgrind's memcheck. This can be
1700 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1701 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001702 *
1703 * \warning This macro is only used for extended testing; it is not considered
1704 * part of the library's API, so it may change or disappear at any time.
1705 *
1706 * Uncomment to enable testing of the constant-flow nature of selected code.
1707 */
1708//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1709
1710/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001711 * \def MBEDTLS_TEST_HOOKS
1712 *
1713 * Enable features for invasive testing such as introspection functions and
1714 * hooks for fault injection. This enables additional unit tests.
1715 *
1716 * Merely enabling this feature should not change the behavior of the product.
1717 * It only adds new code, and new branching points where the default behavior
1718 * is the same as when this feature is disabled.
1719 * However, this feature increases the attack surface: there is an added
1720 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1721 * Therefore this feature must never be enabled in production.
1722 *
1723 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1724 * information.
1725 *
1726 * Uncomment to enable invasive tests.
1727 */
1728//#define MBEDTLS_TEST_HOOKS
1729
1730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001732 *
1733 * Provide your own alternate threading implementation.
1734 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001736 *
1737 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001740
1741/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001743 *
1744 * Enable the pthread wrapper layer for the threading layer.
1745 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001747 *
1748 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001751
1752/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001753 * \def MBEDTLS_USE_PSA_CRYPTO
1754 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001755 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1756 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001757 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001758 * \note Development of this option is currently in progress, and parts of Mbed
1759 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001760 * will still continue to work as usual, so enabling this option should not
1761 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001762 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001763 * \note See docs/use-psa-crypto.md for a complete description of what this
1764 * option currently does, and of parts that are not affected by it so far.
1765 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001766 * \warning If you enable this option, you need to call `psa_crypto_init()`
1767 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001768 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001769 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001770 * Conflicts with: MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001771 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001772 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001773 */
1774//#define MBEDTLS_USE_PSA_CRYPTO
1775
1776/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001777 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1778 *
John Durkop185764f2020-10-12 21:32:12 -07001779 * This setting allows support for cryptographic mechanisms through the PSA
1780 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001781 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001782 * When this option is disabled, the PSA API exposes the cryptographic
1783 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1784 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001785 *
1786 * When this option is enabled, the PSA API exposes the cryptographic
1787 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1788 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1789 * automatically enabled if required (i.e. if no PSA driver provides the
1790 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1791 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001792 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001793 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001794 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001795 *
John Durkop185764f2020-10-12 21:32:12 -07001796 * This feature is still experimental and is not ready for production since
1797 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001798 */
1799//#define MBEDTLS_PSA_CRYPTO_CONFIG
1800
1801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001803 *
1804 * Allow run-time checking of compile-time enabled features. Thus allowing users
1805 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001807 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001809 *
1810 * Comment this to disable run-time checking and save ROM space
1811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001813
1814/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001815 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1816 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001817 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001818 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1819 * the set of trusted certificates through a callback instead of a linked
1820 * list.
1821 *
1822 * This is useful for example in environments where a large number of trusted
1823 * certificates is present and storing them in a linked list isn't efficient
1824 * enough, or when the set of trusted certificates changes frequently.
1825 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001826 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001827 * `mbedtls_ssl_conf_ca_cb()` for more information.
1828 *
1829 * Uncomment to enable trusted certificate callbacks.
1830 */
1831//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1832
1833/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001834 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001835 *
Chris Jones2c745862020-12-16 11:41:06 +00001836 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001837 *
Chris Jones2c745862020-12-16 11:41:06 +00001838 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001839 * and other functions/constants only used by these functions, thus reducing
1840 * the code footprint by several KB.
1841 */
Chris Jones2c745862020-12-16 11:41:06 +00001842//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001843
1844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001846 *
1847 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1848 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1849 *
1850 * Comment this macro to disallow using RSASSA-PSS in certificates.
1851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01001853/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001854
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001855/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001856 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001857 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001858 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001859 * \{
1860 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001861
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001864 *
1865 * Enable AES-NI support on x86-64.
1866 *
1867 * Module: library/aesni.c
1868 * Caller: library/aes.c
1869 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001871 *
1872 * This modules adds support for the AES-NI instructions on x86-64
1873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001875
1876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001878 *
1879 * Enable the AES block cipher.
1880 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001881 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001882 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001883 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00001884 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001885 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00001886 * This module enables the following ciphersuites (if other requisites are
1887 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1889 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1890 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1891 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1892 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1893 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1894 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1895 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1896 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1898 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1899 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1900 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1902 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1903 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1905 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1906 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1908 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1909 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1911 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1912 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1914 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1915 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1916 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1917 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1918 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
1919 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1920 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
1921 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1922 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
1923 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
1924 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1925 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
1926 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1927 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
1928 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1929 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1930 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1931 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1932 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1933 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1934 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1935 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1936 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1937 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1938 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1939 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1940 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
1941 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
1942 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
1943 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
1944 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
1945 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01001946 *
Paul Bakkercff68422013-09-15 20:43:33 +02001947 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00001948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001950
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001953 *
1954 * Enable the generic ASN1 parser.
1955 *
1956 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001957 * Caller: library/x509.c
1958 * library/dhm.c
1959 * library/pkcs12.c
1960 * library/pkcs5.c
1961 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00001962 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001964
1965/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001967 *
1968 * Enable the generic ASN1 writer.
1969 *
1970 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001971 * Caller: library/ecdsa.c
1972 * library/pkwrite.c
1973 * library/x509_create.c
1974 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00001975 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001978
1979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001981 *
1982 * Enable the Base64 module.
1983 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001984 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00001985 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001986 *
Paul Bakker5690efc2011-05-26 13:16:06 +00001987 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00001988 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001990
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001993 *
Paul Bakker9a736322012-11-14 12:39:52 +00001994 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001995 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001996 * Module: library/bignum.c
1997 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001998 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02001999 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002000 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002001 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002002 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002003 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002004 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002007
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002010 *
2011 * Enable the Camellia block cipher.
2012 *
Paul Bakker38119b12009-01-10 23:31:23 +00002013 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002014 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002015 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002016 * This module enables the following ciphersuites (if other requisites are
2017 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2019 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2020 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2021 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2022 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2023 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2024 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2025 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2026 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2027 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2028 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2029 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2030 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2031 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2032 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2033 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2034 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2035 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2036 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2037 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2038 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2039 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2040 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2041 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2042 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2043 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2044 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2045 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2046 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2047 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2048 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2049 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2050 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2051 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2052 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2053 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2054 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2055 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2056 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2057 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2058 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2059 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002062
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002063/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002064 * \def MBEDTLS_ARIA_C
2065 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002066 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002067 *
2068 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002069 * Caller: library/cipher.c
2070 *
2071 * This module enables the following ciphersuites (if other requisites are
2072 * enabled as well):
2073 *
2074 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2075 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2076 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2077 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2078 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2079 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2080 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2081 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2082 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2083 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2084 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2085 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2086 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2087 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2088 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2089 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2090 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2091 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2092 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2093 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2094 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2095 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2096 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2097 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2098 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2099 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2100 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2101 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2102 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2103 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2104 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2105 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2106 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2107 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2108 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2109 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2110 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2111 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002112 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002113#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002114
2115/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002117 *
2118 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2119 *
2120 * Module: library/ccm.c
2121 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002122 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2123 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002124 *
2125 * This module enables the AES-CCM ciphersuites, if other requisites are
2126 * enabled as well.
2127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002129
2130/**
Daniel King34b822c2016-05-15 17:28:08 -03002131 * \def MBEDTLS_CHACHA20_C
2132 *
2133 * Enable the ChaCha20 stream cipher.
2134 *
2135 * Module: library/chacha20.c
2136 */
2137#define MBEDTLS_CHACHA20_C
2138
2139/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002140 * \def MBEDTLS_CHACHAPOLY_C
2141 *
2142 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2143 *
2144 * Module: library/chachapoly.c
2145 *
2146 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2147 */
2148#define MBEDTLS_CHACHAPOLY_C
2149
2150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002152 *
2153 * Enable the generic cipher layer.
2154 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002155 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002156 * Caller: library/ccm.c
2157 * library/cmac.c
2158 * library/gcm.c
2159 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002160 * library/pkcs12.c
2161 * library/pkcs5.c
2162 * library/psa_crypto_aead.c
2163 * library/psa_crypto_mac.c
2164 * library/ssl_ciphersuites.c
2165 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002166 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002167 *
2168 * Uncomment to enable generic cipher wrappers.
2169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002171
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002172/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002173 * \def MBEDTLS_CMAC_C
2174 *
Simon Butcher327398a2016-10-05 14:09:11 +01002175 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2176 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002177 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002178 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2179 * implementation of the CMAC algorithm is provided by an alternate
2180 * implementation, that alternate implementation may opt to not support
2181 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2182 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002183 * Module: library/cmac.c
2184 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002185 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002186 *
2187 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002188#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002189
2190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002192 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002193 * Enable the CTR_DRBG AES-based random generator.
2194 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002195 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002196 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002197 * \note To achieve a 256-bit security strength with CTR_DRBG,
2198 * you must use AES-256 *and* use sufficient entropy.
2199 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002200 *
2201 * Module: library/ctr_drbg.c
2202 * Caller:
2203 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002205 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002206 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002209
2210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002212 *
2213 * Enable the debug functions.
2214 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002215 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002216 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002218 * library/ssl_tls12_*.c
2219 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002220 *
2221 * This module provides debugging functions.
2222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002224
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002225/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002227 *
2228 * Enable the DES block cipher.
2229 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002230 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002231 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002232 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002233 *
Paul Bakkercff68422013-09-15 20:43:33 +02002234 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002235 *
2236 * \warning DES is considered a weak cipher and its use constitutes a
2237 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002240
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002243 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002244 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002245 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002246 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002247 * Caller: library/ssl_tls.c
2248 * library/ssl*_client.c
2249 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002250 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002251 * This module is used by the following key exchanges:
2252 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002253 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002254 * \warning Using DHE constitutes a security risk as it
2255 * is not possible to validate custom DH parameters.
2256 * If possible, it is recommended users should consider
2257 * preferring other methods of key exchange.
2258 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002259 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002262
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002265 *
2266 * Enable the elliptic curve Diffie-Hellman library.
2267 *
2268 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002269 * Caller: library/psa_crypto.c
2270 * library/ssl_tls.c
2271 * library/ssl*_client.c
2272 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002273 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002274 * This module is used by the following key exchanges:
2275 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002276 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002280
2281/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002283 *
2284 * Enable the elliptic curve DSA library.
2285 *
2286 * Module: library/ecdsa.c
2287 * Caller:
2288 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002289 * This module is used by the following key exchanges:
2290 * ECDHE-ECDSA
2291 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002292 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2293 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2294 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002296#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002297
2298/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002299 * \def MBEDTLS_ECJPAKE_C
2300 *
2301 * Enable the elliptic curve J-PAKE library.
2302 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002303 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2304 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002305 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002306 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002307 * Module: library/ecjpake.c
2308 * Caller:
2309 *
2310 * This module is used by the following key exchanges:
2311 * ECJPAKE
2312 *
2313 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2314 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002315#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002316
2317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002319 *
2320 * Enable the elliptic curve over GF(p) library.
2321 *
2322 * Module: library/ecp.c
2323 * Caller: library/ecdh.c
2324 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002325 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002326 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002330
2331/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002333 *
2334 * Enable the platform-specific entropy code.
2335 *
2336 * Module: library/entropy.c
2337 * Caller:
2338 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002340 *
2341 * This module provides a generic entropy pool
2342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002344
2345/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002347 *
2348 * Enable error code to error string conversion.
2349 *
2350 * Module: library/error.c
2351 * Caller:
2352 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002354 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002356
2357/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002359 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002360 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002361 *
2362 * Module: library/gcm.c
2363 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002364 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2365 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002366 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002367 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2368 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002371
2372/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002373 * \def MBEDTLS_HKDF_C
2374 *
2375 * Enable the HKDF algorithm (RFC 5869).
2376 *
2377 * Module: library/hkdf.c
2378 * Caller:
2379 *
2380 * Requires: MBEDTLS_MD_C
2381 *
2382 * This module adds support for the Hashed Message Authentication Code
2383 * (HMAC)-based key derivation function (HKDF).
2384 */
2385#define MBEDTLS_HKDF_C
2386
2387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002389 *
2390 * Enable the HMAC_DRBG random generator.
2391 *
2392 * Module: library/hmac_drbg.c
2393 * Caller:
2394 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002396 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002397 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002400
2401/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002402 * \def MBEDTLS_NIST_KW_C
2403 *
2404 * Enable the Key Wrapping mode for 128-bit block ciphers,
2405 * as defined in NIST SP 800-38F. Only KW and KWP modes
2406 * are supported. At the moment, only AES is approved by NIST.
2407 *
2408 * Module: library/nist_kw.c
2409 *
2410 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2411 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002412#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002413
2414/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002416 *
2417 * Enable the generic message digest layer.
2418 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002419 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002420 * Caller: library/constant_time.c
2421 * library/ecdsa.c
2422 * library/ecjpake.c
2423 * library/hkdf.c
2424 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002425 * library/pk.c
2426 * library/pkcs5.c
2427 * library/pkcs12.c
2428 * library/psa_crypto_ecp.c
2429 * library/psa_crypto_rsa.c
2430 * library/rsa.c
2431 * library/ssl_cookie.c
2432 * library/ssl_msg.c
2433 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002434 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002435 * library/x509_crt.c
2436 * library/x509write_crt.c
2437 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002438 *
2439 * Uncomment to enable generic message digest wrappers.
2440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002442
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002445 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002446 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002447 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002448 * Module: library/md5.c
2449 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002450 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002451 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002452 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002453 * This module is required for TLS 1.2 depending on the handshake parameters.
2454 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2455 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002456 *
2457 * \warning MD5 is considered a weak message digest and its use constitutes a
2458 * security risk. If possible, we recommend avoiding dependencies on
2459 * it, and considering stronger message digests instead.
2460 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462#define MBEDTLS_MD5_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_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002466 *
2467 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002468 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002469 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002470 *
2471 * Module: library/memory_buffer_alloc.c
2472 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473 * Requires: MBEDTLS_PLATFORM_C
2474 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002475 *
2476 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002479
2480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002482 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002483 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2484 *
Simon Butcherd567a232016-03-09 20:19:21 +00002485 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2486 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002487 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002489 * \note See also our Knowledge Base article about porting to a new
2490 * environment:
2491 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2492 *
Andres AG788aa4a2016-09-14 14:32:09 +01002493 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002494 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002495 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002498
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002499/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002501 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002502 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002503 *
2504 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002505 * Caller: library/asn1write.c
2506 * library/pkcs5.c
2507 * library/pkparse.c
2508 * library/pkwrite.c
2509 * library/rsa.c
2510 * library/x509.c
2511 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002512 * library/x509_crl.c
2513 * library/x509_crt.c
2514 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002515 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002516 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002517 *
2518 * This modules translates between OIDs and internal values.
2519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002521
2522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002524 *
2525 * Enable VIA Padlock support on x86.
2526 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002527 * Module: library/padlock.c
2528 * Caller: library/aes.c
2529 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002531 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002532 * This modules adds support for the VIA PadLock on x86.
2533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002538 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002539 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002540 *
2541 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002542 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002543 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002544 * library/x509_crl.c
2545 * library/x509_crt.c
2546 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002549 *
Paul Bakkercff68422013-09-15 20:43:33 +02002550 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002553
2554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002556 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002557 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002558 *
2559 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002560 * Caller: library/pkwrite.c
2561 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002562 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002565 *
2566 * This modules adds support for encoding / writing PEM files.
2567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002569
2570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002572 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002573 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002574 *
2575 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002576 * Caller: library/psa_crypto_rsa.c
2577 * library/ssl_tls.c
2578 * library/ssl*_client.c
2579 * library/ssl*_server.c
2580 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002581 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002582 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002583 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002584 * Uncomment to enable generic public key wrappers.
2585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002587
2588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002590 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002591 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002592 *
2593 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002594 * Caller: library/x509_crt.c
2595 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002596 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002598 *
2599 * Uncomment to enable generic public key parse functions.
2600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002602
2603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002605 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002606 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002607 *
2608 * Module: library/pkwrite.c
2609 * Caller: library/x509write.c
2610 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002612 *
2613 * Uncomment to enable generic public key write functions.
2614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002616
2617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002619 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002620 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002621 *
2622 * Module: library/pkcs5.c
2623 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002624 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002625 *
2626 * This module adds support for the PKCS#5 functions.
2627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002629
2630/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002632 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002633 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002634 * Adds algorithms for parsing PKCS#8 encrypted private keys
2635 *
2636 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002637 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002638 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002640 *
2641 * This module enables PKCS#12 functions.
2642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002644
2645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002647 *
2648 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002649 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002650 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2652 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002653 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002654 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002655 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2656 * as other module rely on it for a fixed snprintf implementation.
2657 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002658 * Module: library/platform.c
2659 * Caller: Most other .c files
2660 *
2661 * This module enables abstraction of common (libc) functions.
2662 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002663#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002664
2665/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002666 * \def MBEDTLS_POLY1305_C
2667 *
2668 * Enable the Poly1305 MAC algorithm.
2669 *
2670 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002671 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002672 */
2673#define MBEDTLS_POLY1305_C
2674
2675/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002676 * \def MBEDTLS_PSA_CRYPTO_C
2677 *
2678 * Enable the Platform Security Architecture cryptography API.
2679 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002680 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002681 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002682 * Requires: MBEDTLS_CIPHER_C,
2683 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002684 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002685 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002686 *
2687 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002688#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002689
2690/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002691 * \def MBEDTLS_PSA_CRYPTO_SE_C
2692 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002693 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002694 * cryptography API.
2695 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002696 * \deprecated This feature is deprecated. Please switch to the driver
2697 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002698 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002699 * Module: library/psa_crypto_se.c
2700 *
2701 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2702 *
2703 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002704//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002705
2706/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002707 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2708 *
2709 * Enable the Platform Security Architecture persistent key storage.
2710 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002711 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002712 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002713 * Requires: MBEDTLS_PSA_CRYPTO_C,
2714 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2715 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002716 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002717#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002718
2719/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002720 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002721 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002722 * Enable the emulation of the Platform Security Architecture
2723 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002724 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002725 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002726 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002727 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002728 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002729#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002730
2731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002733 *
2734 * Enable the RIPEMD-160 hash algorithm.
2735 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002736 * Module: library/ripemd160.c
2737 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002738 *
2739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002741
2742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002744 *
2745 * Enable the RSA public-key cryptosystem.
2746 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002747 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002748 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002749 * Caller: library/pk.c
2750 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002751 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002752 * library/ssl*_client.c
2753 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002754 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002755 * This module is used by the following key exchanges:
2756 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002757 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002760#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002761
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002762/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002764 *
2765 * Enable the SHA1 cryptographic hash algorithm.
2766 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002767 * Module: library/sha1.c
2768 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002769 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002770 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002771 * This module is required for TLS 1.2 depending on the handshake parameters,
2772 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002773 *
2774 * \warning SHA-1 is considered a weak message digest and its use constitutes
2775 * a security risk. If possible, we recommend avoiding dependencies
2776 * on it, and considering stronger message digests instead.
2777 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002780
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002781/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002782 * \def MBEDTLS_SHA224_C
2783 *
2784 * Enable the SHA-224 cryptographic hash algorithm.
2785 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002786 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02002787 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002788 *
2789 * Module: library/sha256.c
2790 * Caller: library/md.c
2791 * library/ssl_cookie.c
2792 *
2793 * This module adds support for SHA-224.
2794 */
2795#define MBEDTLS_SHA224_C
2796
2797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002799 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002800 * Enable the SHA-256 cryptographic hash algorithm.
2801 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002802 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002803 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002804 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002805 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002806 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002807 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002808 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002809 * library/ssl*_client.c
2810 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002811 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002812 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002813 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002816
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002817/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002818 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2819 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002820 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2821 * with the ARMv8 cryptographic extensions if they are available at runtime.
2822 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002823 *
2824 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
2825 * for a non-Aarch64 build it will be silently ignored.
2826 *
2827 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
2828 * of \c -march=armv8-a+crypto.
2829 *
2830 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
2831 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
2832 *
2833 * Requires: MBEDTLS_SHA256_C.
2834 *
2835 * Module: library/sha256.c
2836 *
2837 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
2838 * and use them if available.
2839 */
2840//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2841
2842/**
2843 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
2844 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002845 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2846 * with the ARMv8 cryptographic extensions, which must be available at runtime
2847 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002848 *
2849 * \note This allows builds with a smaller code size than with
2850 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2851 *
2852 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
2853 * of \c -march=armv8-a+crypto.
2854 *
2855 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
2856 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
2857 *
2858 * Requires: MBEDTLS_SHA256_C.
2859 *
2860 * Module: library/sha256.c
2861 *
2862 * Uncomment to have the library use the A64 SHA-256 crypto extensions
2863 * unconditionally.
2864 */
2865//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
2866
2867/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002868 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002869 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002870 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002871 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002872 * Requires: MBEDTLS_SHA512_C
2873 *
2874 * Module: library/sha512.c
2875 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002876 * library/psa_crypto_hash.c
2877 * library/ssl_tls.c
2878 * library/ssl*_client.c
2879 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002880 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002881 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002882 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002883#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002884
2885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002887 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02002888 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002889 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002890 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002891 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002892 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002893 * library/ssl_tls.c
2894 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002895 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02002896 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00002897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002899
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002900/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002901 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2902 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002903 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
2904 * with the ARMv8 cryptographic extensions if they are available at runtime.
2905 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002906 *
2907 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
2908 * for a non-Aarch64 build it will be silently ignored.
2909 *
2910 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
2911 * Clang >= 7, and \c CFLAGS must be set to a minimum of
2912 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
2913 * fastest code.
2914 *
2915 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
2916 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
2917 *
2918 * Requires: MBEDTLS_SHA512_C.
2919 *
2920 * Module: library/sha512.c
2921 *
2922 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
2923 * and use them if available.
2924 */
2925//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2926
2927/**
2928 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
2929 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002930 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
2931 * with the ARMv8 cryptographic extensions, which must be available at runtime
2932 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002933 *
2934 * \note This allows builds with a smaller code size than with
2935 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2936 *
2937 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
2938 * Clang >= 7, and \c CFLAGS must be set to a minimum of
2939 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
2940 * fastest code.
2941 *
2942 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
2943 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
2944 *
2945 * Requires: MBEDTLS_SHA512_C.
2946 *
2947 * Module: library/sha512.c
2948 *
2949 * Uncomment to have the library use the A64 SHA-512 crypto extensions
2950 * unconditionally.
2951 */
2952//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
2953
2954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00002956 *
2957 * Enable simple SSL cache implementation.
2958 *
2959 * Module: library/ssl_cache.c
2960 * Caller:
2961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00002963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00002965
2966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02002968 *
2969 * Enable basic implementation of DTLS cookies for hello verification.
2970 *
2971 * Module: library/ssl_cookie.c
2972 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02002973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02002975
2976/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02002977 * \def MBEDTLS_SSL_TICKET_C
2978 *
2979 * Enable an implementation of TLS server-side callbacks for session tickets.
2980 *
2981 * Module: library/ssl_ticket.c
2982 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02002983 *
Przemek Stekiela09f8352022-05-12 09:34:28 +02002984 * Requires: MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02002985 */
2986#define MBEDTLS_SSL_TICKET_C
2987
2988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002990 *
2991 * Enable the SSL/TLS client code.
2992 *
Ronald Cronde1adee2022-03-07 16:20:30 +01002993 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002994 * Caller:
2995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002997 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002998 * This module is required for SSL/TLS client support.
2999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003001
Paul Bakker9a736322012-11-14 12:39:52 +00003002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003004 *
3005 * Enable the SSL/TLS server code.
3006 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003007 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003008 * Caller:
3009 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003011 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003012 * This module is required for SSL/TLS server support.
3013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003015
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003016/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003018 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003019 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003020 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003021 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003022 * Caller: library/ssl*_client.c
3023 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003024 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3026 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003027 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003028 * This module is required for SSL/TLS.
3029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003031
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003034 *
3035 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003036 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003037 * contexts are not shared between threads. If you do intend to use contexts
3038 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003039 * conditions. See also our Knowledge Base article about threading:
3040 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003041 *
3042 * Module: library/threading.c
3043 *
3044 * This allows different threading implementations (self-implemented or
3045 * provided).
3046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 * You will have to enable either MBEDTLS_THREADING_ALT or
3048 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003049 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003050 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003053
3054/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003056 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003057 * Enable the semi-portable timing interface.
3058 *
Simon Butcherd567a232016-03-09 20:19:21 +00003059 * \note The provided implementation only works on POSIX/Unix (including Linux,
3060 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003061 * module and provide your own implementations of the callbacks needed by
3062 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3063 * your own implementation of the whole module by setting
3064 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003065 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003066 * \note The timing module will include time.h on suitable platforms
3067 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3068 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3069 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003070 * \note See also our Knowledge Base article about porting to a new
3071 * environment:
3072 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3073 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003074 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003077
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003078/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003080 *
3081 * Enable run-time version information.
3082 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003083 * Module: library/version.c
3084 *
3085 * This module provides run-time version information.
3086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003088
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003091 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003092 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003093 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003094 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003095 * Caller: library/x509_crl.c
3096 * library/x509_crt.c
3097 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003098 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3100 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003101 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003102 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003105
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003108 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003109 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003110 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003111 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003112 * Caller: library/ssl_tls.c
3113 * library/ssl*_client.c
3114 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003115 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003117 *
3118 * This module is required for X.509 certificate parsing.
3119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003121
3122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003124 *
3125 * Enable X.509 CRL parsing.
3126 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003127 * Module: library/x509_crl.c
3128 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003129 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003131 *
3132 * This module is required for X.509 CRL parsing.
3133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003135
3136/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003138 *
3139 * Enable X.509 Certificate Signing Request (CSR) parsing.
3140 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003141 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003142 * Caller: library/x509_crt_write.c
3143 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003145 *
3146 * This module is used for reading X.509 certificate request.
3147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003149
3150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003152 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003153 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003154 *
3155 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003156 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003158 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003159 * This module is the basis for creating X.509 certificates and CSRs.
3160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003162
3163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003165 *
3166 * Enable creating X.509 certificates.
3167 *
3168 * Module: library/x509_crt_write.c
3169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003171 *
3172 * This module is required for X.509 certificate creation.
3173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003175
3176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003178 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003179 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003180 *
3181 * Module: library/x509_csr_write.c
3182 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003184 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003185 * This module is required for X.509 certificate request writing.
3186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003188
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003189/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003190
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003191/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003192 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003193 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003194 * This section contains Mbed TLS build settings that are not associated
3195 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003196 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003197 * \{
3198 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003199
Gilles Peskinea02c1242022-03-16 17:03:19 +01003200/**
3201 * \def MBEDTLS_CONFIG_FILE
3202 *
3203 * If defined, this is a header which will be included instead of
3204 * `"mbedtls/mbedtls_config.h"`.
3205 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003206 * Unlike other configuration options, this one must be defined on the
3207 * compiler command line: a definition in `mbedtls_config.h` would have
3208 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003209 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003210 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003211 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003212 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003213 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003214 * The value of this symbol is typically a path in double quotes, either
3215 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003216 */
3217//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3218
3219/**
3220 * \def MBEDTLS_USER_CONFIG_FILE
3221 *
3222 * If defined, this is a header which will be included after
3223 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003224 * This allows you to modify the default configuration, including the ability
3225 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003226 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003227 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003228 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003229 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003230 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003231 * The value of this symbol is typically a path in double quotes, either
3232 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003233 */
3234//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3235
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003236/**
3237 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3238 *
3239 * If defined, this is a header which will be included instead of
3240 * `"psa/crypto_config.h"`.
3241 * This header file specifies which cryptographic mechanisms are available
3242 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3243 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3244 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003245 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003246 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003247 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003248 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003249 * The value of this symbol is typically a path in double quotes, either
3250 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003251 */
3252//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3253
3254/**
3255 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3256 *
3257 * If defined, this is a header which will be included after
3258 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003259 * This allows you to modify the default configuration, including the ability
3260 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003261 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003262 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003263 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003264 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003265 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003266 * The value of this symbol is typically a path in double quotes, either
3267 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003268 */
3269//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3270
Gilles Peskineba4162a2022-04-11 17:04:38 +02003271/** \} name SECTION: General configuration options */
3272
3273/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003274 * \name SECTION: Module configuration options
3275 *
3276 * This section allows for the setting of module specific sizes and
3277 * configuration options. The default values are already present in the
3278 * relevant header files and should suffice for the regular use cases.
3279 *
3280 * Our advice is to enable options and change their values here
3281 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003282 * \{
3283 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003284/* The Doxygen documentation here is used when a user comments out a
3285 * setting and runs doxygen themselves. On the other hand, when we typeset
3286 * the full documentation including disabled settings, the documentation
3287 * in specific modules' header files is used if present. When editing this
3288 * file, make sure that each option is documented in exactly one place,
3289 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3290 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003291
Paul Bakker088c5c52014-04-25 11:11:10 +02003292/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003293//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003295
Paul Bakker088c5c52014-04-25 11:11:10 +02003296/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3298//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3299//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3300//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3301//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003302
Paul Bakker088c5c52014-04-25 11:11:10 +02003303/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3305//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3306//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3307//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003308
Paul Bakker088c5c52014-04-25 11:11:10 +02003309/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003310//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003312
Paul Bakker088c5c52014-04-25 11:11:10 +02003313/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3315//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003316//#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 +01003317
Paul Bakker088c5c52014-04-25 11:11:10 +02003318/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003320
Paul Bakker088c5c52014-04-25 11:11:10 +02003321/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322//#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 +02003323//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3325//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003326//#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 +02003327//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3328//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003329/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003331//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3332//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003333//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3334//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3335//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3338/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003339//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3341//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003342//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3343//#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 +02003344//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3345//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003346/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003348//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003349//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3350//#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 +02003351
Gilles Peskine3f106f72021-09-23 17:42:39 +02003352/** \def MBEDTLS_CHECK_RETURN
3353 *
3354 * This macro is used at the beginning of the declaration of a function
3355 * to indicate that its return value should be checked. It should
3356 * instruct the compiler to emit a warning or an error if the function
3357 * is called without checking its return value.
3358 *
3359 * There is a default implementation for popular compilers in platform_util.h.
3360 * You can override the default implementation by defining your own here.
3361 *
3362 * If the implementation here is empty, this will effectively disable the
3363 * checking of functions' return values.
3364 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003365//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003366
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003367/** \def MBEDTLS_IGNORE_RETURN
3368 *
3369 * This macro requires one argument, which should be a C function call.
3370 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3371 * warning is suppressed.
3372 */
3373//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3374
Gilles Peskineed038902020-11-13 21:33:21 +01003375/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003376/**
Gilles Peskineed038902020-11-13 21:33:21 +01003377 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3378 * PSA crypto subsystem.
3379 *
3380 * If this option is unset:
3381 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003382 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003383 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3384 * on unspecified heuristics.
3385 */
3386//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3387
Steven Cooreman863470a2021-02-15 14:03:19 +01003388/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003389 * Restrict the PSA library to supporting a maximum amount of simultaneously
3390 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3391 * volatile key, or a persistent key which is loaded temporarily by the
3392 * library as part of a crypto operation in flight.
3393 *
3394 * If this option is unset, the library will fall back to a default value of
3395 * 32 keys.
3396 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003397//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003398
Paul Bakker088c5c52014-04-25 11:11:10 +02003399/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3401//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003402
Paul Bakker088c5c52014-04-25 11:11:10 +02003403/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003404
Angus Grattond8213d02016-05-25 20:56:48 +10003405/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3406 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003407 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003408 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003409 * This determines the size of the incoming TLS I/O buffer in such a way
3410 * that it is capable of holding the specified amount of plaintext data,
3411 * regardless of the protection mechanism used.
3412 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003413 * \note When using a value less than the default of 16KB on the client, it is
3414 * recommended to use the Maximum Fragment Length (MFL) extension to
3415 * inform the server about this limitation. On the server, there
3416 * is no supported, standardized way of informing the client about
3417 * restriction on the maximum size of incoming messages, and unless
3418 * the limitation has been communicated by other means, it is recommended
3419 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3420 * while keeping the default value of 16KB for the incoming buffer.
3421 *
David Horstmann95d516f2021-05-04 18:36:56 +01003422 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003423 */
3424//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3425
Gilles Peskined3d02902020-03-04 21:35:27 +01003426/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3427 *
3428 * The maximum length of CIDs used for incoming DTLS messages.
3429 *
3430 */
3431//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3432
3433/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3434 *
3435 * The maximum length of CIDs used for outgoing DTLS messages.
3436 *
3437 */
3438//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3439
TRodziewicze8dd7092021-05-12 14:19:11 +02003440/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003441 *
3442 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003443 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003444 *
3445 * The padding will always be chosen so that the length of the
3446 * padded plaintext is a multiple of the value of this option.
3447 *
3448 * Note: A value of \c 1 means that no padding will be used
3449 * for outgoing records.
3450 *
3451 * Note: On systems lacking division instructions,
3452 * a power of two should be preferred.
3453 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003454//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003455
Angus Grattond8213d02016-05-25 20:56:48 +10003456/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3457 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003458 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003459 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003460 * This determines the size of the outgoing TLS I/O buffer in such a way
3461 * that it is capable of holding the specified amount of plaintext data,
3462 * regardless of the protection mechanism used.
3463 *
Angus Grattond8213d02016-05-25 20:56:48 +10003464 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3465 * the default inward 16384 byte buffer to conform to the TLS specification.
3466 *
3467 * The minimum required outward buffer size is determined by the handshake
3468 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3469 * The specific size requirement depends on the configured ciphers and any
3470 * certificate data which is sent during the handshake.
3471 *
David Horstmann95d516f2021-05-04 18:36:56 +01003472 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003473 */
3474//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3475
Hanno Beckere0b150f2018-08-21 15:51:03 +01003476/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3477 *
3478 * Maximum number of heap-allocated bytes for the purpose of
3479 * DTLS handshake message reassembly and future message buffering.
3480 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003481 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003482 * to account for a reassembled handshake message of maximum size,
3483 * together with its reassembly bitmap.
3484 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003485 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003486 * should be sufficient for all practical situations as it allows
3487 * to reassembly a large handshake message (such as a certificate)
3488 * while buffering multiple smaller handshake messages.
3489 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003490 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003491//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3494//#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 +02003495
Gilles Peskine7dd2f502021-04-24 13:35:41 +02003496/** \def MBEDTLS_TLS_EXT_CID
3497 *
3498 * At the time of writing, the CID extension has not been assigned its
3499 * final value. Set this configuration option to make Mbed TLS use a
3500 * different value.
3501 *
3502 * A future minor revision of Mbed TLS may change the default value of
3503 * this option to match evolving standards and usage.
3504 */
3505//#define MBEDTLS_TLS_EXT_CID 254
3506
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003507/**
3508 * Complete list of ciphersuites to use, in order of preference.
3509 *
3510 * \warning No dependency checking is done on that field! This option can only
3511 * be used to restrict the set of available ciphersuites. It is your
3512 * responsibility to make sure the needed modules are active.
3513 *
3514 * Use this to save a few hundred bytes of ROM (default ordering of all
3515 * available ciphersuites) and a few to a few hundred bytes of RAM.
3516 *
3517 * The value below is only an example, not the default.
3518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519//#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 +02003520
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003521/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003523//#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 +01003524
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003525/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003526 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003527 * mbedtls_platform_zeroize(). This replaces the default implementation in
3528 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003529 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003530 * mbedtls_platform_zeroize() is a widely used function across the library to
3531 * zero a block of memory. The implementation is expected to be secure in the
3532 * sense that it has been written to prevent the compiler from removing calls
3533 * to mbedtls_platform_zeroize() as part of redundant code elimination
3534 * optimizations. However, it is difficult to guarantee that calls to
3535 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3536 * versions of the C language standards do not provide a secure implementation
3537 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3538 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003539 * example by using directives specific to their compiler, features from newer
3540 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003541 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003542 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003543//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003544
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003545/**
3546 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003547 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003548 * platform_util.c.
3549 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003550 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003551 * library will try to use safer implementations of this function, such as
3552 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003553 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003554 * using the standard gmtime(). In this case, calls from the library to
3555 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003556 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003557 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003558 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3559 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3560 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003561 */
Hanno Becker6a739782018-09-05 15:06:19 +01003562//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003563
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003564/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003565 * Enable the verified implementations of ECDH primitives from Project Everest
3566 * (currently only Curve25519). This feature changes the layout of ECDH
3567 * contexts and therefore is a compatibility break for applications that access
3568 * fields of a mbedtls_ecdh_context structure directly. See also
3569 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003570 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003571//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003572
Gilles Peskine611179c2022-04-13 23:04:48 +02003573/** \} name SECTION: Module configuration options */