blob: 1c092736d7e67dd889e2a6da37ee16323ff53514 [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 Peskineb74a1c72018-04-24 13:09:22 +02001408 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1409 *
1410 * Enable asynchronous external private key operations in SSL. This allows
1411 * you to configure an SSL connection to call an external cryptographic
1412 * module to perform private key operations instead of performing the
1413 * operation inside the library.
1414 *
1415 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001416//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001417
1418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001420 *
1421 * Enable the debug messages in SSL module for all issues.
1422 * Debug messages have been disabled in some places to prevent timing
1423 * attacks due to (unbalanced) debugging function calls.
1424 *
1425 * If you need all error reporting you should enable this during debugging,
1426 * but remove this for production servers that should log as well.
1427 *
1428 * Uncomment this macro to report all debug messages on errors introducing
1429 * a timing side-channel.
1430 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001435 *
1436 * Enable support for Encrypt-then-MAC, RFC 7366.
1437 *
1438 * This allows peers that both support it to use a more robust protection for
1439 * ciphersuites using CBC, providing deep resistance against timing attacks
1440 * on the padding or underlying cipher.
1441 *
1442 * This only affects CBC ciphersuites, and is useless if none is defined.
1443 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1445 * MBEDTLS_SSL_PROTO_TLS1_1 or
1446 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001447 *
1448 * Comment this macro to disable support for Encrypt-then-MAC
1449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001453 *
1454 * Enable support for Extended Master Secret, aka Session Hash
1455 * (draft-ietf-tls-session-hash-02).
1456 *
1457 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1458 * attacks, but it is recommended to always use it (even if you disable
1459 * renegotiation), since it actually fixes a more fundamental issue in the
1460 * original SSL/TLS design, and has implications beyond Triple Handshake.
1461 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1463 * MBEDTLS_SSL_PROTO_TLS1_1 or
1464 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001465 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001466 * Comment this macro to disable support for Extended Master Secret.
1467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001469
Paul Bakkerd66f0702013-01-31 16:57:45 +01001470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001472 *
1473 * Enable support for FALLBACK_SCSV (draft-ietf-tls-downgrade-scsv-00).
1474 *
1475 * For servers, it is recommended to always enable this, unless you support
1476 * only one version of TLS, or know for sure that none of your clients
1477 * implements a fallback strategy.
1478 *
1479 * For clients, you only need this if you're using a fallback strategy, which
1480 * is not recommended in the first place, unless you absolutely need it to
1481 * interoperate with buggy (version-intolerant) servers.
1482 *
1483 * Comment this macro to disable support for FALLBACK_SCSV
1484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001486
1487/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001488 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1489 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001490 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001491 * giving access to the peer's certificate after completion of the handshake.
1492 *
1493 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1494 * recommended to disable this option for reduced RAM usage.
1495 *
1496 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1497 * defined, but always returns \c NULL.
1498 *
1499 * \note This option has no influence on the protection against the
1500 * triple handshake attack. Even if it is disabled, Mbed TLS will
1501 * still ensure that certificates do not change during renegotiation,
1502 * for exaple by keeping a hash of the peer's certificate.
1503 *
1504 * Comment this macro to disable storing the peer's certificate
1505 * after the handshake.
1506 */
1507#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1508
1509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001511 *
1512 * Enable hooking functions in SSL module for hardware acceleration of
1513 * individual records.
1514 *
Andres Amaya Garciada154092019-01-15 18:43:48 +00001515 * \deprecated This option is deprecated and will be removed in a future
1516 * version of Mbed TLS.
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001517 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001518 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001521
1522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001524 *
1525 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1526 *
1527 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1528 * of interoperability issues compared to sending 0-length records.
1529 *
1530 * Comment this macro to disable 1/n-1 record splitting.
1531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001533
1534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001536 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001537 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001538 *
1539 * The two main uses of renegotiation are (1) refresh keys on long-lived
1540 * connections and (2) client authentication after the initial handshake.
1541 * If you don't need renegotiation, it's probably better to disable it, since
1542 * it has been associated with security issues in the past and is easy to
1543 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001544 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001545 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001546 *
1547 * \note Even if this option is disabled, both client and server are aware
1548 * of the Renegotiation Indication Extension (RFC 5746) used to
1549 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1550 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1551 * configuration of this extension).
1552 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001555
1556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001558 *
1559 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001561 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001562 * \deprecated This option is deprecated and will be removed in a future
1563 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001564 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001565 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001568
1569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001571 *
1572 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001574 *
1575 * Uncomment this macro to respect client's ciphersuite order
1576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001578
1579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001581 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001582 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001583 *
1584 * Comment this macro to disable support for the max_fragment_length extension
1585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001587
1588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001590 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001591 * Enable support for SSL 3.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001592 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001593 * Requires: MBEDTLS_MD5_C
1594 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001596 * \deprecated This option is deprecated and will be removed in a future
1597 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001598 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001599 * Comment this macro to disable support for SSL 3.0
1600 */
Janos Follathe2681a42016-03-07 15:57:05 +00001601//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001602
1603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001605 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001606 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001607 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 * Requires: MBEDTLS_MD5_C
1609 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001610 *
1611 * Comment this macro to disable support for TLS 1.0
1612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001614
1615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001617 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001618 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001619 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620 * Requires: MBEDTLS_MD5_C
1621 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001622 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001623 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001626
1627/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001629 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001630 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001631 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001633 * (Depends on ciphersuites)
1634 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001635 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001638
1639/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001641 *
1642 * Enable support for DTLS (all available versions).
1643 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1645 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001646 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1648 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001649 *
1650 * Comment this macro to disable support for DTLS
1651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001653
1654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001656 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001657 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001658 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001659 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001662
1663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001665 *
1666 * Enable support for the anti-replay mechanism in DTLS.
1667 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 * Requires: MBEDTLS_SSL_TLS_C
1669 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001670 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001671 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001672 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001673 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001674 * Comment this to disable anti-replay in DTLS.
1675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001677
1678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001680 *
1681 * Enable support for HelloVerifyRequest on DTLS servers.
1682 *
1683 * This feature is highly recommended to prevent DTLS servers being used as
1684 * amplifiers in DoS attacks against other hosts. It should always be enabled
1685 * unless you know for sure amplification cannot be a problem in the
1686 * environment in which your server operates.
1687 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001688 * \warning Disabling this can ba a security risk! (see above)
1689 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001690 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001691 *
1692 * Comment this to disable support for HelloVerifyRequest.
1693 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001695
1696/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001697 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1698 *
1699 * Enable server-side support for clients that reconnect from the same port.
1700 *
1701 * Some clients unexpectedly close the connection and try to reconnect using the
1702 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001703 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001704 * flag enables that support.
1705 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001706 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001707 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001708 * Comment this to disable support for clients reusing the source port.
1709 */
1710#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1711
1712/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001714 *
1715 * Enable support for a limit of records with bad MAC.
1716 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001717 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001722
1723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001725 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001726 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001727 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001728 * session store remains the responsibility of the application, though).
1729 * Server-side, you also need to provide callbacks for writing and parsing
1730 * tickets, including authenticated encryption and key management. Example
1731 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001732 *
1733 * Comment this macro to disable support for SSL session tickets
1734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001736
1737/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001738 * \def MBEDTLS_SSL_EXPORT_KEYS
1739 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001740 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001741 * This is required for certain users of TLS, e.g. EAP-TLS.
1742 *
1743 * Comment this macro to disable support for key export
1744 */
1745#define MBEDTLS_SSL_EXPORT_KEYS
1746
1747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001748 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001749 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001750 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001751 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001753 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001754 * Comment this macro to disable support for server name indication in SSL
1755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001757
1758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001760 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001761 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001762 *
1763 * Comment this macro to disable support for truncated HMAC in SSL
1764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001766
1767/**
Hanno Beckere89353a2017-11-20 16:36:41 +00001768 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1769 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001770 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
1771 * HMAC extension which also truncates the HMAC key. Note that this option is
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001772 * only meant for a transitory upgrade period and will be removed in a future
1773 * version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00001774 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001775 * \warning The old implementation is non-compliant and has a security weakness
1776 * (2^80 brute force attack on the HMAC key used for a single,
1777 * uninterrupted connection). This should only be enabled temporarily
1778 * when (1) the use of truncated HMAC is essential in order to save
1779 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
1780 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00001781 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01001782 * \deprecated This option is deprecated and will be removed in a
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00001783 * future version of Mbed TLS.
1784 *
Hanno Beckere89353a2017-11-20 16:36:41 +00001785 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
1786 *
1787 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
1788 */
1789//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1790
1791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001793 *
1794 * Provide your own alternate threading implementation.
1795 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001797 *
1798 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001801
1802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001804 *
1805 * Enable the pthread wrapper layer for the threading layer.
1806 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001808 *
1809 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001812
1813/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001814 * \def MBEDTLS_USE_PSA_CRYPTO
1815 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001816 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1817 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001818 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001819 * \note Development of this option is currently in progress, and parts of Mbed
1820 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001821 * will still continue to work as usual, so enabling this option should not
1822 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001823 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001824 * \warning Support for PSA is still an experimental feature.
1825 * Any public API that depends on this option may change
1826 * at any time until this warning is removed.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001827 *
1828 * \warning This option enables new Mbed TLS APIs that are dependent on the
1829 * PSA Crypto API, so can't come with the same stability guarantees as the
1830 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001831 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001832 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00001833 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001834 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001835 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001836 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001837 */
1838//#define MBEDTLS_USE_PSA_CRYPTO
1839
1840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001842 *
1843 * Allow run-time checking of compile-time enabled features. Thus allowing users
1844 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001846 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001848 *
1849 * Comment this to disable run-time checking and save ROM space
1850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001852
1853/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001854 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001855 *
1856 * If set, the X509 parser will not break-off when parsing an X509 certificate
1857 * and encountering an extension in a v1 or v2 certificate.
1858 *
1859 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001862
1863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00001865 *
1866 * If set, the X509 parser will not break-off when parsing an X509 certificate
1867 * and encountering an unknown critical extension.
1868 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01001869 * \warning Depending on your PKI use, enabling this can be a security risk!
1870 *
Paul Bakker5c721f92011-07-27 16:51:09 +00001871 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00001872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00001874
1875/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001876 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1877 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001878 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001879 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1880 * the set of trusted certificates through a callback instead of a linked
1881 * list.
1882 *
1883 * This is useful for example in environments where a large number of trusted
1884 * certificates is present and storing them in a linked list isn't efficient
1885 * enough, or when the set of trusted certificates changes frequently.
1886 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001887 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001888 * `mbedtls_ssl_conf_ca_cb()` for more information.
1889 *
1890 * Uncomment to enable trusted certificate callbacks.
1891 */
1892//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1893
1894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001896 *
1897 * Enable verification of the keyUsage extension (CA and leaf certificates).
1898 *
1899 * Disabling this avoids problems with mis-issued and/or misused
1900 * (intermediate) CA and leaf certificates.
1901 *
1902 * \warning Depending on your PKI use, disabling this can be a security risk!
1903 *
1904 * Comment to skip keyUsage checking for both CA and leaf certificates.
1905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001907
1908/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001910 *
1911 * Enable verification of the extendedKeyUsage extension (leaf certificates).
1912 *
1913 * Disabling this avoids problems with mis-issued and/or misused certificates.
1914 *
1915 * \warning Depending on your PKI use, disabling this can be a security risk!
1916 *
1917 * Comment to skip extendedKeyUsage checking for certificates.
1918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001920
1921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001923 *
1924 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1925 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1926 *
1927 * Comment this macro to disallow using RSASSA-PSS in certificates.
1928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001930
1931/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00001933 *
1934 * If set, the SSL/TLS module uses ZLIB to support compression and
1935 * decompression of packet data.
1936 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01001937 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
1938 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01001939 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01001940 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02001941 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02001942 *
Hanno Beckere494e202018-03-08 13:26:12 +00001943 * \deprecated This feature is deprecated and will be removed
1944 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00001945 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00001946 * Used in: library/ssl_tls.c
1947 * library/ssl_cli.c
1948 * library/ssl_srv.c
1949 *
1950 * This feature requires zlib library and headers to be present.
1951 *
1952 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00001953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001955/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001956
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001957/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001958 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001959 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001960 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001961 * \{
1962 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001963
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001966 *
1967 * Enable AES-NI support on x86-64.
1968 *
1969 * Module: library/aesni.c
1970 * Caller: library/aes.c
1971 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001973 *
1974 * This modules adds support for the AES-NI instructions on x86-64
1975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001977
1978/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001980 *
1981 * Enable the AES block cipher.
1982 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001983 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001984 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001985 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00001986 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001987 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00001988 * This module enables the following ciphersuites (if other requisites are
1989 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1991 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1992 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1993 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1994 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1995 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1996 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1997 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1998 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1999 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2000 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2001 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2002 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2003 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2004 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2005 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2006 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2007 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2008 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2009 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2010 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2011 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2012 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2013 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2014 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2015 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2016 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2017 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2018 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2019 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2020 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2021 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2022 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2023 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2024 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2025 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2026 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2027 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2028 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2029 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2030 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2031 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2032 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2033 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2034 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2035 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2036 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2037 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2038 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2039 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2040 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2041 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2042 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2043 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2044 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2045 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2046 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2047 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002048 *
Paul Bakkercff68422013-09-15 20:43:33 +02002049 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002052
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002053/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002055 *
2056 * Enable the ARCFOUR stream cipher.
2057 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002058 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002059 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002060 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002061 * This module enables the following ciphersuites (if other requisites are
2062 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2064 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2065 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2066 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2067 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2068 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2069 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2070 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2071 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2072 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002073 *
2074 * \warning ARC4 is considered a weak cipher and its use constitutes a
2075 * security risk. If possible, we recommend avoidng dependencies on
2076 * it, and considering stronger ciphers instead.
2077 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002080
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002083 *
2084 * Enable the generic ASN1 parser.
2085 *
2086 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002087 * Caller: library/x509.c
2088 * library/dhm.c
2089 * library/pkcs12.c
2090 * library/pkcs5.c
2091 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002094
2095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002097 *
2098 * Enable the generic ASN1 writer.
2099 *
2100 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002101 * Caller: library/ecdsa.c
2102 * library/pkwrite.c
2103 * library/x509_create.c
2104 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002105 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002108
2109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002111 *
2112 * Enable the Base64 module.
2113 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002115 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002116 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002117 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002120
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002123 *
Paul Bakker9a736322012-11-14 12:39:52 +00002124 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002125 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002126 * Module: library/bignum.c
2127 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002128 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002129 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002130 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002131 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002132 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002133 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002134 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002137
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002140 *
2141 * Enable the Blowfish block cipher.
2142 *
2143 * Module: library/blowfish.c
2144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002146
2147/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002149 *
2150 * Enable the Camellia block cipher.
2151 *
Paul Bakker38119b12009-01-10 23:31:23 +00002152 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002153 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002154 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002155 * This module enables the following ciphersuites (if other requisites are
2156 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2158 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2159 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2160 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2161 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2162 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2163 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2164 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2165 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2166 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2167 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2168 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2169 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2170 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2171 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2172 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2173 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2174 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2175 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2176 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2177 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2178 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2179 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2180 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2181 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2182 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2183 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2184 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2185 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2186 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2187 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2188 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2189 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2190 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2191 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2192 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2193 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2194 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2195 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2196 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2197 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2198 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002201
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002202/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002203 * \def MBEDTLS_ARIA_C
2204 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002205 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002206 *
2207 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002208 * Caller: library/cipher.c
2209 *
2210 * This module enables the following ciphersuites (if other requisites are
2211 * enabled as well):
2212 *
2213 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2214 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2215 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2216 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2217 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2218 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2219 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2220 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2221 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2222 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2223 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2224 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2225 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2226 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2227 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2228 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2229 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2230 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2231 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2232 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2233 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2234 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2235 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2236 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2237 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2238 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2239 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2240 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2241 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2242 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2243 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2244 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2245 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2246 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2247 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2248 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2249 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2250 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002251 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002252//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002253
2254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002256 *
2257 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2258 *
2259 * Module: library/ccm.c
2260 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002262 *
2263 * This module enables the AES-CCM ciphersuites, if other requisites are
2264 * enabled as well.
2265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002267
2268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002270 *
2271 * Enable the test certificates.
2272 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002273 * Module: library/certs.c
2274 * Caller:
2275 *
2276 * This module is used for testing (ssl_client/server).
2277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002279
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002280/**
Daniel King34b822c2016-05-15 17:28:08 -03002281 * \def MBEDTLS_CHACHA20_C
2282 *
2283 * Enable the ChaCha20 stream cipher.
2284 *
2285 * Module: library/chacha20.c
2286 */
2287#define MBEDTLS_CHACHA20_C
2288
2289/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002290 * \def MBEDTLS_CHACHAPOLY_C
2291 *
2292 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2293 *
2294 * Module: library/chachapoly.c
2295 *
2296 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2297 */
2298#define MBEDTLS_CHACHAPOLY_C
2299
2300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002302 *
2303 * Enable the generic cipher layer.
2304 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002305 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002306 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002307 *
2308 * Uncomment to enable generic cipher wrappers.
2309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002311
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002312/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002313 * \def MBEDTLS_CMAC_C
2314 *
Simon Butcher327398a2016-10-05 14:09:11 +01002315 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2316 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002317 *
2318 * Module: library/cmac.c
2319 *
Simon Butcher69283e52016-10-06 12:49:58 +01002320 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002321 *
2322 */
Gilles Peskinee59236f2018-01-27 23:32:46 +01002323#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002324
2325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002327 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002328 * Enable the CTR_DRBG AES-based random generator.
2329 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002330 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002331 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002332 * \note To achieve a 256-bit security strength with CTR_DRBG,
2333 * you must use AES-256 *and* use sufficient entropy.
2334 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002335 *
2336 * Module: library/ctr_drbg.c
2337 * Caller:
2338 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002340 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002341 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002344
2345/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002347 *
2348 * Enable the debug functions.
2349 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 * Module: library/debug.c
2351 * Caller: library/ssl_cli.c
2352 * library/ssl_srv.c
2353 * library/ssl_tls.c
2354 *
2355 * This module provides debugging functions.
2356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002358
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002361 *
2362 * Enable the DES block cipher.
2363 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002364 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002365 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002366 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002367 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002368 * This module enables the following ciphersuites (if other requisites are
2369 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2371 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2372 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2373 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2374 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2375 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2376 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2377 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2378 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2379 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002380 *
Paul Bakkercff68422013-09-15 20:43:33 +02002381 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002382 *
2383 * \warning DES is considered a weak cipher and its use constitutes a
2384 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002387
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002390 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002391 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002392 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002393 * Module: library/dhm.c
2394 * Caller: library/ssl_cli.c
2395 * library/ssl_srv.c
2396 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002397 * This module is used by the following key exchanges:
2398 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002399 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002400 * \warning Using DHE constitutes a security risk as it
2401 * is not possible to validate custom DH parameters.
2402 * If possible, it is recommended users should consider
2403 * preferring other methods of key exchange.
2404 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002405 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002408
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002411 *
2412 * Enable the elliptic curve Diffie-Hellman library.
2413 *
2414 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002415 * Caller: library/ssl_cli.c
2416 * library/ssl_srv.c
2417 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002418 * This module is used by the following key exchanges:
2419 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002420 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002424
2425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002427 *
2428 * Enable the elliptic curve DSA library.
2429 *
2430 * Module: library/ecdsa.c
2431 * Caller:
2432 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002433 * This module is used by the following key exchanges:
2434 * ECDHE-ECDSA
2435 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002439
2440/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002441 * \def MBEDTLS_ECJPAKE_C
2442 *
2443 * Enable the elliptic curve J-PAKE library.
2444 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002445 * \warning This is currently experimental. EC J-PAKE support is based on the
2446 * Thread v1.0.0 specification; incompatible changes to the specification
2447 * might still happen. For this reason, this is disabled by default.
2448 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002449 * Module: library/ecjpake.c
2450 * Caller:
2451 *
2452 * This module is used by the following key exchanges:
2453 * ECJPAKE
2454 *
2455 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2456 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002457//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002458
2459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002461 *
2462 * Enable the elliptic curve over GF(p) library.
2463 *
2464 * Module: library/ecp.c
2465 * Caller: library/ecdh.c
2466 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002467 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002468 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002470 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002472
2473/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002475 *
2476 * Enable the platform-specific entropy code.
2477 *
2478 * Module: library/entropy.c
2479 * Caller:
2480 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002482 *
2483 * This module provides a generic entropy pool
2484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002486
2487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002489 *
2490 * Enable error code to error string conversion.
2491 *
2492 * Module: library/error.c
2493 * Caller:
2494 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002498
2499/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002501 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002502 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002503 *
2504 * Module: library/gcm.c
2505 *
Jaeden Amero651ae682019-04-10 18:19:16 +01002506 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002507 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002508 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2509 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002512
2513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002515 *
2516 * Enable the HAVEGE random generator.
2517 *
Paul Bakker2a844242013-06-24 13:01:53 +02002518 * Warning: the HAVEGE random generator is not suitable for virtualized
2519 * environments
2520 *
2521 * Warning: the HAVEGE random generator is dependent on timing and specific
2522 * processor traits. It is therefore not advised to use HAVEGE as
2523 * your applications primary random generator or primary entropy pool
2524 * input. As a secondary input to your entropy pool, it IS able add
2525 * the (limited) extra entropy it provides.
2526 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002527 * Module: library/havege.c
2528 * Caller:
2529 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002531 *
Paul Bakker2a844242013-06-24 13:01:53 +02002532 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002536/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002537 * \def MBEDTLS_HKDF_C
2538 *
2539 * Enable the HKDF algorithm (RFC 5869).
2540 *
2541 * Module: library/hkdf.c
2542 * Caller:
2543 *
2544 * Requires: MBEDTLS_MD_C
2545 *
2546 * This module adds support for the Hashed Message Authentication Code
2547 * (HMAC)-based key derivation function (HKDF).
2548 */
2549#define MBEDTLS_HKDF_C
2550
2551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002553 *
2554 * Enable the HMAC_DRBG random generator.
2555 *
2556 * Module: library/hmac_drbg.c
2557 * Caller:
2558 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002560 *
2561 * Uncomment to enable the HMAC_DRBG random number geerator.
2562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002564
2565/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002566 * \def MBEDTLS_NIST_KW_C
2567 *
2568 * Enable the Key Wrapping mode for 128-bit block ciphers,
2569 * as defined in NIST SP 800-38F. Only KW and KWP modes
2570 * are supported. At the moment, only AES is approved by NIST.
2571 *
2572 * Module: library/nist_kw.c
2573 *
2574 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2575 */
2576//#define MBEDTLS_NIST_KW_C
2577
2578/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002579 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002580 *
2581 * Enable the generic message digest layer.
2582 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002583 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002584 * Caller:
2585 *
2586 * Uncomment to enable generic message digest wrappers.
2587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002589
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002592 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002593 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002594 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002595 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002596 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002597 *
2598 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002599 *
2600 * \warning MD2 is considered a weak message digest and its use constitutes a
2601 * security risk. If possible, we recommend avoiding dependencies on
2602 * it, and considering stronger message digests instead.
2603 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002606
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002609 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002610 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002611 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002612 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002613 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002614 *
2615 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002616 *
2617 * \warning MD4 is considered a weak message digest and its use constitutes a
2618 * security risk. If possible, we recommend avoiding dependencies on
2619 * it, and considering stronger message digests instead.
2620 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002623
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002624/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002626 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002627 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002628 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002629 * Module: library/md5.c
2630 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002631 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002632 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002633 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002634 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2635 * depending on the handshake parameters. Further, it is used for checking
2636 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2637 * encrypted keys.
2638 *
2639 * \warning MD5 is considered a weak message digest and its use constitutes a
2640 * security risk. If possible, we recommend avoiding dependencies on
2641 * it, and considering stronger message digests instead.
2642 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002645
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002648 *
2649 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002650 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002651 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002652 *
2653 * Module: library/memory_buffer_alloc.c
2654 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655 * Requires: MBEDTLS_PLATFORM_C
2656 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002657 *
2658 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002661
2662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002664 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002665 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2666 *
Simon Butcherd567a232016-03-09 20:19:21 +00002667 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2668 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002669 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002670 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002671 * \note See also our Knowledge Base article about porting to a new
2672 * environment:
2673 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2674 *
Andres AG788aa4a2016-09-14 14:32:09 +01002675 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002676 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002677 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002680
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002683 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002684 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002685 *
2686 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002687 * Caller: library/asn1write.c
2688 * library/pkcs5.c
2689 * library/pkparse.c
2690 * library/pkwrite.c
2691 * library/rsa.c
2692 * library/x509.c
2693 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002694 * library/x509_crl.c
2695 * library/x509_crt.c
2696 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002697 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002698 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002699 *
2700 * This modules translates between OIDs and internal values.
2701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002703
2704/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002706 *
2707 * Enable VIA Padlock support on x86.
2708 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002709 * Module: library/padlock.c
2710 * Caller: library/aes.c
2711 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002713 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002714 * This modules adds support for the VIA PadLock on x86.
2715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002717
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002720 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002721 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002722 *
2723 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002724 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002725 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002726 * library/x509_crl.c
2727 * library/x509_crt.c
2728 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002729 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002731 *
Paul Bakkercff68422013-09-15 20:43:33 +02002732 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002735
2736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002738 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002739 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002740 *
2741 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002742 * Caller: library/pkwrite.c
2743 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002744 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002745 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002747 *
2748 * This modules adds support for encoding / writing PEM files.
2749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002751
2752/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002754 *
2755 * Enable the generic public (asymetric) key layer.
2756 *
2757 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002758 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002759 * library/ssl_cli.c
2760 * library/ssl_srv.c
2761 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002762 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002763 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002764 * Uncomment to enable generic public key wrappers.
2765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002767
2768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002770 *
2771 * Enable the generic public (asymetric) key parser.
2772 *
2773 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002774 * Caller: library/x509_crt.c
2775 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002776 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002778 *
2779 * Uncomment to enable generic public key parse functions.
2780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002782
2783/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002785 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002786 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002787 *
2788 * Module: library/pkwrite.c
2789 * Caller: library/x509write.c
2790 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002792 *
2793 * Uncomment to enable generic public key write functions.
2794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002796
2797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002799 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002800 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002801 *
2802 * Module: library/pkcs5.c
2803 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002805 *
2806 * This module adds support for the PKCS#5 functions.
2807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002809
2810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002812 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01002813 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00002814 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00002815 * \deprecated This option is deprecated and will be removed in a future
2816 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00002817 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02002818 * Module: library/pkcs11.c
2819 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002820 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002822 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00002823 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00002824 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00002825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002827
2828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002830 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002831 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002832 * Adds algorithms for parsing PKCS#8 encrypted private keys
2833 *
2834 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002835 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002836 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2838 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002839 *
2840 * This module enables PKCS#12 functions.
2841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002843
2844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002846 *
2847 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002848 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002849 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2851 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002852 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002853 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002854 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2855 * as other module rely on it for a fixed snprintf implementation.
2856 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002857 * Module: library/platform.c
2858 * Caller: Most other .c files
2859 *
2860 * This module enables abstraction of common (libc) functions.
2861 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002862#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002863
2864/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002865 * \def MBEDTLS_POLY1305_C
2866 *
2867 * Enable the Poly1305 MAC algorithm.
2868 *
2869 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002870 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002871 */
2872#define MBEDTLS_POLY1305_C
2873
2874/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002875 * \def MBEDTLS_PSA_CRYPTO_C
2876 *
2877 * Enable the Platform Security Architecture cryptography API.
2878 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002879 * \warning The PSA Crypto API is still beta status. While you're welcome to
2880 * experiment using it, incompatible API changes are still possible, and some
2881 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01002882 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002883 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002884 *
2885 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
2886 *
2887 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002888#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002889
2890/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002891 * \def MBEDTLS_PSA_CRYPTO_SE_C
2892 *
2893 * Enable secure element support in the Platform Security Architecture
2894 * cryptography API.
2895 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02002896 * \warning This feature is not yet suitable for production. It is provided
2897 * for API evaluation and testing purposes only.
2898 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002899 * Module: library/psa_crypto_se.c
2900 *
2901 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2902 *
2903 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002904//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002905
2906/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002907 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2908 *
2909 * Enable the Platform Security Architecture persistent key storage.
2910 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002911 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002912 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002913 * Requires: MBEDTLS_PSA_CRYPTO_C,
2914 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2915 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002916 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002917#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002918
2919/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002920 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002921 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002922 * Enable the emulation of the Platform Security Architecture
2923 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002924 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002925 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002926 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002927 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002928 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002929#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002930
2931/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002933 *
2934 * Enable the RIPEMD-160 hash algorithm.
2935 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002936 * Module: library/ripemd160.c
2937 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002938 *
2939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002941
2942/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002944 *
2945 * Enable the RSA public-key cryptosystem.
2946 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002947 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002948 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002949 * Caller: library/ssl_cli.c
2950 * library/ssl_srv.c
2951 * library/ssl_tls.c
2952 * library/x509.c
2953 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002954 * This module is used by the following key exchanges:
2955 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002956 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002960
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002963 *
2964 * Enable the SHA1 cryptographic hash algorithm.
2965 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002966 * Module: library/sha1.c
2967 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002968 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002969 * library/ssl_srv.c
2970 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002971 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002972 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02002973 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
2974 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002975 *
2976 * \warning SHA-1 is considered a weak message digest and its use constitutes
2977 * a security risk. If possible, we recommend avoiding dependencies
2978 * on it, and considering stronger message digests instead.
2979 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002982
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002985 *
2986 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
2987 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002988 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002989 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002990 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002991 * library/ssl_cli.c
2992 * library/ssl_srv.c
2993 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002994 *
2995 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002996 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002999
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003002 *
3003 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3004 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003005 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003006 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003007 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003008 * library/ssl_cli.c
3009 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003010 *
3011 * This module adds support for SHA-384 and SHA-512.
3012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003014
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003017 *
3018 * Enable simple SSL cache implementation.
3019 *
3020 * Module: library/ssl_cache.c
3021 * Caller:
3022 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003026
3027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003029 *
3030 * Enable basic implementation of DTLS cookies for hello verification.
3031 *
3032 * Module: library/ssl_cookie.c
3033 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003036
3037/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003038 * \def MBEDTLS_SSL_TICKET_C
3039 *
3040 * Enable an implementation of TLS server-side callbacks for session tickets.
3041 *
3042 * Module: library/ssl_ticket.c
3043 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003044 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003045 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003046 */
3047#define MBEDTLS_SSL_TICKET_C
3048
3049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003051 *
3052 * Enable the SSL/TLS client code.
3053 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003054 * Module: library/ssl_cli.c
3055 * Caller:
3056 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003058 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003059 * This module is required for SSL/TLS client support.
3060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003062
Paul Bakker9a736322012-11-14 12:39:52 +00003063/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003065 *
3066 * Enable the SSL/TLS server code.
3067 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003068 * Module: library/ssl_srv.c
3069 * Caller:
3070 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003072 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003073 * This module is required for SSL/TLS server support.
3074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003076
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003079 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003080 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003081 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003082 * Module: library/ssl_tls.c
3083 * Caller: library/ssl_cli.c
3084 * library/ssl_srv.c
3085 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3087 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003088 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003089 * This module is required for SSL/TLS.
3090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003092
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003095 *
3096 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003097 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003098 * contexts are not shared between threads. If you do intend to use contexts
3099 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003100 * conditions. See also our Knowledge Base article about threading:
3101 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003102 *
3103 * Module: library/threading.c
3104 *
3105 * This allows different threading implementations (self-implemented or
3106 * provided).
3107 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108 * You will have to enable either MBEDTLS_THREADING_ALT or
3109 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003110 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003111 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003114
3115/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003117 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003118 * Enable the semi-portable timing interface.
3119 *
Simon Butcherd567a232016-03-09 20:19:21 +00003120 * \note The provided implementation only works on POSIX/Unix (including Linux,
3121 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003122 * module and provide your own implementations of the callbacks needed by
3123 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3124 * your own implementation of the whole module by setting
3125 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003126 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003127 * \note See also our Knowledge Base article about porting to a new
3128 * environment:
3129 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3130 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003131 * Module: library/timing.c
3132 * Caller: library/havege.c
3133 *
3134 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003137
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003140 *
3141 * Enable run-time version information.
3142 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003143 * Module: library/version.c
3144 *
3145 * This module provides run-time version information.
3146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003148
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003149/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003151 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003152 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003153 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003154 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003155 * Caller: library/x509_crl.c
3156 * library/x509_crt.c
3157 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003158 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3160 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003161 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003162 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003165
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003168 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003169 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003170 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003171 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003172 * Caller: library/ssl_cli.c
3173 * library/ssl_srv.c
3174 * library/ssl_tls.c
3175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003177 *
3178 * This module is required for X.509 certificate parsing.
3179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003180#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003181
3182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003184 *
3185 * Enable X.509 CRL parsing.
3186 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003187 * Module: library/x509_crl.c
3188 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003189 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003191 *
3192 * This module is required for X.509 CRL parsing.
3193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003195
3196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003198 *
3199 * Enable X.509 Certificate Signing Request (CSR) parsing.
3200 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003201 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003202 * Caller: library/x509_crt_write.c
3203 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003205 *
3206 * This module is used for reading X.509 certificate request.
3207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003209
3210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003212 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003213 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003214 *
3215 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003216 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003218 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003219 * This module is the basis for creating X.509 certificates and CSRs.
3220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003222
3223/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003225 *
3226 * Enable creating X.509 certificates.
3227 *
3228 * Module: library/x509_crt_write.c
3229 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003231 *
3232 * This module is required for X.509 certificate creation.
3233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003235
3236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003238 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003239 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003240 *
3241 * Module: library/x509_csr_write.c
3242 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003244 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003245 * This module is required for X.509 certificate request writing.
3246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003248
3249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003252 * Enable the XTEA block cipher.
3253 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003254 * Module: library/xtea.c
3255 * Caller:
3256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003258
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003259/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003260
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003261/**
3262 * \name SECTION: Module configuration options
3263 *
3264 * This section allows for the setting of module specific sizes and
3265 * configuration options. The default values are already present in the
3266 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003267 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003268 * Our advice is to enable options and change their values here
3269 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003270 *
3271 * Please check the respective header file for documentation on these
3272 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003273 * \{
3274 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003275
Paul Bakker088c5c52014-04-25 11:11:10 +02003276/* MPI / BIGNUM options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
3278//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003279
Paul Bakker088c5c52014-04-25 11:11:10 +02003280/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003281//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3282//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3283//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3284//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3285//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003286
Paul Bakker088c5c52014-04-25 11:11:10 +02003287/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3289//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3290//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3291//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003292
Paul Bakker088c5c52014-04-25 11:11:10 +02003293/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3295//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3296//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003297
Paul Bakker088c5c52014-04-25 11:11:10 +02003298/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3300//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003301//#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 +01003302
Paul Bakker088c5c52014-04-25 11:11:10 +02003303/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003305
Paul Bakker088c5c52014-04-25 11:11:10 +02003306/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307//#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 +02003308//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3310//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003311//#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 +02003312//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3313//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003314/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003316//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3317//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003318//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3319//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3320//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3323/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003324//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3326//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003327//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3328//#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 +02003329//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3330//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003331/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003333//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003334//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3335//#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 +02003336
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003337/**
3338 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003339 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003340 * (see the documentation of that option for context).
3341 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003342 * When you leave this undefined here, the library provides
3343 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3344 * is defined, the default definition is `assert(cond)`,
3345 * otherwise the default definition calls a function
3346 * mbedtls_param_failed(). This function is declared in
3347 * `platform_util.h` for the benefit of the library, but
3348 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003349 *
3350 * When you define this here, this replaces the default
3351 * definition in platform_util.h (which no longer declares the
3352 * function mbedtls_param_failed()) and it is your responsibility
3353 * to make sure this macro expands to something suitable (in
3354 * particular, that all the necessary declarations are visible
3355 * from within the library - you can ensure that by providing
3356 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003357 * If you define this macro to call `assert`, also define
3358 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3359 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003360 *
3361 * Note that you may define this macro to expand to nothing, in
3362 * which case you don't have to worry about declarations or
3363 * definitions. However, you will then be notified about invalid
3364 * parameters only in non-void functions, and void function will
3365 * just silently return early on invalid parameters, which
3366 * partially negates the benefits of enabling
3367 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3368 *
3369 * \param cond The expression that should evaluate to true, but doesn't.
3370 */
3371//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3372
Paul Bakker088c5c52014-04-25 11:11:10 +02003373/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3375//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003376
Paul Bakker088c5c52014-04-25 11:11:10 +02003377/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003378
3379/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3380 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003381 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003382 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003383 * This determines the size of both the incoming and outgoing TLS I/O buffers
3384 * in such a way that both are capable of holding the specified amount of
3385 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003386 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003387 * To configure incoming and outgoing I/O buffers separately, use
3388 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3389 * which overwrite the value set by this option.
3390 *
3391 * \note When using a value less than the default of 16KB on the client, it is
3392 * recommended to use the Maximum Fragment Length (MFL) extension to
3393 * inform the server about this limitation. On the server, there
3394 * is no supported, standardized way of informing the client about
3395 * restriction on the maximum size of incoming messages, and unless
3396 * the limitation has been communicated by other means, it is recommended
3397 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3398 * while keeping the default value of 16KB for the incoming buffer.
3399 *
3400 * Uncomment to set the maximum plaintext size of both
3401 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003402 */
3403//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3404
3405/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3406 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003407 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003408 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003409 * This determines the size of the incoming TLS I/O buffer in such a way
3410 * that it is capable of holding the specified amount of plaintext data,
3411 * regardless of the protection mechanism used.
3412 *
3413 * If this option is undefined, it inherits its value from
3414 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3415 *
3416 * \note When using a value less than the default of 16KB on the client, it is
3417 * recommended to use the Maximum Fragment Length (MFL) extension to
3418 * inform the server about this limitation. On the server, there
3419 * is no supported, standardized way of informing the client about
3420 * restriction on the maximum size of incoming messages, and unless
3421 * the limitation has been communicated by other means, it is recommended
3422 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3423 * while keeping the default value of 16KB for the incoming buffer.
3424 *
3425 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3426 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003427 */
3428//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3429
3430/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3431 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003432 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003433 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003434 * This determines the size of the outgoing TLS I/O buffer in such a way
3435 * that it is capable of holding the specified amount of plaintext data,
3436 * regardless of the protection mechanism used.
3437 *
3438 * If this option undefined, it inherits its value from
3439 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003440 *
3441 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3442 * the default inward 16384 byte buffer to conform to the TLS specification.
3443 *
3444 * The minimum required outward buffer size is determined by the handshake
3445 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3446 * The specific size requirement depends on the configured ciphers and any
3447 * certificate data which is sent during the handshake.
3448 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003449 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3450 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003451 */
3452//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3453
Hanno Beckere0b150f2018-08-21 15:51:03 +01003454/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3455 *
3456 * Maximum number of heap-allocated bytes for the purpose of
3457 * DTLS handshake message reassembly and future message buffering.
3458 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003459 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003460 * to account for a reassembled handshake message of maximum size,
3461 * together with its reassembly bitmap.
3462 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003463 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003464 * should be sufficient for all practical situations as it allows
3465 * to reassembly a large handshake message (such as a certificate)
3466 * while buffering multiple smaller handshake messages.
3467 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003468 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003469//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003471//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3472//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3473//#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 +02003474
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003475/**
3476 * Complete list of ciphersuites to use, in order of preference.
3477 *
3478 * \warning No dependency checking is done on that field! This option can only
3479 * be used to restrict the set of available ciphersuites. It is your
3480 * responsibility to make sure the needed modules are active.
3481 *
3482 * Use this to save a few hundred bytes of ROM (default ordering of all
3483 * available ciphersuites) and a few to a few hundred bytes of RAM.
3484 *
3485 * The value below is only an example, not the default.
3486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487//#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 +02003488
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003489/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003491//#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 +01003492
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003493/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003494 * Allow SHA-1 in the default TLS configuration for certificate signing.
3495 * Without this build-time option, SHA-1 support must be activated explicitly
3496 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003497 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003498 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003499 *
3500 * \warning SHA-1 is considered a weak message digest and its use constitutes
3501 * a security risk. If possible, we recommend avoiding dependencies
3502 * on it, and considering stronger message digests instead.
3503 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003504 */
Gilles Peskine4e117492020-02-26 18:56:08 +01003505// #define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003506
3507/**
3508 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3509 * signature and ciphersuite selection. Without this build-time option, SHA-1
3510 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3511 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3512 * default. At the time of writing, there is no practical attack on the use
3513 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003514 * to preserve compatibility with existing peers, but the general
3515 * warning applies nonetheless:
3516 *
3517 * \warning SHA-1 is considered a weak message digest and its use constitutes
3518 * a security risk. If possible, we recommend avoiding dependencies
3519 * on it, and considering stronger message digests instead.
3520 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003521 */
3522#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003523
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003524/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003525 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003526 * mbedtls_platform_zeroize(). This replaces the default implementation in
3527 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003528 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003529 * mbedtls_platform_zeroize() is a widely used function across the library to
3530 * zero a block of memory. The implementation is expected to be secure in the
3531 * sense that it has been written to prevent the compiler from removing calls
3532 * to mbedtls_platform_zeroize() as part of redundant code elimination
3533 * optimizations. However, it is difficult to guarantee that calls to
3534 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3535 * versions of the C language standards do not provide a secure implementation
3536 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3537 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003538 * example by using directives specific to their compiler, features from newer
3539 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003540 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003541 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003542//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003543
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003544/**
3545 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003546 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003547 * platform_util.c.
3548 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003549 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003550 * library will try to use safer implementations of this function, such as
3551 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003552 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003553 * using the standard gmtime(). In this case, calls from the library to
3554 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003555 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003556 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003557 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3558 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3559 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003560 */
Hanno Becker6a739782018-09-05 15:06:19 +01003561//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003562
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003563/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003564 * Enable the verified implementations of ECDH primitives from Project Everest
3565 * (currently only Curve25519). This feature changes the layout of ECDH
3566 * contexts and therefore is a compatibility break for applications that access
3567 * fields of a mbedtls_ecdh_context structure directly. See also
3568 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003569 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003570//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003571
Simon Butcher30b5f972016-06-08 19:00:23 +01003572/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003573
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003574/* Target and application specific configurations
3575 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003576 * Allow user to override any previous default.
3577 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003578 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003579#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003580#include MBEDTLS_USER_CONFIG_FILE
3581#endif
3582
Jaeden Amero6609aef2019-07-04 20:01:14 +01003583#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585#endif /* MBEDTLS_CONFIG_H */