blob: a2f187547d03d5a492f5311585f3b835e84fc508 [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écimod5f47592019-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
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100229//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100230//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100231
232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100234 *
235 * Mark deprecated functions so that they generate a warning if used.
236 * Functions deprecated in one version will usually be removed in the next
237 * version. You can enable this to help you prepare the transition to a new
238 * major version by making sure your code is not using these functions.
239 *
240 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100242 *
243 * Uncomment to get warnings on using deprecated functions.
244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100246
247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100249 *
250 * Remove deprecated functions so that they generate an error if used.
251 * Functions deprecated in one version will usually be removed in the next
252 * version. You can enable this to help you prepare the transition to a new
253 * major version by making sure your code is not using these functions.
254 *
255 * Uncomment to get errors on using deprecated functions.
256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100258
Simon Butcherb4868032018-12-06 17:36:34 +0000259/**
260 * \def MBEDTLS_CHECK_PARAMS
261 *
Manuel Pégourié-Gonnardcd2b29c2018-12-12 10:23:57 +0100262 * This configuration option controls whether the library validates more of
263 * the parameters passed to it.
Simon Butcherb4868032018-12-06 17:36:34 +0000264 *
Manuel Pégourié-Gonnardcd2b29c2018-12-12 10:23:57 +0100265 * When this flag is not defined, the library only attempts to validate an
266 * input parameter if: (1) they may come from the outside world (such as the
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +0100267 * network, the filesystem, etc.) or (2) not validating them could result in
268 * internal memory errors such as overflowing a buffer controlled by the
269 * library. On the other hand, it doesn't attempt to validate parameters whose
270 * values are fully controlled by the application (such as pointers).
Simon Butcherb4868032018-12-06 17:36:34 +0000271 *
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +0100272 * When this flag is defined, the library additionally attempts to validate
273 * parameters that are fully controlled by the application, and should always
274 * be valid if the application code is fully correct and trusted.
Simon Butcherb4868032018-12-06 17:36:34 +0000275 *
Manuel Pégourié-Gonnardcd2b29c2018-12-12 10:23:57 +0100276 * For example, when a function accepts as input a pointer to a buffer that may
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +0100277 * contain untrusted data, and its documentation mentions that this pointer
278 * must not be NULL:
Gilles Peskine30346f62019-06-13 16:44:19 +0200279 * - The pointer is checked to be non-NULL only if this option is enabled.
280 * - The content of the buffer is always validated.
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +0100281 *
282 * When this flag is defined, if a library function receives a parameter that
Gilles Peskine30346f62019-06-13 16:44:19 +0200283 * is invalid:
284 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
285 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
286 * will immediately return. If the function returns an Mbed TLS error code,
287 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +0100288 *
Gilles Peskine30346f62019-06-13 16:44:19 +0200289 * When defining this flag, you also need to arrange a definition for
290 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
291 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
292 * function mbedtls_param_failed(), but the library does not define this
293 * function. If you do not make any other arrangements, you must provide
294 * the function mbedtls_param_failed() in your application.
295 * See `platform_util.h` for its prototype.
296 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
297 * library defines #MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
298 * You can still supply an alternative definition of
299 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
300 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
301 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
302 * the library will call the macro that you defined and will not supply
303 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
304 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
305 * files include `<assert.h>`.
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +0100306 *
307 * Uncomment to enable validation of application-controlled parameters.
Simon Butcherb4868032018-12-06 17:36:34 +0000308 */
Manuel Pégourié-Gonnarda9676262018-12-10 16:12:56 +0100309//#define MBEDTLS_CHECK_PARAMS
Simon Butcherb4868032018-12-06 17:36:34 +0000310
Gilles Peskine30346f62019-06-13 16:44:19 +0200311/**
312 * \def MBEDTLS_CHECK_PARAMS_ASSERT
313 *
314 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
315 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
316 *
317 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
318 * calling a function mbedtls_param_failed(). See the documentation of
319 * #MBEDTLS_CHECK_PARAMS for details.
320 *
321 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
322 */
323//#define MBEDTLS_CHECK_PARAMS_ASSERT
324
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200325/* \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000326
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000327/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000328 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000329 *
330 * This section sets support for features that are or are not needed
331 * within the modules that are enabled.
332 * \{
333 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000334
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000335/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200336 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100337 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200338 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200339 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100340 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
343 * You will need to provide a header "timing_alt.h" and an implementation at
344 * compile time.
345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347
348/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100349 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200350 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100351 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100352 * alternate core implementation of a symmetric crypto, an arithmetic or hash
353 * module (e.g. platform specific assembly optimized implementations). Keep
354 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200355 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200356 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000360 * provide the "struct mbedtls_aes_context" definition and omit the base
361 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200362 * "aes.h" to include the new function definitions.
363 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364 * Uncomment a macro to enable alternate implementation of the corresponding
365 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100366 *
367 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
368 * use constitutes a security risk. If possible, we recommend
369 * avoiding dependencies on them, and considering stronger message
370 * digests and ciphers instead.
371 *
Paul Bakker90995b52013-06-24 19:20:35 +0200372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373//#define MBEDTLS_AES_ALT
374//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000375//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376//#define MBEDTLS_BLOWFISH_ALT
377//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200378//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300379//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200380//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200381//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000383//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000384//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100385//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300386//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387//#define MBEDTLS_MD2_ALT
388//#define MBEDTLS_MD4_ALT
389//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300390//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000392//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393//#define MBEDTLS_SHA1_ALT
394//#define MBEDTLS_SHA256_ALT
395//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000396//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000397
Janos Follathb0697532016-08-18 12:38:46 +0100398/*
399 * When replacing the elliptic curve module, pleace consider, that it is
400 * implemented with two .c files:
401 * - ecp.c
402 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000403 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
404 * macros as described above. The only difference is that you have to make sure
405 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100406 */
407//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200408
409/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100410 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200411 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100412 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
413 * alternate core implementation of symmetric crypto or hash function. Keep in
414 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415 *
416 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200418 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
420 * no longer provide the mbedtls_sha1_process() function, but it will still provide
421 * the other function (using your mbedtls_sha1_process() function) and the definition
422 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200423 * with this definition.
424 *
Hanno Beckera5723f42017-06-26 12:46:19 +0100425 * \note Because of a signature change, the core AES encryption and decryption routines are
426 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
427 * respectively. When setting up alternative implementations, these functions should
Antonin Décimod5f47592019-01-23 15:24:37 +0100428 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Becker2de930f2017-07-20 09:50:59 +0100429 * must stay untouched.
Hanno Beckera5723f42017-06-26 12:46:19 +0100430 *
431 * \note If you use the AES_xxx_ALT macros, then is is recommended to also set
432 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
433 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200434 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200435 * Uncomment a macro to enable alternate implementation of the corresponding
436 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100437 *
438 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
439 * constitutes a security risk. If possible, we recommend avoiding
440 * dependencies on them, and considering stronger message digests
441 * and ciphers instead.
442 *
Janos Follath9f24b732019-01-07 15:01:32 +0000443 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
444 * enabled, then the deterministic ECDH signature functions pass the
445 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
446 * alternative implementations should use the RNG only for generating
447 * the ephemeral key and nothing else. If this is not possible, then
448 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
449 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
450 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
451 * desirable).
452 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454//#define MBEDTLS_MD2_PROCESS_ALT
455//#define MBEDTLS_MD4_PROCESS_ALT
456//#define MBEDTLS_MD5_PROCESS_ALT
457//#define MBEDTLS_RIPEMD160_PROCESS_ALT
458//#define MBEDTLS_SHA1_PROCESS_ALT
459//#define MBEDTLS_SHA256_PROCESS_ALT
460//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200461//#define MBEDTLS_DES_SETKEY_ALT
462//#define MBEDTLS_DES_CRYPT_ECB_ALT
463//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200464//#define MBEDTLS_AES_SETKEY_ENC_ALT
465//#define MBEDTLS_AES_SETKEY_DEC_ALT
466//#define MBEDTLS_AES_ENCRYPT_ALT
467//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300468//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300469//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300470//#define MBEDTLS_ECDSA_VERIFY_ALT
471//#define MBEDTLS_ECDSA_SIGN_ALT
472//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200473
474/**
Janos Follathc44ab972016-11-18 16:38:23 +0000475 * \def MBEDTLS_ECP_INTERNAL_ALT
476 *
477 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100478 *
479 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100480 * alternative core implementation of elliptic curve arithmetic. Keep in mind
481 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100482 *
483 * This partially replaces one function. The header file from mbed TLS is still
484 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
485 * is still present and it is used for group structures not supported by the
486 * alternative.
487 *
Janos Follathc44ab972016-11-18 16:38:23 +0000488 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
489 * and implementing the following functions:
490 * unsigned char mbedtls_internal_ecp_grp_capable(
491 * const mbedtls_ecp_group *grp )
492 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Janos Follathd2af46f2018-12-07 10:39:00 +0000493 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000494 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
495 * replacement functions implement arithmetic for the given group and 0
496 * otherwise.
Janos Follathd2af46f2018-12-07 10:39:00 +0000497 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000498 * called before and after each point operation and provide an opportunity to
499 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100500 *
Janos Follathc44ab972016-11-18 16:38:23 +0000501 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
Janos Follath4d9c69d2016-11-01 13:27:03 +0000502 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
Janos Follathc44ab972016-11-18 16:38:23 +0000503 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
504 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
505 * receives it as an argument). If the group is not supported then the original
Janos Follathee782bc2016-11-07 15:41:26 +0000506 * implementation is used. The other functions and the definition of
507 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
Janos Follathc44ab972016-11-18 16:38:23 +0000508 * implementation of mbedtls_internal_ecp_double_jac and
509 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
Janos Follathb0697532016-08-18 12:38:46 +0100510 *
511 * Uncomment a macro to enable alternate implementation of the corresponding
512 * function.
513 */
514/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000515//#define MBEDTLS_ECP_INTERNAL_ALT
Janos Follathb0697532016-08-18 12:38:46 +0100516/* Support for Weierstrass curves with Jacobi representation */
517//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
518//#define MBEDTLS_ECP_ADD_MIXED_ALT
519//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
520//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
521//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
522/* Support for curves with Montgomery arithmetic */
523//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
524//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
525//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
526
527/**
Simon Butcherab5df402016-06-11 02:31:21 +0100528 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100529 *
Simon Butcherab5df402016-06-11 02:31:21 +0100530 * Enables testing and use of mbed TLS without any configured entropy sources.
531 * This permits use of the library on platforms before an entropy source has
532 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
533 * MBEDTLS_ENTROPY_NV_SEED switches).
534 *
535 * WARNING! This switch MUST be disabled in production builds, and is suitable
536 * only for development.
537 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100538 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100539 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
540 *
Janos Follath53de7842016-06-08 15:29:18 +0100541 */
Simon Butcherab5df402016-06-11 02:31:21 +0100542//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100543
544/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200545 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200546 *
547 * Uncomment this macro to let mbed TLS use your own implementation of a
548 * hardware entropy collector.
549 *
550 * Your function must be called \c mbedtls_hardware_poll(), have the same
551 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
552 *
553 * Uncomment to use your own hardware entropy collector.
554 */
555//#define MBEDTLS_ENTROPY_HARDWARE_ALT
556
557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000559 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100560 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000561 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 * Uncomment this macro to use precomputed AES tables stored in ROM.
563 * Comment this macro to generate AES tables in RAM at runtime.
564 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100565 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
566 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100567 * initialization time before the first AES operation can be performed.
568 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
569 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
570 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 *
572 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
573 *
Paul Bakker15566e42011-04-24 21:19:15 +0000574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000576
577/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100578 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200579 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100580 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200581 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100582 * Uncommenting this macro omits 75% of the AES tables from
583 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
584 * by computing their values on the fly during operations
585 * (the tables are entry-wise rotations of one another).
586 *
587 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100588 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100589 * runtime. Specifically, one has to compare 4 accesses within
590 * different tables to 4 accesses with additional arithmetic
591 * operations within the same table. The performance gain/loss
592 * depends on the system and memory details.
593 *
594 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
595 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200596 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100597//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200598
599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200601 *
602 * Use less ROM for the Camellia implementation (saves about 768 bytes).
603 *
604 * Uncomment this macro to use less memory for Camellia.
605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200607
608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200610 *
611 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200614
615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000617 *
618 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000621
622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000624 *
625 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000628
629/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100630 * \def MBEDTLS_CIPHER_MODE_OFB
631 *
632 * Enable Output Feedback mode (OFB) for symmetric ciphers.
633 */
634#define MBEDTLS_CIPHER_MODE_OFB
635
636/**
637 * \def MBEDTLS_CIPHER_MODE_XTS
638 *
639 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
640 */
641#define MBEDTLS_CIPHER_MODE_XTS
642
643/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000645 *
646 * Enable NULL cipher.
647 * Warning: Only do so when you know what you are doing. This allows for
648 * encryption or channels without any security!
649 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650 * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable
Paul Bakkerfab5c822012-02-06 16:45:10 +0000651 * the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
653 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
654 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
655 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
656 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
657 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
658 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
659 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
660 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
661 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
662 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
663 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
664 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
665 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
666 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
667 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
668 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
669 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
670 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000671 *
672 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000675
676/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100677 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200678 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100679 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
680 * specific padding modes in the cipher layer with cipher modes that support
681 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200682 *
683 * If you disable all padding modes, only full blocks can be used with CBC.
684 *
685 * Enable padding modes in the cipher layer.
686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687#define MBEDTLS_CIPHER_PADDING_PKCS7
688#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
689#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
690#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200691
692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000694 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200695 * Enable weak ciphersuites in SSL / TLS.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000696 * Warning: Only do so when you know what you are doing. This allows for
Paul Bakker9a736322012-11-14 12:39:52 +0000697 * channels with virtually no security at all!
Paul Bakkerfab5c822012-02-06 16:45:10 +0000698 *
699 * This enables the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700 * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA
701 * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000702 *
703 * Uncomment this macro to enable weak ciphersuites
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100704 *
705 * \warning DES is considered a weak cipher and its use constitutes a
706 * security risk. We recommend considering stronger ciphers instead.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES
Paul Bakkerfab5c822012-02-06 16:45:10 +0000709
710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711 * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200712 *
713 * Remove RC4 ciphersuites by default in SSL / TLS.
714 * This flag removes the ciphersuites based on RC4 from the default list as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200716 * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200717 * explicitly.
718 *
719 * Uncomment this macro to remove RC4 ciphersuites by default.
720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES
Manuel Pégourié-Gonnard01edb102014-06-24 22:42:34 +0200722
723/**
Andres Amaya Garcia5d8aade2018-10-30 18:21:41 +0000724 * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES
725 *
726 * Remove 3DES ciphersuites by default in SSL / TLS.
727 * This flag removes the ciphersuites based on 3DES from the default list as
728 * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible
729 * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including
730 * them explicitly.
731 *
Andres Amaya Garcia7c86e9a2019-02-11 21:47:30 +0000732 * A man-in-the-browser attacker can recover authentication tokens sent through
Andres Amaya Garcia6882ec12018-11-26 20:57:49 +0000733 * a TLS connection using a 3DES based cipher suite (see "On the Practical
734 * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan
735 * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls
736 * in your threat model or you are unsure, then you should keep this option
737 * enabled to remove 3DES based cipher suites.
738 *
Andres Amaya Garcia5d8aade2018-10-30 18:21:41 +0000739 * Comment this macro to keep 3DES in the default ciphersuite list.
740 */
741#define MBEDTLS_REMOVE_3DES_CIPHERSUITES
742
743/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100744 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200745 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100746 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
747 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200748 *
749 * Comment macros to disable the curve and functions for it
750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
752#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
753#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
754#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
755#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
756#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
757#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
758#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
759#define MBEDTLS_ECP_DP_BP256R1_ENABLED
760#define MBEDTLS_ECP_DP_BP384R1_ENABLED
761#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200762#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000763#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200764
765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200767 *
768 * Enable specific 'modulo p' routines for each NIST prime.
769 * Depending on the prime and architecture, makes operations 4 to 8 times
770 * faster on the corresponding curve.
771 *
772 * Comment this macro to disable NIST curves optimisation.
773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200775
776/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200777 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100778 *
779 * Enable "non-blocking" ECC operations that can return early and be resumed.
780 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200781 * This allows various functions to pause by returning
782 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
783 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
784 * order to further progress and eventually complete their operation. This is
785 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
786 * number of ECC operations a function may perform before pausing; see
787 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100788 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200789 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200790 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100791 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200792 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200793 *
Ron Eldor19779c42018-11-05 16:58:13 +0200794 * \note This option only works with the default software implementation of
795 * elliptic curve functionality. It is incompatible with
Ron Eldor72137442018-11-05 22:31:32 +0200796 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT and MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100797 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200798//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100799
800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100802 *
803 * Enable deterministic ECDSA (RFC 6979).
804 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
805 * may result in a compromise of the long-term signing key. This is avoided by
806 * the deterministic variant.
807 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * Requires: MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100809 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100810 * Comment this macro to disable deterministic ECDSA.
811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100813
814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200816 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200817 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200818 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200819 * This enables the following ciphersuites (if other requisites are
820 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
822 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
823 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
824 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
825 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
826 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
827 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
828 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
829 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
830 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
831 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
832 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200835
836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200839 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200842 *
843 * This enables the following ciphersuites (if other requisites are
844 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
846 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
847 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
848 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
849 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
850 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
851 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
852 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
853 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
854 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
855 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
856 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100857 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100858 * \warning Using DHE constitutes a security risk as it
859 * is not possible to validate custom DH parameters.
860 * If possible, it is recommended users should consider
861 * preferring other methods of key exchange.
862 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100863 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866
867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200869 *
870 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
871 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200873 *
874 * This enables the following ciphersuites (if other requisites are
875 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
877 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
878 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
879 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
880 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
881 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
882 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
883 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200886
887/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200889 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200890 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200891 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
893 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 *
895 * This enables the following ciphersuites (if other requisites are
896 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
898 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
899 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
900 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
901 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
902 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
903 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
904 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
905 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
906 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
907 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
908 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911
912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200914 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200915 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200916 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
918 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200919 *
920 * This enables the following ciphersuites (if other requisites are
921 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
923 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
924 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
925 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
926 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
927 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
928 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
929 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
930 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
931 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
932 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
933 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
934 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
935 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
936 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
Paul Bakkere07f41d2013-04-19 09:08:57 +0200937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200939
940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200942 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200943 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200944 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
946 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200947 *
948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
951 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
952 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
953 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
954 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
955 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
956 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
957 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
958 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
959 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
960 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
961 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
962 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100963 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100964 * \warning Using DHE constitutes a security risk as it
965 * is not possible to validate custom DH parameters.
966 * If possible, it is recommended users should consider
967 * preferring other methods of key exchange.
968 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100969 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200972
973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200975 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200976 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
979 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200980 *
981 * This enables the following ciphersuites (if other requisites are
982 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
984 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
985 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
986 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
987 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
988 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
989 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
990 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
991 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
992 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
993 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
994 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200995 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200997
998/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001000 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001001 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001002 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001004 *
1005 * This enables the following ciphersuites (if other requisites are
1006 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1008 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1009 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1010 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1011 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1012 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1013 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1014 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1015 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1016 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1017 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1018 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001021
1022/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001024 *
1025 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1026 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001028 *
1029 * This enables the following ciphersuites (if other requisites are
1030 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1032 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1033 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1034 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1035 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1036 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1037 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1038 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1039 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1040 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1041 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1042 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001048 *
1049 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001052 *
1053 * This enables the following ciphersuites (if other requisites are
1054 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
1056 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1057 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1058 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1059 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1060 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1061 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1062 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1063 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1064 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1065 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1066 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001069
1070/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001071 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1072 *
1073 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1074 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001075 * \warning This is currently experimental. EC J-PAKE support is based on the
1076 * Thread v1.0.0 specification; incompatible changes to the specification
1077 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001078 *
1079 * Requires: MBEDTLS_ECJPAKE_C
1080 * MBEDTLS_SHA256_C
1081 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1082 *
1083 * This enables the following ciphersuites (if other requisites are
1084 * enabled as well):
1085 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1086 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001087//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001088
1089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001091 *
1092 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1093 * RFC 5915 and RFC 5480.
1094 *
1095 * Currently this means parsing the SpecifiedECDomain choice of EC
1096 * parameters (only known groups are supported, not arbitrary domains, to
1097 * avoid validation issues).
1098 *
1099 * Disable if you only need to support RFC 5915 + 5480 key formats.
1100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001102
1103/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001105 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * Enable a dummy error function to make use of mbedtls_strerror() in
1107 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1108 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001109 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1111 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001112 *
1113 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001117
1118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001120 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001121 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001122 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001126
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001129 *
1130 * Enable functions that use the filesystem.
1131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001133
1134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001136 *
1137 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001139 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001140 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001141 * application.
1142 *
1143 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001146
1147/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001149 *
1150 * Do not use built-in platform entropy functions.
1151 * This is useful if your platform does not support
1152 * standards like the /dev/urandom or Windows CryptoAPI.
1153 *
1154 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001157
1158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001160 *
1161 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1162 * default SHA-512 based one (if both are available).
1163 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001165 *
1166 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1167 * if you have performance concerns.
1168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * This option is only useful if both MBEDTLS_SHA256_C and
1170 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001173
1174/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001175 * \def MBEDTLS_ENTROPY_NV_SEED
1176 *
1177 * Enable the non-volatile (NV) seed file-based entropy source.
1178 * (Also enables the NV seed read/write functions in the platform layer)
1179 *
1180 * This is crucial (if not required) on systems that do not have a
1181 * cryptographic entropy source (in hardware or kernel) available.
1182 *
1183 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1184 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001185 * \note The read/write functions that are used by the entropy source are
1186 * determined in the platform layer, and can be modified at runtime and/or
1187 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1188 *
1189 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001190 * with regular fopen(), please make sure you make a seedfile with the
1191 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1192 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001193 * and written to or you will get an entropy source error! The default
1194 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1195 * bytes from the file.
1196 *
1197 * \note The entropy collector will write to the seed file before entropy is
1198 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001199 */
1200//#define MBEDTLS_ENTROPY_NV_SEED
1201
1202/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001204 *
1205 * Enable debugging of buffer allocator memory issues. Automatically prints
1206 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1207 * function for 'debug output' of allocated memory.
1208 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001210 *
1211 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001214
1215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001217 *
1218 * Include backtrace information with each allocated block.
1219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001221 * GLIBC-compatible backtrace() an backtrace_symbols() support
1222 *
1223 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001226
1227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001229 *
1230 * Support external private RSA keys (eg from a HSM) in the PK layer.
1231 *
1232 * Comment this macro to disable support for external private RSA keys.
1233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001235
1236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001238 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001239 * Enable support for PKCS#1 v1.5 encoding.
1240 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001241 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001242 *
Paul Bakker48377d92013-08-30 12:06:24 +02001243 * This enables support for PKCS#1 v1.5 operations.
1244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001246
1247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001249 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001250 * Enable support for PKCS#1 v2.1 encoding.
1251 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001253 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001254 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001256#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001257
1258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001260 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001261 * Do not use the Chinese Remainder Theorem
1262 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001263 *
1264 * Uncomment this macro to disable the use of CRT in RSA.
1265 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001267//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001268
1269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001271 *
1272 * Enable the checkup functions (*_self_test).
1273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001275
1276/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001277 * \def MBEDTLS_SHA256_SMALLER
1278 *
1279 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1280 * lower performance.
1281 *
1282 * The default implementation is meant to be a reasonnable compromise between
1283 * performance and size. This version optimizes more aggressively for size at
Manuel Pégourié-Gonnard8bf8f2e2019-09-05 13:08:21 +02001284 * the expense of performance.
1285 *
1286 * For example, on a Cortex-M0 core it reduces the size of the module by about
1287 * 2KiB for a performance cost of about 45%; on a Cortex-M4 core the size
1288 * benefit is about 1.5 KiB for a performance cost of of about 30%.
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001289 *
1290 * Uncomment to enable the smaller implementation of SHA256.
1291 */
1292//#define MBEDTLS_SHA256_SMALLER
1293
1294/**
Manuel Pégourié-Gonnard9b781b22019-07-16 14:32:27 +02001295 * \def MBEDTLS_SHA256_NO_SHA224
1296 *
1297 * Disable the SHA-224 option of the SHA-256 module. Use this to save some
1298 * code size on devices that don't use SHA-224.
1299 *
1300 * Uncomment to disable SHA-224
1301 */
1302//#define MBEDTLS_SHA256_NO_SHA224
1303
1304/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001306 *
1307 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001308 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001309 * with other servers, only debugging of failures is harder.
1310 *
1311 * The advantage of not sending alert messages, is that no information is given
1312 * about reasons for failures thus preventing adversaries of gaining intel.
1313 *
1314 * Enable sending of all alert messages
1315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001317
1318/**
Hanno Becker02f26092019-07-03 16:13:00 +01001319 * \def MBEDTLS_SSL_RECORD_CHECKING
1320 *
1321 * Enable the API mbedtls_ssl_check_record() which allows to check the
1322 * validity, freshness and authenticity of an incoming record without
1323 * modifying the externally visible state of the SSL context.
1324 *
1325 * See mbedtls_ssl_check_record() for more information.
1326 *
1327 * Uncomment to enable support for record checking.
1328 */
1329#define MBEDTLS_SSL_RECORD_CHECKING
1330
1331/**
Hanno Beckera5a2b082019-05-15 14:03:01 +01001332 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
Hanno Becker81bd9712019-04-09 15:12:41 +01001333 *
Hanno Beckerefde5b22019-04-23 11:36:56 +01001334 * Enable support for the DTLS Connection ID extension
Hanno Becker3cdf8fe2019-05-15 10:26:32 +01001335 * (version draft-ietf-tls-dtls-connection-id-05,
1336 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
Hanno Beckerefde5b22019-04-23 11:36:56 +01001337 * which allows to identify DTLS connections across changes
1338 * in the underlying transport.
Hanno Becker81bd9712019-04-09 15:12:41 +01001339 *
Manuel Pégourié-Gonnarde4315632019-07-01 10:57:27 +02001340 * Setting this option enables the SSL APIs mbedtls_ssl_set_cid(),
1341 * mbedtls_ssl_get_peer_cid() and mbedtls_ssl_conf_cid().
Hanno Beckeref2b8b02019-05-15 09:44:59 +01001342 * See the corresponding documentation for more information.
Hanno Becker81bd9712019-04-09 15:12:41 +01001343 *
1344 * \warning The Connection ID extension is still in draft state.
1345 * We make no stability promises for the availability
1346 * or the shape of the API controlled by this option.
1347 *
Hanno Beckereec2be92019-05-03 13:06:44 +01001348 * The maximum lengths of outgoing and incoming CIDs can be configured
1349 * through the options
1350 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1351 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
Hanno Becker81bd9712019-04-09 15:12:41 +01001352 *
1353 * Requires: MBEDTLS_SSL_PROTO_DTLS
1354 *
1355 * Uncomment to enable the Connection ID extension.
1356 */
Hanno Becker4753e652019-05-23 17:02:06 +01001357//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
Hanno Becker81bd9712019-04-09 15:12:41 +01001358
1359/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001360 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1361 *
1362 * Enable asynchronous external private key operations in SSL. This allows
1363 * you to configure an SSL connection to call an external cryptographic
1364 * module to perform private key operations instead of performing the
1365 * operation inside the library.
1366 *
1367 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001368//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001369
1370/**
Manuel Pégourié-Gonnard91fa5ba2019-05-28 12:28:17 +02001371 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1372 *
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02001373 * Enable serialization of the TLS context structures, through use of the
1374 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
Manuel Pégourié-Gonnard91fa5ba2019-05-28 12:28:17 +02001375 *
1376 * This pair of functions allows one side of a connection to serialize the
1377 * context associated with the connection, then free or re-use that context
1378 * while the serialized state is persisted elsewhere, and finally deserialize
1379 * that state to a live context for resuming read/write operations on the
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02001380 * connection. From a protocol perspective, the state of the connection is
1381 * unaffected, in particular this is entirely transparent to the peer.
Manuel Pégourié-Gonnard91fa5ba2019-05-28 12:28:17 +02001382 *
1383 * Note: this is distinct from TLS session resumption, which is part of the
1384 * protocol and fully visible by the peer. TLS session resumption enables
1385 * establishing new connections associated to a saved session with shorter,
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02001386 * lighter handshakes, while context serialization is a local optimization in
Manuel Pégourié-Gonnard91fa5ba2019-05-28 12:28:17 +02001387 * handling a single, potentially long-lived connection.
1388 *
1389 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1390 * saved after the handshake to allow for more efficient serialization, so if
1391 * you don't need this feature you'll save RAM by disabling it.
1392 *
1393 * Comment to disable the context serialization APIs.
1394 */
1395#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1396
1397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001398 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001399 *
1400 * Enable the debug messages in SSL module for all issues.
1401 * Debug messages have been disabled in some places to prevent timing
1402 * attacks due to (unbalanced) debugging function calls.
1403 *
1404 * If you need all error reporting you should enable this during debugging,
1405 * but remove this for production servers that should log as well.
1406 *
1407 * Uncomment this macro to report all debug messages on errors introducing
1408 * a timing side-channel.
1409 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001411//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001412
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001414 *
1415 * Enable support for Encrypt-then-MAC, RFC 7366.
1416 *
1417 * This allows peers that both support it to use a more robust protection for
1418 * ciphersuites using CBC, providing deep resistance against timing attacks
1419 * on the padding or underlying cipher.
1420 *
1421 * This only affects CBC ciphersuites, and is useless if none is defined.
1422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1424 * MBEDTLS_SSL_PROTO_TLS1_1 or
1425 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001426 *
1427 * Comment this macro to disable support for Encrypt-then-MAC
1428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001429#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001432 *
1433 * Enable support for Extended Master Secret, aka Session Hash
1434 * (draft-ietf-tls-session-hash-02).
1435 *
1436 * This was introduced as "the proper fix" to the Triple Handshake familiy of
1437 * attacks, but it is recommended to always use it (even if you disable
1438 * renegotiation), since it actually fixes a more fundamental issue in the
1439 * original SSL/TLS design, and has implications beyond Triple Handshake.
1440 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001441 * Requires: MBEDTLS_SSL_PROTO_TLS1 or
1442 * MBEDTLS_SSL_PROTO_TLS1_1 or
1443 * MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001444 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001445 * Comment this macro to disable support for Extended Master Secret.
1446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001448
Paul Bakkerd66f0702013-01-31 16:57:45 +01001449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450 * \def MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001451 *
1452 * Enable support for FALLBACK_SCSV (draft-ietf-tls-downgrade-scsv-00).
1453 *
1454 * For servers, it is recommended to always enable this, unless you support
1455 * only one version of TLS, or know for sure that none of your clients
1456 * implements a fallback strategy.
1457 *
1458 * For clients, you only need this if you're using a fallback strategy, which
1459 * is not recommended in the first place, unless you absolutely need it to
1460 * interoperate with buggy (version-intolerant) servers.
1461 *
1462 * Comment this macro to disable support for FALLBACK_SCSV
1463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464#define MBEDTLS_SSL_FALLBACK_SCSV
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001465
1466/**
Hanno Beckerb90f6552019-02-05 17:04:00 +00001467 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1468 *
Hanno Becker3ed64572019-02-25 10:13:33 +00001469 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerb90f6552019-02-05 17:04:00 +00001470 * giving access to the peer's certificate after completion of the handshake.
1471 *
1472 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1473 * recommended to disable this option for reduced RAM usage.
1474 *
1475 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1476 * defined, but always returns \c NULL.
1477 *
1478 * \note This option has no influence on the protection against the
1479 * triple handshake attack. Even if it is disabled, Mbed TLS will
1480 * still ensure that certificates do not change during renegotiation,
1481 * for exaple by keeping a hash of the peer's certificate.
1482 *
1483 * Comment this macro to disable storing the peer's certificate
1484 * after the handshake.
1485 */
1486#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1487
1488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489 * \def MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001490 *
1491 * Enable hooking functions in SSL module for hardware acceleration of
1492 * individual records.
1493 *
1494 * Uncomment this macro to enable hooking functions.
Paul Bakker05ef8352012-05-08 09:17:57 +00001495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496//#define MBEDTLS_SSL_HW_RECORD_ACCEL
Paul Bakker05ef8352012-05-08 09:17:57 +00001497
1498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001500 *
1501 * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0.
1502 *
1503 * This is a countermeasure to the BEAST attack, which also minimizes the risk
1504 * of interoperability issues compared to sending 0-length records.
1505 *
1506 * Comment this macro to disable 1/n-1 record splitting.
1507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508#define MBEDTLS_SSL_CBC_RECORD_SPLITTING
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001509
1510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001512 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001513 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001514 *
1515 * The two main uses of renegotiation are (1) refresh keys on long-lived
1516 * connections and (2) client authentication after the initial handshake.
1517 * If you don't need renegotiation, it's probably better to disable it, since
1518 * it has been associated with security issues in the past and is easy to
1519 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001520 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001521 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001522 *
1523 * \note Even if this option is disabled, both client and server are aware
1524 * of the Renegotiation Indication Extension (RFC 5746) used to
1525 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1526 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1527 * configuration of this extension).
1528 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001531
1532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533 * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001534 *
1535 * Enable support for receiving and parsing SSLv2 Client Hello messages for the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536 * SSL Server module (MBEDTLS_SSL_SRV_C).
Paul Bakker78a8c712013-03-06 17:01:52 +01001537 *
Manuel Pégourié-Gonnard265dd5c2015-03-10 13:48:34 +00001538 * Uncomment this macro to enable support for SSLv2 Client Hello messages.
Paul Bakker78a8c712013-03-06 17:01:52 +01001539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO
Paul Bakker78a8c712013-03-06 17:01:52 +01001541
1542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543 * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001544 *
1545 * Pick the ciphersuite according to the client's preferences rather than ours
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001547 *
1548 * Uncomment this macro to respect client's ciphersuite order
1549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
Manuel Pégourié-Gonnard1a9f2c72013-11-30 18:30:06 +01001551
1552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001554 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001555 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001556 *
1557 * Comment this macro to disable support for the max_fragment_length extension
1558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001560
1561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562 * \def MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001563 *
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001564 * Enable support for SSL 3.0 (if TLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001565 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 * Requires: MBEDTLS_MD5_C
1567 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001568 *
1569 * Comment this macro to disable support for SSL 3.0
1570 */
Janos Follathe2681a42016-03-07 15:57:05 +00001571//#define MBEDTLS_SSL_PROTO_SSL3
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001572
1573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574 * \def MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001575 *
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001576 * Enable support for TLS 1.0 (if TLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001577 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 * Requires: MBEDTLS_MD5_C
1579 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001580 *
1581 * Comment this macro to disable support for TLS 1.0
1582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583#define MBEDTLS_SSL_PROTO_TLS1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001584
1585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586 * \def MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001587 *
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001588 * Enable support for TLS 1.1 (if TLS is enabled) and DTLS 1.0 (if DTLS is
1589 * enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001590 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591 * Requires: MBEDTLS_MD5_C
1592 * MBEDTLS_SHA1_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001593 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001594 * Comment this macro to disable support for TLS 1.1 / DTLS 1.0
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596#define MBEDTLS_SSL_PROTO_TLS1_1
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001597
1598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001600 *
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001601 * Enable support for TLS 1.2 (if TLS is enabled) and DTLS 1.2 (if DTLS is
1602 * enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604 * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001605 * (Depends on ciphersuites)
1606 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001610
1611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001613 *
1614 * Enable support for DTLS (all available versions).
1615 *
Manuel Pégourié-Gonnardc6d9e3a2019-06-07 11:07:53 +02001616 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2,
1617 * and/or this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0.
1618 *
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001619 * \see MBEDTLS_SSL_PROTO_NO_TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001620 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 * Requires: MBEDTLS_SSL_PROTO_TLS1_1
1622 * or MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001623 *
1624 * Comment this macro to disable support for DTLS
1625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001627
1628/**
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001629 * \def MBEDTLS_SSL_PROTO_NO_TLS
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001630 *
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001631 * Disable support for SSL/TLS (all available versions) - this doesn't affect
Manuel Pégourié-Gonnard41efa212019-06-18 10:28:52 +02001632 * support for DTLS which is controlled by #MBEDTLS_SSL_PROTO_DTLS. This is
1633 * useful to reduce code size in configurations where only DTLS is used.
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001634 *
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001635 * Disable this and enable MBEDTLS_SSL_PROTO_TLS1_2 to enable TLS 1.2;
1636 * disable this and enable MBEDTLS_SSL_PROTO_TLS1_1 to enable TLS 1.1;
1637 * disable this and enable MBEDTLS_SSL_PROTO_TLS1 to enable TLS 1.0;
1638 * disable this and enable MBEDTLS_SSL_PROTO_SSL3 to enable SSL 3.0.
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001639 *
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001640 * Requirements: if this macro is disabled, at least one of the above
1641 * TLS versions needs to be enabled.
Manuel Pégourié-Gonnardc6d9e3a2019-06-07 11:07:53 +02001642 *
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001643 * Uncomment this macro to disable support for TLS.
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001644 */
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001645//#define MBEDTLS_SSL_PROTO_NO_TLS
Manuel Pégourié-Gonnarda7711602019-03-18 10:18:37 +01001646
1647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001649 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001650 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001651 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001652 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001655
1656/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001658 *
1659 * Enable support for the anti-replay mechanism in DTLS.
1660 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661 * Requires: MBEDTLS_SSL_TLS_C
1662 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001663 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001664 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001665 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001666 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001667 * Comment this to disable anti-replay in DTLS.
1668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001670
1671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001673 *
1674 * Enable support for HelloVerifyRequest on DTLS servers.
1675 *
1676 * This feature is highly recommended to prevent DTLS servers being used as
1677 * amplifiers in DoS attacks against other hosts. It should always be enabled
1678 * unless you know for sure amplification cannot be a problem in the
1679 * environment in which your server operates.
1680 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001681 * \warning Disabling this can ba a security risk! (see above)
1682 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001683 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001684 *
1685 * Comment this to disable support for HelloVerifyRequest.
1686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001688
1689/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001690 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1691 *
1692 * Enable server-side support for clients that reconnect from the same port.
1693 *
1694 * Some clients unexpectedly close the connection and try to reconnect using the
1695 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001696 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001697 * flag enables that support.
1698 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001699 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001700 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001701 * Comment this to disable support for clients reusing the source port.
1702 */
1703#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1704
1705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001707 *
1708 * Enable support for a limit of records with bad MAC.
1709 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001710 * See mbedtls_ssl_conf_dtls_badmac_limit().
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001711 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001713 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001715
1716/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001718 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001719 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimod5f47592019-01-23 15:24:37 +01001720 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001721 * session store remains the responsibility of the application, though).
1722 * Server-side, you also need to provide callbacks for writing and parsing
1723 * tickets, including authenticated encryption and key management. Example
1724 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001725 *
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001726 * Requires: !MBEDTLS_SSL_NO_SESSION_RESUMPTION
Jarno Lamsaac57e822019-06-19 10:26:43 +03001727 *
Manuel Pégourié-Gonnard320eb7a2019-07-01 11:06:35 +02001728 * Comment this macro to disable support for SSL session tickets.
Paul Bakkera503a632013-08-14 13:48:06 +02001729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001731
1732/**
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001733 * \def MBEDTLS_SSL_NO_SESSION_CACHE
Jarno Lamsa7be14062019-06-18 13:07:17 +03001734 *
Manuel Pégourié-Gonnard320eb7a2019-07-01 11:06:35 +02001735 * Disable support for cache based session resumption. This is useful to
1736 * reduce code size in configurations where cache-based session resumption is
1737 * not used.
Jarno Lamsaac57e822019-06-19 10:26:43 +03001738 *
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001739 * This option is only about the server-side support of the session caches.
Manuel Pégourié-Gonnard8a0944c2019-07-01 10:59:17 +02001740 * Client will only need !MBEDTLS_SSL_NO_SESSION_RESUMPTION to support
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001741 * cache based session resumption.
Jarno Lamsa7be14062019-06-18 13:07:17 +03001742 *
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001743 * Server-side, you also need to provide callbacks for storing and reading
1744 * sessions from cache. Example callbacks are provided by MBEDTLS_SSL_CACHE_C.
1745 *
1746 * If MBEDTLS_SSL_NO_SESSION_RESUMPTION is defined, this needs to be defined
1747 * as well.
1748 *
Manuel Pégourié-Gonnard320eb7a2019-07-01 11:06:35 +02001749 * Uncomment this macro to disable support for SSL session cache.
Jarno Lamsa7be14062019-06-18 13:07:17 +03001750 */
Manuel Pégourié-Gonnardf130b102019-07-01 10:05:28 +02001751//#define MBEDTLS_SSL_NO_SESSION_CACHE
Jarno Lamsa7be14062019-06-18 13:07:17 +03001752
1753/**
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001754 * \def MBEDTLS_SSL_NO_SESSION_RESUMPTION
Jarno Lamsa59bd12b2019-06-18 13:49:02 +03001755 *
Manuel Pégourié-Gonnard320eb7a2019-07-01 11:06:35 +02001756 * Disable support for session resumption. This is useful to reduce code size
1757 * in configurations where no form of session resumption is used.
Jarno Lamsa59bd12b2019-06-18 13:49:02 +03001758 *
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001759 * \note Session resumption is part of the TLS standard, disabling this
1760 * option means that the full implementation of the standard is no longer
Manuel Pégourié-Gonnard320eb7a2019-07-01 11:06:35 +02001761 * used. This shouldn't cause any interoperability issues as the standard
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001762 * mandates that peers who want to resume a session need to be prepared to
1763 * fall back to a full handshake.
1764 *
1765 * When this flag is enabled, following needs to be true:
1766 * MBEDTLS_SSL_NO_SESSION_CACHE enabled
1767 * MBEDTLS_SSL_SESSION_TICKETS disabled
1768 *
1769 * Client-side, this is enough to enable support for cache-based session
1770 * resumption (as defined by the TLS standard); for ticket-based resumption
1771 * you'll also need to enable MBEDTLS_SSL_SESSION_TICKETS.
1772 *
1773 * Server-side, this option is only useful in conjunction with at least
Manuel Pégourié-Gonnarde4315632019-07-01 10:57:27 +02001774 * one of !MBEDTLS_SSL_NO_SESSION_CACHE or MBEDTLS_SSL_SESSION_TICKETS.
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001775 * Each one of these additionally requires an implementation of the cache
Manuel Pégourié-Gonnarde4315632019-07-01 10:57:27 +02001776 * or tickets, examples of which are provided by MBEDTLS_SSL_CACHE_C
Manuel Pégourié-Gonnardc27fabf2019-07-01 13:05:39 +02001777 * and MBEDTLS_SSL_TICKET_C respectively.
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03001778 *
Manuel Pégourié-Gonnard320eb7a2019-07-01 11:06:35 +02001779 * Uncomment this macro to disable support for SSL session resumption.
Jarno Lamsa59bd12b2019-06-18 13:49:02 +03001780 */
Manuel Pégourié-Gonnardf130b102019-07-01 10:05:28 +02001781//#define MBEDTLS_SSL_NO_SESSION_RESUMPTION
Jarno Lamsa59bd12b2019-06-18 13:49:02 +03001782
1783/**
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001784 * \def MBEDTLS_SSL_EXPORT_KEYS
1785 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001786 * Enable support for exporting key block and master secret.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001787 * This is required for certain users of TLS, e.g. EAP-TLS.
1788 *
1789 * Comment this macro to disable support for key export
1790 */
1791#define MBEDTLS_SSL_EXPORT_KEYS
1792
1793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001795 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001796 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001797 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001799 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001800 * Comment this macro to disable support for server name indication in SSL
1801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001803
1804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 * \def MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001807 * Enable support for RFC 6066 truncated HMAC in SSL.
Paul Bakker1f2bc622013-08-15 13:45:55 +02001808 *
1809 * Comment this macro to disable support for truncated HMAC in SSL
1810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811#define MBEDTLS_SSL_TRUNCATED_HMAC
Paul Bakker1f2bc622013-08-15 13:45:55 +02001812
1813/**
Hanno Beckere89353a2017-11-20 16:36:41 +00001814 * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1815 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001816 * Fallback to old (pre-2.7), non-conforming implementation of the truncated
1817 * HMAC extension which also truncates the HMAC key. Note that this option is
1818 * only meant for a transitory upgrade period and is likely to be removed in
1819 * a future version of the library.
Hanno Beckere89353a2017-11-20 16:36:41 +00001820 *
Hanno Becker702dfbc2017-11-29 16:35:46 +00001821 * \warning The old implementation is non-compliant and has a security weakness
1822 * (2^80 brute force attack on the HMAC key used for a single,
1823 * uninterrupted connection). This should only be enabled temporarily
1824 * when (1) the use of truncated HMAC is essential in order to save
1825 * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use
1826 * the fixed implementation yet (pre-2.7).
Hanno Beckere89353a2017-11-20 16:36:41 +00001827 *
Hanno Becker4c2ac7e2017-11-21 18:22:53 +00001828 * \deprecated This option is deprecated and will likely be removed in a
1829 * future version of Mbed TLS.
1830 *
Hanno Beckere89353a2017-11-20 16:36:41 +00001831 * Uncomment to fallback to old, non-compliant truncated HMAC implementation.
1832 *
1833 * Requires: MBEDTLS_SSL_TRUNCATED_HMAC
1834 */
1835//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT
1836
1837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001838 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001839 *
1840 * Provide your own alternate threading implementation.
1841 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001842 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001843 *
1844 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001847
1848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001850 *
1851 * Enable the pthread wrapper layer for the threading layer.
1852 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001854 *
1855 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001858
1859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001861 *
1862 * Allow run-time checking of compile-time enabled features. Thus allowing users
1863 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001867 *
1868 * Comment this to disable run-time checking and save ROM space
1869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001871
1872/**
Hanno Becker180f7bf2019-02-28 13:23:38 +00001873 * \def MBEDTLS_X509_ON_DEMAND_PARSING
1874 *
1875 * Save RAM by reducing mbedtls_x509_crt to a pointer
1876 * to the raw CRT data and parsing CRTs on demand only.
1877 *
1878 * \warning This option changes the API by removing most of
1879 * the structure fields of mbedtls_x509_crt.
1880 *
1881 * \warning This option and its corresponding X.509 API are currently
1882 * under development and may change at any time.
1883 *
1884 * Regardless of whether this option is enabled or not, direct access of
1885 * structure fields of `mbedtls_x509_crt` should be replaced by calls to
1886 * one of the following functions:
1887 * - mbedtls_x509_crt_get_frame(), to obtain a CRT frame giving
1888 * access to several basic CRT fields (such as the CRT version),
1889 * as well as pointers to the raw ASN.1 data of more complex fields
1890 * (such as the issuer).
1891 * - mbedtls_x509_crt_get_pk(), to obtain a public key context
1892 * for the public key contained in the certificate.
1893 * - mbedtls_x509_crt_get_issuer(), to obtain the issuer name.
1894 * - mbedtls_x509_crt_get_subject(), to obtain the subject name.
1895 * - mbedtls_x509_crt_get_subject_alt_names(), to obtain the
1896 * alternative names from the subject alternative names extension.
1897 * - mbedtls_x509_crt_get_ext_key_usage(), to obtain the state of
1898 * the extended key usage extension.
1899 *
1900 * Uncomment this to enable on-demand CRT parsing to save RAM.
1901 */
1902//#define MBEDTLS_X509_ON_DEMAND_PARSING
1903
1904/**
Hanno Beckerffcd8c32019-03-05 13:44:33 +00001905 * \def MBEDTLS_X509_ALWAYS_FLUSH
1906 *
1907 * Save RAM by having Mbed TLS always flush caches for parsed X.509
1908 * structures after use: This means, firstly, that caches of X.509
1909 * structures used by an API call are flushed when the call returns,
1910 * but it also encompasses immediate flushing of caches when Mbed TLS uses
1911 * multiple structures in succession, thereby reducing the peak RAM usage.
1912 * Setting this option leads to minimal RAM usage of the X.509 module at
1913 * the cost of performance penalties when using X.509 structures multiple
1914 * times (such as trusted CRTs on systems serving many connections).
1915 *
1916 * Uncomment this to always flush caches for unused X.509 structures.
1917 */
1918#define MBEDTLS_X509_ALWAYS_FLUSH
1919
1920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001922 *
1923 * If set, the X509 parser will not break-off when parsing an X509 certificate
1924 * and encountering an extension in a v1 or v2 certificate.
1925 *
1926 * Uncomment to prevent an error.
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
Paul Bakkerc27c4e22013-09-23 15:01:36 +02001929
1930/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker5c721f92011-07-27 16:51:09 +00001932 *
1933 * If set, the X509 parser will not break-off when parsing an X509 certificate
1934 * and encountering an unknown critical extension.
1935 *
Manuel Pégourié-Gonnardcb6af002015-10-05 12:12:39 +01001936 * \warning Depending on your PKI use, enabling this can be a security risk!
1937 *
Paul Bakker5c721f92011-07-27 16:51:09 +00001938 * Uncomment to prevent an error.
Paul Bakker5c721f92011-07-27 16:51:09 +00001939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
Paul Bakker2770fbd2012-07-03 13:30:23 +00001941
1942/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 * \def MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001944 *
1945 * Enable verification of the keyUsage extension (CA and leaf certificates).
1946 *
1947 * Disabling this avoids problems with mis-issued and/or misused
1948 * (intermediate) CA and leaf certificates.
1949 *
1950 * \warning Depending on your PKI use, disabling this can be a security risk!
1951 *
1952 * Comment to skip keyUsage checking for both CA and leaf certificates.
1953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954#define MBEDTLS_X509_CHECK_KEY_USAGE
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +02001955
1956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001958 *
1959 * Enable verification of the extendedKeyUsage extension (leaf certificates).
1960 *
1961 * Disabling this avoids problems with mis-issued and/or misused certificates.
1962 *
1963 * \warning Depending on your PKI use, disabling this can be a security risk!
1964 *
1965 * Comment to skip extendedKeyUsage checking for certificates.
1966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +02001968
1969/**
Hanno Becker02a21932019-06-10 15:08:43 +01001970 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbusdc470ae2018-12-11 13:55:56 -06001971 *
1972 * Enable mbedtls_x509_*_info() and related APIs.
1973 *
1974 * Comment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
1975 * and other functions/constants only used by these functions, thus reducing
1976 * the code footprint by several KB.
1977 */
Hanno Becker02a21932019-06-10 15:08:43 +01001978//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbusdc470ae2018-12-11 13:55:56 -06001979
1980/**
Hanno Becker843b71a2019-06-25 09:39:21 +01001981 * \def MBEDTLS_X509_CRT_REMOVE_TIME
1982 *
1983 * Don't store time validity fields in X.509 certificate structures.
1984 *
1985 * Uncomment this to save some code and RAM on constrained systems which
1986 * don't have time and where there's no use of the time validity fields
1987 * in a certificate.
1988 *
1989 * Requires: !MBEDTLS_HAVE_TIME_DATE
1990 */
1991//#define MBEDTLS_X509_CRT_REMOVE_TIME
1992
1993/**
Hanno Beckerd07614c2019-06-25 10:19:58 +01001994 * \def MBEDTLS_X509_CRT_REMOVE_SUBJECT_ISSUER_ID
1995 *
1996 * Don't store subject and issuer ID in X.509 certificate structures.
1997 *
1998 * Uncomment this to save some code and RAM on constrained systems which
1999 * don't need to inspect issuer and subject ID fields in certificates.
2000 */
2001//#define MBEDTLS_X509_CRT_REMOVE_SUBJECT_ISSUER_ID
2002
2003/**
Teppo Järvelin4009d8f2019-08-19 14:48:09 +03002004 * \def MBEDTLS_X509_REMOVE_HOSTNAME_VERIFICATION
2005 *
2006 * Remove hostname verification from APIs related to X.509 certificate validation.
2007 *
2008 * \warning Uncommenting this affects parsing and verification of
2009 * X.509 certificate by leaving Common Name and Subject Alternative Name fields out
2010 * of parsing and verification.
2011 *
2012 * Affected API's:
2013 * - mbedtls_ssl_set_hostname() not available.
2014 * - mbedtls_x509_crt_get_subject_alt_names() not available.
2015 * - mbedtls_x509_crt_parse_der(): Subject Alternative Name field
2016 * is not parsed.
2017 * - mbedtls_x509_crt_parse_der_nocopy(): Subject Alternative Name field
2018 * is not parsed.
2019 * - mbedtls_x509_crt_parse(): Subject Alternative Name field
2020 * is not parsed.
2021 * - mbedtls_x509_crt_parse_file(): Subject Alternative Name field
2022 * is not parsed.
2023 * - mbedtls_x509_crt_parse_path(): Subject Alternative Name field
2024 * is not parsed.
2025 * - mbedtls_x509_crt_info(): Subject Alternative Name field
2026 * is not parsed.
2027 * - mbedtls_x509_crt_verify(): param \c cn is omitted from the API.
2028 * - mbedtls_x509_crt_verify_with_profile(): param \c cn is omitted from the API.
2029 * - mbedtls_x509_crt_verify_restartable(): param \c cn is omitted from the API.
2030 * -
2031 *
2032 * Affected structs
2033 * - ::mbedtls_x509_crt_frame: subject_alt_raw is defined out.
2034 * - ::mbedtls_x509_crt: subject_alt_names is defined out.
2035 *
2036 * Uncomment this to save some code and RAM on constrained systems which
2037 * don't need hostname verification.
2038 */
2039//#define MBEDTLS_X509_REMOVE_HOSTNAME_VERIFICATION
2040
2041/**
Hanno Becker9ec3fe02019-07-01 17:36:12 +01002042 * \def MBEDTLS_X509_REMOVE_VERIFY_CALLBACK
2043 *
2044 * Remove support for X.509 certificate verification callbacks.
2045 *
2046 * Uncomment to save some bytes of code by removing support for X.509
2047 * certificate verification callbacks in mbedtls_x509_crt_verify() and
2048 * related verification API.
2049 */
Hanno Beckercd239f82019-08-29 11:52:43 +01002050//#define MBEDTLS_X509_REMOVE_VERIFY_CALLBACK
Hanno Becker9ec3fe02019-07-01 17:36:12 +01002051
2052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002053 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002054 *
2055 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2056 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2057 *
2058 * Comment this macro to disallow using RSASSA-PSS in certificates.
2059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002060#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002061
2062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 * \def MBEDTLS_ZLIB_SUPPORT
Paul Bakker2770fbd2012-07-03 13:30:23 +00002064 *
2065 * If set, the SSL/TLS module uses ZLIB to support compression and
2066 * decompression of packet data.
2067 *
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002068 * \warning TLS-level compression MAY REDUCE SECURITY! See for example the
2069 * CRIME attack. Before enabling this option, you should examine with care if
Antonin Décimod5f47592019-01-23 15:24:37 +01002070 * CRIME or similar exploits may be applicable to your use case.
Manuel Pégourié-Gonnardbb4dd372014-03-11 10:30:38 +01002071 *
Manuel Pégourié-Gonnard7c3b4ab2015-07-02 17:59:52 +02002072 * \note Currently compression can't be used with DTLS.
Manuel Pégourié-Gonnarda0e16322014-07-14 17:38:41 +02002073 *
Hanno Beckere494e202018-03-08 13:26:12 +00002074 * \deprecated This feature is deprecated and will be removed
2075 * in the next major revision of the library.
Hanno Beckercf092b22018-03-06 14:23:38 +00002076 *
Paul Bakker2770fbd2012-07-03 13:30:23 +00002077 * Used in: library/ssl_tls.c
2078 * library/ssl_cli.c
2079 * library/ssl_srv.c
2080 *
2081 * This feature requires zlib library and headers to be present.
2082 *
2083 * Uncomment to enable use of ZLIB
Paul Bakker2770fbd2012-07-03 13:30:23 +00002084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002085//#define MBEDTLS_ZLIB_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002086/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002087
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002088/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002089 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002090 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002091 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002092 * \{
2093 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002094
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002097 *
2098 * Enable AES-NI support on x86-64.
2099 *
2100 * Module: library/aesni.c
2101 * Caller: library/aes.c
2102 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002104 *
2105 * This modules adds support for the AES-NI instructions on x86-64
2106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002108
2109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002111 *
2112 * Enable the AES block cipher.
2113 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002115 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002116 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002117 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002118 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002119 * This module enables the following ciphersuites (if other requisites are
2120 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2125 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2127 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2129 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2130 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2132 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2137 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2138 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2141 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2142 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2143 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2144 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2145 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2146 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2147 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2148 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2152 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2154 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2157 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2158 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2159 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2160 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2161 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2162 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2164 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2165 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2166 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2171 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2172 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2173 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2174 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2175 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2176 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2177 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2178 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002179 *
Paul Bakkercff68422013-09-15 20:43:33 +02002180 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002183
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002186 *
2187 * Enable the ARCFOUR stream cipher.
2188 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002189 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002190 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002191 *
Paul Bakker41c83d32013-03-20 14:39:14 +01002192 * This module enables the following ciphersuites (if other requisites are
2193 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA
2195 * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA
2198 * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA
2199 * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA
2200 * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA
2201 * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5
2202 * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA
2203 * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002204 *
2205 * \warning ARC4 is considered a weak cipher and its use constitutes a
2206 * security risk. If possible, we recommend avoidng dependencies on
2207 * it, and considering stronger ciphers instead.
2208 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002211
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002212/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002214 *
2215 * Enable the generic ASN1 parser.
2216 *
2217 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002218 * Caller: library/x509.c
2219 * library/dhm.c
2220 * library/pkcs12.c
2221 * library/pkcs5.c
2222 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002225
2226/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002228 *
2229 * Enable the generic ASN1 writer.
2230 *
2231 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002232 * Caller: library/ecdsa.c
2233 * library/pkwrite.c
2234 * library/x509_create.c
2235 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002236 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002239
2240/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002242 *
2243 * Enable the Base64 module.
2244 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002245 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002246 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002247 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002248 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002251
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002252/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002254 *
Paul Bakker9a736322012-11-14 12:39:52 +00002255 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002256 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002257 * Module: library/bignum.c
2258 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002259 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002260 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002261 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002262 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002264 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002265 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002271 *
2272 * Enable the Blowfish block cipher.
2273 *
2274 * Module: library/blowfish.c
2275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00002277
2278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002280 *
2281 * Enable the Camellia block cipher.
2282 *
Paul Bakker38119b12009-01-10 23:31:23 +00002283 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002284 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002285 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002286 * This module enables the following ciphersuites (if other requisites are
2287 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2289 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2291 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2292 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2293 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2294 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2296 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2297 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2298 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2299 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2300 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2301 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2302 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2303 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2304 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2305 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2308 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2309 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2310 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2311 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2312 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2313 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2314 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2315 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2316 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2317 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2318 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2319 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2320 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2321 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2322 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2323 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2324 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2325 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2326 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2327 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2328 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2329 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002332
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002333/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002334 * \def MBEDTLS_ARIA_C
2335 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002336 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002337 *
2338 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002339 * Caller: library/cipher.c
2340 *
2341 * This module enables the following ciphersuites (if other requisites are
2342 * enabled as well):
2343 *
2344 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2345 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2346 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2347 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2348 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2349 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2350 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2351 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2352 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2353 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2354 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2356 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2357 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2358 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2359 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2360 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2361 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2362 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2364 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2366 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2368 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2369 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2370 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2371 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2372 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2373 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2374 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2375 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2376 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2377 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2378 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2379 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2380 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2381 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002382 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01002383//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002384
2385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002387 *
2388 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2389 *
2390 * Module: library/ccm.c
2391 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002392 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002393 *
2394 * This module enables the AES-CCM ciphersuites, if other requisites are
2395 * enabled as well.
2396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002397#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002398
2399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400 * \def MBEDTLS_CERTS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002401 *
2402 * Enable the test certificates.
2403 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002404 * Module: library/certs.c
2405 * Caller:
2406 *
2407 * This module is used for testing (ssl_client/server).
2408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#define MBEDTLS_CERTS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002410
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002411/**
Daniel King34b822c2016-05-15 17:28:08 -03002412 * \def MBEDTLS_CHACHA20_C
2413 *
2414 * Enable the ChaCha20 stream cipher.
2415 *
2416 * Module: library/chacha20.c
2417 */
2418#define MBEDTLS_CHACHA20_C
2419
2420/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002421 * \def MBEDTLS_CHACHAPOLY_C
2422 *
2423 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2424 *
2425 * Module: library/chachapoly.c
2426 *
2427 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2428 */
2429#define MBEDTLS_CHACHAPOLY_C
2430
2431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002433 *
2434 * Enable the generic cipher layer.
2435 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002436 * Module: library/cipher.c
Paul Bakker04784f52013-08-19 13:30:57 +02002437 * Caller: library/ssl_tls.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00002438 *
2439 * Uncomment to enable generic cipher wrappers.
2440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002442
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002443/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002444 * \def MBEDTLS_CMAC_C
2445 *
Simon Butcher327398a2016-10-05 14:09:11 +01002446 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2447 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002448 *
2449 * Module: library/cmac.c
2450 *
Simon Butcher69283e52016-10-06 12:49:58 +01002451 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002452 *
2453 */
Brian Murray53e23b62016-09-13 14:00:15 -07002454//#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002455
2456/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002458 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002459 * Enable the CTR_DRBG AES-based random generator.
2460 * The CTR_DRBG generator uses AES-256 by default.
2461 * To use AES-128 instead, enable MBEDTLS_CTR_DRBG_USE_128_BIT_KEY below.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002462 *
2463 * Module: library/ctr_drbg.c
2464 * Caller:
2465 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002467 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002468 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002471
2472/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002474 *
2475 * Enable the debug functions.
2476 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002477 * Module: library/debug.c
2478 * Caller: library/ssl_cli.c
2479 * library/ssl_srv.c
2480 * library/ssl_tls.c
2481 *
2482 * This module provides debugging functions.
2483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002485
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488 *
2489 * Enable the DES block cipher.
2490 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002491 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002492 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002493 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002494 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002495 * This module enables the following ciphersuites (if other requisites are
2496 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
2498 * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
2499 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
2500 * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
2501 * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
2502 * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
2503 * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
2504 * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA
2505 * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
2506 * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002507 *
Paul Bakkercff68422013-09-15 20:43:33 +02002508 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002509 *
2510 * \warning DES is considered a weak cipher and its use constitutes a
2511 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002514
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002515/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002517 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002518 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002519 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002520 * Module: library/dhm.c
2521 * Caller: library/ssl_cli.c
2522 * library/ssl_srv.c
2523 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002524 * This module is used by the following key exchanges:
2525 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002526 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002527 * \warning Using DHE constitutes a security risk as it
2528 * is not possible to validate custom DH parameters.
2529 * If possible, it is recommended users should consider
2530 * preferring other methods of key exchange.
2531 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002532 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002538 *
2539 * Enable the elliptic curve Diffie-Hellman library.
2540 *
2541 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002542 * Caller: library/ssl_cli.c
2543 * library/ssl_srv.c
2544 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002545 * This module is used by the following key exchanges:
2546 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002551
2552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002554 *
2555 * Enable the elliptic curve DSA library.
2556 *
2557 * Module: library/ecdsa.c
2558 * Caller:
2559 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002560 * This module is used by the following key exchanges:
2561 * ECDHE-ECDSA
2562 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002566
2567/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002568 * \def MBEDTLS_ECJPAKE_C
2569 *
2570 * Enable the elliptic curve J-PAKE library.
2571 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002572 * \warning This is currently experimental. EC J-PAKE support is based on the
2573 * Thread v1.0.0 specification; incompatible changes to the specification
2574 * might still happen. For this reason, this is disabled by default.
2575 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002576 * Module: library/ecjpake.c
2577 * Caller:
2578 *
2579 * This module is used by the following key exchanges:
2580 * ECJPAKE
2581 *
2582 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
2583 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02002584//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002585
2586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002588 *
2589 * Enable the elliptic curve over GF(p) library.
2590 *
2591 * Module: library/ecp.c
2592 * Caller: library/ecdh.c
2593 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002594 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002599
2600/**
Manuel Pégourié-Gonnardafdc1b52019-05-09 11:24:11 +02002601 * \def MBEDTLS_USE_TINYCRYPT
Jarno Lamsa9454dfa2019-04-24 16:28:59 +03002602 *
Manuel Pégourié-Gonnard00c99d72019-05-09 11:38:19 +02002603 * Enable the TinyCrypt ECC library. This module provides alternative ECC
2604 * handling functions replacing the native Mbed TLS ECP module.
2605 *
2606 * TinyCrypt is a project independent from Mbed TLS, licensed under 3-clause
2607 * BSD, and can be found at https://github.com/intel/tinycrypt - this option
2608 * only enables the ECC modules from TinyCrypt.
Jarno Lamsa9454dfa2019-04-24 16:28:59 +03002609 *
Jarno Lamsab4983462019-07-31 14:43:55 +03002610 * Requires: MBEDTLS_SSL_CONF_RNG
2611 * MBEDTLS_SSL_CONF_SINGLE_EC
2612 * MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID == 23
Hanno Becker49ac40b2019-08-29 16:25:49 +01002613 * MBEDTLS_SSL_CONF_SINGLE_UECC_GRP_ID == MBEDTLS_UECC_DP_SECP256R1
Jarno Lamsab4983462019-07-31 14:43:55 +03002614 *
2615 * \see MBEDTLS_SSL_CONF_RNG
2616 *
2617 * \see MBEDTLS_SSL_CONF_SINGLE_EC
2618 *
Jarno Lamsa9454dfa2019-04-24 16:28:59 +03002619 * Module: tinycrypt/ecc.c
2620 * tinycrypt/ecc_dh.c
2621 * tinycrypt/ecc_dsa.c
Jarno Lamsa9454dfa2019-04-24 16:28:59 +03002622 */
Manuel Pégourié-Gonnardafdc1b52019-05-09 11:24:11 +02002623//#define MBEDTLS_USE_TINYCRYPT
Jarno Lamsa9454dfa2019-04-24 16:28:59 +03002624
2625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002627 *
2628 * Enable the platform-specific entropy code.
2629 *
2630 * Module: library/entropy.c
2631 * Caller:
2632 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002634 *
2635 * This module provides a generic entropy pool
2636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002638
2639/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002641 *
2642 * Enable error code to error string conversion.
2643 *
2644 * Module: library/error.c
2645 * Caller:
2646 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002650
2651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002653 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002654 * Enable the Galois/Counter Mode (GCM) for AES.
Paul Bakker89e80c92012-03-20 13:50:09 +00002655 *
2656 * Module: library/gcm.c
2657 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002659 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002660 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2661 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002664
2665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * \def MBEDTLS_HAVEGE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002667 *
2668 * Enable the HAVEGE random generator.
2669 *
Paul Bakker2a844242013-06-24 13:01:53 +02002670 * Warning: the HAVEGE random generator is not suitable for virtualized
2671 * environments
2672 *
2673 * Warning: the HAVEGE random generator is dependent on timing and specific
2674 * processor traits. It is therefore not advised to use HAVEGE as
2675 * your applications primary random generator or primary entropy pool
2676 * input. As a secondary input to your entropy pool, it IS able add
2677 * the (limited) extra entropy it provides.
2678 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002679 * Module: library/havege.c
2680 * Caller:
2681 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * Requires: MBEDTLS_TIMING_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002683 *
Paul Bakker2a844242013-06-24 13:01:53 +02002684 * Uncomment to enable the HAVEGE random generator.
Paul Bakker2a844242013-06-24 13:01:53 +02002685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686//#define MBEDTLS_HAVEGE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002687
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002688/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002689 * \def MBEDTLS_HKDF_C
2690 *
2691 * Enable the HKDF algorithm (RFC 5869).
2692 *
2693 * Module: library/hkdf.c
2694 * Caller:
2695 *
2696 * Requires: MBEDTLS_MD_C
2697 *
2698 * This module adds support for the Hashed Message Authentication Code
2699 * (HMAC)-based key derivation function (HKDF).
2700 */
2701#define MBEDTLS_HKDF_C
2702
2703/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002705 *
2706 * Enable the HMAC_DRBG random generator.
2707 *
2708 * Module: library/hmac_drbg.c
2709 * Caller:
2710 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002712 *
2713 * Uncomment to enable the HMAC_DRBG random number geerator.
2714 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002716
2717/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002718 * \def MBEDTLS_NIST_KW_C
2719 *
2720 * Enable the Key Wrapping mode for 128-bit block ciphers,
2721 * as defined in NIST SP 800-38F. Only KW and KWP modes
2722 * are supported. At the moment, only AES is approved by NIST.
2723 *
2724 * Module: library/nist_kw.c
2725 *
2726 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2727 */
2728//#define MBEDTLS_NIST_KW_C
2729
2730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002732 *
2733 * Enable the generic message digest layer.
2734 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002735 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00002736 * Caller:
2737 *
2738 * Uncomment to enable generic message digest wrappers.
2739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002741
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002744 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002745 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002746 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002747 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002748 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002749 *
2750 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002751 *
2752 * \warning MD2 is considered a weak message digest and its use constitutes a
2753 * security risk. If possible, we recommend avoiding dependencies on
2754 * it, and considering stronger message digests instead.
2755 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002758
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002760 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002761 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002762 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002763 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002764 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002765 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00002766 *
2767 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002768 *
2769 * \warning MD4 is considered a weak message digest and its use constitutes a
2770 * security risk. If possible, we recommend avoiding dependencies on
2771 * it, and considering stronger message digests instead.
2772 *
Paul Bakker6506aff2009-07-28 20:52:02 +00002773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002775
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002776/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002778 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002779 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002780 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002781 * Module: library/md5.c
2782 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002783 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002784 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002785 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002786 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
2787 * depending on the handshake parameters. Further, it is used for checking
2788 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
2789 * encrypted keys.
2790 *
2791 * \warning MD5 is considered a weak message digest and its use constitutes a
2792 * security risk. If possible, we recommend avoiding dependencies on
2793 * it, and considering stronger message digests instead.
2794 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002797
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002800 *
2801 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002802 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002803 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002804 *
2805 * Module: library/memory_buffer_alloc.c
2806 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807 * Requires: MBEDTLS_PLATFORM_C
2808 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002809 *
2810 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002813
2814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002816 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002817 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2818 *
Simon Butcherd567a232016-03-09 20:19:21 +00002819 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2820 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002821 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002823 * \note See also our Knowledge Base article about porting to a new
2824 * environment:
2825 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2826 *
Andres AG788aa4a2016-09-14 14:32:09 +01002827 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002828 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002829 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002830 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002832
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002833/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002835 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002836 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002837 *
2838 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002839 * Caller: library/asn1write.c
2840 * library/pkcs5.c
2841 * library/pkparse.c
2842 * library/pkwrite.c
2843 * library/rsa.c
2844 * library/x509.c
2845 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002846 * library/x509_crl.c
2847 * library/x509_crt.c
2848 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002849 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002850 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002851 *
2852 * This modules translates between OIDs and internal values.
2853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002855
2856/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002858 *
2859 * Enable VIA Padlock support on x86.
2860 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002861 * Module: library/padlock.c
2862 * Caller: library/aes.c
2863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002865 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002866 * This modules adds support for the VIA PadLock on x86.
2867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002869
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002872 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002873 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002874 *
2875 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002876 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002877 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002878 * library/x509_crl.c
2879 * library/x509_crt.c
2880 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002881 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002883 *
Paul Bakkercff68422013-09-15 20:43:33 +02002884 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002887
2888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002890 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002891 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002892 *
2893 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002894 * Caller: library/pkwrite.c
2895 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002896 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002897 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002899 *
2900 * This modules adds support for encoding / writing PEM files.
2901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002903
2904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002906 *
2907 * Enable the generic public (asymetric) key layer.
2908 *
2909 * Module: library/pk.c
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002910 * Caller: library/ssl_tls.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002911 * library/ssl_cli.c
2912 * library/ssl_srv.c
2913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002915 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002916 * Uncomment to enable generic public key wrappers.
2917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002919
2920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002922 *
2923 * Enable the generic public (asymetric) key parser.
2924 *
2925 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002926 * Caller: library/x509_crt.c
2927 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002928 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002930 *
2931 * Uncomment to enable generic public key parse functions.
2932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002934
2935/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002937 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02002938 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002939 *
2940 * Module: library/pkwrite.c
2941 * Caller: library/x509write.c
2942 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002944 *
2945 * Uncomment to enable generic public key write functions.
2946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002948
2949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002951 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002952 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002953 *
2954 * Module: library/pkcs5.c
2955 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002957 *
2958 * This module adds support for the PKCS#5 functions.
2959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002961
2962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * \def MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002964 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00002965 * Enable wrapper for PKCS#11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00002966 *
Manuel Pégourié-Gonnard51be5592013-08-22 13:35:53 +02002967 * Module: library/pkcs11.c
2968 * Caller: library/pk.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002969 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * Requires: MBEDTLS_PK_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002971 *
Paul Bakkereb2c6582012-09-27 19:15:01 +00002972 * This module enables SSL/TLS PKCS #11 smartcard support.
Paul Bakker5690efc2011-05-26 13:16:06 +00002973 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
Paul Bakker5690efc2011-05-26 13:16:06 +00002974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975//#define MBEDTLS_PKCS11_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002976
2977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002979 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002980 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002981 * Adds algorithms for parsing PKCS#8 encrypted private keys
2982 *
2983 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002984 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002985 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2987 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002988 *
2989 * This module enables PKCS#12 functions.
2990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002992
2993/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002995 *
2996 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002997 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002998 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3000 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003001 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003002 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003003 * \note This abstraction layer must be enabled on Windows (including MSYS2)
3004 * as other module rely on it for a fixed snprintf implementation.
3005 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003006 * Module: library/platform.c
3007 * Caller: Most other .c files
3008 *
3009 * This module enables abstraction of common (libc) functions.
3010 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003011#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003012
3013/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003014 * \def MBEDTLS_POLY1305_C
3015 *
3016 * Enable the Poly1305 MAC algorithm.
3017 *
3018 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003019 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003020 */
3021#define MBEDTLS_POLY1305_C
3022
3023/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003025 *
3026 * Enable the RIPEMD-160 hash algorithm.
3027 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003028 * Module: library/ripemd160.c
3029 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003030 *
3031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003033
3034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003036 *
3037 * Enable the RSA public-key cryptosystem.
3038 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003039 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01003040 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003041 * Caller: library/ssl_cli.c
3042 * library/ssl_srv.c
3043 * library/ssl_tls.c
3044 * library/x509.c
3045 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003046 * This module is used by the following key exchanges:
3047 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003052
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003053/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003055 *
3056 * Enable the SHA1 cryptographic hash algorithm.
3057 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003058 * Module: library/sha1.c
3059 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003060 * library/ssl_cli.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003061 * library/ssl_srv.c
3062 * library/ssl_tls.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003063 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003064 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003065 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
3066 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003067 *
3068 * \warning SHA-1 is considered a weak message digest and its use constitutes
3069 * a security risk. If possible, we recommend avoiding dependencies
3070 * on it, and considering stronger message digests instead.
3071 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003074
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003077 *
3078 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
3079 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003080 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003081 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003082 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003083 * library/ssl_cli.c
3084 * library/ssl_srv.c
3085 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003086 *
3087 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003088 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003091
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003094 *
3095 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
3096 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003097 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003098 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003099 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003100 * library/ssl_cli.c
3101 * library/ssl_srv.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003102 *
3103 * This module adds support for SHA-384 and SHA-512.
3104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003105#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003106
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003109 *
3110 * Enable simple SSL cache implementation.
3111 *
3112 * Module: library/ssl_cache.c
3113 * Caller:
3114 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003115 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003118
3119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003121 *
3122 * Enable basic implementation of DTLS cookies for hello verification.
3123 *
3124 * Module: library/ssl_cookie.c
3125 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003128
3129/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003130 * \def MBEDTLS_SSL_TICKET_C
3131 *
3132 * Enable an implementation of TLS server-side callbacks for session tickets.
3133 *
3134 * Module: library/ssl_ticket.c
3135 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003136 *
Manuel Pégourié-Gonnard4214e3a2015-05-25 19:34:49 +02003137 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003138 */
3139#define MBEDTLS_SSL_TICKET_C
3140
3141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003143 *
3144 * Enable the SSL/TLS client code.
3145 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003146 * Module: library/ssl_cli.c
3147 * Caller:
3148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003150 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 * This module is required for SSL/TLS client support.
3152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003154
Paul Bakker9a736322012-11-14 12:39:52 +00003155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003157 *
3158 * Enable the SSL/TLS server code.
3159 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003160 * Module: library/ssl_srv.c
3161 * Caller:
3162 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003164 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003165 * This module is required for SSL/TLS server support.
3166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003168
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003171 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003172 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003173 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003174 * Module: library/ssl_tls.c
3175 * Caller: library/ssl_cli.c
3176 * library/ssl_srv.c
3177 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3179 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003180 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003181 * This module is required for SSL/TLS.
3182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003184
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003187 *
3188 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003189 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003190 * contexts are not shared between threads. If you do intend to use contexts
3191 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003192 * conditions. See also our Knowledge Base article about threading:
3193 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003194 *
3195 * Module: library/threading.c
3196 *
3197 * This allows different threading implementations (self-implemented or
3198 * provided).
3199 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200 * You will have to enable either MBEDTLS_THREADING_ALT or
3201 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003202 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003203 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003206
3207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003209 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003210 * Enable the semi-portable timing interface.
3211 *
Simon Butcherd567a232016-03-09 20:19:21 +00003212 * \note The provided implementation only works on POSIX/Unix (including Linux,
3213 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003214 * module and provide your own implementations of the callbacks needed by
3215 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3216 * your own implementation of the whole module by setting
3217 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003218 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003219 * \note See also our Knowledge Base article about porting to a new
3220 * environment:
3221 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3222 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003223 * Module: library/timing.c
3224 * Caller: library/havege.c
3225 *
3226 * This module is used by the HAVEGE random number generator.
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003229
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003230/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003232 *
3233 * Enable run-time version information.
3234 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003235 * Module: library/version.c
3236 *
3237 * This module provides run-time version information.
3238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003240
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003243 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003244 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003245 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003246 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003247 * Caller: library/x509_crl.c
3248 * library/x509_crt.c
3249 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003250 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003251 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
3252 * MBEDTLS_PK_PARSE_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003253 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003254 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003257
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003260 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003261 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003262 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003263 * Module: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003264 * Caller: library/ssl_cli.c
3265 * library/ssl_srv.c
3266 * library/ssl_tls.c
3267 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003268 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003269 *
3270 * This module is required for X.509 certificate parsing.
3271 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003272#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003273
3274/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003275 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003276 *
3277 * Enable X.509 CRL parsing.
3278 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003279 * Module: library/x509_crl.c
3280 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003281 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003283 *
3284 * This module is required for X.509 CRL parsing.
3285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003287
3288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003290 *
3291 * Enable X.509 Certificate Signing Request (CSR) parsing.
3292 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003293 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003294 * Caller: library/x509_crt_write.c
3295 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003297 *
3298 * This module is used for reading X.509 certificate request.
3299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003301
3302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003304 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003305 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003306 *
3307 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003308 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003310 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003311 * This module is the basis for creating X.509 certificates and CSRs.
3312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003314
3315/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003317 *
3318 * Enable creating X.509 certificates.
3319 *
3320 * Module: library/x509_crt_write.c
3321 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003323 *
3324 * This module is required for X.509 certificate creation.
3325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003327
3328/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003330 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003331 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003332 *
3333 * Module: library/x509_csr_write.c
3334 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003336 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003337 * This module is required for X.509 certificate request writing.
3338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003340
3341/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003343 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003344 * Enable the XTEA block cipher.
3345 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003346 * Module: library/xtea.c
3347 * Caller:
3348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01003350
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003351/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003352
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003353/**
3354 * \name SECTION: Module configuration options
3355 *
3356 * This section allows for the setting of module specific sizes and
3357 * configuration options. The default values are already present in the
3358 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003359 *
Paul Bakker088c5c52014-04-25 11:11:10 +02003360 * Our advice is to enable options and change their values here
3361 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003362 *
3363 * Please check the respective header file for documentation on these
3364 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003365 * \{
3366 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003367
Paul Bakker088c5c52014-04-25 11:11:10 +02003368/* MPI / BIGNUM options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
3370//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003371
Paul Bakker088c5c52014-04-25 11:11:10 +02003372/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3374//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3375//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3376//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3377//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Nir Sonnenscheince266e42018-08-29 10:11:46 +03003378//#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 +02003379
Paul Bakker088c5c52014-04-25 11:11:10 +02003380/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3382//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3383//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3384//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003385
Paul Bakker088c5c52014-04-25 11:11:10 +02003386/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
3388//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
3389//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003390
Paul Bakker088c5c52014-04-25 11:11:10 +02003391/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3393//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003394//#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 +01003395
Paul Bakker088c5c52014-04-25 11:11:10 +02003396/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003398
Paul Bakker088c5c52014-04-25 11:11:10 +02003399/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400//#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 +02003401//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
3403//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003404//#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 +02003405//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3406//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimod5f47592019-01-23 15:24:37 +01003407/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003409//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3410//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003411//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3412//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3413//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3416/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003417//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3419//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003420//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3421//#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 +02003422//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3423//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimod5f47592019-01-23 15:24:37 +01003424/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003426//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3427//#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 +02003428
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +01003429/**
3430 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskine30346f62019-06-13 16:44:19 +02003431 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Manuel Pégourié-Gonnard35acb092018-12-11 12:26:49 +01003432 * (see the documentation of that option for context).
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +01003433 *
Gilles Peskine30346f62019-06-13 16:44:19 +02003434 * When you leave this undefined here, the library provides
3435 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
3436 * is defined, the default definition is `assert(cond)`,
3437 * otherwise the default definition calls a function
3438 * mbedtls_param_failed(). This function is declared in
3439 * `platform_util.h` for the benefit of the library, but
3440 * you need to define in your application.
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +01003441 *
3442 * When you define this here, this replaces the default
3443 * definition in platform_util.h (which no longer declares the
Manuel Pégourié-Gonnard35acb092018-12-11 12:26:49 +01003444 * function mbedtls_param_failed()) and it is your responsibility
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +01003445 * to make sure this macro expands to something suitable (in
3446 * particular, that all the necessary declarations are visible
Manuel Pégourié-Gonnardcd2b29c2018-12-12 10:23:57 +01003447 * from within the library - you can ensure that by providing
3448 * them in this file next to the macro definition).
Gilles Peskine30346f62019-06-13 16:44:19 +02003449 * If you define this macro to call `assert`, also define
3450 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
3451 * include `<assert.h>`.
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +01003452 *
Manuel Pégourié-Gonnarde7306d32018-12-13 09:45:49 +01003453 * Note that you may define this macro to expand to nothing, in
3454 * which case you don't have to worry about declarations or
3455 * definitions. However, you will then be notified about invalid
3456 * parameters only in non-void functions, and void function will
Manuel Pégourié-Gonnard548cecd2018-12-17 13:13:30 +01003457 * just silently return early on invalid parameters, which
3458 * partially negates the benefits of enabling
3459 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
Manuel Pégourié-Gonnarde7306d32018-12-13 09:45:49 +01003460 *
Manuel Pégourié-Gonnardab588522018-12-10 16:04:46 +01003461 * \param cond The expression that should evaluate to true, but doesn't.
3462 */
3463//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
Simon Butcherb4868032018-12-06 17:36:34 +00003464
Paul Bakker088c5c52014-04-25 11:11:10 +02003465/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3467//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003468
Paul Bakker088c5c52014-04-25 11:11:10 +02003469/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003470
3471/** \def MBEDTLS_SSL_MAX_CONTENT_LEN
3472 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003473 * Maximum length (in bytes) of incoming and outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003474 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003475 * This determines the size of both the incoming and outgoing TLS I/O buffers
3476 * in such a way that both are capable of holding the specified amount of
3477 * plaintext data, regardless of the protection mechanism used.
Angus Grattond8213d02016-05-25 20:56:48 +10003478 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003479 * To configure incoming and outgoing I/O buffers separately, use
3480 * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN,
3481 * which overwrite the value set by this option.
3482 *
3483 * \note When using a value less than the default of 16KB on the client, it is
3484 * recommended to use the Maximum Fragment Length (MFL) extension to
Hanno Becker8e530112018-10-25 14:01:41 +01003485 * inform the server about this limitation. On the server, there
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003486 * is no supported, standardized way of informing the client about
3487 * restriction on the maximum size of incoming messages, and unless
3488 * the limitation has been communicated by other means, it is recommended
3489 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3490 * while keeping the default value of 16KB for the incoming buffer.
3491 *
3492 * Uncomment to set the maximum plaintext size of both
3493 * incoming and outgoing I/O buffers.
Angus Grattond8213d02016-05-25 20:56:48 +10003494 */
3495//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
3496
3497/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3498 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003499 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003500 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003501 * This determines the size of the incoming TLS I/O buffer in such a way
3502 * that it is capable of holding the specified amount of plaintext data,
3503 * regardless of the protection mechanism used.
3504 *
3505 * If this option is undefined, it inherits its value from
3506 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
3507 *
3508 * \note When using a value less than the default of 16KB on the client, it is
3509 * recommended to use the Maximum Fragment Length (MFL) extension to
Hanno Becker8e530112018-10-25 14:01:41 +01003510 * inform the server about this limitation. On the server, there
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003511 * is no supported, standardized way of informing the client about
3512 * restriction on the maximum size of incoming messages, and unless
3513 * the limitation has been communicated by other means, it is recommended
3514 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3515 * while keeping the default value of 16KB for the incoming buffer.
3516 *
3517 * Uncomment to set the maximum plaintext size of the incoming I/O buffer
3518 * independently of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003519 */
3520//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3521
Hanno Becker81bd9712019-04-09 15:12:41 +01003522/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3523 *
3524 * The maximum length of CIDs used for incoming DTLS messages.
3525 *
3526 */
3527//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3528
3529/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3530 *
3531 * The maximum length of CIDs used for outgoing DTLS messages.
3532 *
3533 */
3534//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3535
Hanno Becker550e1662019-05-08 17:37:58 +01003536/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY
3537 *
3538 * This option controls the use of record plaintext padding
3539 * when using the Connection ID extension in DTLS 1.2.
3540 *
3541 * The padding will always be chosen so that the length of the
3542 * padded plaintext is a multiple of the value of this option.
3543 *
3544 * Note: A value of \c 1 means that no padding will be used
3545 * for outgoing records.
3546 *
Hanno Becker78426092019-05-13 15:31:17 +01003547 * Note: On systems lacking division instructions,
3548 * a power of two should be preferred.
Hanno Becker550e1662019-05-08 17:37:58 +01003549 *
3550 */
3551//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
3552
Angus Grattond8213d02016-05-25 20:56:48 +10003553/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3554 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003555 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003556 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003557 * This determines the size of the outgoing TLS I/O buffer in such a way
3558 * that it is capable of holding the specified amount of plaintext data,
3559 * regardless of the protection mechanism used.
3560 *
3561 * If this option undefined, it inherits its value from
3562 * #MBEDTLS_SSL_MAX_CONTENT_LEN.
Angus Grattond8213d02016-05-25 20:56:48 +10003563 *
3564 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3565 * the default inward 16384 byte buffer to conform to the TLS specification.
3566 *
3567 * The minimum required outward buffer size is determined by the handshake
3568 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3569 * The specific size requirement depends on the configured ciphers and any
3570 * certificate data which is sent during the handshake.
3571 *
Hanno Beckerb5d835f2018-10-23 09:59:19 +01003572 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer
3573 * independently of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003574 */
3575//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3576
Hanno Beckere0b150f2018-08-21 15:51:03 +01003577/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3578 *
3579 * Maximum number of heap-allocated bytes for the purpose of
3580 * DTLS handshake message reassembly and future message buffering.
3581 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003582 * This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003583 * to account for a reassembled handshake message of maximum size,
3584 * together with its reassembly bitmap.
3585 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003586 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003587 * should be sufficient for all practical situations as it allows
3588 * to reassembly a large handshake message (such as a certificate)
3589 * while buffering multiple smaller handshake messages.
3590 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003591 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003592//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
3595//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3596//#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 +02003597
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003598/**
3599 * Complete list of ciphersuites to use, in order of preference.
3600 *
3601 * \warning No dependency checking is done on that field! This option can only
3602 * be used to restrict the set of available ciphersuites. It is your
3603 * responsibility to make sure the needed modules are active.
3604 *
3605 * Use this to save a few hundred bytes of ROM (default ordering of all
3606 * available ciphersuites) and a few to a few hundred bytes of RAM.
3607 *
3608 * The value below is only an example, not the default.
3609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610//#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 +02003611
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003612/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003614//#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 +01003615
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003616/**
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003617 * Allow SHA-1 in the default TLS configuration for certificate signing.
3618 * Without this build-time option, SHA-1 support must be activated explicitly
3619 * through mbedtls_ssl_conf_cert_profile. Turning on this option is not
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003620 * recommended because of it is possible to generate SHA-1 collisions, however
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003621 * this may be safe for legacy infrastructure where additional controls apply.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003622 *
3623 * \warning SHA-1 is considered a weak message digest and its use constitutes
3624 * a security risk. If possible, we recommend avoiding dependencies
3625 * on it, and considering stronger message digests instead.
3626 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003627 */
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003628// #define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
3629
3630/**
3631 * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake
3632 * signature and ciphersuite selection. Without this build-time option, SHA-1
3633 * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes.
3634 * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by
3635 * default. At the time of writing, there is no practical attack on the use
3636 * of SHA-1 in handshake signatures, hence this option is turned on by default
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003637 * to preserve compatibility with existing peers, but the general
3638 * warning applies nonetheless:
3639 *
3640 * \warning SHA-1 is considered a weak message digest and its use constitutes
3641 * a security risk. If possible, we recommend avoiding dependencies
3642 * on it, and considering stronger message digests instead.
3643 *
Gilles Peskine5d2511c2017-05-12 13:16:40 +02003644 */
3645#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003646
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003647/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003648 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003649 * mbedtls_platform_zeroize(). This replaces the default implementation in
3650 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003651 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003652 * mbedtls_platform_zeroize() is a widely used function across the library to
3653 * zero a block of memory. The implementation is expected to be secure in the
3654 * sense that it has been written to prevent the compiler from removing calls
3655 * to mbedtls_platform_zeroize() as part of redundant code elimination
3656 * optimizations. However, it is difficult to guarantee that calls to
3657 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3658 * versions of the C language standards do not provide a secure implementation
3659 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3660 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003661 * example by using directives specific to their compiler, features from newer
3662 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003663 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003664 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003665//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003666
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003667/**
3668 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003669 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003670 * platform_util.c.
3671 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003672 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003673 * library will try to use safer implementations of this function, such as
3674 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003675 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003676 * using the standard gmtime(). In this case, calls from the library to
3677 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003678 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003679 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003680 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3681 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3682 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003683 */
Hanno Becker6a739782018-09-05 15:06:19 +01003684//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003685
Simon Butcher30b5f972016-06-08 19:00:23 +01003686/* \} name SECTION: Customisation configuration options */
Manuel Pégourié-Gonnard43569a92015-07-31 15:37:29 +02003687
Hanno Beckeraabbb582019-06-11 13:43:27 +01003688/**
3689 * \name SECTION: Compile-time SSL configuration
3690 *
3691 * This section allows to fix parts of the SSL configuration
3692 * at compile-time. If a field is fixed at compile-time, the
3693 * corresponding SSL configuration API `mbedtls_ssl_conf_xxx()`
Hanno Beckerf765ce62019-06-21 13:17:14 +01003694 * is removed.
Hanno Beckeraabbb582019-06-11 13:43:27 +01003695 *
3696 * This can be used on constrained systems to reduce code-size.
3697 * \{
3698 */
3699
Hanno Beckerb0b2b672019-06-12 16:58:10 +01003700//#define MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION
3701
Hanno Beckeracd4fc02019-06-12 16:40:50 +01003702//#define MBEDTLS_SSL_CONF_AUTHMODE MBEDTLS_SSL_VERIFY_REQUIRED
3703
Hanno Becker1f835fa2019-06-13 10:14:59 +01003704/* Timeout */
3705//#define MBEDTLS_SSL_CONF_READ_TIMEOUT 0
3706
Hanno Becker2d9623f2019-06-13 12:07:05 +01003707/* Endpoint (Client/Server) */
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01003708//#define MBEDTLS_SSL_CONF_ENDPOINT MBEDTLS_SSL_IS_CLIENT
3709
3710//#define MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED
Hanno Becker2d9623f2019-06-13 12:07:05 +01003711
Hanno Beckerde671542019-06-12 16:30:46 +01003712/* DTLS-specific settings */
Hanno Becker1f835fa2019-06-13 10:14:59 +01003713//#define MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN
3714//#define MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX
Hanno Becker7f376f42019-06-12 16:20:48 +01003715//#define MBEDTLS_SSL_CONF_ANTI_REPLAY MBEDTLS_SSL_ANTI_REPLAY_ENABLED
Hanno Beckerde671542019-06-12 16:30:46 +01003716//#define MBEDTLS_SSL_CONF_BADMAC_LIMIT 0
Hanno Beckere0200da2019-06-13 09:23:43 +01003717//#define MBEDTLS_SSL_CONF_CID_LEN 0
3718//#define MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
Hanno Becker7f376f42019-06-12 16:20:48 +01003719
Hanno Becker0ae6b242019-06-13 16:45:36 +01003720/* The timer callbacks to use by the SSL module.
3721 * If defined,
3722 * - MBEDTLS_SSL_CONF_SET_TIMER must evaluate to the name of an externally
3723 * defined function with signature
Hanno Becker572a5d82019-07-04 11:31:36 +01003724 * void f_set_timer( void* , uint32_t, uint32_t ),
Hanno Becker0ae6b242019-06-13 16:45:36 +01003725 * * MBEDTLS_SSL_CONF_SEND must evaluate to the name of an externally
3726 * defined function with signature
Hanno Becker572a5d82019-07-04 11:31:36 +01003727 * int f_get_timer( void* ).
Hanno Becker0ae6b242019-06-13 16:45:36 +01003728 */
3729//#define MBEDTLS_SSL_CONF_GET_TIMER mbedtls_timing_get_delay
3730//#define MBEDTLS_SSL_CONF_SET_TIMER mbedtls_timing_set_delay
3731
Hanno Beckera58a8962019-06-13 16:11:15 +01003732/* The send and receive callbacks to use by the SSL module.
3733 * If defined,
3734 * - MBEDTLS_SSL_CONF_RECV must evaluate to the name of an externally
3735 * defined function with signature
Hanno Becker572a5d82019-07-04 11:31:36 +01003736 * int f_recv( void*, unsigned char *, size_t ),
Hanno Beckera58a8962019-06-13 16:11:15 +01003737 * * MBEDTLS_SSL_CONF_SEND must evaluate to the name of an externally
3738 * defined function with signature
Hanno Becker572a5d82019-07-04 11:31:36 +01003739 * int f_send( void*, const unsigned char *, size_t ),
Hanno Beckera58a8962019-06-13 16:11:15 +01003740 * * MBEDTLS_SSL_CONF_RECV_TIMEOUT must evaluate to the name of an
Hanno Becker56ab3ea2019-07-04 16:40:10 +01003741 * externally defined function with signature
Hanno Becker572a5d82019-07-04 11:31:36 +01003742 * int f_recv_timeout( void*, const unsigned char *, size_t, uint32_t ).
Hanno Beckera58a8962019-06-13 16:11:15 +01003743 */
3744//#define MBEDTLS_SSL_CONF_RECV mbedtls_net_recv
3745//#define MBEDTLS_SSL_CONF_SEND mbedtls_net_send
3746//#define MBEDTLS_SSL_CONF_RECV_TIMEOUT mbedtls_net_recv_timeout
3747
Hanno Beckerece325c2019-06-13 15:39:27 +01003748/* The PRNG to use by the SSL module. If defined, this must
Hanno Becker665d6982019-08-13 11:06:41 +01003749 * evaluate to the name of an externally defined function with signature
Hanno Becker572a5d82019-07-04 11:31:36 +01003750 * int f_rng(void *, unsigned char *, size_t),
Hanno Becker572d4482019-07-23 13:47:53 +01003751 * which ignores its first parameter (the stack will always
3752 * pass NULL to this function).
Hanno Becker0f36e7b2019-08-13 11:06:51 +01003753 * NB: The reason not to drop the context parameter entirely
3754 * is for compatibility with the Crypto and X.509 libraries
3755 * which use RNG callbacks including context parameters.
Hanno Beckerece325c2019-06-13 15:39:27 +01003756 */
Hanno Becker572d4482019-07-23 13:47:53 +01003757//#define MBEDTLS_SSL_CONF_RNG rng_wrap
Hanno Beckerece325c2019-06-13 15:39:27 +01003758
Hanno Beckere965bd32019-06-12 14:04:34 +01003759/* TLS version */
3760//#define MBEDTLS_SSL_CONF_MIN_MINOR_VER MBEDTLS_SSL_MINOR_VERSION_3
3761//#define MBEDTLS_SSL_CONF_MAX_MINOR_VER MBEDTLS_SSL_MINOR_VERSION_3
3762//#define MBEDTLS_SSL_CONF_MIN_MAJOR_VER MBEDTLS_SSL_MAJOR_VERSION_3
3763//#define MBEDTLS_SSL_CONF_MAX_MAJOR_VER MBEDTLS_SSL_MAJOR_VERSION_3
3764
Hanno Beckeraabbb582019-06-11 13:43:27 +01003765/* ExtendedMasterSecret extension
3766 * The following two options must be set/unset simultaneously. */
3767//#define MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET MBEDTLS_SSL_EXTENDED_MS_ENABLED
3768//#define MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED
3769
Hanno Becker5cce9362019-06-26 11:39:32 +01003770/* Set this to MBEDTLS_SUITE_{OFFICIAL_SUITE_NAME} to hardcode
3771 * the choice of a fixed ciphersuite at compile-time.
3772 *
3773 * You need to make sure that the corresponding ciphersuite attributes
3774 * are defined through macros in ssl_ciphersuites.h. See the definitions
3775 * of MBEDTLS_SUITE_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8_XXX for an example.
3776 *
3777 * If this option is set, the API mbedtls_ssl_conf_ciphersuites() is removed.
3778 */
Hanno Becker73f4cb12019-06-27 13:51:07 +01003779//#define MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE MBEDTLS_SUITE_TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8
Hanno Becker5cce9362019-06-26 11:39:32 +01003780
Hanno Becker7ae30262019-07-10 09:40:52 +01003781/* Enable support of a single elliptic curve fixed
Hanno Beckerc1096e72019-06-19 12:30:41 +01003782 * at compile-time, at the benefit of code-size.
3783 *
Hanno Becker7ae30262019-07-10 09:40:52 +01003784 * On highly constrained systems with large control
Hanno Beckerc1096e72019-06-19 12:30:41 +01003785 * over the configuration of the connection endpoints,
3786 * this option can be used to hardcode the choice of
Hanno Becker7ae30262019-07-10 09:40:52 +01003787 * a single elliptic curve to be used for all elliptic
Hanno Beckerc1096e72019-06-19 12:30:41 +01003788 * curve operations during the handshake.
3789 *
3790 * If this is set, you must also define the following:
Hanno Becker49ac40b2019-08-29 16:25:49 +01003791 * - MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID (if MBEDTLS_ECP_C is set)
Hanno Beckerc1096e72019-06-19 12:30:41 +01003792 * This must resolve to the Mbed TLS group ID for the elliptic
Hanno Becker2736d192019-07-26 07:49:02 +01003793 * curve to use (e.g. MBEDTLS_ECP_DP_SECP256R1); see
Hanno Beckerc1096e72019-06-19 12:30:41 +01003794 * ::mbedtls_ecp_group_id in mbedtls/ecp.h for a complete list
3795 * of curve identifiers.
Hanno Becker49ac40b2019-08-29 16:25:49 +01003796 * - MBEDTLS_SSL_CONF_SINGLE_UECC_GRP_ID (if MBEDTLS_USE_TINYCRYPT is set)
3797 * This must resolve to MBEDTLS_UECC_DP_SECP256R1.
Hanno Beckerc1096e72019-06-19 12:30:41 +01003798 * - MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID
3799 * This must resolve to the identifier for the elliptic curve
3800 * to use according to the IANA NamedCurve registry:
3801 * https://tools.ietf.org/html/rfc4492#section-5.1
3802 *
3803 * If defined, this option overwrites the effect of the
3804 * runtime configuration API mbedtls_ssl_conf_curves().
3805 */
3806//#define MBEDTLS_SSL_CONF_SINGLE_EC
Hanno Becker2736d192019-07-26 07:49:02 +01003807//#define MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID 23
3808//#define MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID MBEDTLS_ECP_DP_SECP256R1
Hanno Becker49ac40b2019-08-29 16:25:49 +01003809//#define MBEDTLS_SSL_CONF_SINGLE_UECC_GRP_ID MBEDTLS_UECC_DP_SECP256R1
Hanno Beckerc1096e72019-06-19 12:30:41 +01003810
Hanno Becker56595f42019-06-19 16:31:38 +01003811/* Enable support a single signature hash algorithm
3812 * at compile-time, at the benefit of code-size.
3813 *
Hanno Beckerf28ce6e2019-07-22 13:12:47 +01003814 * On highly constrained systems with large control
Hanno Becker56595f42019-06-19 16:31:38 +01003815 * over the configuration of the connection endpoints,
3816 * this option can be used to hardcode the choice of
3817 * hash algorithm to be used for signatures in the
3818 * ServerKeyExchange and CertificateVerify messages.
3819 *
3820 * If this is set, you must also define the following:
3821 * - MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID
3822 * This must resolve to the Mbed TLS hash ID for the hash
3823 * algorithm to use (e.g. MBEDTLS_MD_SHA256). See
3824 * ::mbedtls_md_type_t in mbedtls/md.h for a complete
3825 * list of supported hash algorithm identifiers.
3826 * - MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID
3827 * This must resolve to the TLS identifier for the hash
3828 * algorithm to use. See
3829 * https://tools.ietf.org/html/rfc5246#section-7.4.1.4.1
3830 * for a list of the supported identifiers.
3831 *
3832 * If defined, this option overwrites the effect of the
3833 * runtime configuration API mbedtls_ssl_conf_sig_hashes().
3834 */
3835//#define MBEDTLS_SSL_CONF_SINGLE_SIG_HASH
3836//#define MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID
3837//#define MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID
3838
Hanno Becker1292c352019-08-13 15:43:26 +01003839/* Set this to MBEDTLS_MD_INFO_{DIGEST} support of a single message
3840 * digest at compile-time, at the benefit of code-size.
3841 *
3842 * On highly constrained systems with large control over the configuration of
3843 * the connection endpoints, this option can be used to hardcode support for
3844 * a single hash algorithm.
3845 *
3846 * You need to make sure that the corresponding digest algorithm attributes
3847 * are defined through macros in md.c. See the definitions
3848 * MBEDTLS_MD_INFO_SHA256_XXX for example.
3849 *
3850 */
3851//#define MBEDTLS_MD_SINGLE_HASH MBEDTLS_MD_INFO_SHA256
3852
Manuel Pégourié-Gonnard1c1cc0d2019-09-19 10:45:14 +02003853/* Enable support for a single PK type in the PK layer.
3854 *
3855 * This is mainly intented to reduce code size on highly constrained system
3856 * with large control over the set of algorithms they need to support. It will
3857 * also reduce dynamic memory allocation.
3858 *
3859 * Currently this is only supported with EC keys in conjunction with the
3860 * MBEDTLS_USE_TINYCRYPT option. Set this to MBEDTLS_PK_INFO_ECKEY to enable.
3861 */
3862//#define MBEDTLS_PK_SINGLE_TYPE MBEDTLS_PK_INFO_ECKEY
3863
Hanno Beckeraabbb582019-06-11 13:43:27 +01003864/* \} SECTION: Compile-time SSL configuration */
3865
Arto Kinnunen77b9cfc2019-08-30 11:43:21 +03003866/**
3867 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
3868 *
3869 * Use only 128-bit keys in AES operations.
3870 *
3871 * Uncommenting this macro removes support for AES operations that are using 192
3872 * or 256-bit keys.
3873 *
3874 * Tradeoff: Uncommenting this macro reduces ROM footprint by ~200 bytes.
3875 *
3876 * If uncommented, uncomment also MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
3877 *
3878 * Module: library/aes.c
3879 *
3880 * Requires: MBEDTLS_AES_C
3881 *
3882 */
3883//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
3884
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003885/* Target and application specific configurations
3886 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003887 * Allow user to override any previous default.
3888 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003889 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01003890#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02003891#include MBEDTLS_USER_CONFIG_FILE
3892#endif
3893
Manuel Pégourié-Gonnard14d55952014-04-30 12:35:08 +02003894#include "check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01003895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003896#endif /* MBEDTLS_CONFIG_H */