blob: a57eac958e50e1922aa81d96390bbfebec616ad5 [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 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_MD2_PROCESS_ALT
446//#define MBEDTLS_MD4_PROCESS_ALT
447//#define MBEDTLS_MD5_PROCESS_ALT
448//#define MBEDTLS_RIPEMD160_PROCESS_ALT
449//#define MBEDTLS_SHA1_PROCESS_ALT
450//#define MBEDTLS_SHA256_PROCESS_ALT
451//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200452//#define MBEDTLS_DES_SETKEY_ALT
453//#define MBEDTLS_DES_CRYPT_ECB_ALT
454//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200455//#define MBEDTLS_AES_SETKEY_ENC_ALT
456//#define MBEDTLS_AES_SETKEY_DEC_ALT
457//#define MBEDTLS_AES_ENCRYPT_ALT
458//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300459//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300460//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300461//#define MBEDTLS_ECDSA_VERIFY_ALT
462//#define MBEDTLS_ECDSA_SIGN_ALT
463//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200464
465/**
Janos Follathc44ab972016-11-18 16:38:23 +0000466 * \def MBEDTLS_ECP_INTERNAL_ALT
467 *
468 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100469 *
470 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100471 * alternative core implementation of elliptic curve arithmetic. Keep in mind
472 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100473 *
474 * This partially replaces one function. The header file from mbed TLS is still
475 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
476 * is still present and it is used for group structures not supported by the
477 * alternative.
478 *
Janos Follathc44ab972016-11-18 16:38:23 +0000479 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
480 * and implementing the following functions:
481 * unsigned char mbedtls_internal_ecp_grp_capable(
482 * const mbedtls_ecp_group *grp )
483 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500484 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000485 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
486 * replacement functions implement arithmetic for the given group and 0
487 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500488 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000489 * called before and after each point operation and provide an opportunity to
490 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100491 *
Janos Follathc44ab972016-11-18 16:38:23 +0000492 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
Janos Follath4d9c69d2016-11-01 13:27:03 +0000493 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
Janos Follathc44ab972016-11-18 16:38:23 +0000494 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
495 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
496 * receives it as an argument). If the group is not supported then the original
Janos Follathee782bc2016-11-07 15:41:26 +0000497 * implementation is used. The other functions and the definition of
498 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
Janos Follathc44ab972016-11-18 16:38:23 +0000499 * implementation of mbedtls_internal_ecp_double_jac and
500 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
Janos Follathb0697532016-08-18 12:38:46 +0100501 *
502 * Uncomment a macro to enable alternate implementation of the corresponding
503 * function.
504 */
505/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000506//#define MBEDTLS_ECP_INTERNAL_ALT
Janos Follathb0697532016-08-18 12:38:46 +0100507/* Support for Weierstrass curves with Jacobi representation */
508//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
509//#define MBEDTLS_ECP_ADD_MIXED_ALT
510//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
511//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
512//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
513/* Support for curves with Montgomery arithmetic */
514//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
515//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
516//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
517
518/**
Simon Butcherab5df402016-06-11 02:31:21 +0100519 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100520 *
Simon Butcherab5df402016-06-11 02:31:21 +0100521 * Enables testing and use of mbed TLS without any configured entropy sources.
522 * This permits use of the library on platforms before an entropy source has
523 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
524 * MBEDTLS_ENTROPY_NV_SEED switches).
525 *
526 * WARNING! This switch MUST be disabled in production builds, and is suitable
527 * only for development.
528 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100529 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100530 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
531 *
Janos Follath53de7842016-06-08 15:29:18 +0100532 */
Simon Butcherab5df402016-06-11 02:31:21 +0100533//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100534
535/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200536 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200537 *
538 * Uncomment this macro to let mbed TLS use your own implementation of a
539 * hardware entropy collector.
540 *
541 * Your function must be called \c mbedtls_hardware_poll(), have the same
542 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
543 *
544 * Uncomment to use your own hardware entropy collector.
545 */
546//#define MBEDTLS_ENTROPY_HARDWARE_ALT
547
548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000550 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100551 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000552 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100553 * Uncomment this macro to use precomputed AES tables stored in ROM.
554 * Comment this macro to generate AES tables in RAM at runtime.
555 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100556 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
557 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100558 * initialization time before the first AES operation can be performed.
559 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
560 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
561 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 *
563 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
564 *
Paul Bakker15566e42011-04-24 21:19:15 +0000565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000567
568/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100569 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200570 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200572 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100573 * Uncommenting this macro omits 75% of the AES tables from
574 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
575 * by computing their values on the fly during operations
576 * (the tables are entry-wise rotations of one another).
577 *
578 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100579 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100580 * runtime. Specifically, one has to compare 4 accesses within
581 * different tables to 4 accesses with additional arithmetic
582 * operations within the same table. The performance gain/loss
583 * depends on the system and memory details.
584 *
585 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
586 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200587 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100588//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200589
590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200592 *
593 * Use less ROM for the Camellia implementation (saves about 768 bytes).
594 *
595 * Uncomment this macro to use less memory for Camellia.
596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200598
599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200601 *
602 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200605
606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000608 *
609 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000612
613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000615 *
616 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000619
620/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100621 * \def MBEDTLS_CIPHER_MODE_OFB
622 *
623 * Enable Output Feedback mode (OFB) for symmetric ciphers.
624 */
625#define MBEDTLS_CIPHER_MODE_OFB
626
627/**
628 * \def MBEDTLS_CIPHER_MODE_XTS
629 *
630 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
631 */
632#define MBEDTLS_CIPHER_MODE_XTS
633
634/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000636 *
637 * Enable NULL cipher.
638 * Warning: Only do so when you know what you are doing. This allows for
639 * encryption or channels without any security!
640 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000642 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
644 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
645 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
646 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
647 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
648 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
649 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
650 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
651 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
652 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
653 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
654 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
655 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
656 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
657 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
658 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
659 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
660 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
661 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000662 *
663 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000666
667/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100668 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200669 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100670 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
671 * specific padding modes in the cipher layer with cipher modes that support
672 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200673 *
674 * If you disable all padding modes, only full blocks can be used with CBC.
675 *
676 * Enable padding modes in the cipher layer.
677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678#define MBEDTLS_CIPHER_PADDING_PKCS7
679#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
680#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
681#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200682
683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000685 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200686 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000687 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000688 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000689 *
690 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
692 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000693 *
694 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100695 *
696 * \warning DES is considered a weak cipher and its use constitutes a
697 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000700
701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200703 *
704 * Remove RC4 ciphersuites by default in SSL / TLS.
705 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200707 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200708 * explicitly.
709 *
710 * Uncomment this macro to remove RC4 ciphersuites by default.
711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200713
714/**
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000715 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
716 *
717 * Remove 3DES ciphersuites by default in SSL / TLS.
718 * This flag removes the ciphersuites based on 3DES from the default list as
719 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
720 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
721 * them explicitly.
722 *
Andres Amaya Garciabdfba792019-02-11 21:47:30 +0000723 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia22a89052018-11-26 20:57:49 +0000724 * a TLS connection using a 3DES based cipher suite (see "On the Practical
725 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
726 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
727 * in your threat model or you are unsure, then you should keep this option
728 * enabled to remove 3DES based cipher suites.
729 *
Andres Amaya Garcia4a512282018-10-30 18:21:41 +0000730 * Comment this macro to keep 3DES in the default ciphersuite list.
731 */
732#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
733
734/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100735 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200736 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100737 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
738 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200739 *
740 * Comment macros to disable the curve and functions for it
741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200742#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
743#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
744#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
745#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
746#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
747#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
748#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
749#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
750#define MBEDTLS_ECP_DP_BP256R1_ENABLED
751#define MBEDTLS_ECP_DP_BP384R1_ENABLED
752#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200753#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000754#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200755
756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200758 *
759 * Enable specific 'modulo p' routines for each NIST prime.
760 * Depending on the prime and architecture, makes operations 4 to 8 times
761 * faster on the corresponding curve.
762 *
763 * Comment this macro to disable NIST curves optimisation.
764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200766
767/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200768 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100769 *
770 * Enable "non-blocking" ECC operations that can return early and be resumed.
771 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200772 * This allows various functions to pause by returning
773 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
774 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
775 * order to further progress and eventually complete their operation. This is
776 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
777 * number of ECC operations a function may perform before pausing; see
778 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100779 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200780 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200781 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100782 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200783 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200784 *
Ron Eldor19779c42018-11-05 16:58:13 +0200785 * \note This option only works with the default software implementation of
786 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100787 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
788 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100789 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200790//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100791
792/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100793 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
794 *
795 * Use a backward compatible ECDH context.
796 *
797 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
798 * defined in `ecdh.h`). For most applications, the choice of format makes
799 * no difference, since all library functions can work with either format,
800 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
801
802 * The new format used when this option is disabled is smaller
803 * (56 bytes on a 32-bit platform). In future versions of the library, it
804 * will support alternative implementations of ECDH operations.
805 * The new format is incompatible with applications that access
806 * context fields directly and with restartable ECP operations.
807 *
808 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
809 * want to access ECDH context fields directly. Otherwise you should
810 * comment out this macro definition.
811 *
812 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
813 *
814 * \note This configuration option is experimental. Future versions of the
815 * library may modify the way the ECDH context layout is configured
816 * and may modify the layout of the new context type.
817 */
818#define MBEDTLS_ECDH_LEGACY_CONTEXT
819
820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100822 *
823 * Enable deterministic ECDSA (RFC 6979).
824 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
825 * may result in a compromise of the long-term signing key. This is avoided by
826 * the deterministic variant.
827 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 * Requires: MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100829 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100830 * Comment this macro to disable deterministic ECDSA.
831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100833
834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200837 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200838 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839 * This enables the following ciphersuites (if other requisites are
840 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
842 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
843 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
844 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
845 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
846 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
847 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
848 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
849 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
850 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
851 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
852 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200855
856/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200859 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862 *
863 * This enables the following ciphersuites (if other requisites are
864 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
866 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
867 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
868 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
869 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
870 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
871 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
872 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
873 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
874 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
875 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
876 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100877 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100878 * \warning Using DHE constitutes a security risk as it
879 * is not possible to validate custom DH parameters.
880 * If possible, it is recommended users should consider
881 * preferring other methods of key exchange.
882 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100883 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886
887/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200889 *
890 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
891 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200893 *
894 * This enables the following ciphersuites (if other requisites are
895 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
897 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
898 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
899 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
900 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
901 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
902 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
903 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200910 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200911 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
913 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200914 *
915 * This enables the following ciphersuites (if other requisites are
916 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
918 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
919 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
920 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
921 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
922 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
923 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
924 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
925 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
926 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
927 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
928 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200931
932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200934 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200935 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200936 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
938 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200939 *
940 * This enables the following ciphersuites (if other requisites are
941 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
943 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
944 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
945 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
946 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
947 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
948 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
949 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
950 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
951 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
952 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
953 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
954 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
955 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
956 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +0200957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200959
960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200962 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200963 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200964 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
966 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200967 *
968 * This enables the following ciphersuites (if other requisites are
969 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
971 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
972 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
973 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
974 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
975 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
976 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
977 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
978 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
979 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
980 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
981 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
982 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100983 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100984 * \warning Using DHE constitutes a security risk as it
985 * is not possible to validate custom DH parameters.
986 * If possible, it is recommended users should consider
987 * preferring other methods of key exchange.
988 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100989 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200992
993/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200995 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200996 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200997 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
999 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001000 *
1001 * This enables the following ciphersuites (if other requisites are
1002 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1004 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1005 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1006 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1007 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1008 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1009 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1010 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1011 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1012 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1013 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1014 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +02001015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001017
1018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001020 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001021 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001022 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001024 *
1025 * This enables the following ciphersuites (if other requisites are
1026 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1028 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1029 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1030 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1031 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1032 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1033 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1034 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1035 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1036 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1037 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1038 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001041
1042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001044 *
1045 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001048 *
1049 * This enables the following ciphersuites (if other requisites are
1050 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1052 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1053 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1054 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1055 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1056 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1057 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1058 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1059 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1060 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1061 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1062 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001065
1066/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001068 *
1069 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1070 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001072 *
1073 * This enables the following ciphersuites (if other requisites are
1074 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1076 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1077 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1078 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1079 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1080 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1081 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1082 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1083 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1084 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1085 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1086 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001089
1090/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001091 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1092 *
1093 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1094 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001095 * \warning This is currently experimental. EC J-PAKE support is based on the
1096 * Thread v1.0.0 specification; incompatible changes to the specification
1097 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001098 *
1099 * Requires: MBEDTLS_ECJPAKE_C
1100 * MBEDTLS_SHA256_C
1101 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1102 *
1103 * This enables the following ciphersuites (if other requisites are
1104 * enabled as well):
1105 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1106 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001107//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001108
1109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001111 *
1112 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1113 * RFC 5915 and RFC 5480.
1114 *
1115 * Currently this means parsing the SpecifiedECDomain choice of EC
1116 * parameters (only known groups are supported, not arbitrary domains, to
1117 * avoid validation issues).
1118 *
1119 * Disable if you only need to support RFC 5915 + 5480 key formats.
1120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001122
1123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001125 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * Enable a dummy error function to make use of mbedtls_strerror() in
1127 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1128 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001129 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1131 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001132 *
1133 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001137
1138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001140 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001141 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001142 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001146
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001147/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001149 *
1150 * Enable functions that use the filesystem.
1151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001153
1154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001156 *
1157 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001159 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001160 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001161 * application.
1162 *
1163 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001166
1167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001169 *
1170 * Do not use built-in platform entropy functions.
1171 * This is useful if your platform does not support
1172 * standards like the /dev/urandom or Windows CryptoAPI.
1173 *
1174 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001177
1178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001180 *
1181 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1182 * default SHA-512 based one (if both are available).
1183 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001185 *
1186 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1187 * if you have performance concerns.
1188 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 * This option is only useful if both MBEDTLS_SHA256_C and
1190 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001193
1194/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001195 * \def MBEDTLS_ENTROPY_NV_SEED
1196 *
1197 * Enable the non-volatile (NV) seed file-based entropy source.
1198 * (Also enables the NV seed read/write functions in the platform layer)
1199 *
1200 * This is crucial (if not required) on systems that do not have a
1201 * cryptographic entropy source (in hardware or kernel) available.
1202 *
1203 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1204 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001205 * \note The read/write functions that are used by the entropy source are
1206 * determined in the platform layer, and can be modified at runtime and/or
1207 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1208 *
1209 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001210 * with regular fopen(), please make sure you make a seedfile with the
1211 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1212 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001213 * and written to or you will get an entropy source error! The default
1214 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1215 * bytes from the file.
1216 *
1217 * \note The entropy collector will write to the seed file before entropy is
1218 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001219 */
1220//#define MBEDTLS_ENTROPY_NV_SEED
1221
1222/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001223 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001224 *
1225 * Enable debugging of buffer allocator memory issues. Automatically prints
1226 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1227 * function for 'debug output' of allocated memory.
1228 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001230 *
1231 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001234
1235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001237 *
1238 * Include backtrace information with each allocated block.
1239 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001241 * GLIBC-compatible backtrace() an backtrace_symbols() support
1242 *
1243 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001246
1247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001249 *
1250 * Support external private RSA keys (eg from a HSM) in the PK layer.
1251 *
1252 * Comment this macro to disable support for external private RSA keys.
1253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001255
1256/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001258 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001259 * Enable support for PKCS#1 v1.5 encoding.
1260 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001261 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001262 *
Paul Bakker48377d92013-08-30 12:06:24 +02001263 * This enables support for PKCS#1 v1.5 operations.
1264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001266
1267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001269 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001270 * Enable support for PKCS#1 v2.1 encoding.
1271 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001273 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001274 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001277
1278/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001279 * \def MBEDTLS_PSA_CRYPTO_SPM
1280 *
1281 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1282 * Partition Manager) integration which separates the code into two parts: a
1283 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1284 * Environment).
1285 *
1286 * Module: library/psa_crypto.c
1287 * Requires: MBEDTLS_PSA_CRYPTO_C
1288 *
1289 */
1290//#define MBEDTLS_PSA_CRYPTO_SPM
1291
1292/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001293 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001295 * Enable support for entropy injection at first boot. This feature is
1296 * required on systems that do not have a built-in entropy source (TRNG).
1297 * This feature is currently not supported on systems that have a built-in
1298 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001299 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001300 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001301 *
1302 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001303//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001304
1305/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001307 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001308 * Do not use the Chinese Remainder Theorem
1309 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001310 *
1311 * Uncomment this macro to disable the use of CRT in RSA.
1312 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001315
1316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001318 *
1319 * Enable the checkup functions (*_self_test).
1320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001322
1323/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001324 * \def MBEDTLS_SHA256_SMALLER
1325 *
1326 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1327 * lower performance.
1328 *
1329 * The default implementation is meant to be a reasonnable compromise between
1330 * performance and size. This version optimizes more aggressively for size at
1331 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1332 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1333 * 30%.
1334 *
1335 * Uncomment to enable the smaller implementation of SHA256.
1336 */
1337//#define MBEDTLS_SHA256_SMALLER
1338
1339/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001340 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001341 *
1342 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001343 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001344 * with other servers, only debugging of failures is harder.
1345 *
1346 * The advantage of not sending alert messages, is that no information is given
1347 * about reasons for failures thus preventing adversaries of gaining intel.
1348 *
1349 * Enable sending of all alert messages
1350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001352
1353/**
Hanno Beckercfe45792019-07-03 16:13:00 +01001354 * \def MBEDTLS_SSL_RECORD_CHECKING
1355 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001356 * Enable the function mbedtls_ssl_check_record() which can be used to check
1357 * the validity and authenticity of an incoming record, to verify that it has
1358 * not been seen before. These checks are performed without modifying the
1359 * externally visible state of the SSL context.
Hanno Beckercfe45792019-07-03 16:13:00 +01001360 *
1361 * See mbedtls_ssl_check_record() for more information.
1362 *
1363 * Uncomment to enable support for record checking.
1364 */
1365#define MBEDTLS_SSL_RECORD_CHECKING
1366
1367/**
Hanno Beckera0e20d02019-05-15 14:03:01 +01001368 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
Hanno Becker2234e652019-04-09 15:12:41 +01001369 *
Hanno Becker97428092019-04-23 11:36:56 +01001370 * Enable support for the DTLS Connection ID extension
Hanno Beckerebcc9132019-05-15 10:26:32 +01001371 * (version draft-ietf-tls-dtls-connection-id-05,
1372 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
Hanno Becker97428092019-04-23 11:36:56 +01001373 * which allows to identify DTLS connections across changes
1374 * in the underlying transport.
Hanno Becker2234e652019-04-09 15:12:41 +01001375 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001376 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Hanno Becker8367ccc2019-05-14 11:30:10 +01001377 * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`.
Hanno Becker56f81c72019-05-15 09:44:59 +01001378 * See the corresponding documentation for more information.
Hanno Becker2234e652019-04-09 15:12:41 +01001379 *
1380 * \warning The Connection ID extension is still in draft state.
1381 * We make no stability promises for the availability
1382 * or the shape of the API controlled by this option.
1383 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001384 * The maximum lengths of outgoing and incoming CIDs can be configured
1385 * through the options
1386 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1387 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
Hanno Becker2234e652019-04-09 15:12:41 +01001388 *
1389 * Requires: MBEDTLS_SSL_PROTO_DTLS
1390 *
1391 * Uncomment to enable the Connection ID extension.
1392 */
Hanno Becker3739e202019-05-23 17:02:06 +01001393//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
Hanno Becker2234e652019-04-09 15:12:41 +01001394
1395/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001396 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1397 *
1398 * Enable asynchronous external private key operations in SSL. This allows
1399 * you to configure an SSL connection to call an external cryptographic
1400 * module to perform private key operations instead of performing the
1401 * operation inside the library.
1402 *
1403 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001404//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001405
1406/**
Manuel Pégourié-Gonnardafa8f712019-05-28 12:28:17 +02001407 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1408 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02001409 * Enable serialization of the TLS context structures, through use of the
1410 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
Manuel Pégourié-Gonnardafa8f712019-05-28 12:28:17 +02001411 *
1412 * This pair of functions allows one side of a connection to serialize the
1413 * context associated with the connection, then free or re-use that context
1414 * while the serialized state is persisted elsewhere, and finally deserialize
1415 * that state to a live context for resuming read/write operations on the
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02001416 * connection. From a protocol perspective, the state of the connection is
1417 * unaffected, in particular this is entirely transparent to the peer.
Manuel Pégourié-Gonnardafa8f712019-05-28 12:28:17 +02001418 *
1419 * Note: this is distinct from TLS session resumption, which is part of the
1420 * protocol and fully visible by the peer. TLS session resumption enables
1421 * establishing new connections associated to a saved session with shorter,
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02001422 * lighter handshakes, while context serialization is a local optimization in
Manuel Pégourié-Gonnardafa8f712019-05-28 12:28:17 +02001423 * handling a single, potentially long-lived connection.
1424 *
1425 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1426 * saved after the handshake to allow for more efficient serialization, so if
1427 * you don't need this feature you'll save RAM by disabling it.
1428 *
1429 * Comment to disable the context serialization APIs.
1430 */
1431#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1432
1433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001435 *
1436 * Enable the debug messages in SSL module for all issues.
1437 * Debug messages have been disabled in some places to prevent timing
1438 * attacks due to (unbalanced) debugging function calls.
1439 *
1440 * If you need all error reporting you should enable this during debugging,
1441 * but remove this for production servers that should log as well.
1442 *
1443 * Uncomment this macro to report all debug messages on errors introducing
1444 * a timing side-channel.
1445 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001448
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001450 *
1451 * Enable support for Encrypt-then-MAC, RFC 7366.
1452 *
1453 * This allows peers that both support it to use a more robust protection for
1454 * ciphersuites using CBC, providing deep resistance against timing attacks
1455 * on the padding or underlying cipher.
1456 *
1457 * This only affects CBC ciphersuites, and is useless if none is defined.
1458 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1460 * MBEDTLS_SSL_PROTO_TLS1_1 or
1461 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001462 *
1463 * Comment this macro to disable support for Encrypt-then-MAC
1464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001467/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001468 *
1469 * Enable support for Extended Master Secret, aka Session Hash
1470 * (draft-ietf-tls-session-hash-02).
1471 *
1472 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1473 * attacks, but it is recommended to always use it (even if you disable
1474 * renegotiation), since it actually fixes a more fundamental issue in the
1475 * original SSL/TLS design, and has implications beyond Triple Handshake.
1476 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1478 * MBEDTLS_SSL_PROTO_TLS1_1 or
1479 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001480 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001481 * Comment this macro to disable support for Extended Master Secret.
1482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001484
Paul Bakkerd66f0702013-01-31 16:57:45 +01001485/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001487 *
1488 * Enable support for FALLBACK_SCSV (draft-ietf-tls-downgrade-scsv-00).
1489 *
1490 * For servers, it is recommended to always enable this, unless you support
1491 * only one version of TLS, or know for sure that none of your clients
1492 * implements a fallback strategy.
1493 *
1494 * For clients, you only need this if you're using a fallback strategy, which
1495 * is not recommended in the first place, unless you absolutely need it to
1496 * interoperate with buggy (version-intolerant) servers.
1497 *
1498 * Comment this macro to disable support for FALLBACK_SCSV
1499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001501
1502/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001503 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1504 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001505 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001506 * giving access to the peer's certificate after completion of the handshake.
1507 *
1508 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1509 * recommended to disable this option for reduced RAM usage.
1510 *
1511 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1512 * defined, but always returns \c NULL.
1513 *
1514 * \note This option has no influence on the protection against the
1515 * triple handshake attack. Even if it is disabled, Mbed TLS will
1516 * still ensure that certificates do not change during renegotiation,
1517 * for exaple by keeping a hash of the peer's certificate.
1518 *
1519 * Comment this macro to disable storing the peer's certificate
1520 * after the handshake.
1521 */
1522#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1523
1524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001526 *
1527 * Enable hooking functions in SSL module for hardware acceleration of
1528 * individual records.
1529 *
Andres Amaya Garcia84b4e792018-12-05 22:39:38 +00001530 * \deprecated This option is deprecated and will likely be removed in a
1531 * future version of Mbed TLS.
1532 *
Paul Bakker05ef8352012-05-08 09:17:57 +00001533 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001536
1537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001539 *
1540 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1541 *
1542 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1543 * of interoperability issues compared to sending 0-length records.
1544 *
1545 * Comment this macro to disable 1/n-1 record splitting.
1546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001548
1549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001551 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001552 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553 *
1554 * The two main uses of renegotiation are (1) refresh keys on long-lived
1555 * connections and (2) client authentication after the initial handshake.
1556 * If you don't need renegotiation, it's probably better to disable it, since
1557 * it has been associated with security issues in the past and is easy to
1558 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001559 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001560 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001561 *
1562 * \note Even if this option is disabled, both client and server are aware
1563 * of the Renegotiation Indication Extension (RFC 5746) used to
1564 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1565 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1566 * configuration of this extension).
1567 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001570
1571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001573 *
1574 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001576 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001577 * \deprecated This option is deprecated and will be removed in a future
1578 * version of Mbed TLS.
Andres Amaya Garcia09634242018-11-29 09:55:41 +00001579 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001580 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001583
1584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001586 *
1587 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001589 *
1590 * Uncomment this macro to respect client's ciphersuite order
1591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001593
1594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001596 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001597 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001598 *
1599 * Comment this macro to disable support for the max_fragment_length extension
1600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001602
1603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001605 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001606 * Enable support for SSL 3.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 *
Andres Amaya Garcia835b2992019-01-15 19:36:00 +00001611 * \deprecated This option is deprecated and will be removed in a future
1612 * version of Mbed TLS.
Andres Amaya Garcia88c2cc72018-11-29 09:56:02 +00001613 *
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001614 * Comment this macro to disable support for SSL 3.0
1615 */
Janos Follathe2681a42016-03-07 15:57:05 +00001616//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001617
1618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001621 * Enable support for TLS 1.0.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001622 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623 * Requires: MBEDTLS_MD5_C
1624 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001625 *
1626 * Comment this macro to disable support for TLS 1.0
1627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001629
1630/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001632 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001633 * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001634 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635 * Requires: MBEDTLS_MD5_C
1636 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001637 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001638 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001641
1642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001644 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001645 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001646 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001648 * (Depends on ciphersuites)
1649 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001650 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001653
1654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001656 *
1657 * Enable support for DTLS (all available versions).
1658 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659 * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0,
1660 * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001661 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1663 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001664 *
1665 * Comment this macro to disable support for DTLS
1666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001668
1669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001671 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001672 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001673 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001674 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001677
1678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001680 *
1681 * Enable support for the anti-replay mechanism in DTLS.
1682 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001683 * Requires: MBEDTLS_SSL_TLS_C
1684 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001685 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001686 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001687 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001688 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001689 * Comment this to disable anti-replay in DTLS.
1690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001691#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001692
1693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001695 *
1696 * Enable support for HelloVerifyRequest on DTLS servers.
1697 *
1698 * This feature is highly recommended to prevent DTLS servers being used as
1699 * amplifiers in DoS attacks against other hosts. It should always be enabled
1700 * unless you know for sure amplification cannot be a problem in the
1701 * environment in which your server operates.
1702 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001703 * \warning Disabling this can ba a security risk! (see above)
1704 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001705 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001706 *
1707 * Comment this to disable support for HelloVerifyRequest.
1708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001710
1711/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001712 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1713 *
1714 * Enable server-side support for clients that reconnect from the same port.
1715 *
1716 * Some clients unexpectedly close the connection and try to reconnect using the
1717 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001718 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001719 * flag enables that support.
1720 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001721 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001722 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001723 * Comment this to disable support for clients reusing the source port.
1724 */
1725#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1726
1727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001729 *
1730 * Enable support for a limit of records with bad MAC.
1731 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001732 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001733 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001737
1738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001740 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001741 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001742 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001743 * session store remains the responsibility of the application, though).
1744 * Server-side, you also need to provide callbacks for writing and parsing
1745 * tickets, including authenticated encryption and key management. Example
1746 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001747 *
1748 * Comment this macro to disable support for SSL session tickets
1749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001751
1752/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001753 * \def MBEDTLS_SSL_EXPORT_KEYS
1754 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001755 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001756 * This is required for certain users of TLS, e.g. EAP-TLS.
1757 *
1758 * Comment this macro to disable support for key export
1759 */
1760#define MBEDTLS_SSL_EXPORT_KEYS
1761
1762/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001764 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001765 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001766 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001768 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001769 * Comment this macro to disable support for server name indication in SSL
1770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001772
1773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001775 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001776 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001777 *
1778 * Comment this macro to disable support for truncated HMAC in SSL
1779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001781
1782/**
Hanno Beckere89353a2017-11-20 16:36:41 +00001783 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1784 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001785 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
1786 * HMAC extension which also truncates the HMAC key. Note that this option is
1787 * only meant for a transitory upgrade period and is likely to be removed in
1788 * a future version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00001789 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001790 * \warning The old implementation is non-compliant and has a security weakness
1791 * (2^80 brute force attack on the HMAC key used for a single,
1792 * uninterrupted connection). This should only be enabled temporarily
1793 * when (1) the use of truncated HMAC is essential in order to save
1794 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
1795 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00001796 *
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00001797 * \deprecated This option is deprecated and will likely be removed in a
1798 * future version of Mbed TLS.
1799 *
Hanno Beckere89353a2017-11-20 16:36:41 +00001800 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
1801 *
1802 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
1803 */
1804//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1805
1806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001808 *
1809 * Provide your own alternate threading implementation.
1810 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001812 *
1813 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001816
1817/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001819 *
1820 * Enable the pthread wrapper layer for the threading layer.
1821 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001823 *
1824 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001827
1828/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001829 * \def MBEDTLS_USE_PSA_CRYPTO
1830 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001831 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1832 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001833 *
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001834 * \note Development of this option is currently in progress, and parts
1835 * of the X.509 and TLS modules are not ported to PSA yet. However, these parts
1836 * will still continue to work as usual, so enabling this option should not
1837 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001838 *
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001839 * \warning The PSA Crypto API is in beta stage. While you're welcome to
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001840 * experiment using it, incompatible API changes are still possible, and some
1841 * parts may not have reached the same quality as the rest of Mbed TLS yet.
1842 *
1843 * \warning This option enables new Mbed TLS APIs that are dependent on the
1844 * PSA Crypto API, so can't come with the same stability guarantees as the
1845 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001846 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001847 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker51560b62018-11-19 09:46:26 +00001848 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001849 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001850 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001851 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001852 */
1853//#define MBEDTLS_USE_PSA_CRYPTO
1854
1855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001857 *
1858 * Allow run-time checking of compile-time enabled features. Thus allowing users
1859 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001863 *
1864 * Comment this to disable run-time checking and save ROM space
1865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001867
1868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001870 *
1871 * If set, the X509 parser will not break-off when parsing an X509 certificate
1872 * and encountering an extension in a v1 or v2 certificate.
1873 *
1874 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001877
1878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00001880 *
1881 * If set, the X509 parser will not break-off when parsing an X509 certificate
1882 * and encountering an unknown critical extension.
1883 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01001884 * \warning Depending on your PKI use, enabling this can be a security risk!
1885 *
Paul Bakker5c721f92011-07-27 16:51:09 +00001886 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00001887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00001889
1890/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001891 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1892 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001893 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001894 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1895 * the set of trusted certificates through a callback instead of a linked
1896 * list.
1897 *
1898 * This is useful for example in environments where a large number of trusted
1899 * certificates is present and storing them in a linked list isn't efficient
1900 * enough, or when the set of trusted certificates changes frequently.
1901 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001902 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001903 * `mbedtls_ssl_conf_ca_cb()` for more information.
1904 *
1905 * Uncomment to enable trusted certificate callbacks.
1906 */
1907//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1908
1909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001911 *
1912 * Enable verification of the keyUsage extension (CA and leaf certificates).
1913 *
1914 * Disabling this avoids problems with mis-issued and/or misused
1915 * (intermediate) CA and leaf certificates.
1916 *
1917 * \warning Depending on your PKI use, disabling this can be a security risk!
1918 *
1919 * Comment to skip keyUsage checking for both CA and leaf certificates.
1920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001922
1923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001925 *
1926 * Enable verification of the extendedKeyUsage extension (leaf certificates).
1927 *
1928 * Disabling this avoids problems with mis-issued and/or misused certificates.
1929 *
1930 * \warning Depending on your PKI use, disabling this can be a security risk!
1931 *
1932 * Comment to skip extendedKeyUsage checking for certificates.
1933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001935
1936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001938 *
1939 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1940 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1941 *
1942 * Comment this macro to disallow using RSASSA-PSS in certificates.
1943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001945
1946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00001948 *
1949 * If set, the SSL/TLS module uses ZLIB to support compression and
1950 * decompression of packet data.
1951 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01001952 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
1953 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimo36e89b52019-01-23 15:24:37 +01001954 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01001955 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02001956 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02001957 *
Hanno Beckere494e202018-03-08 13:26:12 +00001958 * \deprecated This feature is deprecated and will be removed
1959 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00001960 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00001961 * Used in: library/ssl_tls.c
1962 * library/ssl_cli.c
1963 * library/ssl_srv.c
1964 *
1965 * This feature requires zlib library and headers to be present.
1966 *
1967 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00001968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001970/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001971
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001972/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001973 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001974 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001975 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001976 * \{
1977 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001978
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001981 *
1982 * Enable AES-NI support on x86-64.
1983 *
1984 * Module: library/aesni.c
1985 * Caller: library/aes.c
1986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001988 *
1989 * This modules adds support for the AES-NI instructions on x86-64
1990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001992
1993/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001995 *
1996 * Enable the AES block cipher.
1997 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001998 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001999 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002000 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002001 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002002 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002003 * This module enables the following ciphersuites (if other requisites are
2004 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2006 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2007 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2008 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2009 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2010 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2011 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2012 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2013 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2014 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2015 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2016 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2017 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2018 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2019 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2020 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2021 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2022 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2023 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2024 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2025 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2026 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2027 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2028 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2029 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2030 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2031 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2032 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2033 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2034 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2035 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2036 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2037 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2038 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2039 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2040 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2041 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2042 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2043 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2044 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2045 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2046 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2047 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2048 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2049 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2050 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2051 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2052 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2053 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2054 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2055 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2056 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2057 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2058 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2059 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2060 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2061 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2062 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002063 *
Paul Bakkercff68422013-09-15 20:43:33 +02002064 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002070 *
2071 * Enable the ARCFOUR stream cipher.
2072 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002073 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002074 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002075 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002076 * This module enables the following ciphersuites (if other requisites are
2077 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2079 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2080 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2081 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2082 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2083 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2084 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2085 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2086 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2087 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002088 *
2089 * \warning ARC4 is considered a weak cipher and its use constitutes a
2090 * security risk. If possible, we recommend avoidng dependencies on
2091 * it, and considering stronger ciphers instead.
2092 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002095
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002098 *
2099 * Enable the generic ASN1 parser.
2100 *
2101 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002102 * Caller: library/x509.c
2103 * library/dhm.c
2104 * library/pkcs12.c
2105 * library/pkcs5.c
2106 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002109
2110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002112 *
2113 * Enable the generic ASN1 writer.
2114 *
2115 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002116 * Caller: library/ecdsa.c
2117 * library/pkwrite.c
2118 * library/x509_create.c
2119 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002120 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002123
2124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002126 *
2127 * Enable the Base64 module.
2128 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002129 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002130 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002131 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002132 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002135
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002136/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002138 *
Paul Bakker9a736322012-11-14 12:39:52 +00002139 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002140 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002141 * Module: library/bignum.c
2142 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002143 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002144 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002145 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002146 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002148 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002149 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002152
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002155 *
2156 * Enable the Blowfish block cipher.
2157 *
2158 * Module: library/blowfish.c
2159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002161
2162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002164 *
2165 * Enable the Camellia block cipher.
2166 *
Paul Bakker38119b12009-01-10 23:31:23 +00002167 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002168 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002169 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002170 * This module enables the following ciphersuites (if other requisites are
2171 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2173 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2174 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2175 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2180 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2181 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2182 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2183 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2184 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2185 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2186 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2187 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2188 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2189 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2192 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2193 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2194 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2195 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2196 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2197 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2198 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2199 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2200 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2201 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2202 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2203 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2204 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2205 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2206 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2207 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2208 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2209 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2210 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2211 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2212 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2213 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002216
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002217/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002218 * \def MBEDTLS_ARIA_C
2219 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002220 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002221 *
2222 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002223 * Caller: library/cipher.c
2224 *
2225 * This module enables the following ciphersuites (if other requisites are
2226 * enabled as well):
2227 *
2228 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2229 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2230 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2231 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2232 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2233 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2234 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2235 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2236 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2237 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2238 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2239 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2240 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2241 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2242 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2243 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2244 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2245 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2246 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2247 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2248 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2249 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2250 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2251 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2252 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2254 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2255 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2256 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2257 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2258 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2259 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2262 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2264 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2265 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002266 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002267//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002268
2269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002271 *
2272 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2273 *
2274 * Module: library/ccm.c
2275 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002277 *
2278 * This module enables the AES-CCM ciphersuites, if other requisites are
2279 * enabled as well.
2280 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002282
2283/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002285 *
2286 * Enable the test certificates.
2287 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002288 * Module: library/certs.c
2289 * Caller:
2290 *
2291 * This module is used for testing (ssl_client/server).
2292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002294
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002295/**
Daniel King34b822c2016-05-15 17:28:08 -03002296 * \def MBEDTLS_CHACHA20_C
2297 *
2298 * Enable the ChaCha20 stream cipher.
2299 *
2300 * Module: library/chacha20.c
2301 */
2302#define MBEDTLS_CHACHA20_C
2303
2304/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002305 * \def MBEDTLS_CHACHAPOLY_C
2306 *
2307 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2308 *
2309 * Module: library/chachapoly.c
2310 *
2311 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2312 */
2313#define MBEDTLS_CHACHAPOLY_C
2314
2315/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002317 *
2318 * Enable the generic cipher layer.
2319 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002320 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002321 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002322 *
2323 * Uncomment to enable generic cipher wrappers.
2324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002326
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002327/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002328 * \def MBEDTLS_CMAC_C
2329 *
Simon Butcher327398a2016-10-05 14:09:11 +01002330 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2331 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002332 *
2333 * Module: library/cmac.c
2334 *
Simon Butcher69283e52016-10-06 12:49:58 +01002335 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002336 *
2337 */
Brian Murray53e23b62016-09-13 14:00:15 -07002338//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002339
2340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002342 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002343 * Enable the CTR_DRBG AES-based random generator.
2344 * The CTR_DRBG generator uses AES-256 by default.
2345 * To use AES-128 instead, enable MBEDTLS_CTR_DRBG_USE_128_BIT_KEY below.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002346 *
2347 * Module: library/ctr_drbg.c
2348 * Caller:
2349 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002351 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002352 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002355
2356/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002358 *
2359 * Enable the debug functions.
2360 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002361 * Module: library/debug.c
2362 * Caller: library/ssl_cli.c
2363 * library/ssl_srv.c
2364 * library/ssl_tls.c
2365 *
2366 * This module provides debugging functions.
2367 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002369
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002372 *
2373 * Enable the DES block cipher.
2374 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002375 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002376 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002377 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002378 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002379 * This module enables the following ciphersuites (if other requisites are
2380 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2382 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2383 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2384 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2385 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2386 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2387 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2388 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2389 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2390 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002391 *
Paul Bakkercff68422013-09-15 20:43:33 +02002392 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002393 *
2394 * \warning DES is considered a weak cipher and its use constitutes a
2395 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002397#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002398
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002401 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002402 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002403 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002404 * Module: library/dhm.c
2405 * Caller: library/ssl_cli.c
2406 * library/ssl_srv.c
2407 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002408 * This module is used by the following key exchanges:
2409 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002410 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002411 * \warning Using DHE constitutes a security risk as it
2412 * is not possible to validate custom DH parameters.
2413 * If possible, it is recommended users should consider
2414 * preferring other methods of key exchange.
2415 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002416 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002419
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002422 *
2423 * Enable the elliptic curve Diffie-Hellman library.
2424 *
2425 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002426 * Caller: library/ssl_cli.c
2427 * library/ssl_srv.c
2428 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002429 * This module is used by the following key exchanges:
2430 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002431 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002435
2436/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002438 *
2439 * Enable the elliptic curve DSA library.
2440 *
2441 * Module: library/ecdsa.c
2442 * Caller:
2443 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002444 * This module is used by the following key exchanges:
2445 * ECDHE-ECDSA
2446 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002450
2451/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002452 * \def MBEDTLS_ECJPAKE_C
2453 *
2454 * Enable the elliptic curve J-PAKE library.
2455 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002456 * \warning This is currently experimental. EC J-PAKE support is based on the
2457 * Thread v1.0.0 specification; incompatible changes to the specification
2458 * might still happen. For this reason, this is disabled by default.
2459 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002460 * Module: library/ecjpake.c
2461 * Caller:
2462 *
2463 * This module is used by the following key exchanges:
2464 * ECJPAKE
2465 *
2466 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2467 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002468//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002469
2470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002472 *
2473 * Enable the elliptic curve over GF(p) library.
2474 *
2475 * Module: library/ecp.c
2476 * Caller: library/ecdh.c
2477 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002478 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002479 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002483
2484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002486 *
2487 * Enable the platform-specific entropy code.
2488 *
2489 * Module: library/entropy.c
2490 * Caller:
2491 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002493 *
2494 * This module provides a generic entropy pool
2495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002497
2498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002500 *
2501 * Enable error code to error string conversion.
2502 *
2503 * Module: library/error.c
2504 * Caller:
2505 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002509
2510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002512 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002513 * Enable the Galois/Counter Mode (GCM) for AES.
Paul Bakker89e80c92012-03-20 13:50:09 +00002514 *
2515 * Module: library/gcm.c
2516 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002518 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002519 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2520 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002523
2524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002526 *
2527 * Enable the HAVEGE random generator.
2528 *
Paul Bakker2a844242013-06-24 13:01:53 +02002529 * Warning: the HAVEGE random generator is not suitable for virtualized
2530 * environments
2531 *
2532 * Warning: the HAVEGE random generator is dependent on timing and specific
2533 * processor traits. It is therefore not advised to use HAVEGE as
2534 * your applications primary random generator or primary entropy pool
2535 * input. As a secondary input to your entropy pool, it IS able add
2536 * the (limited) extra entropy it provides.
2537 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002538 * Module: library/havege.c
2539 * Caller:
2540 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002542 *
Paul Bakker2a844242013-06-24 13:01:53 +02002543 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002546
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002547/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002548 * \def MBEDTLS_HKDF_C
2549 *
2550 * Enable the HKDF algorithm (RFC 5869).
2551 *
2552 * Module: library/hkdf.c
2553 * Caller:
2554 *
2555 * Requires: MBEDTLS_MD_C
2556 *
2557 * This module adds support for the Hashed Message Authentication Code
2558 * (HMAC)-based key derivation function (HKDF).
2559 */
2560#define MBEDTLS_HKDF_C
2561
2562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002564 *
2565 * Enable the HMAC_DRBG random generator.
2566 *
2567 * Module: library/hmac_drbg.c
2568 * Caller:
2569 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002571 *
2572 * Uncomment to enable the HMAC_DRBG random number geerator.
2573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002574#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002575
2576/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002577 * \def MBEDTLS_NIST_KW_C
2578 *
2579 * Enable the Key Wrapping mode for 128-bit block ciphers,
2580 * as defined in NIST SP 800-38F. Only KW and KWP modes
2581 * are supported. At the moment, only AES is approved by NIST.
2582 *
2583 * Module: library/nist_kw.c
2584 *
2585 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2586 */
2587//#define MBEDTLS_NIST_KW_C
2588
2589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002591 *
2592 * Enable the generic message digest layer.
2593 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002594 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002595 * Caller:
2596 *
2597 * Uncomment to enable generic message digest wrappers.
2598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002600
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002603 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002604 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002605 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002606 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002607 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002608 *
2609 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002610 *
2611 * \warning MD2 is considered a weak message digest and its use constitutes a
2612 * security risk. If possible, we recommend avoiding dependencies on
2613 * it, and considering stronger message digests instead.
2614 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002617
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002621 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002622 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002623 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002624 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002625 *
2626 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002627 *
2628 * \warning MD4 is considered a weak message digest and its use constitutes a
2629 * security risk. If possible, we recommend avoiding dependencies on
2630 * it, and considering stronger message digests instead.
2631 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002634
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002635/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002637 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002638 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002639 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002640 * Module: library/md5.c
2641 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002642 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002643 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002644 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002645 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2646 * depending on the handshake parameters. Further, it is used for checking
2647 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2648 * encrypted keys.
2649 *
2650 * \warning MD5 is considered a weak message digest and its use constitutes a
2651 * security risk. If possible, we recommend avoiding dependencies on
2652 * it, and considering stronger message digests instead.
2653 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002656
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002659 *
2660 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002661 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002662 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002663 *
2664 * Module: library/memory_buffer_alloc.c
2665 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * Requires: MBEDTLS_PLATFORM_C
2667 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002668 *
2669 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002672
2673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002675 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002676 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2677 *
Simon Butcherd567a232016-03-09 20:19:21 +00002678 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2679 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002680 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002681 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002682 * \note See also our Knowledge Base article about porting to a new
2683 * environment:
2684 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2685 *
Andres AG788aa4a2016-09-14 14:32:09 +01002686 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002687 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002688 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002691
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002694 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002695 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002696 *
2697 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002698 * Caller: library/asn1write.c
2699 * library/pkcs5.c
2700 * library/pkparse.c
2701 * library/pkwrite.c
2702 * library/rsa.c
2703 * library/x509.c
2704 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002705 * library/x509_crl.c
2706 * library/x509_crt.c
2707 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002708 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002709 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002710 *
2711 * This modules translates between OIDs and internal values.
2712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002714
2715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002717 *
2718 * Enable VIA Padlock support on x86.
2719 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002720 * Module: library/padlock.c
2721 * Caller: library/aes.c
2722 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002724 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002725 * This modules adds support for the VIA PadLock on x86.
2726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002728
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002731 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002732 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002733 *
2734 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002735 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002736 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002737 * library/x509_crl.c
2738 * library/x509_crt.c
2739 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002740 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002742 *
Paul Bakkercff68422013-09-15 20:43:33 +02002743 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002746
2747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002749 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002750 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002751 *
2752 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002753 * Caller: library/pkwrite.c
2754 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002755 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002756 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002758 *
2759 * This modules adds support for encoding / writing PEM files.
2760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002762
2763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002765 *
2766 * Enable the generic public (asymetric) key layer.
2767 *
2768 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002769 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002770 * library/ssl_cli.c
2771 * library/ssl_srv.c
2772 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002774 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002775 * Uncomment to enable generic public key wrappers.
2776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002778
2779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002781 *
2782 * Enable the generic public (asymetric) key parser.
2783 *
2784 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002785 * Caller: library/x509_crt.c
2786 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002787 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002789 *
2790 * Uncomment to enable generic public key parse functions.
2791 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002793
2794/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002796 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002797 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002798 *
2799 * Module: library/pkwrite.c
2800 * Caller: library/x509write.c
2801 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002803 *
2804 * Uncomment to enable generic public key write functions.
2805 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002807
2808/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002810 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002811 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002812 *
2813 * Module: library/pkcs5.c
2814 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002816 *
2817 * This module adds support for the PKCS#5 functions.
2818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002820
2821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002823 *
Gilles Peskine907e95a2020-01-23 15:51:40 +01002824 * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library.
Paul Bakker5690efc2011-05-26 13:16:06 +00002825 *
Andres Amaya Garcia99fc3872019-01-15 19:07:43 +00002826 * \deprecated This option is deprecated and will be removed in a future
2827 * version of Mbed TLS.
Paul Bakker5690efc2011-05-26 13:16:06 +00002828 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02002829 * Module: library/pkcs11.c
2830 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002831 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002833 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00002834 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00002835 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00002836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002838
2839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002841 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002842 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002843 * Adds algorithms for parsing PKCS#8 encrypted private keys
2844 *
2845 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002846 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002847 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2849 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002850 *
2851 * This module enables PKCS#12 functions.
2852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002854
2855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002857 *
2858 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002859 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002860 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2862 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002863 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002864 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002865 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2866 * as other module rely on it for a fixed snprintf implementation.
2867 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002868 * Module: library/platform.c
2869 * Caller: Most other .c files
2870 *
2871 * This module enables abstraction of common (libc) functions.
2872 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002873#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002874
2875/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002876 * \def MBEDTLS_POLY1305_C
2877 *
2878 * Enable the Poly1305 MAC algorithm.
2879 *
2880 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002881 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002882 */
2883#define MBEDTLS_POLY1305_C
2884
2885/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002886 * \def MBEDTLS_PSA_CRYPTO_C
2887 *
2888 * Enable the Platform Security Architecture cryptography API.
2889 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002890 * \warning The PSA Crypto API is still beta status. While you're welcome to
2891 * experiment using it, incompatible API changes are still possible, and some
2892 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01002893 *
2894 * Module: crypto/library/psa_crypto.c
2895 *
2896 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
2897 *
2898 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002899#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002900
2901/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002902 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2903 *
2904 * Enable the Platform Security Architecture persistent key storage.
2905 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002906 * Module: crypto/library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002907 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002908 * Requires: MBEDTLS_PSA_CRYPTO_C,
2909 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2910 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002911 */
2912//#define MBEDTLS_PSA_CRYPTO_STORAGE_C
2913
2914/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002915 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002916 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002917 * Enable the emulation of the Platform Security Architecture
2918 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002919 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002920 * Module: crypto/library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002921 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002922 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002923 *
2924 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002925//#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002926
2927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002929 *
2930 * Enable the RIPEMD-160 hash algorithm.
2931 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002932 * Module: library/ripemd160.c
2933 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002934 *
2935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002937
2938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002940 *
2941 * Enable the RSA public-key cryptosystem.
2942 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002943 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002944 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002945 * Caller: library/ssl_cli.c
2946 * library/ssl_srv.c
2947 * library/ssl_tls.c
2948 * library/x509.c
2949 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002950 * This module is used by the following key exchanges:
2951 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002952 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002956
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002959 *
2960 * Enable the SHA1 cryptographic hash algorithm.
2961 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002962 * Module: library/sha1.c
2963 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002964 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002965 * library/ssl_srv.c
2966 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002967 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002968 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02002969 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
2970 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002971 *
2972 * \warning SHA-1 is considered a weak message digest and its use constitutes
2973 * a security risk. If possible, we recommend avoiding dependencies
2974 * on it, and considering stronger message digests instead.
2975 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002978
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002981 *
2982 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
2983 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002984 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002985 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002986 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002987 * library/ssl_cli.c
2988 * library/ssl_srv.c
2989 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002990 *
2991 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002992 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002995
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002996/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002998 *
2999 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3000 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003001 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003002 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003003 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003004 * library/ssl_cli.c
3005 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003006 *
3007 * This module adds support for SHA-384 and SHA-512.
3008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003010
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003013 *
3014 * Enable simple SSL cache implementation.
3015 *
3016 * Module: library/ssl_cache.c
3017 * Caller:
3018 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003022
3023/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003025 *
3026 * Enable basic implementation of DTLS cookies for hello verification.
3027 *
3028 * Module: library/ssl_cookie.c
3029 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003032
3033/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003034 * \def MBEDTLS_SSL_TICKET_C
3035 *
3036 * Enable an implementation of TLS server-side callbacks for session tickets.
3037 *
3038 * Module: library/ssl_ticket.c
3039 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003040 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003041 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003042 */
3043#define MBEDTLS_SSL_TICKET_C
3044
3045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003047 *
3048 * Enable the SSL/TLS client code.
3049 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 * Module: library/ssl_cli.c
3051 * Caller:
3052 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003054 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003055 * This module is required for SSL/TLS client support.
3056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003058
Paul Bakker9a736322012-11-14 12:39:52 +00003059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061 *
3062 * Enable the SSL/TLS server code.
3063 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003064 * Module: library/ssl_srv.c
3065 * Caller:
3066 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003068 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003069 * This module is required for SSL/TLS server support.
3070 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003072
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003075 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003076 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003077 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 * Module: library/ssl_tls.c
3079 * Caller: library/ssl_cli.c
3080 * library/ssl_srv.c
3081 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3083 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003084 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003085 * This module is required for SSL/TLS.
3086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003088
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003091 *
3092 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003093 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003094 * contexts are not shared between threads. If you do intend to use contexts
3095 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003096 * conditions. See also our Knowledge Base article about threading:
3097 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003098 *
3099 * Module: library/threading.c
3100 *
3101 * This allows different threading implementations (self-implemented or
3102 * provided).
3103 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104 * You will have to enable either MBEDTLS_THREADING_ALT or
3105 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003106 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003107 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003110
3111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003113 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003114 * Enable the semi-portable timing interface.
3115 *
Simon Butcherd567a232016-03-09 20:19:21 +00003116 * \note The provided implementation only works on POSIX/Unix (including Linux,
3117 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003118 * module and provide your own implementations of the callbacks needed by
3119 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3120 * your own implementation of the whole module by setting
3121 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003122 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003123 * \note See also our Knowledge Base article about porting to a new
3124 * environment:
3125 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3126 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003127 * Module: library/timing.c
3128 * Caller: library/havege.c
3129 *
3130 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003133
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003136 *
3137 * Enable run-time version information.
3138 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003139 * Module: library/version.c
3140 *
3141 * This module provides run-time version information.
3142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003144
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003145/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003147 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003148 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003149 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003150 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003151 * Caller: library/x509_crl.c
3152 * library/x509_crt.c
3153 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003154 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3156 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003157 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003158 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003161
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003164 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003165 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003166 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003167 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003168 * Caller: library/ssl_cli.c
3169 * library/ssl_srv.c
3170 * library/ssl_tls.c
3171 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003173 *
3174 * This module is required for X.509 certificate parsing.
3175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003177
3178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003180 *
3181 * Enable X.509 CRL parsing.
3182 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003183 * Module: library/x509_crl.c
3184 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003185 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003187 *
3188 * This module is required for X.509 CRL parsing.
3189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003191
3192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003194 *
3195 * Enable X.509 Certificate Signing Request (CSR) parsing.
3196 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003197 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003198 * Caller: library/x509_crt_write.c
3199 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003201 *
3202 * This module is used for reading X.509 certificate request.
3203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003205
3206/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003208 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003209 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003210 *
3211 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003212 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003214 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003215 * This module is the basis for creating X.509 certificates and CSRs.
3216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003218
3219/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003221 *
3222 * Enable creating X.509 certificates.
3223 *
3224 * Module: library/x509_crt_write.c
3225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003227 *
3228 * This module is required for X.509 certificate creation.
3229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003231
3232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003234 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003235 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003236 *
3237 * Module: library/x509_csr_write.c
3238 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003240 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003241 * This module is required for X.509 certificate request writing.
3242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003244
3245/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003247 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003248 * Enable the XTEA block cipher.
3249 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003250 * Module: library/xtea.c
3251 * Caller:
3252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003254
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003255/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003256
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003257/**
3258 * \name SECTION: Module configuration options
3259 *
3260 * This section allows for the setting of module specific sizes and
3261 * configuration options. The default values are already present in the
3262 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003263 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003264 * Our advice is to enable options and change their values here
3265 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003266 *
3267 * Please check the respective header file for documentation on these
3268 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003269 * \{
3270 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003271
Paul Bakker088c5c52014-04-25 11:11:10 +02003272/* MPI / BIGNUM options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
3274//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003275
Paul Bakker088c5c52014-04-25 11:11:10 +02003276/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3278//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3279//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3280//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3281//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Nir Sonnenscheince266e42018-08-29 10:11:46 +03003282//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY /**< Use 128-bit key for CTR_DRBG - may reduce security (see ctr_drbg.h) */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003283
Paul Bakker088c5c52014-04-25 11:11:10 +02003284/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3286//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3287//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3288//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003289
Paul Bakker088c5c52014-04-25 11:11:10 +02003290/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3292//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3293//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003294
Paul Bakker088c5c52014-04-25 11:11:10 +02003295/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3297//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003298//#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 +01003299
Paul Bakker088c5c52014-04-25 11:11:10 +02003300/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003302
Paul Bakker088c5c52014-04-25 11:11:10 +02003303/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304//#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 +02003305//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3307//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003308//#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 +02003309//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3310//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003311/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003313//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3314//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003315//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3316//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3317//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3320/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003321//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3323//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003324//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3325//#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 +02003326//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3327//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003328/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003330//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003331//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3332//#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 +02003333
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003334/**
3335 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003336 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003337 * (see the documentation of that option for context).
3338 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003339 * When you leave this undefined here, the library provides
3340 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3341 * is defined, the default definition is `assert(cond)`,
3342 * otherwise the default definition calls a function
3343 * mbedtls_param_failed(). This function is declared in
3344 * `platform_util.h` for the benefit of the library, but
3345 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003346 *
3347 * When you define this here, this replaces the default
3348 * definition in platform_util.h (which no longer declares the
3349 * function mbedtls_param_failed()) and it is your responsibility
3350 * to make sure this macro expands to something suitable (in
3351 * particular, that all the necessary declarations are visible
3352 * from within the library - you can ensure that by providing
3353 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02003354 * If you define this macro to call `assert`, also define
3355 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3356 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003357 *
3358 * Note that you may define this macro to expand to nothing, in
3359 * which case you don't have to worry about declarations or
3360 * definitions. However, you will then be notified about invalid
3361 * parameters only in non-void functions, and void function will
3362 * just silently return early on invalid parameters, which
3363 * partially negates the benefits of enabling
3364 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
3365 *
3366 * \param cond The expression that should evaluate to true, but doesn't.
3367 */
3368//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
3369
Paul Bakker088c5c52014-04-25 11:11:10 +02003370/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3372//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003373
Paul Bakker088c5c52014-04-25 11:11:10 +02003374/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003375
3376/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3377 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003378 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003379 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003380 * This determines the size of both the incoming and outgoing TLS I/O buffers
3381 * in such a way that both are capable of holding the specified amount of
3382 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003383 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003384 * To configure incoming and outgoing I/O buffers separately, use
3385 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3386 * which overwrite the value set by this option.
3387 *
3388 * \note When using a value less than the default of 16KB on the client, it is
3389 * recommended to use the Maximum Fragment Length (MFL) extension to
3390 * inform the server about this limitation. On the server, there
3391 * is no supported, standardized way of informing the client about
3392 * restriction on the maximum size of incoming messages, and unless
3393 * the limitation has been communicated by other means, it is recommended
3394 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3395 * while keeping the default value of 16KB for the incoming buffer.
3396 *
3397 * Uncomment to set the maximum plaintext size of both
3398 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003399 */
3400//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3401
3402/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3403 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003404 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003405 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003406 * This determines the size of the incoming TLS I/O buffer in such a way
3407 * that it is capable of holding the specified amount of plaintext data,
3408 * regardless of the protection mechanism used.
3409 *
3410 * If this option is undefined, it inherits its value from
3411 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3412 *
3413 * \note When using a value less than the default of 16KB on the client, it is
3414 * recommended to use the Maximum Fragment Length (MFL) extension to
3415 * inform the server about this limitation. On the server, there
3416 * is no supported, standardized way of informing the client about
3417 * restriction on the maximum size of incoming messages, and unless
3418 * the limitation has been communicated by other means, it is recommended
3419 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3420 * while keeping the default value of 16KB for the incoming buffer.
3421 *
3422 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3423 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003424 */
3425//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3426
Hanno Becker2234e652019-04-09 15:12:41 +01003427/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3428 *
3429 * The maximum length of CIDs used for incoming DTLS messages.
3430 *
3431 */
3432//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3433
3434/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3435 *
3436 * The maximum length of CIDs used for outgoing DTLS messages.
3437 *
3438 */
3439//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3440
Hanno Beckerb1aa1b32019-05-08 17:37:58 +01003441/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3442 *
3443 * This option controls the use of record plaintext padding
3444 * when using the Connection ID extension in DTLS 1.2.
3445 *
3446 * The padding will always be chosen so that the length of the
3447 * padded plaintext is a multiple of the value of this option.
3448 *
3449 * Note: A value of \c 1 means that no padding will be used
3450 * for outgoing records.
3451 *
Hanno Beckerb9ec44f2019-05-13 15:31:17 +01003452 * Note: On systems lacking division instructions,
3453 * a power of two should be preferred.
Hanno Beckerb1aa1b32019-05-08 17:37:58 +01003454 *
3455 */
3456//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3457
Angus Grattond8213d02016-05-25 20:56:48 +10003458/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3459 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003460 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003461 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003462 * This determines the size of the outgoing TLS I/O buffer in such a way
3463 * that it is capable of holding the specified amount of plaintext data,
3464 * regardless of the protection mechanism used.
3465 *
3466 * If this option undefined, it inherits its value from
3467 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003468 *
3469 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3470 * the default inward 16384 byte buffer to conform to the TLS specification.
3471 *
3472 * The minimum required outward buffer size is determined by the handshake
3473 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3474 * The specific size requirement depends on the configured ciphers and any
3475 * certificate data which is sent during the handshake.
3476 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003477 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3478 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003479 */
3480//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3481
Hanno Beckere0b150f2018-08-21 15:51:03 +01003482/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3483 *
3484 * Maximum number of heap-allocated bytes for the purpose of
3485 * DTLS handshake message reassembly and future message buffering.
3486 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003487 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003488 * to account for a reassembled handshake message of maximum size,
3489 * together with its reassembly bitmap.
3490 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003491 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003492 * should be sufficient for all practical situations as it allows
3493 * to reassembly a large handshake message (such as a certificate)
3494 * while buffering multiple smaller handshake messages.
3495 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003496 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003497//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003498
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003499//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3500//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3501//#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 +02003502
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003503/**
3504 * Complete list of ciphersuites to use, in order of preference.
3505 *
3506 * \warning No dependency checking is done on that field! This option can only
3507 * be used to restrict the set of available ciphersuites. It is your
3508 * responsibility to make sure the needed modules are active.
3509 *
3510 * Use this to save a few hundred bytes of ROM (default ordering of all
3511 * available ciphersuites) and a few to a few hundred bytes of RAM.
3512 *
3513 * The value below is only an example, not the default.
3514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515//#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 +02003516
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003517/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003519//#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 +01003520
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003521/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003522 * Allow SHA-1 in the default TLS configuration for certificate signing.
3523 * Without this build-time option, SHA-1 support must be activated explicitly
3524 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003525 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003526 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003527 *
3528 * \warning SHA-1 is considered a weak message digest and its use constitutes
3529 * a security risk. If possible, we recommend avoiding dependencies
3530 * on it, and considering stronger message digests instead.
3531 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003532 */
Gilles Peskine5639aef2019-07-27 23:39:56 +02003533//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003534
3535/**
3536 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3537 * signature and ciphersuite selection. Without this build-time option, SHA-1
3538 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3539 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3540 * default. At the time of writing, there is no practical attack on the use
3541 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003542 * to preserve compatibility with existing peers, but the general
3543 * warning applies nonetheless:
3544 *
3545 * \warning SHA-1 is considered a weak message digest and its use constitutes
3546 * a security risk. If possible, we recommend avoiding dependencies
3547 * on it, and considering stronger message digests instead.
3548 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003549 */
3550#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003551
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003552/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003553 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003554 * mbedtls_platform_zeroize(). This replaces the default implementation in
3555 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003556 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003557 * mbedtls_platform_zeroize() is a widely used function across the library to
3558 * zero a block of memory. The implementation is expected to be secure in the
3559 * sense that it has been written to prevent the compiler from removing calls
3560 * to mbedtls_platform_zeroize() as part of redundant code elimination
3561 * optimizations. However, it is difficult to guarantee that calls to
3562 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3563 * versions of the C language standards do not provide a secure implementation
3564 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3565 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003566 * example by using directives specific to their compiler, features from newer
3567 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003568 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003569 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003570//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003571
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003572/**
3573 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003574 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003575 * platform_util.c.
3576 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003577 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003578 * library will try to use safer implementations of this function, such as
3579 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003580 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003581 * using the standard gmtime(). In this case, calls from the library to
3582 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003583 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003584 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003585 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3586 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3587 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003588 */
Hanno Becker6a739782018-09-05 15:06:19 +01003589//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003590
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003591/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003592 * Enable the verified implementations of ECDH primitives from Project Everest
3593 * (currently only Curve25519). This feature changes the layout of ECDH
3594 * contexts and therefore is a compatibility break for applications that access
3595 * fields of a mbedtls_ecdh_context structure directly. See also
3596 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003597 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003598//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003599
Simon Butcher30b5f972016-06-08 19:00:23 +01003600/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003601
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003602/* Target and application specific configurations
3603 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003604 * Allow user to override any previous default.
3605 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003606 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003607#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003608#include MBEDTLS_USER_CONFIG_FILE
3609#endif
3610
Jaeden Amero6609aef2019-07-04 20:01:14 +01003611#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613#endif /* MBEDTLS_CONFIG_H */