blob: bff1e496cc7ba54378f7ba4cb49accc06df7a5f0 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file config.h
3 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Thomas Fossati656864b2016-07-17 08:51:22 +010011 * Copyright (C) 2006-2018, ARM Limited, All Rights Reserved
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.
Paul Bakkerb96f1542010-07-18 20:36:00 +000025 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000026 * This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020027 */
28
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#ifndef MBEDTLS_CONFIG_H
30#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000031
Paul Bakkercce9d772011-11-18 14:26:47 +000032#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000033#define _CRT_SECURE_NO_DEPRECATE 1
34#endif
35
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
Paul Bakker68041ec2009-04-19 21:17:55 +000052 * library/timing.c
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000053 * include/mbedtls/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000054 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010055 * Required by:
56 * MBEDTLS_AESNI_C
57 * MBEDTLS_PADLOCK_C
58 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020059 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000062
Paul Bakkerf3b86c12011-01-27 15:24:17 +000063/**
Gilles Peskineed942f82017-06-08 15:19:20 +020064 * \def MBEDTLS_NO_UDBL_DIVISION
65 *
66 * The platform lacks support for double-width integer division (64-bit
67 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
68 *
69 * Used in:
70 * include/mbedtls/bignum.h
71 * library/bignum.c
72 *
73 * The bignum code uses double-width division to speed up some operations.
74 * Double-width division is often implemented in software that needs to
75 * be linked with the program. The presence of a double-width integer
76 * type is usually detected automatically through preprocessor macros,
77 * but the automatic detection cannot know whether the code needs to
78 * and can be linked with an implementation of division for that type.
79 * By default division is assumed to be usable if the type is present.
80 * Uncomment this option to prevent the use of double-width division.
81 *
82 * Note that division for the native integer type is always required.
83 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010084 * platform, but it need not support multiplication or division. In some
85 * cases it is also desirable to disable some double-width operations. For
86 * example, if double-width division is implemented in software, disabling
87 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020088 */
89//#define MBEDTLS_NO_UDBL_DIVISION
90
91/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020092 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
93 *
94 * The platform lacks support for 32x32 -> 64-bit multiplication.
95 *
96 * Used in:
97 * library/poly1305.c
98 *
99 * Some parts of the library may use multiplication of two unsigned 32-bit
100 * operands with a 64-bit result in order to speed up computations. On some
101 * platforms, this is not available in hardware and has to be implemented in
102 * software, usually in a library provided by the toolchain.
103 *
104 * Sometimes it is not desirable to have to link to that library. This option
105 * removes the dependency of that library on platforms that lack a hardware
106 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
107 *
108 * Note that depending on the compiler, this may decrease performance compared
109 * to using the library function provided by the toolchain.
110 */
111//#define MBEDTLS_NO_64BIT_MULTIPLICATION
112
113/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000115 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000116 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000117 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200121
122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200124 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200125 * System has time.h and time().
126 * The time does not need to be correct, only time differences are used,
127 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100129 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
130 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
131 * MBEDTLS_PLATFORM_STD_TIME.
132 *
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200133 * Comment if your system does not support time functions
134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100136
137/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200138 * \def MBEDTLS_HAVE_TIME_DATE
139 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100140 * System has time.h, time(), and an implementation for
141 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100142 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200143 * the date should be correct). This is used to verify the validity period of
144 * X.509 certificates.
145 *
146 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100147 *
Hanno Becker6a739782018-09-05 15:06:19 +0100148 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100149 * behaves similarly to the gmtime_r() function from the C standard. Refer to
150 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100151 *
152 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100153 * mbedtls_platform_gmtime_r() at compile-time by using the macro
154 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200155 */
156#define MBEDTLS_HAVE_TIME_DATE
157
158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100160 *
161 * Enable the memory allocation layer.
162 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200163 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100164 * This allows different allocators (self-implemented or provided) to be
165 * provided to the platform abstraction layer.
166 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200168 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
169 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000170 * free() function pointer at runtime.
171 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200173 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000174 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100177 *
178 * Enable this layer to allow use of alternative memory allocators.
179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100181
182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200184 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200185 * Do not assign standard functions in the platform layer (e.g. calloc() to
186 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200187 *
188 * This makes sure there are no linking errors on platforms that do not support
189 * these functions. You will HAVE to provide alternatives, either at runtime
190 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
192 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200193 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200195 *
196 * Uncomment to prevent default assignment of standard functions in the
197 * platform layer.
198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200200
201/**
Janos Follathc351d182016-03-21 08:43:59 +0000202 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100203 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100204 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
205 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100206 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
208 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100209 * alternative printf function pointer.
210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100212 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200213 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
214 * it will be enabled automatically by check_config.h
215 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200216 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000218 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100219 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
220 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100221 * Uncomment a macro to enable alternate implementation of specific base
222 * platform function
223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100225//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226//#define MBEDTLS_PLATFORM_FPRINTF_ALT
227//#define MBEDTLS_PLATFORM_PRINTF_ALT
228//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200229//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100230//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100231//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100232
233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100235 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000236 * Mark deprecated functions and features so that they generate a warning if
237 * used. Functionality deprecated in one version will usually be removed in the
238 * next version. You can enable this to help you prepare the transition to a
239 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100240 *
241 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000244 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100247
248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000251 * Remove deprecated functions and features so that they generate an error if
252 * used. Functionality deprecated in one version will usually be removed in the
253 * next version. You can enable this to help you prepare the transition to a
254 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000256 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100259
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500260/**
261 * \def MBEDTLS_CHECK_PARAMS
262 *
263 * This configuration option controls whether the library validates more of
264 * the parameters passed to it.
265 *
266 * When this flag is not defined, the library only attempts to validate an
267 * input parameter if: (1) they may come from the outside world (such as the
268 * network, the filesystem, etc.) or (2) not validating them could result in
269 * internal memory errors such as overflowing a buffer controlled by the
270 * library. On the other hand, it doesn't attempt to validate parameters whose
271 * values are fully controlled by the application (such as pointers).
272 *
273 * When this flag is defined, the library additionally attempts to validate
274 * parameters that are fully controlled by the application, and should always
275 * be valid if the application code is fully correct and trusted.
276 *
277 * For example, when a function accepts as input a pointer to a buffer that may
278 * contain untrusted data, and its documentation mentions that this pointer
279 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200280 * - The pointer is checked to be non-NULL only if this option is enabled.
281 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500282 *
283 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200284 * is invalid:
285 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
286 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
287 * will immediately return. If the function returns an Mbed TLS error code,
288 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500289 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200290 * When defining this flag, you also need to arrange a definition for
291 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
292 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
293 * function mbedtls_param_failed(), but the library does not define this
294 * function. If you do not make any other arrangements, you must provide
295 * the function mbedtls_param_failed() in your application.
296 * See `platform_util.h` for its prototype.
297 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amerodbe4ff82019-07-04 21:15:37 +0100298 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200299 * You can still supply an alternative definition of
300 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
301 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
302 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
303 * the library will call the macro that you defined and will not supply
304 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
305 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
306 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500307 *
308 * Uncomment to enable validation of application-controlled parameters.
309 */
310//#define MBEDTLS_CHECK_PARAMS
311
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200312/**
313 * \def MBEDTLS_CHECK_PARAMS_ASSERT
314 *
315 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
316 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
317 *
318 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
319 * calling a function mbedtls_param_failed(). See the documentation of
320 * #MBEDTLS_CHECK_PARAMS for details.
321 *
322 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
323 */
324//#define MBEDTLS_CHECK_PARAMS_ASSERT
325
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200326/* \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000327
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000328/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000329 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000330 *
331 * This section sets support for features that are or are not needed
332 * within the modules that are enabled.
333 * \{
334 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000335
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100338 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200340 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100341 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200342 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100343 *
344 * You will need to provide a header "timing_alt.h" and an implementation at
345 * compile time.
346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200347//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100348
349/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100350 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200351 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100352 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100353 * alternate core implementation of a symmetric crypto, an arithmetic or hash
354 * module (e.g. platform specific assembly optimized implementations). Keep
355 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200356 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200359 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000361 * provide the "struct mbedtls_aes_context" definition and omit the base
362 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200363 * "aes.h" to include the new function definitions.
364 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200365 * Uncomment a macro to enable alternate implementation of the corresponding
366 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100367 *
368 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
369 * use constitutes a security risk. If possible, we recommend
370 * avoiding dependencies on them, and considering stronger message
371 * digests and ciphers instead.
372 *
Paul Bakker90995b52013-06-24 19:20:35 +0200373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374//#define MBEDTLS_AES_ALT
375//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000376//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377//#define MBEDTLS_BLOWFISH_ALT
378//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200379//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300380//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200381//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200382//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000384//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000385//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100386//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300387//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388//#define MBEDTLS_MD2_ALT
389//#define MBEDTLS_MD4_ALT
390//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300391//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000393//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_SHA1_ALT
395//#define MBEDTLS_SHA256_ALT
396//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000397//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000398
Janos Follathb0697532016-08-18 12:38:46 +0100399/*
400 * When replacing the elliptic curve module, pleace consider, that it is
401 * implemented with two .c files:
402 * - ecp.c
403 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000404 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
405 * macros as described above. The only difference is that you have to make sure
406 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100407 */
408//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200409
410/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100411 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200412 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100413 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
414 * alternate core implementation of symmetric crypto or hash function. Keep in
415 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200416 *
417 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200419 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
421 * no longer provide the mbedtls_sha1_process() function, but it will still provide
422 * the other function (using your mbedtls_sha1_process() function) and the definition
423 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200424 * with this definition.
425 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100426 * \note Because of a signature change, the core AES encryption and decryption routines are
427 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
428 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100429 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100430 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100431 *
432 * \note If you use the AES_xxx_ALT macros, then is is recommended to also set
433 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
434 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200435 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200436 * Uncomment a macro to enable alternate implementation of the corresponding
437 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100438 *
439 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
440 * constitutes a security risk. If possible, we recommend avoiding
441 * dependencies on them, and considering stronger message digests
442 * and ciphers instead.
443 *
Janos Follath1231d212019-01-07 15:01:32 +0000444 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
445 * enabled, then the deterministic ECDH signature functions pass the
446 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
447 * alternative implementations should use the RNG only for generating
448 * the ephemeral key and nothing else. If this is not possible, then
449 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
450 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
451 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
452 * desirable).
453 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200455//#define MBEDTLS_MD2_PROCESS_ALT
456//#define MBEDTLS_MD4_PROCESS_ALT
457//#define MBEDTLS_MD5_PROCESS_ALT
458//#define MBEDTLS_RIPEMD160_PROCESS_ALT
459//#define MBEDTLS_SHA1_PROCESS_ALT
460//#define MBEDTLS_SHA256_PROCESS_ALT
461//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200462//#define MBEDTLS_DES_SETKEY_ALT
463//#define MBEDTLS_DES_CRYPT_ECB_ALT
464//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200465//#define MBEDTLS_AES_SETKEY_ENC_ALT
466//#define MBEDTLS_AES_SETKEY_DEC_ALT
467//#define MBEDTLS_AES_ENCRYPT_ALT
468//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300469//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300470//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300471//#define MBEDTLS_ECDSA_VERIFY_ALT
472//#define MBEDTLS_ECDSA_SIGN_ALT
473//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200474
475/**
Janos Follathc44ab972016-11-18 16:38:23 +0000476 * \def MBEDTLS_ECP_INTERNAL_ALT
477 *
478 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100479 *
480 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100481 * alternative core implementation of elliptic curve arithmetic. Keep in mind
482 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100483 *
484 * This partially replaces one function. The header file from mbed TLS is still
485 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
486 * is still present and it is used for group structures not supported by the
487 * alternative.
488 *
Janos Follathc44ab972016-11-18 16:38:23 +0000489 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
490 * and implementing the following functions:
491 * unsigned char mbedtls_internal_ecp_grp_capable(
492 * const mbedtls_ecp_group *grp )
493 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500494 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000495 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
496 * replacement functions implement arithmetic for the given group and 0
497 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500498 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000499 * called before and after each point operation and provide an opportunity to
500 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100501 *
Janos Follathc44ab972016-11-18 16:38:23 +0000502 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
Janos Follath4d9c69d2016-11-01 13:27:03 +0000503 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
Janos Follathc44ab972016-11-18 16:38:23 +0000504 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
505 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
506 * receives it as an argument). If the group is not supported then the original
Janos Follathee782bc2016-11-07 15:41:26 +0000507 * implementation is used. The other functions and the definition of
508 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
Janos Follathc44ab972016-11-18 16:38:23 +0000509 * implementation of mbedtls_internal_ecp_double_jac and
510 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
Janos Follathb0697532016-08-18 12:38:46 +0100511 *
512 * Uncomment a macro to enable alternate implementation of the corresponding
513 * function.
514 */
515/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000516//#define MBEDTLS_ECP_INTERNAL_ALT
Janos Follathb0697532016-08-18 12:38:46 +0100517/* Support for Weierstrass curves with Jacobi representation */
518//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
519//#define MBEDTLS_ECP_ADD_MIXED_ALT
520//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
521//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
522//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
523/* Support for curves with Montgomery arithmetic */
524//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
525//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
526//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
527
528/**
Simon Butcherab5df402016-06-11 02:31:21 +0100529 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100530 *
Simon Butcherab5df402016-06-11 02:31:21 +0100531 * Enables testing and use of mbed TLS without any configured entropy sources.
532 * This permits use of the library on platforms before an entropy source has
533 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
534 * MBEDTLS_ENTROPY_NV_SEED switches).
535 *
536 * WARNING! This switch MUST be disabled in production builds, and is suitable
537 * only for development.
538 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100539 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100540 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
541 *
Janos Follath53de7842016-06-08 15:29:18 +0100542 */
Simon Butcherab5df402016-06-11 02:31:21 +0100543//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100544
545/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200546 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200547 *
548 * Uncomment this macro to let mbed TLS use your own implementation of a
549 * hardware entropy collector.
550 *
551 * Your function must be called \c mbedtls_hardware_poll(), have the same
552 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
553 *
554 * Uncomment to use your own hardware entropy collector.
555 */
556//#define MBEDTLS_ENTROPY_HARDWARE_ALT
557
558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000560 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100561 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000562 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100563 * Uncomment this macro to use precomputed AES tables stored in ROM.
564 * Comment this macro to generate AES tables in RAM at runtime.
565 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100566 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
567 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100568 * initialization time before the first AES operation can be performed.
569 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
570 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
571 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100572 *
573 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
574 *
Paul Bakker15566e42011-04-24 21:19:15 +0000575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000577
578/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100579 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100581 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200582 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100583 * Uncommenting this macro omits 75% of the AES tables from
584 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
585 * by computing their values on the fly during operations
586 * (the tables are entry-wise rotations of one another).
587 *
588 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100589 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100590 * runtime. Specifically, one has to compare 4 accesses within
591 * different tables to 4 accesses with additional arithmetic
592 * operations within the same table. The performance gain/loss
593 * depends on the system and memory details.
594 *
595 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
596 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200597 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100598//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200599
600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200602 *
603 * Use less ROM for the Camellia implementation (saves about 768 bytes).
604 *
605 * Uncomment this macro to use less memory for Camellia.
606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200608
609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200611 *
612 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200615
616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000618 *
619 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000622
623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000625 *
626 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000629
630/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100631 * \def MBEDTLS_CIPHER_MODE_OFB
632 *
633 * Enable Output Feedback mode (OFB) for symmetric ciphers.
634 */
635#define MBEDTLS_CIPHER_MODE_OFB
636
637/**
638 * \def MBEDTLS_CIPHER_MODE_XTS
639 *
640 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
641 */
642#define MBEDTLS_CIPHER_MODE_XTS
643
644/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000646 *
647 * Enable NULL cipher.
648 * Warning: Only do so when you know what you are doing. This allows for
649 * encryption or channels without any security!
650 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000652 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
654 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
655 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
656 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
657 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
658 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
659 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
660 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
661 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
662 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
663 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
664 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
665 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
666 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
667 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
668 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
669 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
670 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
671 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000672 *
673 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000676
677/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100678 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200679 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100680 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
681 * specific padding modes in the cipher layer with cipher modes that support
682 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200683 *
684 * If you disable all padding modes, only full blocks can be used with CBC.
685 *
686 * Enable padding modes in the cipher layer.
687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688#define MBEDTLS_CIPHER_PADDING_PKCS7
689#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
690#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
691#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200692
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200693/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
694 *
695 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
696 * By default, CTR_DRBG uses a 256-bit key.
697 */
698//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
699
Paul Bakker48e93c82013-08-14 12:21:18 +0200700/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000702 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200703 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000704 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000705 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000706 *
707 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
709 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000710 *
711 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100712 *
713 * \warning DES is considered a weak cipher and its use constitutes a
714 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000717
718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200719 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200720 *
721 * Remove RC4 ciphersuites by default in SSL / TLS.
722 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200723 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200724 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200725 * explicitly.
726 *
727 * Uncomment this macro to remove RC4 ciphersuites by default.
728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200729#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200730
731/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000732 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
733 *
734 * Remove 3DES ciphersuites by default in SSL / TLS.
735 * This flag removes the ciphersuites based on 3DES from the default list as
736 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
737 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
738 * them explicitly.
739 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000740 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000741 * a TLS connection using a 3DES based cipher suite (see "On the Practical
742 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
743 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
744 * in your threat model or you are unsure, then you should keep this option
745 * enabled to remove 3DES based cipher suites.
746 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000747 * Comment this macro to keep 3DES in the default ciphersuite list.
748 */
749#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
750
751/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100752 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200753 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100754 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
755 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200756 *
757 * Comment macros to disable the curve and functions for it
758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
761#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
762#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
763#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
764#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
765#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
766#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
767#define MBEDTLS_ECP_DP_BP256R1_ENABLED
768#define MBEDTLS_ECP_DP_BP384R1_ENABLED
769#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200770#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000771#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200772
773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200775 *
776 * Enable specific 'modulo p' routines for each NIST prime.
777 * Depending on the prime and architecture, makes operations 4 to 8 times
778 * faster on the corresponding curve.
779 *
780 * Comment this macro to disable NIST curves optimisation.
781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200783
784/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200785 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100786 *
787 * Enable "non-blocking" ECC operations that can return early and be resumed.
788 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200789 * This allows various functions to pause by returning
790 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
791 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
792 * order to further progress and eventually complete their operation. This is
793 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
794 * number of ECC operations a function may perform before pausing; see
795 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100796 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200797 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200798 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100799 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200800 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200801 *
Ron Eldor19779c42018-11-05 16:58:13 +0200802 * \note This option only works with the default software implementation of
803 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100804 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
805 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100806 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200807//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100808
809/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100810 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
811 *
812 * Use a backward compatible ECDH context.
813 *
814 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
815 * defined in `ecdh.h`). For most applications, the choice of format makes
816 * no difference, since all library functions can work with either format,
817 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
818
819 * The new format used when this option is disabled is smaller
820 * (56 bytes on a 32-bit platform). In future versions of the library, it
821 * will support alternative implementations of ECDH operations.
822 * The new format is incompatible with applications that access
823 * context fields directly and with restartable ECP operations.
824 *
825 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
826 * want to access ECDH context fields directly. Otherwise you should
827 * comment out this macro definition.
828 *
829 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
830 *
831 * \note This configuration option is experimental. Future versions of the
832 * library may modify the way the ECDH context layout is configured
833 * and may modify the layout of the new context type.
834 */
835#define MBEDTLS_ECDH_LEGACY_CONTEXT
836
837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100839 *
840 * Enable deterministic ECDSA (RFC 6979).
841 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
842 * may result in a compromise of the long-term signing key. This is avoided by
843 * the deterministic variant.
844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * Requires: MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100846 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100847 * Comment this macro to disable deterministic ECDSA.
848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100850
851/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200853 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200854 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200855 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 * This enables the following ciphersuites (if other requisites are
857 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
859 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
860 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
861 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
862 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
863 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
864 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
865 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
866 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
867 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
868 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
869 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200872
873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200875 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200876 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200877 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200878 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200879 *
880 * This enables the following ciphersuites (if other requisites are
881 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
883 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
884 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
885 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
886 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
887 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
888 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
889 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
890 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
891 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
892 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
893 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100894 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100895 * \warning Using DHE constitutes a security risk as it
896 * is not possible to validate custom DH parameters.
897 * If possible, it is recommended users should consider
898 * preferring other methods of key exchange.
899 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100900 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200903
904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200906 *
907 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
908 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200910 *
911 * This enables the following ciphersuites (if other requisites are
912 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
914 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
915 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
916 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
917 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
918 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
919 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
920 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200923
924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200926 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200927 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200928 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
930 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200931 *
932 * This enables the following ciphersuites (if other requisites are
933 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
935 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
936 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
937 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
938 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
939 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
940 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
942 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
943 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
944 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
945 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200948
949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200951 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200952 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
955 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200956 *
957 * This enables the following ciphersuites (if other requisites are
958 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
960 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
961 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
962 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
963 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
964 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
965 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
966 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
967 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
968 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
969 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
970 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
971 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
972 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
973 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +0200974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200976
977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200979 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200980 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200981 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
983 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200984 *
985 * This enables the following ciphersuites (if other requisites are
986 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
988 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
989 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
990 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
991 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
992 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
993 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
994 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
995 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
996 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
997 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
998 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
999 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001000 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001001 * \warning Using DHE constitutes a security risk as it
1002 * is not possible to validate custom DH parameters.
1003 * If possible, it is recommended users should consider
1004 * preferring other methods of key exchange.
1005 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001006 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001009
1010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001012 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001013 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001014 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
1016 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001017 *
1018 * This enables the following ciphersuites (if other requisites are
1019 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1021 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1022 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1023 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1024 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1025 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1026 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1027 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1028 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1029 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1030 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1031 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001034
1035/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001037 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001038 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001041 *
1042 * This enables the following ciphersuites (if other requisites are
1043 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1046 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1047 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1049 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1050 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1051 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1052 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1053 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1054 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1055 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001058
1059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001061 *
1062 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1063 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001065 *
1066 * This enables the following ciphersuites (if other requisites are
1067 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1069 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1072 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1073 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1074 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1075 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1076 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1077 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1078 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1079 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001082
1083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001085 *
1086 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1087 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001089 *
1090 * This enables the following ciphersuites (if other requisites are
1091 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1093 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1094 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1095 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1096 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1097 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1098 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1099 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1100 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1101 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1102 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1103 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001106
1107/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001108 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1109 *
1110 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1111 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001112 * \warning This is currently experimental. EC J-PAKE support is based on the
1113 * Thread v1.0.0 specification; incompatible changes to the specification
1114 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001115 *
1116 * Requires: MBEDTLS_ECJPAKE_C
1117 * MBEDTLS_SHA256_C
1118 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1119 *
1120 * This enables the following ciphersuites (if other requisites are
1121 * enabled as well):
1122 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1123 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001124//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001125
1126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001128 *
1129 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1130 * RFC 5915 and RFC 5480.
1131 *
1132 * Currently this means parsing the SpecifiedECDomain choice of EC
1133 * parameters (only known groups are supported, not arbitrary domains, to
1134 * avoid validation issues).
1135 *
1136 * Disable if you only need to support RFC 5915 + 5480 key formats.
1137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001139
1140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001142 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * Enable a dummy error function to make use of mbedtls_strerror() in
1144 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1145 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001146 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1148 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001149 *
1150 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001154
1155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001157 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001158 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001163
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001164/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001166 *
1167 * Enable functions that use the filesystem.
1168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001170
1171/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001173 *
1174 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001176 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001177 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001178 * application.
1179 *
1180 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001183
1184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001186 *
1187 * Do not use built-in platform entropy functions.
1188 * This is useful if your platform does not support
1189 * standards like the /dev/urandom or Windows CryptoAPI.
1190 *
1191 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001194
1195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001197 *
1198 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1199 * default SHA-512 based one (if both are available).
1200 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001202 *
1203 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1204 * if you have performance concerns.
1205 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 * This option is only useful if both MBEDTLS_SHA256_C and
1207 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001210
1211/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001212 * \def MBEDTLS_ENTROPY_NV_SEED
1213 *
1214 * Enable the non-volatile (NV) seed file-based entropy source.
1215 * (Also enables the NV seed read/write functions in the platform layer)
1216 *
1217 * This is crucial (if not required) on systems that do not have a
1218 * cryptographic entropy source (in hardware or kernel) available.
1219 *
1220 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1221 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001222 * \note The read/write functions that are used by the entropy source are
1223 * determined in the platform layer, and can be modified at runtime and/or
1224 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1225 *
1226 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001227 * with regular fopen(), please make sure you make a seedfile with the
1228 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1229 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001230 * and written to or you will get an entropy source error! The default
1231 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1232 * bytes from the file.
1233 *
1234 * \note The entropy collector will write to the seed file before entropy is
1235 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001236 */
1237//#define MBEDTLS_ENTROPY_NV_SEED
1238
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001239/* MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
1240 *
1241 * In PSA key storage, encode the owner of the key.
1242 *
1243 * This is only meaningful when building the library as part of a
1244 * multi-client service. When you activate this option, you must provide
1245 * an implementation of the type psa_key_owner_id_t and a translation
1246 * from psa_key_file_id_t to file name in all the storage backends that
1247 * you wish to support.
1248 *
1249 * Note that this option is meant for internal use only and may be removed
1250 * without notice.
1251 */
1252//#define MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
1253
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001256 *
1257 * Enable debugging of buffer allocator memory issues. Automatically prints
1258 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1259 * function for 'debug output' of allocated memory.
1260 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001261 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001262 *
1263 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001266
1267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001269 *
1270 * Include backtrace information with each allocated block.
1271 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001273 * GLIBC-compatible backtrace() an backtrace_symbols() support
1274 *
1275 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001278
1279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001280 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001281 *
1282 * Support external private RSA keys (eg from a HSM) in the PK layer.
1283 *
1284 * Comment this macro to disable support for external private RSA keys.
1285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001287
1288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001290 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001291 * Enable support for PKCS#1 v1.5 encoding.
1292 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001294 *
Paul Bakker48377d92013-08-30 12:06:24 +02001295 * This enables support for PKCS#1 v1.5 operations.
1296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001298
1299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001301 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001302 * Enable support for PKCS#1 v2.1 encoding.
1303 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001305 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001306 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001309
1310/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001311 * \def MBEDTLS_PSA_CRYPTO_SPM
1312 *
1313 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1314 * Partition Manager) integration which separates the code into two parts: a
1315 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1316 * Environment).
1317 *
1318 * Module: library/psa_crypto.c
1319 * Requires: MBEDTLS_PSA_CRYPTO_C
1320 *
1321 */
1322//#define MBEDTLS_PSA_CRYPTO_SPM
1323
1324/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001325 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001326 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001327 * Enable support for entropy injection at first boot. This feature is
1328 * required on systems that do not have a built-in entropy source (TRNG).
1329 * This feature is currently not supported on systems that have a built-in
1330 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001331 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001332 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001333 *
1334 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001335//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001336
1337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001339 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001340 * Do not use the Chinese Remainder Theorem
1341 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001342 *
1343 * Uncomment this macro to disable the use of CRT in RSA.
1344 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001347
1348/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001350 *
1351 * Enable the checkup functions (*_self_test).
1352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001354
1355/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001356 * \def MBEDTLS_SHA256_SMALLER
1357 *
1358 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1359 * lower performance.
1360 *
1361 * The default implementation is meant to be a reasonnable compromise between
1362 * performance and size. This version optimizes more aggressively for size at
1363 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1364 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1365 * 30%.
1366 *
1367 * Uncomment to enable the smaller implementation of SHA256.
1368 */
1369//#define MBEDTLS_SHA256_SMALLER
1370
1371/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001372 * \def MBEDTLS_SHA512_SMALLER
1373 *
1374 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1375 * lower performance.
1376 *
1377 * Uncomment to enable the smaller implementation of SHA512.
1378 */
1379//#define MBEDTLS_SHA512_SMALLER
1380
1381/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001382 * \def MBEDTLS_SHA512_NO_SHA384
1383 *
1384 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1385 * code size on devices that don't use SHA-384.
1386 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001387 * Requires: MBEDTLS_SHA512_C
1388 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001389 * Uncomment to disable SHA-384
1390 */
1391//#define MBEDTLS_SHA512_NO_SHA384
1392
1393/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001395 *
1396 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001397 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001398 * with other servers, only debugging of failures is harder.
1399 *
1400 * The advantage of not sending alert messages, is that no information is given
1401 * about reasons for failures thus preventing adversaries of gaining intel.
1402 *
1403 * Enable sending of all alert messages
1404 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001405#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001406
1407/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001408 * \def MBEDTLS_SSL_RECORD_CHECKING
1409 *
1410 * Enable the function mbedtls_ssl_check_record() which can be used to check
1411 * the validity and authenticity of an incoming record, to verify that it has
1412 * not been seen before. These checks are performed without modifying the
1413 * externally visible state of the SSL context.
1414 *
1415 * See mbedtls_ssl_check_record() for more information.
1416 *
1417 * Uncomment to enable support for record checking.
1418 */
1419#define MBEDTLS_SSL_RECORD_CHECKING
1420
1421/**
1422 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1423 *
1424 * Enable support for the DTLS Connection ID extension
1425 * (version draft-ietf-tls-dtls-connection-id-05,
1426 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1427 * which allows to identify DTLS connections across changes
1428 * in the underlying transport.
1429 *
1430 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
1431 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
1432 * See the corresponding documentation for more information.
1433 *
1434 * \warning The Connection ID extension is still in draft state.
1435 * We make no stability promises for the availability
1436 * or the shape of the API controlled by this option.
1437 *
1438 * The maximum lengths of outgoing and incoming CIDs can be configured
1439 * through the options
1440 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1441 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1442 *
1443 * Requires: MBEDTLS_SSL_PROTO_DTLS
1444 *
1445 * Uncomment to enable the Connection ID extension.
1446 */
1447//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1448
1449/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001450 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1451 *
1452 * Enable asynchronous external private key operations in SSL. This allows
1453 * you to configure an SSL connection to call an external cryptographic
1454 * module to perform private key operations instead of performing the
1455 * operation inside the library.
1456 *
1457 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001458//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001459
1460/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001461 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1462 *
1463 * Enable serialization of the TLS context structures, through use of the
1464 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1465 *
1466 * This pair of functions allows one side of a connection to serialize the
1467 * context associated with the connection, then free or re-use that context
1468 * while the serialized state is persisted elsewhere, and finally deserialize
1469 * that state to a live context for resuming read/write operations on the
1470 * connection. From a protocol perspective, the state of the connection is
1471 * unaffected, in particular this is entirely transparent to the peer.
1472 *
1473 * Note: this is distinct from TLS session resumption, which is part of the
1474 * protocol and fully visible by the peer. TLS session resumption enables
1475 * establishing new connections associated to a saved session with shorter,
1476 * lighter handshakes, while context serialization is a local optimization in
1477 * handling a single, potentially long-lived connection.
1478 *
1479 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1480 * saved after the handshake to allow for more efficient serialization, so if
1481 * you don't need this feature you'll save RAM by disabling it.
1482 *
1483 * Comment to disable the context serialization APIs.
1484 */
1485#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1486
1487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001489 *
1490 * Enable the debug messages in SSL module for all issues.
1491 * Debug messages have been disabled in some places to prevent timing
1492 * attacks due to (unbalanced) debugging function calls.
1493 *
1494 * If you need all error reporting you should enable this during debugging,
1495 * but remove this for production servers that should log as well.
1496 *
1497 * Uncomment this macro to report all debug messages on errors introducing
1498 * a timing side-channel.
1499 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001504 *
1505 * Enable support for Encrypt-then-MAC, RFC 7366.
1506 *
1507 * This allows peers that both support it to use a more robust protection for
1508 * ciphersuites using CBC, providing deep resistance against timing attacks
1509 * on the padding or underlying cipher.
1510 *
1511 * This only affects CBC ciphersuites, and is useless if none is defined.
1512 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1514 * MBEDTLS_SSL_PROTO_TLS1_1 or
1515 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001516 *
1517 * Comment this macro to disable support for Encrypt-then-MAC
1518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001519#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001522 *
1523 * Enable support for Extended Master Secret, aka Session Hash
1524 * (draft-ietf-tls-session-hash-02).
1525 *
1526 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1527 * attacks, but it is recommended to always use it (even if you disable
1528 * renegotiation), since it actually fixes a more fundamental issue in the
1529 * original SSL/TLS design, and has implications beyond Triple Handshake.
1530 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1532 * MBEDTLS_SSL_PROTO_TLS1_1 or
1533 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001534 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001535 * Comment this macro to disable support for Extended Master Secret.
1536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001538
Paul Bakkerd66f0702013-01-31 16:57:45 +01001539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001541 *
1542 * Enable support for FALLBACK_SCSV (draft-ietf-tls-downgrade-scsv-00).
1543 *
1544 * For servers, it is recommended to always enable this, unless you support
1545 * only one version of TLS, or know for sure that none of your clients
1546 * implements a fallback strategy.
1547 *
1548 * For clients, you only need this if you're using a fallback strategy, which
1549 * is not recommended in the first place, unless you absolutely need it to
1550 * interoperate with buggy (version-intolerant) servers.
1551 *
1552 * Comment this macro to disable support for FALLBACK_SCSV
1553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001555
1556/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001557 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1558 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001559 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001560 * giving access to the peer's certificate after completion of the handshake.
1561 *
1562 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1563 * recommended to disable this option for reduced RAM usage.
1564 *
1565 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1566 * defined, but always returns \c NULL.
1567 *
1568 * \note This option has no influence on the protection against the
1569 * triple handshake attack. Even if it is disabled, Mbed TLS will
1570 * still ensure that certificates do not change during renegotiation,
1571 * for exaple by keeping a hash of the peer's certificate.
1572 *
1573 * Comment this macro to disable storing the peer's certificate
1574 * after the handshake.
1575 */
1576#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1577
1578/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001580 *
1581 * Enable hooking functions in SSL module for hardware acceleration of
1582 * individual records.
1583 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001584 * \deprecated This option is deprecated and will be removed in a future
1585 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001586 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001587 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001590
1591/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001593 *
1594 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1595 *
1596 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1597 * of interoperability issues compared to sending 0-length records.
1598 *
1599 * Comment this macro to disable 1/n-1 record splitting.
1600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001602
1603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001605 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001606 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001607 *
1608 * The two main uses of renegotiation are (1) refresh keys on long-lived
1609 * connections and (2) client authentication after the initial handshake.
1610 * If you don't need renegotiation, it's probably better to disable it, since
1611 * it has been associated with security issues in the past and is easy to
1612 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001613 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001614 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001615 *
1616 * \note Even if this option is disabled, both client and server are aware
1617 * of the Renegotiation Indication Extension (RFC 5746) used to
1618 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1619 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1620 * configuration of this extension).
1621 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001624
1625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001627 *
1628 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001630 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001631 * \deprecated This option is deprecated and will be removed in a future
1632 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001633 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001634 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001635 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001636//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001637
1638/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001640 *
1641 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001643 *
1644 * Uncomment this macro to respect client's ciphersuite order
1645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001647
1648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001650 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001651 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001652 *
1653 * Comment this macro to disable support for the max_fragment_length extension
1654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001656
1657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001659 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001660 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001661 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 * Requires: MBEDTLS_MD5_C
1663 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001664 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001665 * \deprecated This option is deprecated and will be removed in a future
1666 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001667 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001668 * Comment this macro to disable support for SSL 3.0
1669 */
Janos Follathe2681a42016-03-07 15:57:05 +00001670//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001671
1672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001674 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001675 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 * Requires: MBEDTLS_MD5_C
1678 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001679 *
1680 * Comment this macro to disable support for TLS 1.0
1681 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001683
1684/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001685 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001686 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001687 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001688 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 * Requires: MBEDTLS_MD5_C
1690 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001691 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001692 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001693 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001695
1696/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001698 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001699 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001700 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001702 * (Depends on ciphersuites)
1703 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001707
1708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710 *
1711 * Enable support for DTLS (all available versions).
1712 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1714 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1717 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001718 *
1719 * Comment this macro to disable support for DTLS
1720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001722
1723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001725 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001726 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001727 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001728 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001731
1732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001734 *
1735 * Enable support for the anti-replay mechanism in DTLS.
1736 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737 * Requires: MBEDTLS_SSL_TLS_C
1738 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001739 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001740 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001741 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001742 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001743 * Comment this to disable anti-replay in DTLS.
1744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001746
1747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001748 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001749 *
1750 * Enable support for HelloVerifyRequest on DTLS servers.
1751 *
1752 * This feature is highly recommended to prevent DTLS servers being used as
1753 * amplifiers in DoS attacks against other hosts. It should always be enabled
1754 * unless you know for sure amplification cannot be a problem in the
1755 * environment in which your server operates.
1756 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001757 * \warning Disabling this can ba a security risk! (see above)
1758 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001759 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001760 *
1761 * Comment this to disable support for HelloVerifyRequest.
1762 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001764
1765/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001766 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1767 *
1768 * Enable server-side support for clients that reconnect from the same port.
1769 *
1770 * Some clients unexpectedly close the connection and try to reconnect using the
1771 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001772 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001773 * flag enables that support.
1774 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001775 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001776 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001777 * Comment this to disable support for clients reusing the source port.
1778 */
1779#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1780
1781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001783 *
1784 * Enable support for a limit of records with bad MAC.
1785 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001786 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001787 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001791
1792/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001794 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001795 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001796 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001797 * session store remains the responsibility of the application, though).
1798 * Server-side, you also need to provide callbacks for writing and parsing
1799 * tickets, including authenticated encryption and key management. Example
1800 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001801 *
1802 * Comment this macro to disable support for SSL session tickets
1803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001805
1806/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001807 * \def MBEDTLS_SSL_EXPORT_KEYS
1808 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001809 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001810 * This is required for certain users of TLS, e.g. EAP-TLS.
1811 *
1812 * Comment this macro to disable support for key export
1813 */
1814#define MBEDTLS_SSL_EXPORT_KEYS
1815
1816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001819 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001820 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001822 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001823 * Comment this macro to disable support for server name indication in SSL
1824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001826
1827/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001829 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001830 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001831 *
1832 * Comment this macro to disable support for truncated HMAC in SSL
1833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001835
1836/**
Hanno Beckere89353a2017-11-20 16:36:41 +00001837 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1838 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001839 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
1840 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001841 * only meant for a transitory upgrade period and will be removed in a future
1842 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00001843 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001844 * \warning The old implementation is non-compliant and has a security weakness
1845 * (2^80 brute force attack on the HMAC key used for a single,
1846 * uninterrupted connection). This should only be enabled temporarily
1847 * when (1) the use of truncated HMAC is essential in order to save
1848 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
1849 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00001850 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001851 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00001852 * future version of Mbed TLS.
1853 *
Hanno Beckere89353a2017-11-20 16:36:41 +00001854 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
1855 *
1856 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
1857 */
1858//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1859
1860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001862 *
1863 * Provide your own alternate threading implementation.
1864 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001866 *
1867 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001870
1871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001873 *
1874 * Enable the pthread wrapper layer for the threading layer.
1875 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001877 *
1878 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001881
1882/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001883 * \def MBEDTLS_USE_PSA_CRYPTO
1884 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001885 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1886 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001887 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001888 * \note Development of this option is currently in progress, and parts of Mbed
1889 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001890 * will still continue to work as usual, so enabling this option should not
1891 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001892 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001893 * \warning The PSA Crypto API is in beta stage. While you're welcome to
1894 * experiment using it, incompatible API changes are still possible, and some
1895 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001896 *
1897 * \warning This option enables new Mbed TLS APIs that are dependent on the
1898 * PSA Crypto API, so can't come with the same stability guarantees as the
1899 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001900 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001901 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00001902 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001903 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001904 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001905 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001906 */
1907//#define MBEDTLS_USE_PSA_CRYPTO
1908
1909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001911 *
1912 * Allow run-time checking of compile-time enabled features. Thus allowing users
1913 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001917 *
1918 * Comment this to disable run-time checking and save ROM space
1919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001921
1922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001924 *
1925 * If set, the X509 parser will not break-off when parsing an X509 certificate
1926 * and encountering an extension in a v1 or v2 certificate.
1927 *
1928 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001930//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001931
1932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00001934 *
1935 * If set, the X509 parser will not break-off when parsing an X509 certificate
1936 * and encountering an unknown critical extension.
1937 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01001938 * \warning Depending on your PKI use, enabling this can be a security risk!
1939 *
Paul Bakker5c721f92011-07-27 16:51:09 +00001940 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00001941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00001943
1944/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001945 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1946 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001947 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001948 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1949 * the set of trusted certificates through a callback instead of a linked
1950 * list.
1951 *
1952 * This is useful for example in environments where a large number of trusted
1953 * certificates is present and storing them in a linked list isn't efficient
1954 * enough, or when the set of trusted certificates changes frequently.
1955 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001956 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001957 * `mbedtls_ssl_conf_ca_cb()` for more information.
1958 *
1959 * Uncomment to enable trusted certificate callbacks.
1960 */
1961//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1962
1963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001965 *
1966 * Enable verification of the keyUsage extension (CA and leaf certificates).
1967 *
1968 * Disabling this avoids problems with mis-issued and/or misused
1969 * (intermediate) CA and leaf certificates.
1970 *
1971 * \warning Depending on your PKI use, disabling this can be a security risk!
1972 *
1973 * Comment to skip keyUsage checking for both CA and leaf certificates.
1974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001976
1977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001979 *
1980 * Enable verification of the extendedKeyUsage extension (leaf certificates).
1981 *
1982 * Disabling this avoids problems with mis-issued and/or misused certificates.
1983 *
1984 * \warning Depending on your PKI use, disabling this can be a security risk!
1985 *
1986 * Comment to skip extendedKeyUsage checking for certificates.
1987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001989
1990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001992 *
1993 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1994 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1995 *
1996 * Comment this macro to disallow using RSASSA-PSS in certificates.
1997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001999
2000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002002 *
2003 * If set, the SSL/TLS module uses ZLIB to support compression and
2004 * decompression of packet data.
2005 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002006 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2007 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01002008 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002009 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002010 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002011 *
Hanno Beckere494e202018-03-08 13:26:12 +00002012 * \deprecated This feature is deprecated and will be removed
2013 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002014 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002015 * Used in: library/ssl_tls.c
2016 * library/ssl_cli.c
2017 * library/ssl_srv.c
2018 *
2019 * This feature requires zlib library and headers to be present.
2020 *
2021 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002024/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002025
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002026/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002027 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002028 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002029 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002030 * \{
2031 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002032
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002035 *
2036 * Enable AES-NI support on x86-64.
2037 *
2038 * Module: library/aesni.c
2039 * Caller: library/aes.c
2040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002042 *
2043 * This modules adds support for the AES-NI instructions on x86-64
2044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002045#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002046
2047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002049 *
2050 * Enable the AES block cipher.
2051 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002052 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002053 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002054 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002055 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002056 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002057 * This module enables the following ciphersuites (if other requisites are
2058 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002059 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2060 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2061 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2062 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2063 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2064 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2065 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2066 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2067 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2068 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2069 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2070 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2071 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2072 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2073 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2074 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2075 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2076 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2077 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2078 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2079 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2080 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2081 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2082 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2083 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2084 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2085 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2086 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2087 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2088 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2089 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2090 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2091 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2092 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2093 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2094 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2095 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2096 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2097 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2098 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2099 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2100 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2101 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2102 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2103 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2104 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2105 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2106 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2107 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2108 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2109 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2110 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2111 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2112 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2113 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2114 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2115 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2116 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002117 *
Paul Bakkercff68422013-09-15 20:43:33 +02002118 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002121
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002124 *
2125 * Enable the ARCFOUR stream cipher.
2126 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002127 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002128 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002129 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002130 * This module enables the following ciphersuites (if other requisites are
2131 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2133 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2135 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2136 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2137 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2138 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2139 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2140 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2141 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002142 *
2143 * \warning ARC4 is considered a weak cipher and its use constitutes a
2144 * security risk. If possible, we recommend avoidng dependencies on
2145 * it, and considering stronger ciphers instead.
2146 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002149
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002152 *
2153 * Enable the generic ASN1 parser.
2154 *
2155 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002156 * Caller: library/x509.c
2157 * library/dhm.c
2158 * library/pkcs12.c
2159 * library/pkcs5.c
2160 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002162#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002163
2164/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002166 *
2167 * Enable the generic ASN1 writer.
2168 *
2169 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002170 * Caller: library/ecdsa.c
2171 * library/pkwrite.c
2172 * library/x509_create.c
2173 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002174 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002177
2178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002180 *
2181 * Enable the Base64 module.
2182 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002183 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002184 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002185 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002186 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002189
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002192 *
Paul Bakker9a736322012-11-14 12:39:52 +00002193 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002194 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002195 * Module: library/bignum.c
2196 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002197 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002198 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002199 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002200 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002201 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002202 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002203 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002209 *
2210 * Enable the Blowfish block cipher.
2211 *
2212 * Module: library/blowfish.c
2213 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002214#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002215
2216/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002218 *
2219 * Enable the Camellia block cipher.
2220 *
Paul Bakker38119b12009-01-10 23:31:23 +00002221 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002222 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002223 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002224 * This module enables the following ciphersuites (if other requisites are
2225 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2227 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2228 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2229 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2230 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2231 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2232 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2233 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2234 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2235 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2236 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2237 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2238 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2239 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2240 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2241 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2242 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2243 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2244 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2245 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2246 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2247 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2248 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2249 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2250 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2251 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2252 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2254 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2255 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2256 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2257 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2258 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2259 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2260 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2261 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2262 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2264 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2265 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2266 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2267 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002270
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002272 * \def MBEDTLS_ARIA_C
2273 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002274 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002275 *
2276 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002277 * Caller: library/cipher.c
2278 *
2279 * This module enables the following ciphersuites (if other requisites are
2280 * enabled as well):
2281 *
2282 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2283 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2284 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2285 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2286 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2288 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2289 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2291 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2292 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2293 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2294 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2296 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2297 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2298 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2299 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2300 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2301 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2302 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2303 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2304 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2305 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2306 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2308 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2309 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2310 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2311 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2312 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2313 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2314 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2315 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2316 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2317 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2318 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2319 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002320 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002321//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002322
2323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002325 *
2326 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2327 *
2328 * Module: library/ccm.c
2329 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002330 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002331 *
2332 * This module enables the AES-CCM ciphersuites, if other requisites are
2333 * enabled as well.
2334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002336
2337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002338 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002339 *
2340 * Enable the test certificates.
2341 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002342 * Module: library/certs.c
2343 * Caller:
2344 *
2345 * This module is used for testing (ssl_client/server).
2346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002348
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002349/**
Daniel King34b822c2016-05-15 17:28:08 -03002350 * \def MBEDTLS_CHACHA20_C
2351 *
2352 * Enable the ChaCha20 stream cipher.
2353 *
2354 * Module: library/chacha20.c
2355 */
2356#define MBEDTLS_CHACHA20_C
2357
2358/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002359 * \def MBEDTLS_CHACHAPOLY_C
2360 *
2361 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2362 *
2363 * Module: library/chachapoly.c
2364 *
2365 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2366 */
2367#define MBEDTLS_CHACHAPOLY_C
2368
2369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002371 *
2372 * Enable the generic cipher layer.
2373 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002374 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002375 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002376 *
2377 * Uncomment to enable generic cipher wrappers.
2378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002380
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002381/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002382 * \def MBEDTLS_CMAC_C
2383 *
Simon Butcher327398a2016-10-05 14:09:11 +01002384 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2385 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002386 *
2387 * Module: library/cmac.c
2388 *
Simon Butcher69283e52016-10-06 12:49:58 +01002389 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002390 *
2391 */
Gilles Peskined3d02902020-03-04 21:35:27 +01002392//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002393
2394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002396 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002397 * Enable the CTR_DRBG AES-based random generator.
2398 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002399 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002400 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002401 * \note To achieve a 256-bit security strength with CTR_DRBG,
2402 * you must use AES-256 *and* use sufficient entropy.
2403 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002404 *
2405 * Module: library/ctr_drbg.c
2406 * Caller:
2407 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002409 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002410 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002411 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002413
2414/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002416 *
2417 * Enable the debug functions.
2418 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002419 * Module: library/debug.c
2420 * Caller: library/ssl_cli.c
2421 * library/ssl_srv.c
2422 * library/ssl_tls.c
2423 *
2424 * This module provides debugging functions.
2425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002427
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002430 *
2431 * Enable the DES block cipher.
2432 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002433 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002434 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002435 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002436 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002437 * This module enables the following ciphersuites (if other requisites are
2438 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2440 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2441 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2442 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2443 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2444 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2445 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2446 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2447 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2448 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002449 *
Paul Bakkercff68422013-09-15 20:43:33 +02002450 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002451 *
2452 * \warning DES is considered a weak cipher and its use constitutes a
2453 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002456
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002457/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002459 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002460 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002461 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002462 * Module: library/dhm.c
2463 * Caller: library/ssl_cli.c
2464 * library/ssl_srv.c
2465 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002466 * This module is used by the following key exchanges:
2467 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002468 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002469 * \warning Using DHE constitutes a security risk as it
2470 * is not possible to validate custom DH parameters.
2471 * If possible, it is recommended users should consider
2472 * preferring other methods of key exchange.
2473 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002474 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002477
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002480 *
2481 * Enable the elliptic curve Diffie-Hellman library.
2482 *
2483 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002484 * Caller: library/ssl_cli.c
2485 * library/ssl_srv.c
2486 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002487 * This module is used by the following key exchanges:
2488 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002493
2494/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002496 *
2497 * Enable the elliptic curve DSA library.
2498 *
2499 * Module: library/ecdsa.c
2500 * Caller:
2501 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002502 * This module is used by the following key exchanges:
2503 * ECDHE-ECDSA
2504 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002508
2509/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002510 * \def MBEDTLS_ECJPAKE_C
2511 *
2512 * Enable the elliptic curve J-PAKE library.
2513 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002514 * \warning This is currently experimental. EC J-PAKE support is based on the
2515 * Thread v1.0.0 specification; incompatible changes to the specification
2516 * might still happen. For this reason, this is disabled by default.
2517 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002518 * Module: library/ecjpake.c
2519 * Caller:
2520 *
2521 * This module is used by the following key exchanges:
2522 * ECJPAKE
2523 *
2524 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2525 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002526//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002527
2528/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002530 *
2531 * Enable the elliptic curve over GF(p) library.
2532 *
2533 * Module: library/ecp.c
2534 * Caller: library/ecdh.c
2535 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002536 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002537 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541
2542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002544 *
2545 * Enable the platform-specific entropy code.
2546 *
2547 * Module: library/entropy.c
2548 * Caller:
2549 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002551 *
2552 * This module provides a generic entropy pool
2553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002555
2556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002558 *
2559 * Enable error code to error string conversion.
2560 *
2561 * Module: library/error.c
2562 * Caller:
2563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002567
2568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002570 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002571 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002572 *
2573 * Module: library/gcm.c
2574 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002575 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002576 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002577 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2578 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002579 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002581
2582/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002584 *
2585 * Enable the HAVEGE random generator.
2586 *
Paul Bakker2a844242013-06-24 13:01:53 +02002587 * Warning: the HAVEGE random generator is not suitable for virtualized
2588 * environments
2589 *
2590 * Warning: the HAVEGE random generator is dependent on timing and specific
2591 * processor traits. It is therefore not advised to use HAVEGE as
2592 * your applications primary random generator or primary entropy pool
2593 * input. As a secondary input to your entropy pool, it IS able add
2594 * the (limited) extra entropy it provides.
2595 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002596 * Module: library/havege.c
2597 * Caller:
2598 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002600 *
Paul Bakker2a844242013-06-24 13:01:53 +02002601 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002604
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002605/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002606 * \def MBEDTLS_HKDF_C
2607 *
2608 * Enable the HKDF algorithm (RFC 5869).
2609 *
2610 * Module: library/hkdf.c
2611 * Caller:
2612 *
2613 * Requires: MBEDTLS_MD_C
2614 *
2615 * This module adds support for the Hashed Message Authentication Code
2616 * (HMAC)-based key derivation function (HKDF).
2617 */
2618#define MBEDTLS_HKDF_C
2619
2620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002622 *
2623 * Enable the HMAC_DRBG random generator.
2624 *
2625 * Module: library/hmac_drbg.c
2626 * Caller:
2627 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002629 *
2630 * Uncomment to enable the HMAC_DRBG random number geerator.
2631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002633
2634/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002635 * \def MBEDTLS_NIST_KW_C
2636 *
2637 * Enable the Key Wrapping mode for 128-bit block ciphers,
2638 * as defined in NIST SP 800-38F. Only KW and KWP modes
2639 * are supported. At the moment, only AES is approved by NIST.
2640 *
2641 * Module: library/nist_kw.c
2642 *
2643 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2644 */
2645//#define MBEDTLS_NIST_KW_C
2646
2647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002649 *
2650 * Enable the generic message digest layer.
2651 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002652 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002653 * Caller:
2654 *
2655 * Uncomment to enable generic message digest wrappers.
2656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002658
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002659/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002661 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002662 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002663 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002664 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002665 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002666 *
2667 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002668 *
2669 * \warning MD2 is considered a weak message digest and its use constitutes a
2670 * security risk. If possible, we recommend avoiding dependencies on
2671 * it, and considering stronger message digests instead.
2672 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002675
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002679 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002680 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002681 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002682 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002683 *
2684 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002685 *
2686 * \warning MD4 is considered a weak message digest and its use constitutes a
2687 * security risk. If possible, we recommend avoiding dependencies on
2688 * it, and considering stronger message digests instead.
2689 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002692
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002695 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002696 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002697 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002698 * Module: library/md5.c
2699 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002700 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002701 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002702 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002703 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2704 * depending on the handshake parameters. Further, it is used for checking
2705 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2706 * encrypted keys.
2707 *
2708 * \warning MD5 is considered a weak message digest and its use constitutes a
2709 * security risk. If possible, we recommend avoiding dependencies on
2710 * it, and considering stronger message digests instead.
2711 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002714
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002717 *
2718 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002719 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002720 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002721 *
2722 * Module: library/memory_buffer_alloc.c
2723 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 * Requires: MBEDTLS_PLATFORM_C
2725 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002726 *
2727 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002730
2731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002733 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002734 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2735 *
Simon Butcherd567a232016-03-09 20:19:21 +00002736 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2737 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002738 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002739 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002740 * \note See also our Knowledge Base article about porting to a new
2741 * environment:
2742 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2743 *
Andres AG788aa4a2016-09-14 14:32:09 +01002744 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002745 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002746 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002747 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002749
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002752 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002753 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002754 *
2755 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002756 * Caller: library/asn1write.c
2757 * library/pkcs5.c
2758 * library/pkparse.c
2759 * library/pkwrite.c
2760 * library/rsa.c
2761 * library/x509.c
2762 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002763 * library/x509_crl.c
2764 * library/x509_crt.c
2765 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002766 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002767 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002768 *
2769 * This modules translates between OIDs and internal values.
2770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002772
2773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002775 *
2776 * Enable VIA Padlock support on x86.
2777 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002778 * Module: library/padlock.c
2779 * Caller: library/aes.c
2780 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002782 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002783 * This modules adds support for the VIA PadLock on x86.
2784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002786
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002789 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002790 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002791 *
2792 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002793 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002794 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002795 * library/x509_crl.c
2796 * library/x509_crt.c
2797 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002798 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002800 *
Paul Bakkercff68422013-09-15 20:43:33 +02002801 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002804
2805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002808 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002809 *
2810 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002811 * Caller: library/pkwrite.c
2812 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002813 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002814 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002816 *
2817 * This modules adds support for encoding / writing PEM files.
2818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002820
2821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002823 *
2824 * Enable the generic public (asymetric) key layer.
2825 *
2826 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002827 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002828 * library/ssl_cli.c
2829 * library/ssl_srv.c
2830 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002832 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002833 * Uncomment to enable generic public key wrappers.
2834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002836
2837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002839 *
2840 * Enable the generic public (asymetric) key parser.
2841 *
2842 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002843 * Caller: library/x509_crt.c
2844 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002845 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002847 *
2848 * Uncomment to enable generic public key parse functions.
2849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002851
2852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002854 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002855 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002856 *
2857 * Module: library/pkwrite.c
2858 * Caller: library/x509write.c
2859 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002861 *
2862 * Uncomment to enable generic public key write functions.
2863 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002865
2866/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002868 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002869 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002870 *
2871 * Module: library/pkcs5.c
2872 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002874 *
2875 * This module adds support for the PKCS#5 functions.
2876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002878
2879/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002881 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01002882 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00002883 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00002884 * \deprecated This option is deprecated and will be removed in a future
2885 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00002886 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02002887 * Module: library/pkcs11.c
2888 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002891 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00002892 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00002893 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00002894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002896
2897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002899 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002900 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002901 * Adds algorithms for parsing PKCS#8 encrypted private keys
2902 *
2903 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002904 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2907 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002908 *
2909 * This module enables PKCS#12 functions.
2910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002912
2913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002915 *
2916 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002917 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002918 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2920 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002921 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002922 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002923 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2924 * as other module rely on it for a fixed snprintf implementation.
2925 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002926 * Module: library/platform.c
2927 * Caller: Most other .c files
2928 *
2929 * This module enables abstraction of common (libc) functions.
2930 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002931#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002932
2933/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002934 * \def MBEDTLS_POLY1305_C
2935 *
2936 * Enable the Poly1305 MAC algorithm.
2937 *
2938 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002939 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002940 */
2941#define MBEDTLS_POLY1305_C
2942
2943/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002944 * \def MBEDTLS_PSA_CRYPTO_C
2945 *
2946 * Enable the Platform Security Architecture cryptography API.
2947 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002948 * \warning The PSA Crypto API is still beta status. While you're welcome to
2949 * experiment using it, incompatible API changes are still possible, and some
2950 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01002951 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002952 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002953 *
2954 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
2955 *
2956 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002957#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002958
2959/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002960 * \def MBEDTLS_PSA_CRYPTO_SE_C
2961 *
2962 * Enable secure element support in the Platform Security Architecture
2963 * cryptography API.
2964 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02002965 * \warning This feature is not yet suitable for production. It is provided
2966 * for API evaluation and testing purposes only.
2967 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002968 * Module: library/psa_crypto_se.c
2969 *
2970 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2971 *
2972 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002973//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002974
2975/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002976 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2977 *
2978 * Enable the Platform Security Architecture persistent key storage.
2979 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002980 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002981 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002982 * Requires: MBEDTLS_PSA_CRYPTO_C,
2983 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2984 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002985 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002986#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002987
2988/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002989 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002990 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002991 * Enable the emulation of the Platform Security Architecture
2992 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002993 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002994 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002995 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002996 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002997 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002998#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002999
3000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003002 *
3003 * Enable the RIPEMD-160 hash algorithm.
3004 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003005 * Module: library/ripemd160.c
3006 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003007 *
3008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003010
3011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003013 *
3014 * Enable the RSA public-key cryptosystem.
3015 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003016 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003017 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003018 * Caller: library/ssl_cli.c
3019 * library/ssl_srv.c
3020 * library/ssl_tls.c
3021 * library/x509.c
3022 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003023 * This module is used by the following key exchanges:
3024 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003025 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003029
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003032 *
3033 * Enable the SHA1 cryptographic hash algorithm.
3034 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003035 * Module: library/sha1.c
3036 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003037 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003038 * library/ssl_srv.c
3039 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003040 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003041 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003042 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3043 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003044 *
3045 * \warning SHA-1 is considered a weak message digest and its use constitutes
3046 * a security risk. If possible, we recommend avoiding dependencies
3047 * on it, and considering stronger message digests instead.
3048 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003051
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003054 *
3055 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3056 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003057 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003058 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003059 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003060 * library/ssl_cli.c
3061 * library/ssl_srv.c
3062 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003063 *
3064 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003065 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003068
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003071 *
3072 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3073 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003074 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003075 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003076 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003077 * library/ssl_cli.c
3078 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003079 *
3080 * This module adds support for SHA-384 and SHA-512.
3081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003083
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003084/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003086 *
3087 * Enable simple SSL cache implementation.
3088 *
3089 * Module: library/ssl_cache.c
3090 * Caller:
3091 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003095
3096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003098 *
3099 * Enable basic implementation of DTLS cookies for hello verification.
3100 *
3101 * Module: library/ssl_cookie.c
3102 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003105
3106/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003107 * \def MBEDTLS_SSL_TICKET_C
3108 *
3109 * Enable an implementation of TLS server-side callbacks for session tickets.
3110 *
3111 * Module: library/ssl_ticket.c
3112 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003113 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003114 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003115 */
3116#define MBEDTLS_SSL_TICKET_C
3117
3118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003120 *
3121 * Enable the SSL/TLS client code.
3122 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003123 * Module: library/ssl_cli.c
3124 * Caller:
3125 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003127 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003128 * This module is required for SSL/TLS client support.
3129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003131
Paul Bakker9a736322012-11-14 12:39:52 +00003132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003134 *
3135 * Enable the SSL/TLS server code.
3136 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003137 * Module: library/ssl_srv.c
3138 * Caller:
3139 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003141 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 * This module is required for SSL/TLS server support.
3143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003145
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003148 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003149 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003150 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 * Module: library/ssl_tls.c
3152 * Caller: library/ssl_cli.c
3153 * library/ssl_srv.c
3154 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3156 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003157 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003158 * This module is required for SSL/TLS.
3159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003161
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003164 *
3165 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003166 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003167 * contexts are not shared between threads. If you do intend to use contexts
3168 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003169 * conditions. See also our Knowledge Base article about threading:
3170 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003171 *
3172 * Module: library/threading.c
3173 *
3174 * This allows different threading implementations (self-implemented or
3175 * provided).
3176 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 * You will have to enable either MBEDTLS_THREADING_ALT or
3178 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003179 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003180 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003183
3184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003186 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003187 * Enable the semi-portable timing interface.
3188 *
Simon Butcherd567a232016-03-09 20:19:21 +00003189 * \note The provided implementation only works on POSIX/Unix (including Linux,
3190 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003191 * module and provide your own implementations of the callbacks needed by
3192 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3193 * your own implementation of the whole module by setting
3194 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003195 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003196 * \note See also our Knowledge Base article about porting to a new
3197 * environment:
3198 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3199 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 * Module: library/timing.c
3201 * Caller: library/havege.c
3202 *
3203 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003209 *
3210 * Enable run-time version information.
3211 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003212 * Module: library/version.c
3213 *
3214 * This module provides run-time version information.
3215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003217
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003220 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003221 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003222 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003223 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003224 * Caller: library/x509_crl.c
3225 * library/x509_crt.c
3226 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003227 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3229 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003230 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003231 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003234
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003237 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003238 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003239 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003240 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003241 * Caller: library/ssl_cli.c
3242 * library/ssl_srv.c
3243 * library/ssl_tls.c
3244 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003246 *
3247 * This module is required for X.509 certificate parsing.
3248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003250
3251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003253 *
3254 * Enable X.509 CRL parsing.
3255 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003256 * Module: library/x509_crl.c
3257 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003258 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003260 *
3261 * This module is required for X.509 CRL parsing.
3262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003264
3265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003267 *
3268 * Enable X.509 Certificate Signing Request (CSR) parsing.
3269 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003270 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003271 * Caller: library/x509_crt_write.c
3272 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003274 *
3275 * This module is used for reading X.509 certificate request.
3276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003278
3279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003281 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003282 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003283 *
3284 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003285 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003287 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003288 * This module is the basis for creating X.509 certificates and CSRs.
3289 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003290#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003291
3292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003294 *
3295 * Enable creating X.509 certificates.
3296 *
3297 * Module: library/x509_crt_write.c
3298 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003300 *
3301 * This module is required for X.509 certificate creation.
3302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003304
3305/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003307 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003308 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003309 *
3310 * Module: library/x509_csr_write.c
3311 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003313 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003314 * This module is required for X.509 certificate request writing.
3315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003317
3318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003320 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003321 * Enable the XTEA block cipher.
3322 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003323 * Module: library/xtea.c
3324 * Caller:
3325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003327
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003328/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003329
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003330/**
3331 * \name SECTION: Module configuration options
3332 *
3333 * This section allows for the setting of module specific sizes and
3334 * configuration options. The default values are already present in the
3335 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003336 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003337 * Our advice is to enable options and change their values here
3338 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003339 *
3340 * Please check the respective header file for documentation on these
3341 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003342 * \{
3343 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003344
Paul Bakker088c5c52014-04-25 11:11:10 +02003345/* MPI / BIGNUM options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
3347//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003348
Paul Bakker088c5c52014-04-25 11:11:10 +02003349/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3351//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3352//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3353//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3354//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003355
Paul Bakker088c5c52014-04-25 11:11:10 +02003356/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3358//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3359//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3360//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003361
Paul Bakker088c5c52014-04-25 11:11:10 +02003362/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3364//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3365//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003366
Paul Bakker088c5c52014-04-25 11:11:10 +02003367/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3369//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003370//#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 +01003371
Paul Bakker088c5c52014-04-25 11:11:10 +02003372/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003374
Paul Bakker088c5c52014-04-25 11:11:10 +02003375/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376//#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 +02003377//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3379//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003380//#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 +02003381//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3382//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003383/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003385//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3386//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003387//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3388//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3389//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3392/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003393//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3395//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003396//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3397//#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 +02003398//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3399//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003400/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003402//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003403//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3404//#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 +02003405
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003406/**
3407 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003408 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003409 * (see the documentation of that option for context).
3410 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003411 * When you leave this undefined here, the library provides
3412 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3413 * is defined, the default definition is `assert(cond)`,
3414 * otherwise the default definition calls a function
3415 * mbedtls_param_failed(). This function is declared in
3416 * `platform_util.h` for the benefit of the library, but
3417 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003418 *
3419 * When you define this here, this replaces the default
3420 * definition in platform_util.h (which no longer declares the
3421 * function mbedtls_param_failed()) and it is your responsibility
3422 * to make sure this macro expands to something suitable (in
3423 * particular, that all the necessary declarations are visible
3424 * from within the library - you can ensure that by providing
3425 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003426 * If you define this macro to call `assert`, also define
3427 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3428 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003429 *
3430 * Note that you may define this macro to expand to nothing, in
3431 * which case you don't have to worry about declarations or
3432 * definitions. However, you will then be notified about invalid
3433 * parameters only in non-void functions, and void function will
3434 * just silently return early on invalid parameters, which
3435 * partially negates the benefits of enabling
3436 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3437 *
3438 * \param cond The expression that should evaluate to true, but doesn't.
3439 */
3440//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3441
Paul Bakker088c5c52014-04-25 11:11:10 +02003442/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3444//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003445
Paul Bakker088c5c52014-04-25 11:11:10 +02003446/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003447
3448/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3449 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003450 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003451 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003452 * This determines the size of both the incoming and outgoing TLS I/O buffers
3453 * in such a way that both are capable of holding the specified amount of
3454 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003455 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003456 * To configure incoming and outgoing I/O buffers separately, use
3457 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3458 * which overwrite the value set by this option.
3459 *
3460 * \note When using a value less than the default of 16KB on the client, it is
3461 * recommended to use the Maximum Fragment Length (MFL) extension to
3462 * inform the server about this limitation. On the server, there
3463 * is no supported, standardized way of informing the client about
3464 * restriction on the maximum size of incoming messages, and unless
3465 * the limitation has been communicated by other means, it is recommended
3466 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3467 * while keeping the default value of 16KB for the incoming buffer.
3468 *
3469 * Uncomment to set the maximum plaintext size of both
3470 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003471 */
3472//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3473
3474/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3475 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003476 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003477 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003478 * This determines the size of the incoming TLS I/O buffer in such a way
3479 * that it is capable of holding the specified amount of plaintext data,
3480 * regardless of the protection mechanism used.
3481 *
3482 * If this option is undefined, it inherits its value from
3483 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3484 *
3485 * \note When using a value less than the default of 16KB on the client, it is
3486 * recommended to use the Maximum Fragment Length (MFL) extension to
3487 * inform the server about this limitation. On the server, there
3488 * is no supported, standardized way of informing the client about
3489 * restriction on the maximum size of incoming messages, and unless
3490 * the limitation has been communicated by other means, it is recommended
3491 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3492 * while keeping the default value of 16KB for the incoming buffer.
3493 *
3494 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3495 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003496 */
3497//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3498
Gilles Peskined3d02902020-03-04 21:35:27 +01003499/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3500 *
3501 * The maximum length of CIDs used for incoming DTLS messages.
3502 *
3503 */
3504//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3505
3506/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3507 *
3508 * The maximum length of CIDs used for outgoing DTLS messages.
3509 *
3510 */
3511//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3512
3513/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3514 *
3515 * This option controls the use of record plaintext padding
3516 * when using the Connection ID extension in DTLS 1.2.
3517 *
3518 * The padding will always be chosen so that the length of the
3519 * padded plaintext is a multiple of the value of this option.
3520 *
3521 * Note: A value of \c 1 means that no padding will be used
3522 * for outgoing records.
3523 *
3524 * Note: On systems lacking division instructions,
3525 * a power of two should be preferred.
3526 *
3527 */
3528//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3529
Angus Grattond8213d02016-05-25 20:56:48 +10003530/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3531 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003532 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003533 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003534 * This determines the size of the outgoing TLS I/O buffer in such a way
3535 * that it is capable of holding the specified amount of plaintext data,
3536 * regardless of the protection mechanism used.
3537 *
3538 * If this option undefined, it inherits its value from
3539 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003540 *
3541 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3542 * the default inward 16384 byte buffer to conform to the TLS specification.
3543 *
3544 * The minimum required outward buffer size is determined by the handshake
3545 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3546 * The specific size requirement depends on the configured ciphers and any
3547 * certificate data which is sent during the handshake.
3548 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003549 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3550 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003551 */
3552//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3553
Hanno Beckere0b150f2018-08-21 15:51:03 +01003554/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3555 *
3556 * Maximum number of heap-allocated bytes for the purpose of
3557 * DTLS handshake message reassembly and future message buffering.
3558 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003559 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003560 * to account for a reassembled handshake message of maximum size,
3561 * together with its reassembly bitmap.
3562 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003563 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003564 * should be sufficient for all practical situations as it allows
3565 * to reassembly a large handshake message (such as a certificate)
3566 * while buffering multiple smaller handshake messages.
3567 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003568 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003569//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3572//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3573//#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 +02003574
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003575/**
3576 * Complete list of ciphersuites to use, in order of preference.
3577 *
3578 * \warning No dependency checking is done on that field! This option can only
3579 * be used to restrict the set of available ciphersuites. It is your
3580 * responsibility to make sure the needed modules are active.
3581 *
3582 * Use this to save a few hundred bytes of ROM (default ordering of all
3583 * available ciphersuites) and a few to a few hundred bytes of RAM.
3584 *
3585 * The value below is only an example, not the default.
3586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587//#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 +02003588
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003589/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003591//#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 +01003592
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003593/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003594 * Allow SHA-1 in the default TLS configuration for certificate signing.
3595 * Without this build-time option, SHA-1 support must be activated explicitly
3596 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003597 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003598 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003599 *
3600 * \warning SHA-1 is considered a weak message digest and its use constitutes
3601 * a security risk. If possible, we recommend avoiding dependencies
3602 * on it, and considering stronger message digests instead.
3603 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003604 */
Gilles Peskined3d02902020-03-04 21:35:27 +01003605//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003606
3607/**
3608 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3609 * signature and ciphersuite selection. Without this build-time option, SHA-1
3610 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3611 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3612 * default. At the time of writing, there is no practical attack on the use
3613 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003614 * to preserve compatibility with existing peers, but the general
3615 * warning applies nonetheless:
3616 *
3617 * \warning SHA-1 is considered a weak message digest and its use constitutes
3618 * a security risk. If possible, we recommend avoiding dependencies
3619 * on it, and considering stronger message digests instead.
3620 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003621 */
3622#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003623
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003624/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003625 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003626 * mbedtls_platform_zeroize(). This replaces the default implementation in
3627 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003628 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003629 * mbedtls_platform_zeroize() is a widely used function across the library to
3630 * zero a block of memory. The implementation is expected to be secure in the
3631 * sense that it has been written to prevent the compiler from removing calls
3632 * to mbedtls_platform_zeroize() as part of redundant code elimination
3633 * optimizations. However, it is difficult to guarantee that calls to
3634 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3635 * versions of the C language standards do not provide a secure implementation
3636 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3637 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003638 * example by using directives specific to their compiler, features from newer
3639 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003640 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003641 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003642//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003643
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003644/**
3645 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003646 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003647 * platform_util.c.
3648 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003649 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003650 * library will try to use safer implementations of this function, such as
3651 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003652 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003653 * using the standard gmtime(). In this case, calls from the library to
3654 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003655 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003656 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003657 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3658 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3659 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003660 */
Hanno Becker6a739782018-09-05 15:06:19 +01003661//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003662
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003663/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003664 * Enable the verified implementations of ECDH primitives from Project Everest
3665 * (currently only Curve25519). This feature changes the layout of ECDH
3666 * contexts and therefore is a compatibility break for applications that access
3667 * fields of a mbedtls_ecdh_context structure directly. See also
3668 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003669 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003670//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003671
Simon Butcher30b5f972016-06-08 19:00:23 +01003672/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003673
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003674/* Target and application specific configurations
3675 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003676 * Allow user to override any previous default.
3677 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003678 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003679#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003680#include MBEDTLS_USER_CONFIG_FILE
3681#endif
3682
Jaeden Amero6609aef2019-07-04 20:01:14 +01003683#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003685#endif /* MBEDTLS_CONFIG_H */