Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1 | /** |
Bence Szépkúti | bb0cfeb | 2021-05-28 09:42:25 +0200 | [diff] [blame] | 2 | * \file mbedtls_config.h |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3 | * |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 4 | * \brief Configuration options (set of defines) |
| 5 | * |
Simon Butcher | 5b331b9 | 2016-01-03 16:14:14 +0000 | [diff] [blame] | 6 | * This set of compile-time options may be used to enable |
| 7 | * or disable features selectively, and reduce the global |
| 8 | * memory footprint. |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 9 | */ |
| 10 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 11 | * Copyright The Mbed TLS Contributors |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 12 | * SPDX-License-Identifier: Apache-2.0 |
| 13 | * |
| 14 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 15 | * not use this file except in compliance with the License. |
| 16 | * You may obtain a copy of the License at |
| 17 | * |
| 18 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 19 | * |
| 20 | * Unless required by applicable law or agreed to in writing, software |
| 21 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 22 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 23 | * See the License for the specific language governing permissions and |
| 24 | * limitations under the License. |
Manuel Pégourié-Gonnard | e2b0efe | 2015-08-11 10:38:37 +0200 | [diff] [blame] | 25 | */ |
| 26 | |
Bence Szépkúti | 2bb7456 | 2021-06-21 16:19:00 +0200 | [diff] [blame] | 27 | /** |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 28 | * This is an optional version symbol that enables compatibility handling of |
Bence Szépkúti | 2bb7456 | 2021-06-21 16:19:00 +0200 | [diff] [blame] | 29 | * config files. |
| 30 | * |
Bence Szépkúti | 1b2a883 | 2021-06-28 10:26:11 +0100 | [diff] [blame] | 31 | * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that |
Bence Szépkúti | 2bb7456 | 2021-06-21 16:19:00 +0200 | [diff] [blame] | 32 | * introduced the config format we want to be compatible with. |
| 33 | */ |
Bence Szépkúti | 1cafe5c | 2021-06-22 09:30:08 +0200 | [diff] [blame] | 34 | //#define MBEDTLS_CONFIG_VERSION 0x03000000 |
Bence Szépkúti | ba7248a | 2021-05-31 16:53:56 +0200 | [diff] [blame] | 35 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 36 | /** |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 37 | * \name SECTION: System support |
| 38 | * |
| 39 | * This section sets system specific settings. |
| 40 | * \{ |
| 41 | */ |
| 42 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 43 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 44 | * \def MBEDTLS_HAVE_ASM |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 45 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 46 | * The compiler has support for asm(). |
Paul Bakker | 68041ec | 2009-04-19 21:17:55 +0000 | [diff] [blame] | 47 | * |
| 48 | * Requires support for asm() in compiler. |
| 49 | * |
| 50 | * Used in: |
Dave Rodgman | cb0f2c4 | 2022-12-23 13:15:37 +0000 | [diff] [blame] | 51 | * library/aesni.h |
Manuel Pégourié-Gonnard | 26b54fa | 2018-02-27 12:20:20 +0100 | [diff] [blame] | 52 | * library/aria.c |
Chris Jones | 4c5819c | 2021-03-03 17:45:34 +0000 | [diff] [blame] | 53 | * library/bn_mul.h |
Dave Rodgman | cb0f2c4 | 2022-12-23 13:15:37 +0000 | [diff] [blame] | 54 | * library/constant_time.c |
| 55 | * library/padlock.h |
Paul Bakker | 68041ec | 2009-04-19 21:17:55 +0000 | [diff] [blame] | 56 | * |
Manuel Pégourié-Gonnard | 26b54fa | 2018-02-27 12:20:20 +0100 | [diff] [blame] | 57 | * Required by: |
| 58 | * MBEDTLS_AESNI_C |
| 59 | * MBEDTLS_PADLOCK_C |
| 60 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 61 | * Comment to disable the use of assembly code. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 62 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 63 | #define MBEDTLS_HAVE_ASM |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 64 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 65 | /** |
Gilles Peskine | ed942f8 | 2017-06-08 15:19:20 +0200 | [diff] [blame] | 66 | * \def MBEDTLS_NO_UDBL_DIVISION |
| 67 | * |
| 68 | * The platform lacks support for double-width integer division (64-bit |
| 69 | * division on a 32-bit platform, 128-bit division on a 64-bit platform). |
| 70 | * |
| 71 | * Used in: |
| 72 | * include/mbedtls/bignum.h |
| 73 | * library/bignum.c |
| 74 | * |
| 75 | * The bignum code uses double-width division to speed up some operations. |
| 76 | * Double-width division is often implemented in software that needs to |
| 77 | * be linked with the program. The presence of a double-width integer |
| 78 | * type is usually detected automatically through preprocessor macros, |
| 79 | * but the automatic detection cannot know whether the code needs to |
| 80 | * and can be linked with an implementation of division for that type. |
| 81 | * By default division is assumed to be usable if the type is present. |
| 82 | * Uncomment this option to prevent the use of double-width division. |
| 83 | * |
| 84 | * Note that division for the native integer type is always required. |
| 85 | * Furthermore, a 64-bit type is always required even on a 32-bit |
Andres Amaya Garcia | 2801d00 | 2017-07-21 10:56:22 +0100 | [diff] [blame] | 86 | * platform, but it need not support multiplication or division. In some |
| 87 | * cases it is also desirable to disable some double-width operations. For |
| 88 | * example, if double-width division is implemented in software, disabling |
| 89 | * it can reduce code size in some embedded targets. |
Gilles Peskine | ed942f8 | 2017-06-08 15:19:20 +0200 | [diff] [blame] | 90 | */ |
| 91 | //#define MBEDTLS_NO_UDBL_DIVISION |
| 92 | |
| 93 | /** |
Manuel Pégourié-Gonnard | 2adb375 | 2018-06-07 10:51:44 +0200 | [diff] [blame] | 94 | * \def MBEDTLS_NO_64BIT_MULTIPLICATION |
| 95 | * |
| 96 | * The platform lacks support for 32x32 -> 64-bit multiplication. |
| 97 | * |
| 98 | * Used in: |
| 99 | * library/poly1305.c |
| 100 | * |
| 101 | * Some parts of the library may use multiplication of two unsigned 32-bit |
| 102 | * operands with a 64-bit result in order to speed up computations. On some |
| 103 | * platforms, this is not available in hardware and has to be implemented in |
| 104 | * software, usually in a library provided by the toolchain. |
| 105 | * |
| 106 | * Sometimes it is not desirable to have to link to that library. This option |
| 107 | * removes the dependency of that library on platforms that lack a hardware |
| 108 | * 64-bit multiplier by embedding a software implementation in Mbed TLS. |
| 109 | * |
| 110 | * Note that depending on the compiler, this may decrease performance compared |
| 111 | * to using the library function provided by the toolchain. |
| 112 | */ |
| 113 | //#define MBEDTLS_NO_64BIT_MULTIPLICATION |
| 114 | |
| 115 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 116 | * \def MBEDTLS_HAVE_SSE2 |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 117 | * |
Paul Bakker | e23c315 | 2012-10-01 14:42:47 +0000 | [diff] [blame] | 118 | * CPU supports SSE2 instruction set. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 119 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 120 | * Uncomment if the CPU supports SSE2 (IA-32 specific). |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 121 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 122 | //#define MBEDTLS_HAVE_SSE2 |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 123 | |
| 124 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 125 | * \def MBEDTLS_HAVE_TIME |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 126 | * |
Manuel Pégourié-Gonnard | 60c793b | 2015-06-18 20:52:58 +0200 | [diff] [blame] | 127 | * System has time.h and time(). |
| 128 | * The time does not need to be correct, only time differences are used, |
| 129 | * by contrast with MBEDTLS_HAVE_TIME_DATE |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 130 | * |
Andres Amaya Garcia | 1e4ec66 | 2016-07-20 10:16:25 +0100 | [diff] [blame] | 131 | * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT, |
| 132 | * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and |
| 133 | * MBEDTLS_PLATFORM_STD_TIME. |
| 134 | * |
Andrzej Kurek | 5735369 | 2022-04-07 08:08:21 -0400 | [diff] [blame] | 135 | * Comment if your system does not support time functions. |
| 136 | * |
| 137 | * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing |
| 138 | * interface - timing.c will include time.h on suitable platforms |
| 139 | * regardless of the setting of MBEDTLS_HAVE_TIME, unless |
| 140 | * MBEDTLS_TIMING_ALT is used. See timing.c for more information. |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 141 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 142 | #define MBEDTLS_HAVE_TIME |
Manuel Pégourié-Gonnard | 10934de | 2013-12-13 12:54:09 +0100 | [diff] [blame] | 143 | |
| 144 | /** |
Manuel Pégourié-Gonnard | 60c793b | 2015-06-18 20:52:58 +0200 | [diff] [blame] | 145 | * \def MBEDTLS_HAVE_TIME_DATE |
| 146 | * |
Hanno Becker | 4e67cca | 2018-09-05 16:18:38 +0100 | [diff] [blame] | 147 | * System has time.h, time(), and an implementation for |
| 148 | * mbedtls_platform_gmtime_r() (see below). |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 149 | * The time needs to be correct (not necessarily very accurate, but at least |
Manuel Pégourié-Gonnard | 60c793b | 2015-06-18 20:52:58 +0200 | [diff] [blame] | 150 | * the date should be correct). This is used to verify the validity period of |
| 151 | * X.509 certificates. |
| 152 | * |
| 153 | * Comment if your system does not have a correct clock. |
Andres Amaya Garcia | 97f3ecb | 2018-08-07 20:39:27 +0100 | [diff] [blame] | 154 | * |
Hanno Becker | 6a73978 | 2018-09-05 15:06:19 +0100 | [diff] [blame] | 155 | * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that |
Hanno Becker | c52ef40 | 2018-09-05 16:28:59 +0100 | [diff] [blame] | 156 | * behaves similarly to the gmtime_r() function from the C standard. Refer to |
| 157 | * the documentation for mbedtls_platform_gmtime_r() for more information. |
Andres Amaya Garcia | c99b12b | 2018-08-21 19:32:44 +0100 | [diff] [blame] | 158 | * |
| 159 | * \note It is possible to configure an implementation for |
Hanno Becker | 6a73978 | 2018-09-05 15:06:19 +0100 | [diff] [blame] | 160 | * mbedtls_platform_gmtime_r() at compile-time by using the macro |
| 161 | * MBEDTLS_PLATFORM_GMTIME_R_ALT. |
Manuel Pégourié-Gonnard | 60c793b | 2015-06-18 20:52:58 +0200 | [diff] [blame] | 162 | */ |
| 163 | #define MBEDTLS_HAVE_TIME_DATE |
| 164 | |
| 165 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 166 | * \def MBEDTLS_PLATFORM_MEMORY |
Paul Bakker | defc0ca | 2014-02-04 17:30:24 +0100 | [diff] [blame] | 167 | * |
| 168 | * Enable the memory allocation layer. |
| 169 | * |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 170 | * By default mbed TLS uses the system-provided calloc() and free(). |
Paul Bakker | defc0ca | 2014-02-04 17:30:24 +0100 | [diff] [blame] | 171 | * This allows different allocators (self-implemented or provided) to be |
| 172 | * provided to the platform abstraction layer. |
| 173 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 174 | * Enabling MBEDTLS_PLATFORM_MEMORY without the |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 175 | * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide |
| 176 | * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and |
Rich Evans | 16f8cd8 | 2015-02-06 16:14:34 +0000 | [diff] [blame] | 177 | * free() function pointer at runtime. |
| 178 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 179 | * Enabling MBEDTLS_PLATFORM_MEMORY and specifying |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 180 | * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the |
Rich Evans | 16f8cd8 | 2015-02-06 16:14:34 +0000 | [diff] [blame] | 181 | * alternate function at compile time. |
Paul Bakker | defc0ca | 2014-02-04 17:30:24 +0100 | [diff] [blame] | 182 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 183 | * Requires: MBEDTLS_PLATFORM_C |
Paul Bakker | defc0ca | 2014-02-04 17:30:24 +0100 | [diff] [blame] | 184 | * |
| 185 | * Enable this layer to allow use of alternative memory allocators. |
| 186 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 187 | //#define MBEDTLS_PLATFORM_MEMORY |
Paul Bakker | defc0ca | 2014-02-04 17:30:24 +0100 | [diff] [blame] | 188 | |
| 189 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 190 | * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 191 | * |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 192 | * Do not assign standard functions in the platform layer (e.g. calloc() to |
| 193 | * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF) |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 194 | * |
| 195 | * This makes sure there are no linking errors on platforms that do not support |
| 196 | * these functions. You will HAVE to provide alternatives, either at runtime |
| 197 | * via the platform_set_xxx() functions or at compile time by setting |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 198 | * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a |
| 199 | * MBEDTLS_PLATFORM_XXX_MACRO. |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 200 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 201 | * Requires: MBEDTLS_PLATFORM_C |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 202 | * |
| 203 | * Uncomment to prevent default assignment of standard functions in the |
| 204 | * platform layer. |
| 205 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 206 | //#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 207 | |
| 208 | /** |
Janos Follath | c351d18 | 2016-03-21 08:43:59 +0000 | [diff] [blame] | 209 | * \def MBEDTLS_PLATFORM_EXIT_ALT |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 210 | * |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 211 | * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the |
| 212 | * function in the platform abstraction layer. |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 213 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 214 | * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will |
| 215 | * provide a function "mbedtls_platform_set_printf()" that allows you to set an |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 216 | * alternative printf function pointer. |
| 217 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 218 | * All these define require MBEDTLS_PLATFORM_C to be defined! |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 219 | * |
Manuel Pégourié-Gonnard | 9db2887 | 2015-06-26 10:52:01 +0200 | [diff] [blame] | 220 | * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows; |
| 221 | * it will be enabled automatically by check_config.h |
| 222 | * |
Manuel Pégourié-Gonnard | 6c0c8e0 | 2015-06-22 10:23:34 +0200 | [diff] [blame] | 223 | * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 224 | * MBEDTLS_PLATFORM_XXX_MACRO! |
Rich Evans | 16f8cd8 | 2015-02-06 16:14:34 +0000 | [diff] [blame] | 225 | * |
Andres Amaya Garcia | 1e4ec66 | 2016-07-20 10:16:25 +0100 | [diff] [blame] | 226 | * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME |
| 227 | * |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 228 | * Uncomment a macro to enable alternate implementation of specific base |
| 229 | * platform function |
| 230 | */ |
Gilles Peskine | 6497b5a | 2022-06-30 17:01:40 +0200 | [diff] [blame] | 231 | //#define MBEDTLS_PLATFORM_SETBUF_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 232 | //#define MBEDTLS_PLATFORM_EXIT_ALT |
SimonB | d5800b7 | 2016-04-26 07:43:27 +0100 | [diff] [blame] | 233 | //#define MBEDTLS_PLATFORM_TIME_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 234 | //#define MBEDTLS_PLATFORM_FPRINTF_ALT |
| 235 | //#define MBEDTLS_PLATFORM_PRINTF_ALT |
| 236 | //#define MBEDTLS_PLATFORM_SNPRINTF_ALT |
k-stachowiak | 723f867 | 2018-07-16 14:27:07 +0200 | [diff] [blame] | 237 | //#define MBEDTLS_PLATFORM_VSNPRINTF_ALT |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 238 | //#define MBEDTLS_PLATFORM_NV_SEED_ALT |
Andres Amaya Garcia | 59c2026 | 2017-07-18 10:23:04 +0100 | [diff] [blame] | 239 | //#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 240 | |
| 241 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 242 | * \def MBEDTLS_DEPRECATED_WARNING |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 243 | * |
Andres Amaya Garcia | 0963424 | 2018-11-29 09:55:41 +0000 | [diff] [blame] | 244 | * Mark deprecated functions and features so that they generate a warning if |
| 245 | * used. Functionality deprecated in one version will usually be removed in the |
| 246 | * next version. You can enable this to help you prepare the transition to a |
| 247 | * new major version by making sure your code is not using this functionality. |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 248 | * |
| 249 | * This only works with GCC and Clang. With other compilers, you may want to |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 250 | * use MBEDTLS_DEPRECATED_REMOVED |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 251 | * |
Andres Amaya Garcia | 0963424 | 2018-11-29 09:55:41 +0000 | [diff] [blame] | 252 | * Uncomment to get warnings on using deprecated functions and features. |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 253 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 254 | //#define MBEDTLS_DEPRECATED_WARNING |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 255 | |
| 256 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 257 | * \def MBEDTLS_DEPRECATED_REMOVED |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 258 | * |
Andres Amaya Garcia | 0963424 | 2018-11-29 09:55:41 +0000 | [diff] [blame] | 259 | * Remove deprecated functions and features so that they generate an error if |
| 260 | * used. Functionality deprecated in one version will usually be removed in the |
| 261 | * next version. You can enable this to help you prepare the transition to a |
| 262 | * new major version by making sure your code is not using this functionality. |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 263 | * |
Andres Amaya Garcia | 0963424 | 2018-11-29 09:55:41 +0000 | [diff] [blame] | 264 | * Uncomment to get errors on using deprecated functions and features. |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 265 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 266 | //#define MBEDTLS_DEPRECATED_REMOVED |
Manuel Pégourié-Gonnard | c70581c | 2015-03-23 13:58:27 +0100 | [diff] [blame] | 267 | |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 268 | /** \} name SECTION: System support */ |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 269 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 270 | /** |
Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 271 | * \name SECTION: mbed TLS feature support |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 272 | * |
| 273 | * This section sets support for features that are or are not needed |
| 274 | * within the modules that are enabled. |
| 275 | * \{ |
| 276 | */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 277 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 278 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 279 | * \def MBEDTLS_TIMING_ALT |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 280 | * |
TRodziewicz | d854083 | 2021-06-10 15:16:50 +0200 | [diff] [blame] | 281 | * Uncomment to provide your own alternate implementation for |
Manuel Pégourié-Gonnard | a63bc94 | 2015-05-14 18:22:47 +0200 | [diff] [blame] | 282 | * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay() |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 283 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 284 | * Only works if you have MBEDTLS_TIMING_C enabled. |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 285 | * |
| 286 | * You will need to provide a header "timing_alt.h" and an implementation at |
| 287 | * compile time. |
| 288 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 289 | //#define MBEDTLS_TIMING_ALT |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 290 | |
| 291 | /** |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 292 | * \def MBEDTLS_AES_ALT |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 293 | * |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 294 | * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 295 | * alternate core implementation of a symmetric crypto, an arithmetic or hash |
| 296 | * module (e.g. platform specific assembly optimized implementations). Keep |
| 297 | * in mind that the function prototypes should remain the same. |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 298 | * |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 299 | * This replaces the whole module. If you only want to replace one of the |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 300 | * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags. |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 301 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 302 | * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer |
Janos Follath | ee782bc | 2016-11-07 15:41:26 +0000 | [diff] [blame] | 303 | * provide the "struct mbedtls_aes_context" definition and omit the base |
| 304 | * function declarations and implementations. "aes_alt.h" will be included from |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 305 | * "aes.h" to include the new function definitions. |
| 306 | * |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 307 | * Uncomment a macro to enable alternate implementation of the corresponding |
| 308 | * module. |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 309 | * |
TRodziewicz | 10e8cf5 | 2021-05-31 17:58:57 +0200 | [diff] [blame] | 310 | * \warning MD5, DES and SHA-1 are considered weak and their |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 311 | * use constitutes a security risk. If possible, we recommend |
| 312 | * avoiding dependencies on them, and considering stronger message |
| 313 | * digests and ciphers instead. |
| 314 | * |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 315 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 316 | //#define MBEDTLS_AES_ALT |
Markku-Juhani O. Saarinen | 0fb47fe | 2017-12-01 15:41:38 +0000 | [diff] [blame] | 317 | //#define MBEDTLS_ARIA_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 318 | //#define MBEDTLS_CAMELLIA_ALT |
Steven Cooreman | 222e2ff | 2017-04-04 11:37:15 +0200 | [diff] [blame] | 319 | //#define MBEDTLS_CCM_ALT |
Daniel King | 34b822c | 2016-05-15 17:28:08 -0300 | [diff] [blame] | 320 | //#define MBEDTLS_CHACHA20_ALT |
Manuel Pégourié-Gonnard | e533b22 | 2018-06-04 12:23:19 +0200 | [diff] [blame] | 321 | //#define MBEDTLS_CHACHAPOLY_ALT |
Steven Cooreman | 6334277 | 2017-04-04 11:47:16 +0200 | [diff] [blame] | 322 | //#define MBEDTLS_CMAC_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 323 | //#define MBEDTLS_DES_ALT |
nirekh01 | d569ecf | 2018-01-09 16:43:21 +0000 | [diff] [blame] | 324 | //#define MBEDTLS_DHM_ALT |
Hanno Becker | 616d1ca | 2018-01-24 10:25:05 +0000 | [diff] [blame] | 325 | //#define MBEDTLS_ECJPAKE_ALT |
Jaeden Amero | 1526330 | 2017-09-21 12:53:48 +0100 | [diff] [blame] | 326 | //#define MBEDTLS_GCM_ALT |
Ron Eldor | 466a57f | 2018-05-03 16:54:28 +0300 | [diff] [blame] | 327 | //#define MBEDTLS_NIST_KW_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 328 | //#define MBEDTLS_MD5_ALT |
Daniel King | adc32c0 | 2016-05-16 18:25:45 -0300 | [diff] [blame] | 329 | //#define MBEDTLS_POLY1305_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 330 | //#define MBEDTLS_RIPEMD160_ALT |
Hanno Becker | 88683b2 | 2018-01-04 18:26:54 +0000 | [diff] [blame] | 331 | //#define MBEDTLS_RSA_ALT |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 332 | //#define MBEDTLS_SHA1_ALT |
| 333 | //#define MBEDTLS_SHA256_ALT |
| 334 | //#define MBEDTLS_SHA512_ALT |
Markku-Juhani O. Saarinen | 0fb47fe | 2017-12-01 15:41:38 +0000 | [diff] [blame] | 335 | |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 336 | /* |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 337 | * When replacing the elliptic curve module, please consider, that it is |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 338 | * implemented with two .c files: |
| 339 | * - ecp.c |
| 340 | * - ecp_curves.c |
Janos Follath | ee782bc | 2016-11-07 15:41:26 +0000 | [diff] [blame] | 341 | * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT |
| 342 | * macros as described above. The only difference is that you have to make sure |
| 343 | * that you provide functionality for both .c files. |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 344 | */ |
| 345 | //#define MBEDTLS_ECP_ALT |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 346 | |
| 347 | /** |
TRodziewicz | 75628d5 | 2021-06-18 12:56:27 +0200 | [diff] [blame] | 348 | * \def MBEDTLS_SHA256_PROCESS_ALT |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 349 | * |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 350 | * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you |
| 351 | * alternate core implementation of symmetric crypto or hash function. Keep in |
| 352 | * mind that function prototypes should remain the same. |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 353 | * |
| 354 | * This replaces only one function. The header file from mbed TLS is still |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 355 | * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags. |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 356 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 357 | * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will |
| 358 | * no longer provide the mbedtls_sha1_process() function, but it will still provide |
| 359 | * the other function (using your mbedtls_sha1_process() function) and the definition |
| 360 | * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 361 | * with this definition. |
| 362 | * |
Tobias Nießen | 1e8ca12 | 2021-05-10 19:53:15 +0200 | [diff] [blame] | 363 | * \note If you use the AES_xxx_ALT macros, then it is recommended to also set |
Hanno Becker | a5723f4 | 2017-06-26 12:46:19 +0100 | [diff] [blame] | 364 | * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES |
| 365 | * tables. |
Manuel Pégourié-Gonnard | 31993f2 | 2015-05-12 15:41:08 +0200 | [diff] [blame] | 366 | * |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 367 | * Uncomment a macro to enable alternate implementation of the corresponding |
| 368 | * function. |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 369 | * |
TRodziewicz | 10e8cf5 | 2021-05-31 17:58:57 +0200 | [diff] [blame] | 370 | * \warning MD5, DES and SHA-1 are considered weak and their use |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 371 | * constitutes a security risk. If possible, we recommend avoiding |
| 372 | * dependencies on them, and considering stronger message digests |
| 373 | * and ciphers instead. |
| 374 | * |
Janos Follath | 1231d21 | 2019-01-07 15:01:32 +0000 | [diff] [blame] | 375 | * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are |
| 376 | * enabled, then the deterministic ECDH signature functions pass the |
| 377 | * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore |
| 378 | * alternative implementations should use the RNG only for generating |
| 379 | * the ephemeral key and nothing else. If this is not possible, then |
| 380 | * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative |
TRodziewicz | c1c479f | 2021-05-06 00:53:22 +0200 | [diff] [blame] | 381 | * implementation should be provided for mbedtls_ecdsa_sign_det_ext(). |
Janos Follath | 1231d21 | 2019-01-07 15:01:32 +0000 | [diff] [blame] | 382 | * |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 383 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 384 | //#define MBEDTLS_MD5_PROCESS_ALT |
| 385 | //#define MBEDTLS_RIPEMD160_PROCESS_ALT |
| 386 | //#define MBEDTLS_SHA1_PROCESS_ALT |
| 387 | //#define MBEDTLS_SHA256_PROCESS_ALT |
| 388 | //#define MBEDTLS_SHA512_PROCESS_ALT |
Manuel Pégourié-Gonnard | 70a5010 | 2015-05-12 15:02:45 +0200 | [diff] [blame] | 389 | //#define MBEDTLS_DES_SETKEY_ALT |
| 390 | //#define MBEDTLS_DES_CRYPT_ECB_ALT |
| 391 | //#define MBEDTLS_DES3_CRYPT_ECB_ALT |
Manuel Pégourié-Gonnard | 31993f2 | 2015-05-12 15:41:08 +0200 | [diff] [blame] | 392 | //#define MBEDTLS_AES_SETKEY_ENC_ALT |
| 393 | //#define MBEDTLS_AES_SETKEY_DEC_ALT |
| 394 | //#define MBEDTLS_AES_ENCRYPT_ALT |
| 395 | //#define MBEDTLS_AES_DECRYPT_ALT |
Ron Eldor | a84c1cb | 2017-10-10 19:04:27 +0300 | [diff] [blame] | 396 | //#define MBEDTLS_ECDH_GEN_PUBLIC_ALT |
Ron Eldor | 3226d36 | 2017-10-12 14:17:48 +0300 | [diff] [blame] | 397 | //#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT |
Ron Eldor | 314adb6 | 2017-10-10 18:28:25 +0300 | [diff] [blame] | 398 | //#define MBEDTLS_ECDSA_VERIFY_ALT |
| 399 | //#define MBEDTLS_ECDSA_SIGN_ALT |
| 400 | //#define MBEDTLS_ECDSA_GENKEY_ALT |
Manuel Pégourié-Gonnard | 427b672 | 2015-03-31 18:32:50 +0200 | [diff] [blame] | 401 | |
| 402 | /** |
Janos Follath | c44ab97 | 2016-11-18 16:38:23 +0000 | [diff] [blame] | 403 | * \def MBEDTLS_ECP_INTERNAL_ALT |
| 404 | * |
| 405 | * Expose a part of the internal interface of the Elliptic Curve Point module. |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 406 | * |
| 407 | * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your |
Janos Follath | 372697b | 2016-10-28 16:53:11 +0100 | [diff] [blame] | 408 | * alternative core implementation of elliptic curve arithmetic. Keep in mind |
| 409 | * that function prototypes should remain the same. |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 410 | * |
| 411 | * This partially replaces one function. The header file from mbed TLS is still |
| 412 | * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation |
| 413 | * is still present and it is used for group structures not supported by the |
| 414 | * alternative. |
| 415 | * |
Steven Cooreman | 97b4984 | 2021-01-08 16:32:20 +0100 | [diff] [blame] | 416 | * The original implementation can in addition be removed by setting the |
Steven Cooreman | 6226a12 | 2021-01-21 13:58:31 +0100 | [diff] [blame] | 417 | * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the |
Steven Cooreman | 97b4984 | 2021-01-08 16:32:20 +0100 | [diff] [blame] | 418 | * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be |
| 419 | * able to fallback to curves not supported by the alternative implementation. |
| 420 | * |
Janos Follath | c44ab97 | 2016-11-18 16:38:23 +0000 | [diff] [blame] | 421 | * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT |
| 422 | * and implementing the following functions: |
| 423 | * unsigned char mbedtls_internal_ecp_grp_capable( |
| 424 | * const mbedtls_ecp_group *grp ) |
| 425 | * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp ) |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 426 | * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp ) |
Janos Follath | c44ab97 | 2016-11-18 16:38:23 +0000 | [diff] [blame] | 427 | * The mbedtls_internal_ecp_grp_capable function should return 1 if the |
| 428 | * replacement functions implement arithmetic for the given group and 0 |
| 429 | * otherwise. |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 430 | * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are |
Janos Follath | c44ab97 | 2016-11-18 16:38:23 +0000 | [diff] [blame] | 431 | * called before and after each point operation and provide an opportunity to |
| 432 | * implement optimized set up and tear down instructions. |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 433 | * |
Steven Cooreman | 6226a12 | 2021-01-21 13:58:31 +0100 | [diff] [blame] | 434 | * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and |
| 435 | * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac() |
| 436 | * function, but will use your mbedtls_internal_ecp_double_jac() if the group |
| 437 | * for the operation is supported by your implementation (i.e. your |
| 438 | * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the |
| 439 | * group is not supported by your implementation, then the original mbed TLS |
| 440 | * implementation of ecp_double_jac() is used instead, unless this fallback |
| 441 | * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case |
| 442 | * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE). |
| 443 | * |
| 444 | * The function prototypes and the definition of mbedtls_ecp_group and |
| 445 | * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your |
| 446 | * implementation of mbedtls_internal_ecp__function_name__ must be compatible |
| 447 | * with their definitions. |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 448 | * |
| 449 | * Uncomment a macro to enable alternate implementation of the corresponding |
| 450 | * function. |
| 451 | */ |
| 452 | /* Required for all the functions in this section */ |
Janos Follath | c44ab97 | 2016-11-18 16:38:23 +0000 | [diff] [blame] | 453 | //#define MBEDTLS_ECP_INTERNAL_ALT |
Steven Cooreman | 97b4984 | 2021-01-08 16:32:20 +0100 | [diff] [blame] | 454 | /* Turn off software fallback for curves not supported in hardware */ |
| 455 | //#define MBEDTLS_ECP_NO_FALLBACK |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 456 | /* Support for Weierstrass curves with Jacobi representation */ |
| 457 | //#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT |
| 458 | //#define MBEDTLS_ECP_ADD_MIXED_ALT |
| 459 | //#define MBEDTLS_ECP_DOUBLE_JAC_ALT |
| 460 | //#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT |
| 461 | //#define MBEDTLS_ECP_NORMALIZE_JAC_ALT |
| 462 | /* Support for curves with Montgomery arithmetic */ |
| 463 | //#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT |
| 464 | //#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT |
| 465 | //#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT |
| 466 | |
| 467 | /** |
Manuel Pégourié-Gonnard | 8ba88f0 | 2015-06-22 12:14:20 +0200 | [diff] [blame] | 468 | * \def MBEDTLS_ENTROPY_HARDWARE_ALT |
Manuel Pégourié-Gonnard | 3f77dfb | 2015-06-19 10:06:21 +0200 | [diff] [blame] | 469 | * |
| 470 | * Uncomment this macro to let mbed TLS use your own implementation of a |
| 471 | * hardware entropy collector. |
| 472 | * |
| 473 | * Your function must be called \c mbedtls_hardware_poll(), have the same |
Chris Jones | 3848e31 | 2021-03-11 16:17:59 +0000 | [diff] [blame] | 474 | * prototype as declared in library/entropy_poll.h, and accept NULL as first |
| 475 | * argument. |
Manuel Pégourié-Gonnard | 3f77dfb | 2015-06-19 10:06:21 +0200 | [diff] [blame] | 476 | * |
| 477 | * Uncomment to use your own hardware entropy collector. |
| 478 | */ |
| 479 | //#define MBEDTLS_ENTROPY_HARDWARE_ALT |
| 480 | |
| 481 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 482 | * \def MBEDTLS_AES_ROM_TABLES |
Paul Bakker | 15566e4 | 2011-04-24 21:19:15 +0000 | [diff] [blame] | 483 | * |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 484 | * Use precomputed AES tables stored in ROM. |
Paul Bakker | 15566e4 | 2011-04-24 21:19:15 +0000 | [diff] [blame] | 485 | * |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 486 | * Uncomment this macro to use precomputed AES tables stored in ROM. |
| 487 | * Comment this macro to generate AES tables in RAM at runtime. |
| 488 | * |
Hanno Becker | 4c1dc3c | 2018-03-27 16:52:03 +0100 | [diff] [blame] | 489 | * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb |
| 490 | * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the |
Hanno Becker | 6a92ce6 | 2018-03-28 11:42:05 +0100 | [diff] [blame] | 491 | * initialization time before the first AES operation can be performed. |
| 492 | * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c |
| 493 | * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded |
| 494 | * performance if ROM access is slower than RAM access. |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 495 | * |
| 496 | * This option is independent of \c MBEDTLS_AES_FEWER_TABLES. |
| 497 | * |
Paul Bakker | 15566e4 | 2011-04-24 21:19:15 +0000 | [diff] [blame] | 498 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 499 | //#define MBEDTLS_AES_ROM_TABLES |
Paul Bakker | 15566e4 | 2011-04-24 21:19:15 +0000 | [diff] [blame] | 500 | |
| 501 | /** |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 502 | * \def MBEDTLS_AES_FEWER_TABLES |
Jussi Kivilinna | 2fd1bb8 | 2015-11-12 16:38:31 +0200 | [diff] [blame] | 503 | * |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 504 | * Use less ROM/RAM for AES tables. |
Jussi Kivilinna | 2fd1bb8 | 2015-11-12 16:38:31 +0200 | [diff] [blame] | 505 | * |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 506 | * Uncommenting this macro omits 75% of the AES tables from |
| 507 | * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES) |
| 508 | * by computing their values on the fly during operations |
| 509 | * (the tables are entry-wise rotations of one another). |
| 510 | * |
| 511 | * Tradeoff: Uncommenting this reduces the RAM / ROM footprint |
Hanno Becker | 08a5c18 | 2017-06-19 16:33:58 +0100 | [diff] [blame] | 512 | * by ~6kb but at the cost of more arithmetic operations during |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 513 | * runtime. Specifically, one has to compare 4 accesses within |
| 514 | * different tables to 4 accesses with additional arithmetic |
| 515 | * operations within the same table. The performance gain/loss |
| 516 | * depends on the system and memory details. |
| 517 | * |
| 518 | * This option is independent of \c MBEDTLS_AES_ROM_TABLES. |
| 519 | * |
Jussi Kivilinna | 2fd1bb8 | 2015-11-12 16:38:31 +0200 | [diff] [blame] | 520 | */ |
Hanno Becker | 177d3cf | 2017-06-07 15:52:48 +0100 | [diff] [blame] | 521 | //#define MBEDTLS_AES_FEWER_TABLES |
Jussi Kivilinna | 2fd1bb8 | 2015-11-12 16:38:31 +0200 | [diff] [blame] | 522 | |
| 523 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 524 | * \def MBEDTLS_CAMELLIA_SMALL_MEMORY |
Manuel Pégourié-Gonnard | 62edcc8 | 2015-04-03 16:28:19 +0200 | [diff] [blame] | 525 | * |
| 526 | * Use less ROM for the Camellia implementation (saves about 768 bytes). |
| 527 | * |
| 528 | * Uncomment this macro to use less memory for Camellia. |
| 529 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 530 | //#define MBEDTLS_CAMELLIA_SMALL_MEMORY |
Manuel Pégourié-Gonnard | 62edcc8 | 2015-04-03 16:28:19 +0200 | [diff] [blame] | 531 | |
| 532 | /** |
Gilles Peskine | 9a7d4c2 | 2021-09-23 18:07:36 +0200 | [diff] [blame] | 533 | * \def MBEDTLS_CHECK_RETURN_WARNING |
| 534 | * |
| 535 | * If this macro is defined, emit a compile-time warning if application code |
| 536 | * calls a function without checking its return value, but the return value |
| 537 | * should generally be checked in portable applications. |
| 538 | * |
| 539 | * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is |
| 540 | * implemented. Otherwise this option has no effect. |
| 541 | * |
| 542 | * Uncomment to get warnings on using fallible functions without checking |
| 543 | * their return value. |
| 544 | * |
| 545 | * \note This feature is a work in progress. |
| 546 | * Warnings will be added to more functions in the future. |
| 547 | * |
| 548 | * \note A few functions are considered critical, and ignoring the return |
| 549 | * value of these functions will trigger a warning even if this |
| 550 | * macro is not defined. To completely disable return value check |
| 551 | * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion. |
| 552 | */ |
| 553 | //#define MBEDTLS_CHECK_RETURN_WARNING |
| 554 | |
| 555 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 556 | * \def MBEDTLS_CIPHER_MODE_CBC |
Manuel Pégourié-Gonnard | f7dc378 | 2013-09-13 14:10:44 +0200 | [diff] [blame] | 557 | * |
| 558 | * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers. |
| 559 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 560 | #define MBEDTLS_CIPHER_MODE_CBC |
Manuel Pégourié-Gonnard | f7dc378 | 2013-09-13 14:10:44 +0200 | [diff] [blame] | 561 | |
| 562 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 563 | * \def MBEDTLS_CIPHER_MODE_CFB |
Paul Bakker | b6ecaf5 | 2011-04-19 14:29:23 +0000 | [diff] [blame] | 564 | * |
| 565 | * Enable Cipher Feedback mode (CFB) for symmetric ciphers. |
| 566 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 567 | #define MBEDTLS_CIPHER_MODE_CFB |
Paul Bakker | b6ecaf5 | 2011-04-19 14:29:23 +0000 | [diff] [blame] | 568 | |
| 569 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 570 | * \def MBEDTLS_CIPHER_MODE_CTR |
Paul Bakker | b6ecaf5 | 2011-04-19 14:29:23 +0000 | [diff] [blame] | 571 | * |
| 572 | * Enable Counter Block Cipher mode (CTR) for symmetric ciphers. |
| 573 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 574 | #define MBEDTLS_CIPHER_MODE_CTR |
Paul Bakker | b6ecaf5 | 2011-04-19 14:29:23 +0000 | [diff] [blame] | 575 | |
| 576 | /** |
Jaeden Amero | ff2f493 | 2018-06-14 11:38:50 +0100 | [diff] [blame] | 577 | * \def MBEDTLS_CIPHER_MODE_OFB |
| 578 | * |
| 579 | * Enable Output Feedback mode (OFB) for symmetric ciphers. |
| 580 | */ |
| 581 | #define MBEDTLS_CIPHER_MODE_OFB |
| 582 | |
| 583 | /** |
| 584 | * \def MBEDTLS_CIPHER_MODE_XTS |
| 585 | * |
| 586 | * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES. |
| 587 | */ |
| 588 | #define MBEDTLS_CIPHER_MODE_XTS |
| 589 | |
| 590 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 591 | * \def MBEDTLS_CIPHER_NULL_CIPHER |
Paul Bakker | fab5c82 | 2012-02-06 16:45:10 +0000 | [diff] [blame] | 592 | * |
| 593 | * Enable NULL cipher. |
| 594 | * Warning: Only do so when you know what you are doing. This allows for |
| 595 | * encryption or channels without any security! |
| 596 | * |
Ronald Cron | cee4270 | 2021-04-26 11:34:44 +0200 | [diff] [blame] | 597 | * To enable the following ciphersuites: |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 598 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA |
| 599 | * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA |
| 600 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA |
| 601 | * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA |
| 602 | * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 |
| 603 | * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 |
| 604 | * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA |
| 605 | * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384 |
| 606 | * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256 |
| 607 | * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA |
| 608 | * MBEDTLS_TLS_RSA_WITH_NULL_SHA256 |
| 609 | * MBEDTLS_TLS_RSA_WITH_NULL_SHA |
| 610 | * MBEDTLS_TLS_RSA_WITH_NULL_MD5 |
| 611 | * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384 |
| 612 | * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256 |
| 613 | * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA |
| 614 | * MBEDTLS_TLS_PSK_WITH_NULL_SHA384 |
| 615 | * MBEDTLS_TLS_PSK_WITH_NULL_SHA256 |
| 616 | * MBEDTLS_TLS_PSK_WITH_NULL_SHA |
Paul Bakker | fab5c82 | 2012-02-06 16:45:10 +0000 | [diff] [blame] | 617 | * |
| 618 | * Uncomment this macro to enable the NULL cipher and ciphersuites |
Paul Bakker | fab5c82 | 2012-02-06 16:45:10 +0000 | [diff] [blame] | 619 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 620 | //#define MBEDTLS_CIPHER_NULL_CIPHER |
Paul Bakker | fab5c82 | 2012-02-06 16:45:10 +0000 | [diff] [blame] | 621 | |
| 622 | /** |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 623 | * \def MBEDTLS_CIPHER_PADDING_PKCS7 |
Paul Bakker | 48e93c8 | 2013-08-14 12:21:18 +0200 | [diff] [blame] | 624 | * |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 625 | * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for |
| 626 | * specific padding modes in the cipher layer with cipher modes that support |
| 627 | * padding (e.g. CBC) |
Paul Bakker | 48e93c8 | 2013-08-14 12:21:18 +0200 | [diff] [blame] | 628 | * |
| 629 | * If you disable all padding modes, only full blocks can be used with CBC. |
| 630 | * |
| 631 | * Enable padding modes in the cipher layer. |
| 632 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 633 | #define MBEDTLS_CIPHER_PADDING_PKCS7 |
| 634 | #define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS |
| 635 | #define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN |
| 636 | #define MBEDTLS_CIPHER_PADDING_ZEROS |
Paul Bakker | 48e93c8 | 2013-08-14 12:21:18 +0200 | [diff] [blame] | 637 | |
Gilles Peskine | 1540e5b | 2019-10-03 14:21:14 +0200 | [diff] [blame] | 638 | /** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY |
| 639 | * |
| 640 | * Uncomment this macro to use a 128-bit key in the CTR_DRBG module. |
| 641 | * By default, CTR_DRBG uses a 256-bit key. |
| 642 | */ |
| 643 | //#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY |
| 644 | |
Paul Bakker | 48e93c8 | 2013-08-14 12:21:18 +0200 | [diff] [blame] | 645 | /** |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 646 | * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED |
Paul Bakker | 5dc6b5f | 2013-06-29 23:26:34 +0200 | [diff] [blame] | 647 | * |
Manuel Pégourié-Gonnard | 76da60c | 2016-01-04 13:51:01 +0100 | [diff] [blame] | 648 | * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve |
| 649 | * module. By default all supported curves are enabled. |
Paul Bakker | 5dc6b5f | 2013-06-29 23:26:34 +0200 | [diff] [blame] | 650 | * |
| 651 | * Comment macros to disable the curve and functions for it |
| 652 | */ |
Gilles Peskine | 799e576 | 2018-09-14 17:34:00 +0200 | [diff] [blame] | 653 | /* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 654 | #define MBEDTLS_ECP_DP_SECP192R1_ENABLED |
| 655 | #define MBEDTLS_ECP_DP_SECP224R1_ENABLED |
| 656 | #define MBEDTLS_ECP_DP_SECP256R1_ENABLED |
| 657 | #define MBEDTLS_ECP_DP_SECP384R1_ENABLED |
| 658 | #define MBEDTLS_ECP_DP_SECP521R1_ENABLED |
| 659 | #define MBEDTLS_ECP_DP_SECP192K1_ENABLED |
| 660 | #define MBEDTLS_ECP_DP_SECP224K1_ENABLED |
| 661 | #define MBEDTLS_ECP_DP_SECP256K1_ENABLED |
| 662 | #define MBEDTLS_ECP_DP_BP256R1_ENABLED |
| 663 | #define MBEDTLS_ECP_DP_BP384R1_ENABLED |
| 664 | #define MBEDTLS_ECP_DP_BP512R1_ENABLED |
Gilles Peskine | 799e576 | 2018-09-14 17:34:00 +0200 | [diff] [blame] | 665 | /* Montgomery curves (supporting ECP) */ |
Manuel Pégourié-Gonnard | 0789433 | 2015-06-23 00:18:41 +0200 | [diff] [blame] | 666 | #define MBEDTLS_ECP_DP_CURVE25519_ENABLED |
Nicholas Wilson | 08f3ef1 | 2015-11-10 13:10:01 +0000 | [diff] [blame] | 667 | #define MBEDTLS_ECP_DP_CURVE448_ENABLED |
Paul Bakker | 5dc6b5f | 2013-06-29 23:26:34 +0200 | [diff] [blame] | 668 | |
| 669 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 670 | * \def MBEDTLS_ECP_NIST_OPTIM |
Manuel Pégourié-Gonnard | c04c530 | 2013-10-23 16:11:52 +0200 | [diff] [blame] | 671 | * |
| 672 | * Enable specific 'modulo p' routines for each NIST prime. |
| 673 | * Depending on the prime and architecture, makes operations 4 to 8 times |
| 674 | * faster on the corresponding curve. |
| 675 | * |
| 676 | * Comment this macro to disable NIST curves optimisation. |
| 677 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 678 | #define MBEDTLS_ECP_NIST_OPTIM |
Manuel Pégourié-Gonnard | c04c530 | 2013-10-23 16:11:52 +0200 | [diff] [blame] | 679 | |
| 680 | /** |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 681 | * \def MBEDTLS_ECP_RESTARTABLE |
Manuel Pégourié-Gonnard | c3a3bc7 | 2017-03-22 11:17:51 +0100 | [diff] [blame] | 682 | * |
| 683 | * Enable "non-blocking" ECC operations that can return early and be resumed. |
| 684 | * |
Manuel Pégourié-Gonnard | f0bbd7e | 2018-10-15 13:22:41 +0200 | [diff] [blame] | 685 | * This allows various functions to pause by returning |
| 686 | * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module, |
| 687 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in |
| 688 | * order to further progress and eventually complete their operation. This is |
| 689 | * controlled through mbedtls_ecp_set_max_ops() which limits the maximum |
| 690 | * number of ECC operations a function may perform before pausing; see |
| 691 | * mbedtls_ecp_set_max_ops() for more information. |
Manuel Pégourié-Gonnard | c3a3bc7 | 2017-03-22 11:17:51 +0100 | [diff] [blame] | 692 | * |
Manuel Pégourié-Gonnard | 8b7b96b | 2017-08-23 10:02:51 +0200 | [diff] [blame] | 693 | * This is useful in non-threaded environments if you want to avoid blocking |
Manuel Pégourié-Gonnard | f0bbd7e | 2018-10-15 13:22:41 +0200 | [diff] [blame] | 694 | * for too long on ECC (and, hence, X.509 or SSL/TLS) operations. |
Manuel Pégourié-Gonnard | c3a3bc7 | 2017-03-22 11:17:51 +0100 | [diff] [blame] | 695 | * |
Manuel Pégourié-Gonnard | 2b7ad64 | 2022-12-06 10:42:44 +0100 | [diff] [blame] | 696 | * This option: |
| 697 | * - Adds xxx_restartable() variants of existing operations in the |
| 698 | * following modules, with corresponding restart context types: |
Manuel Pégourié-Gonnard | b2812cc | 2022-12-09 09:53:55 +0100 | [diff] [blame] | 699 | * - ECP (for Short Weierstrass curves only): scalar multiplication (mul), |
| 700 | * linear combination (muladd); |
Manuel Pégourié-Gonnard | 2b7ad64 | 2022-12-06 10:42:44 +0100 | [diff] [blame] | 701 | * - ECDSA: signature generation & verification; |
| 702 | * - PK: signature generation & verification; |
| 703 | * - X509: certificate chain verification. |
| 704 | * - Adds mbedtls_ecdh_enable_restart() in the ECDH module. |
| 705 | * - Changes the behaviour of TLS 1.2 clients (not servers) when using the |
| 706 | * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC |
| 707 | * computations restartable: |
Manuel Pégourié-Gonnard | b2812cc | 2022-12-09 09:53:55 +0100 | [diff] [blame] | 708 | * - ECDH operations from the key exchange, only for Short Weierstass |
| 709 | * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled. |
Manuel Pégourié-Gonnard | 2b7ad64 | 2022-12-06 10:42:44 +0100 | [diff] [blame] | 710 | * - verification of the server's key exchange signature; |
| 711 | * - verification of the server's certificate chain; |
Manuel Pégourié-Gonnard | b2812cc | 2022-12-09 09:53:55 +0100 | [diff] [blame] | 712 | * - generation of the client's signature if client authentication is used, |
| 713 | * with an ECC key/certificate. |
Manuel Pégourié-Gonnard | 2b7ad64 | 2022-12-06 10:42:44 +0100 | [diff] [blame] | 714 | * |
| 715 | * \note In the cases above, the usual SSL/TLS functions, such as |
| 716 | * mbedtls_ssl_handshake(), can now return |
| 717 | * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS. |
Ron Eldor | 5ed8c1e | 2018-11-05 14:04:26 +0200 | [diff] [blame] | 718 | * |
Manuel Pégourié-Gonnard | 55a188b | 2022-12-06 12:00:33 +0100 | [diff] [blame] | 719 | * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled, |
| 720 | * restartable operations in PK, X.509 and TLS (see above) are not |
| 721 | * using PSA. On the other hand, ECDH computations in TLS are using |
Manuel Pégourié-Gonnard | b2812cc | 2022-12-09 09:53:55 +0100 | [diff] [blame] | 722 | * PSA, and are not restartable. These are temporary limitations that |
| 723 | * should be lifted in the future. |
Ron Eldor | 5ed8c1e | 2018-11-05 14:04:26 +0200 | [diff] [blame] | 724 | * |
Ron Eldor | 19779c4 | 2018-11-05 16:58:13 +0200 | [diff] [blame] | 725 | * \note This option only works with the default software implementation of |
| 726 | * elliptic curve functionality. It is incompatible with |
Thomas Daubney | 537e643 | 2021-06-03 15:46:33 +0100 | [diff] [blame] | 727 | * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT. |
Manuel Pégourié-Gonnard | 2b7ad64 | 2022-12-06 10:42:44 +0100 | [diff] [blame] | 728 | * |
Manuel Pégourié-Gonnard | ad45c4d | 2022-12-06 13:20:06 +0100 | [diff] [blame] | 729 | * Requires: MBEDTLS_ECP_C |
| 730 | * |
Manuel Pégourié-Gonnard | 2b7ad64 | 2022-12-06 10:42:44 +0100 | [diff] [blame] | 731 | * Uncomment this macro to enable restartable ECC computations. |
Manuel Pégourié-Gonnard | c3a3bc7 | 2017-03-22 11:17:51 +0100 | [diff] [blame] | 732 | */ |
Manuel Pégourié-Gonnard | c9e16a9 | 2017-08-15 14:30:59 +0200 | [diff] [blame] | 733 | //#define MBEDTLS_ECP_RESTARTABLE |
Manuel Pégourié-Gonnard | c3a3bc7 | 2017-03-22 11:17:51 +0100 | [diff] [blame] | 734 | |
| 735 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 736 | * \def MBEDTLS_ECDSA_DETERMINISTIC |
Manuel Pégourié-Gonnard | 461d416 | 2014-01-06 10:16:28 +0100 | [diff] [blame] | 737 | * |
| 738 | * Enable deterministic ECDSA (RFC 6979). |
| 739 | * Standard ECDSA is "fragile" in the sense that lack of entropy when signing |
| 740 | * may result in a compromise of the long-term signing key. This is avoided by |
| 741 | * the deterministic variant. |
| 742 | * |
John Durkop | 36a82e5 | 2020-10-26 09:39:05 -0700 | [diff] [blame] | 743 | * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C |
Manuel Pégourié-Gonnard | 5b1a573 | 2014-01-07 16:46:17 +0100 | [diff] [blame] | 744 | * |
Manuel Pégourié-Gonnard | 461d416 | 2014-01-06 10:16:28 +0100 | [diff] [blame] | 745 | * Comment this macro to disable deterministic ECDSA. |
| 746 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 747 | #define MBEDTLS_ECDSA_DETERMINISTIC |
Manuel Pégourié-Gonnard | 461d416 | 2014-01-06 10:16:28 +0100 | [diff] [blame] | 748 | |
| 749 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 750 | * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 751 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 752 | * Enable the PSK based ciphersuite modes in SSL / TLS. |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 753 | * |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 754 | * This enables the following ciphersuites (if other requisites are |
| 755 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 756 | * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 |
| 757 | * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 |
| 758 | * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA |
| 759 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 760 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 761 | * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 |
| 762 | * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 |
| 763 | * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA |
| 764 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 765 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 766 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 767 | #define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 768 | |
| 769 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 770 | * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 771 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 772 | * Enable the DHE-PSK based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 773 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 774 | * Requires: MBEDTLS_DHM_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 775 | * |
| 776 | * This enables the following ciphersuites (if other requisites are |
| 777 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 778 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 |
| 779 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 |
| 780 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA |
| 781 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 782 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 783 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 |
| 784 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 |
| 785 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA |
| 786 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 787 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 788 | * |
Hanno Becker | f9734b3 | 2017-10-03 12:09:22 +0100 | [diff] [blame] | 789 | * \warning Using DHE constitutes a security risk as it |
| 790 | * is not possible to validate custom DH parameters. |
| 791 | * If possible, it is recommended users should consider |
| 792 | * preferring other methods of key exchange. |
| 793 | * See dhm.h for more details. |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 794 | * |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 795 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 796 | #define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 797 | |
| 798 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 799 | * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 800 | * |
| 801 | * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS. |
| 802 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 803 | * Requires: MBEDTLS_ECDH_C |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 804 | * |
| 805 | * This enables the following ciphersuites (if other requisites are |
| 806 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 807 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 |
| 808 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA |
| 809 | * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 810 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 |
| 811 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA |
| 812 | * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 813 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 814 | #define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 815 | |
| 816 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 817 | * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 818 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 819 | * Enable the RSA-PSK based ciphersuite modes in SSL / TLS. |
Manuel Pégourié-Gonnard | 0fae60b | 2013-10-14 17:39:48 +0200 | [diff] [blame] | 820 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 821 | * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, |
| 822 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 823 | * |
| 824 | * This enables the following ciphersuites (if other requisites are |
| 825 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 826 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 |
| 827 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 |
| 828 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA |
| 829 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 830 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 831 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 |
| 832 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 |
| 833 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA |
| 834 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 835 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 836 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 837 | #define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 838 | |
| 839 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 840 | * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 841 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 842 | * Enable the RSA-only based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 843 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 844 | * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, |
| 845 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 846 | * |
| 847 | * This enables the following ciphersuites (if other requisites are |
| 848 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 849 | * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 |
| 850 | * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 |
| 851 | * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA |
| 852 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 853 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 |
| 854 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA |
| 855 | * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 |
| 856 | * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 |
| 857 | * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA |
| 858 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 859 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 860 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 861 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 862 | #define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 863 | |
| 864 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 865 | * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 866 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 867 | * Enable the DHE-RSA based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 868 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 869 | * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, |
| 870 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 871 | * |
| 872 | * This enables the following ciphersuites (if other requisites are |
| 873 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 874 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 |
| 875 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 |
| 876 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA |
| 877 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 878 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 |
| 879 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA |
| 880 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 |
| 881 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 |
| 882 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA |
| 883 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 884 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 885 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 886 | * |
Hanno Becker | f9734b3 | 2017-10-03 12:09:22 +0100 | [diff] [blame] | 887 | * \warning Using DHE constitutes a security risk as it |
| 888 | * is not possible to validate custom DH parameters. |
| 889 | * If possible, it is recommended users should consider |
| 890 | * preferring other methods of key exchange. |
| 891 | * See dhm.h for more details. |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 892 | * |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 893 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 894 | #define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 895 | |
| 896 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 897 | * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 898 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 899 | * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 900 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 901 | * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, |
| 902 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 903 | * |
| 904 | * This enables the following ciphersuites (if other requisites are |
| 905 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 906 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 |
| 907 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 |
| 908 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA |
| 909 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 910 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 911 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
| 912 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
| 913 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA |
| 914 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 915 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 916 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 917 | #define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 918 | |
| 919 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 920 | * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 921 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 922 | * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS. |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 923 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 924 | * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C, |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 925 | * |
| 926 | * This enables the following ciphersuites (if other requisites are |
| 927 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 928 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 |
| 929 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 |
| 930 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA |
| 931 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 932 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 933 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 |
| 934 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 |
| 935 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA |
| 936 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 937 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 938 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 939 | #define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 940 | |
| 941 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 942 | * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 943 | * |
| 944 | * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS. |
| 945 | * |
Gilles Peskine | 7ab66a6 | 2018-09-14 17:47:41 +0200 | [diff] [blame] | 946 | * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 947 | * |
| 948 | * This enables the following ciphersuites (if other requisites are |
| 949 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 950 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA |
| 951 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA |
| 952 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 |
| 953 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 |
| 954 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 |
| 955 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 |
| 956 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 957 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 958 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 959 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 960 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 961 | #define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 962 | |
| 963 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 964 | * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 965 | * |
| 966 | * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS. |
| 967 | * |
Gilles Peskine | 7ab66a6 | 2018-09-14 17:47:41 +0200 | [diff] [blame] | 968 | * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 969 | * |
| 970 | * This enables the following ciphersuites (if other requisites are |
| 971 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 972 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA |
| 973 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA |
| 974 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 |
| 975 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 |
| 976 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 |
| 977 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 |
| 978 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 979 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 980 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 981 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 982 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 983 | #define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 984 | |
| 985 | /** |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 986 | * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED |
| 987 | * |
| 988 | * Enable the ECJPAKE based ciphersuite modes in SSL / TLS. |
| 989 | * |
Manuel Pégourié-Gonnard | 75df902 | 2015-09-16 23:21:01 +0200 | [diff] [blame] | 990 | * \warning This is currently experimental. EC J-PAKE support is based on the |
| 991 | * Thread v1.0.0 specification; incompatible changes to the specification |
| 992 | * might still happen. For this reason, this is disabled by default. |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 993 | * |
| 994 | * Requires: MBEDTLS_ECJPAKE_C |
Manuel Pégourié-Gonnard | b4e28aa | 2022-09-19 11:55:00 +0200 | [diff] [blame] | 995 | * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C) |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 996 | * MBEDTLS_ECP_DP_SECP256R1_ENABLED |
| 997 | * |
| 998 | * This enables the following ciphersuites (if other requisites are |
| 999 | * enabled as well): |
| 1000 | * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 |
| 1001 | */ |
Manuel Pégourié-Gonnard | cf82893 | 2015-10-20 14:57:00 +0200 | [diff] [blame] | 1002 | //#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 1003 | |
| 1004 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1005 | * \def MBEDTLS_PK_PARSE_EC_EXTENDED |
Manuel Pégourié-Gonnard | 6fac351 | 2014-03-19 16:39:52 +0100 | [diff] [blame] | 1006 | * |
| 1007 | * Enhance support for reading EC keys using variants of SEC1 not allowed by |
| 1008 | * RFC 5915 and RFC 5480. |
| 1009 | * |
| 1010 | * Currently this means parsing the SpecifiedECDomain choice of EC |
| 1011 | * parameters (only known groups are supported, not arbitrary domains, to |
| 1012 | * avoid validation issues). |
| 1013 | * |
| 1014 | * Disable if you only need to support RFC 5915 + 5480 key formats. |
| 1015 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1016 | #define MBEDTLS_PK_PARSE_EC_EXTENDED |
Manuel Pégourié-Gonnard | 6fac351 | 2014-03-19 16:39:52 +0100 | [diff] [blame] | 1017 | |
| 1018 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1019 | * \def MBEDTLS_ERROR_STRERROR_DUMMY |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 1020 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1021 | * Enable a dummy error function to make use of mbedtls_strerror() in |
| 1022 | * third party libraries easier when MBEDTLS_ERROR_C is disabled |
| 1023 | * (no effect when MBEDTLS_ERROR_C is enabled). |
Manuel Pégourié-Gonnard | dc16aa7 | 2014-06-25 12:55:12 +0200 | [diff] [blame] | 1024 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1025 | * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're |
| 1026 | * not using mbedtls_strerror() or error_strerror() in your application. |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 1027 | * |
| 1028 | * Disable if you run into name conflicts and want to really remove the |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1029 | * mbedtls_strerror() |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 1030 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1031 | #define MBEDTLS_ERROR_STRERROR_DUMMY |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 1032 | |
| 1033 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1034 | * \def MBEDTLS_GENPRIME |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1035 | * |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 1036 | * Enable the prime-number generation code. |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1037 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1038 | * Requires: MBEDTLS_BIGNUM_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1039 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1040 | #define MBEDTLS_GENPRIME |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1041 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1042 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1043 | * \def MBEDTLS_FS_IO |
Paul Bakker | 335db3f | 2011-04-25 15:28:35 +0000 | [diff] [blame] | 1044 | * |
| 1045 | * Enable functions that use the filesystem. |
| 1046 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1047 | #define MBEDTLS_FS_IO |
Paul Bakker | 335db3f | 2011-04-25 15:28:35 +0000 | [diff] [blame] | 1048 | |
| 1049 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1050 | * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES |
Paul Bakker | 43655f4 | 2011-12-15 20:11:16 +0000 | [diff] [blame] | 1051 | * |
TRodziewicz | 15a7b73 | 2021-06-16 11:22:53 +0200 | [diff] [blame] | 1052 | * Do not add default entropy sources in mbedtls_entropy_init(). |
Paul Bakker | 43655f4 | 2011-12-15 20:11:16 +0000 | [diff] [blame] | 1053 | * |
Shuo Chen | 95a0d11 | 2014-04-04 21:04:40 -0700 | [diff] [blame] | 1054 | * This is useful to have more control over the added entropy sources in an |
Paul Bakker | 43655f4 | 2011-12-15 20:11:16 +0000 | [diff] [blame] | 1055 | * application. |
| 1056 | * |
| 1057 | * Uncomment this macro to prevent loading of default entropy functions. |
Paul Bakker | 43655f4 | 2011-12-15 20:11:16 +0000 | [diff] [blame] | 1058 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1059 | //#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES |
Paul Bakker | 43655f4 | 2011-12-15 20:11:16 +0000 | [diff] [blame] | 1060 | |
| 1061 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1062 | * \def MBEDTLS_NO_PLATFORM_ENTROPY |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 1063 | * |
| 1064 | * Do not use built-in platform entropy functions. |
| 1065 | * This is useful if your platform does not support |
| 1066 | * standards like the /dev/urandom or Windows CryptoAPI. |
| 1067 | * |
| 1068 | * Uncomment this macro to disable the built-in platform entropy functions. |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 1069 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1070 | //#define MBEDTLS_NO_PLATFORM_ENTROPY |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 1071 | |
| 1072 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1073 | * \def MBEDTLS_ENTROPY_FORCE_SHA256 |
Paul Bakker | 2ceda57 | 2014-02-06 15:55:25 +0100 | [diff] [blame] | 1074 | * |
| 1075 | * Force the entropy accumulator to use a SHA-256 accumulator instead of the |
| 1076 | * default SHA-512 based one (if both are available). |
| 1077 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1078 | * Requires: MBEDTLS_SHA256_C |
Paul Bakker | 2ceda57 | 2014-02-06 15:55:25 +0100 | [diff] [blame] | 1079 | * |
| 1080 | * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option |
| 1081 | * if you have performance concerns. |
| 1082 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1083 | * This option is only useful if both MBEDTLS_SHA256_C and |
| 1084 | * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used. |
Paul Bakker | 2ceda57 | 2014-02-06 15:55:25 +0100 | [diff] [blame] | 1085 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1086 | //#define MBEDTLS_ENTROPY_FORCE_SHA256 |
Paul Bakker | 2ceda57 | 2014-02-06 15:55:25 +0100 | [diff] [blame] | 1087 | |
| 1088 | /** |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 1089 | * \def MBEDTLS_ENTROPY_NV_SEED |
| 1090 | * |
| 1091 | * Enable the non-volatile (NV) seed file-based entropy source. |
| 1092 | * (Also enables the NV seed read/write functions in the platform layer) |
| 1093 | * |
| 1094 | * This is crucial (if not required) on systems that do not have a |
| 1095 | * cryptographic entropy source (in hardware or kernel) available. |
| 1096 | * |
| 1097 | * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C |
| 1098 | * |
Paul Bakker | 71a597a | 2016-06-07 10:59:03 +0100 | [diff] [blame] | 1099 | * \note The read/write functions that are used by the entropy source are |
| 1100 | * determined in the platform layer, and can be modified at runtime and/or |
| 1101 | * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used. |
| 1102 | * |
| 1103 | * \note If you use the default implementation functions that read a seedfile |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 1104 | * with regular fopen(), please make sure you make a seedfile with the |
| 1105 | * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at |
| 1106 | * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from |
Paul Bakker | 71a597a | 2016-06-07 10:59:03 +0100 | [diff] [blame] | 1107 | * and written to or you will get an entropy source error! The default |
| 1108 | * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE |
| 1109 | * bytes from the file. |
| 1110 | * |
| 1111 | * \note The entropy collector will write to the seed file before entropy is |
| 1112 | * given to an external source, to update it. |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 1113 | */ |
| 1114 | //#define MBEDTLS_ENTROPY_NV_SEED |
| 1115 | |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 1116 | /* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER |
Gilles Peskine | 69d7c8b | 2019-02-19 14:00:31 +0100 | [diff] [blame] | 1117 | * |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 1118 | * Enable key identifiers that encode a key owner identifier. |
Gilles Peskine | 69d7c8b | 2019-02-19 14:00:31 +0100 | [diff] [blame] | 1119 | * |
Ronald Cron | 9a2511e | 2020-09-14 10:02:56 +0200 | [diff] [blame] | 1120 | * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t |
| 1121 | * which is currently hard-coded to be int32_t. |
Gilles Peskine | 69d7c8b | 2019-02-19 14:00:31 +0100 | [diff] [blame] | 1122 | * |
| 1123 | * Note that this option is meant for internal use only and may be removed |
Andrzej Kurek | cfc920a | 2022-01-25 06:33:08 -0500 | [diff] [blame] | 1124 | * without notice. |
Gilles Peskine | 69d7c8b | 2019-02-19 14:00:31 +0100 | [diff] [blame] | 1125 | */ |
Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 1126 | //#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER |
Gilles Peskine | 69d7c8b | 2019-02-19 14:00:31 +0100 | [diff] [blame] | 1127 | |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 1128 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1129 | * \def MBEDTLS_MEMORY_DEBUG |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1130 | * |
| 1131 | * Enable debugging of buffer allocator memory issues. Automatically prints |
| 1132 | * (to stderr) all (fatal) messages on memory allocation issues. Enables |
| 1133 | * function for 'debug output' of allocated memory. |
| 1134 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1135 | * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1136 | * |
| 1137 | * Uncomment this macro to let the buffer allocator print out error messages. |
Paul Bakker | a7ea6a5 | 2013-10-15 11:55:10 +0200 | [diff] [blame] | 1138 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1139 | //#define MBEDTLS_MEMORY_DEBUG |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1140 | |
| 1141 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1142 | * \def MBEDTLS_MEMORY_BACKTRACE |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1143 | * |
| 1144 | * Include backtrace information with each allocated block. |
| 1145 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1146 | * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C |
Tom Cosgrove | ce7f18c | 2022-07-28 05:50:56 +0100 | [diff] [blame] | 1147 | * GLIBC-compatible backtrace() and backtrace_symbols() support |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1148 | * |
| 1149 | * Uncomment this macro to include backtrace information |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1150 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1151 | //#define MBEDTLS_MEMORY_BACKTRACE |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1152 | |
| 1153 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1154 | * \def MBEDTLS_PK_RSA_ALT_SUPPORT |
Manuel Pégourié-Gonnard | 348bcb3 | 2015-03-31 14:01:33 +0200 | [diff] [blame] | 1155 | * |
| 1156 | * Support external private RSA keys (eg from a HSM) in the PK layer. |
| 1157 | * |
| 1158 | * Comment this macro to disable support for external private RSA keys. |
| 1159 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1160 | #define MBEDTLS_PK_RSA_ALT_SUPPORT |
Manuel Pégourié-Gonnard | 348bcb3 | 2015-03-31 14:01:33 +0200 | [diff] [blame] | 1161 | |
| 1162 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1163 | * \def MBEDTLS_PKCS1_V15 |
Paul Bakker | 48377d9 | 2013-08-30 12:06:24 +0200 | [diff] [blame] | 1164 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1165 | * Enable support for PKCS#1 v1.5 encoding. |
| 1166 | * |
Manuel Pégourié-Gonnard | 98b91d4 | 2022-10-19 10:59:30 +0200 | [diff] [blame] | 1167 | * Requires: MBEDTLS_RSA_C |
Paul Bakker | 48377d9 | 2013-08-30 12:06:24 +0200 | [diff] [blame] | 1168 | * |
Paul Bakker | 48377d9 | 2013-08-30 12:06:24 +0200 | [diff] [blame] | 1169 | * This enables support for PKCS#1 v1.5 operations. |
| 1170 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1171 | #define MBEDTLS_PKCS1_V15 |
Paul Bakker | 48377d9 | 2013-08-30 12:06:24 +0200 | [diff] [blame] | 1172 | |
| 1173 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1174 | * \def MBEDTLS_PKCS1_V21 |
Paul Bakker | 9dcc322 | 2011-03-08 14:16:06 +0000 | [diff] [blame] | 1175 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1176 | * Enable support for PKCS#1 v2.1 encoding. |
| 1177 | * |
Manuel Pégourié-Gonnard | 077ba84 | 2022-07-27 10:42:31 +0200 | [diff] [blame] | 1178 | * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C). |
| 1179 | * |
| 1180 | * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init() |
| 1181 | * before doing any PKCS#1 v2.1 operation. |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 1182 | * |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 1183 | * \warning When building with MBEDTLS_MD_C, all hashes used with this |
Manuel Pégourié-Gonnard | fecc6b2 | 2022-11-24 09:40:12 +0100 | [diff] [blame] | 1184 | * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C, |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 1185 | * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by |
| 1186 | * this module in builds where MBEDTLS_MD_C is disabled. |
| 1187 | * |
Paul Bakker | 9dcc322 | 2011-03-08 14:16:06 +0000 | [diff] [blame] | 1188 | * This enables support for RSAES-OAEP and RSASSA-PSS operations. |
| 1189 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1190 | #define MBEDTLS_PKCS1_V21 |
Paul Bakker | 9dcc322 | 2011-03-08 14:16:06 +0000 | [diff] [blame] | 1191 | |
Steven Cooreman | 6801f08 | 2021-02-19 17:21:22 +0100 | [diff] [blame] | 1192 | /** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS |
| 1193 | * |
| 1194 | * Enable support for platform built-in keys. If you enable this feature, |
| 1195 | * you must implement the function mbedtls_psa_platform_get_builtin_key(). |
| 1196 | * See the documentation of that function for more information. |
| 1197 | * |
| 1198 | * Built-in keys are typically derived from a hardware unique key or |
| 1199 | * stored in a secure element. |
| 1200 | * |
| 1201 | * Requires: MBEDTLS_PSA_CRYPTO_C. |
| 1202 | * |
| 1203 | * \warning This interface is experimental and may change or be removed |
| 1204 | * without notice. |
| 1205 | */ |
| 1206 | //#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS |
| 1207 | |
Ronald Cron | 3768ac1 | 2021-01-26 16:58:00 +0100 | [diff] [blame] | 1208 | /** \def MBEDTLS_PSA_CRYPTO_CLIENT |
| 1209 | * |
| 1210 | * Enable support for PSA crypto client. |
| 1211 | * |
| 1212 | * \note This option allows to include the code necessary for a PSA |
| 1213 | * crypto client when the PSA crypto implementation is not included in |
| 1214 | * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the |
| 1215 | * code to set and get PSA key attributes. |
| 1216 | * The development of PSA drivers partially relying on the library to |
| 1217 | * fulfill the hardware gaps is another possible usage of this option. |
| 1218 | * |
| 1219 | * \warning This interface is experimental and may change or be removed |
| 1220 | * without notice. |
| 1221 | */ |
| 1222 | //#define MBEDTLS_PSA_CRYPTO_CLIENT |
| 1223 | |
Steven Cooreman | 0d59f7b0 | 2020-07-16 20:27:57 +0200 | [diff] [blame] | 1224 | /** \def MBEDTLS_PSA_CRYPTO_DRIVERS |
| 1225 | * |
| 1226 | * Enable support for the experimental PSA crypto driver interface. |
| 1227 | * |
John Durkop | 185764f | 2020-10-12 21:32:12 -0700 | [diff] [blame] | 1228 | * Requires: MBEDTLS_PSA_CRYPTO_C |
Steven Cooreman | 0d59f7b0 | 2020-07-16 20:27:57 +0200 | [diff] [blame] | 1229 | * |
Gilles Peskine | 4b87387 | 2022-06-20 18:50:09 +0200 | [diff] [blame] | 1230 | * \warning This interface is experimental. We intend to maintain backward |
| 1231 | * compatibility with application code that relies on drivers, |
| 1232 | * but the driver interfaces may change without notice. |
Steven Cooreman | 0d59f7b0 | 2020-07-16 20:27:57 +0200 | [diff] [blame] | 1233 | */ |
| 1234 | //#define MBEDTLS_PSA_CRYPTO_DRIVERS |
| 1235 | |
Gilles Peskine | f08b3f8 | 2020-11-13 17:36:48 +0100 | [diff] [blame] | 1236 | /** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG |
| 1237 | * |
| 1238 | * Make the PSA Crypto module use an external random generator provided |
| 1239 | * by a driver, instead of Mbed TLS's entropy and DRBG modules. |
| 1240 | * |
Gilles Peskine | b663a60 | 2020-11-18 15:27:37 +0100 | [diff] [blame] | 1241 | * \note This random generator must deliver random numbers with cryptographic |
| 1242 | * quality and high performance. It must supply unpredictable numbers |
| 1243 | * with a uniform distribution. The implementation of this function |
| 1244 | * is responsible for ensuring that the random generator is seeded |
| 1245 | * with sufficient entropy. If you have a hardware TRNG which is slow |
| 1246 | * or delivers non-uniform output, declare it as an entropy source |
| 1247 | * with mbedtls_entropy_add_source() instead of enabling this option. |
| 1248 | * |
Gilles Peskine | b0a748e | 2020-11-30 12:01:54 +0100 | [diff] [blame] | 1249 | * If you enable this option, you must configure the type |
Gilles Peskine | b8af228 | 2020-11-13 18:00:34 +0100 | [diff] [blame] | 1250 | * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h |
| 1251 | * and define a function called mbedtls_psa_external_get_random() |
| 1252 | * with the following prototype: |
Gilles Peskine | f08b3f8 | 2020-11-13 17:36:48 +0100 | [diff] [blame] | 1253 | * ``` |
| 1254 | * psa_status_t mbedtls_psa_external_get_random( |
| 1255 | * mbedtls_psa_external_random_context_t *context, |
| 1256 | * uint8_t *output, size_t output_size, size_t *output_length); |
| 1257 | * ); |
| 1258 | * ``` |
| 1259 | * The \c context value is initialized to 0 before the first call. |
| 1260 | * The function must fill the \c output buffer with \p output_size bytes |
| 1261 | * of random data and set \c *output_length to \p output_size. |
| 1262 | * |
| 1263 | * Requires: MBEDTLS_PSA_CRYPTO_C |
| 1264 | * |
| 1265 | * \warning If you enable this option, code that uses the PSA cryptography |
| 1266 | * interface will not use any of the entropy sources set up for |
| 1267 | * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED |
| 1268 | * enables. |
| 1269 | * |
| 1270 | * \note This option is experimental and may be removed without notice. |
| 1271 | */ |
| 1272 | //#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG |
| 1273 | |
Paul Bakker | 9dcc322 | 2011-03-08 14:16:06 +0000 | [diff] [blame] | 1274 | /** |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 1275 | * \def MBEDTLS_PSA_CRYPTO_SPM |
| 1276 | * |
| 1277 | * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure |
| 1278 | * Partition Manager) integration which separates the code into two parts: a |
| 1279 | * NSPE (Non-Secure Process Environment) and an SPE (Secure Process |
| 1280 | * Environment). |
| 1281 | * |
| 1282 | * Module: library/psa_crypto.c |
| 1283 | * Requires: MBEDTLS_PSA_CRYPTO_C |
| 1284 | * |
| 1285 | */ |
| 1286 | //#define MBEDTLS_PSA_CRYPTO_SPM |
| 1287 | |
| 1288 | /** |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 1289 | * \def MBEDTLS_PSA_INJECT_ENTROPY |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 1290 | * |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 1291 | * Enable support for entropy injection at first boot. This feature is |
| 1292 | * required on systems that do not have a built-in entropy source (TRNG). |
| 1293 | * This feature is currently not supported on systems that have a built-in |
| 1294 | * entropy source. |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 1295 | * |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 1296 | * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 1297 | * |
| 1298 | */ |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 1299 | //#define MBEDTLS_PSA_INJECT_ENTROPY |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 1300 | |
| 1301 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1302 | * \def MBEDTLS_RSA_NO_CRT |
Paul Bakker | 0216cc1 | 2011-03-26 13:40:23 +0000 | [diff] [blame] | 1303 | * |
Hanno Becker | 88ec238 | 2017-05-03 13:51:16 +0100 | [diff] [blame] | 1304 | * Do not use the Chinese Remainder Theorem |
| 1305 | * for the RSA private operation. |
Paul Bakker | 0216cc1 | 2011-03-26 13:40:23 +0000 | [diff] [blame] | 1306 | * |
| 1307 | * Uncomment this macro to disable the use of CRT in RSA. |
| 1308 | * |
Paul Bakker | 0216cc1 | 2011-03-26 13:40:23 +0000 | [diff] [blame] | 1309 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1310 | //#define MBEDTLS_RSA_NO_CRT |
Paul Bakker | 15566e4 | 2011-04-24 21:19:15 +0000 | [diff] [blame] | 1311 | |
| 1312 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1313 | * \def MBEDTLS_SELF_TEST |
Paul Bakker | 15566e4 | 2011-04-24 21:19:15 +0000 | [diff] [blame] | 1314 | * |
| 1315 | * Enable the checkup functions (*_self_test). |
| 1316 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1317 | #define MBEDTLS_SELF_TEST |
Paul Bakker | 5c721f9 | 2011-07-27 16:51:09 +0000 | [diff] [blame] | 1318 | |
| 1319 | /** |
Manuel Pégourié-Gonnard | eb0d870 | 2015-05-28 12:54:04 +0200 | [diff] [blame] | 1320 | * \def MBEDTLS_SHA256_SMALLER |
| 1321 | * |
| 1322 | * Enable an implementation of SHA-256 that has lower ROM footprint but also |
| 1323 | * lower performance. |
| 1324 | * |
Adam Wolf | 039080f | 2019-09-10 09:53:08 -0500 | [diff] [blame] | 1325 | * The default implementation is meant to be a reasonable compromise between |
Manuel Pégourié-Gonnard | eb0d870 | 2015-05-28 12:54:04 +0200 | [diff] [blame] | 1326 | * performance and size. This version optimizes more aggressively for size at |
| 1327 | * the expense of performance. Eg on Cortex-M4 it reduces the size of |
| 1328 | * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about |
| 1329 | * 30%. |
| 1330 | * |
| 1331 | * Uncomment to enable the smaller implementation of SHA256. |
| 1332 | */ |
| 1333 | //#define MBEDTLS_SHA256_SMALLER |
| 1334 | |
| 1335 | /** |
Manuel Pégourié-Gonnard | 2306d15 | 2019-07-17 12:36:53 +0200 | [diff] [blame] | 1336 | * \def MBEDTLS_SHA512_SMALLER |
| 1337 | * |
| 1338 | * Enable an implementation of SHA-512 that has lower ROM footprint but also |
| 1339 | * lower performance. |
| 1340 | * |
| 1341 | * Uncomment to enable the smaller implementation of SHA512. |
| 1342 | */ |
| 1343 | //#define MBEDTLS_SHA512_SMALLER |
| 1344 | |
| 1345 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1346 | * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES |
Paul Bakker | 40865c8 | 2013-01-31 17:13:13 +0100 | [diff] [blame] | 1347 | * |
| 1348 | * Enable sending of alert messages in case of encountered errors as per RFC. |
Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 1349 | * If you choose not to send the alert messages, mbed TLS can still communicate |
Paul Bakker | 40865c8 | 2013-01-31 17:13:13 +0100 | [diff] [blame] | 1350 | * with other servers, only debugging of failures is harder. |
| 1351 | * |
| 1352 | * The advantage of not sending alert messages, is that no information is given |
| 1353 | * about reasons for failures thus preventing adversaries of gaining intel. |
| 1354 | * |
| 1355 | * Enable sending of all alert messages |
| 1356 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1357 | #define MBEDTLS_SSL_ALL_ALERT_MESSAGES |
Paul Bakker | 40865c8 | 2013-01-31 17:13:13 +0100 | [diff] [blame] | 1358 | |
| 1359 | /** |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1360 | * \def MBEDTLS_SSL_DTLS_CONNECTION_ID |
| 1361 | * |
Hannes Tschofenig | e2c46e0 | 2022-11-23 10:44:11 +0100 | [diff] [blame] | 1362 | * Enable support for the DTLS Connection ID (CID) extension, |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1363 | * which allows to identify DTLS connections across changes |
Hannes Tschofenig | e2c46e0 | 2022-11-23 10:44:11 +0100 | [diff] [blame] | 1364 | * in the underlying transport. The CID functionality is described |
| 1365 | * in RFC 9146. |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1366 | * |
| 1367 | * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`, |
Paul Elliott | 0113cf1 | 2022-03-11 20:26:47 +0000 | [diff] [blame] | 1368 | * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and |
| 1369 | * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for |
| 1370 | * more information. |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1371 | * |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1372 | * The maximum lengths of outgoing and incoming CIDs can be configured |
| 1373 | * through the options |
| 1374 | * - MBEDTLS_SSL_CID_OUT_LEN_MAX |
| 1375 | * - MBEDTLS_SSL_CID_IN_LEN_MAX. |
| 1376 | * |
| 1377 | * Requires: MBEDTLS_SSL_PROTO_DTLS |
| 1378 | * |
| 1379 | * Uncomment to enable the Connection ID extension. |
| 1380 | */ |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 1381 | #define MBEDTLS_SSL_DTLS_CONNECTION_ID |
| 1382 | |
| 1383 | |
| 1384 | /** |
| 1385 | * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT |
| 1386 | * |
| 1387 | * Defines whether RFC 9146 (default) or the legacy version |
| 1388 | * (version draft-ietf-tls-dtls-connection-id-05, |
| 1389 | * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) |
| 1390 | * is used. |
| 1391 | * |
| 1392 | * Set the value to 0 for the standard version, and |
| 1393 | * 1 for the legacy draft version. |
| 1394 | * |
Hannes Tschofenig | e2c46e0 | 2022-11-23 10:44:11 +0100 | [diff] [blame] | 1395 | * \deprecated Support for the legacy version of the DTLS |
| 1396 | * Connection ID feature is deprecated. Please |
| 1397 | * switch to the standardized version defined |
| 1398 | * in RFC 9146 enabled by utilizing |
| 1399 | * MBEDTLS_SSL_DTLS_CONNECTION_ID without use |
| 1400 | * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT. |
| 1401 | * |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 1402 | * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID |
| 1403 | */ |
| 1404 | #define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0 |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1405 | |
| 1406 | /** |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 1407 | * \def MBEDTLS_SSL_ASYNC_PRIVATE |
| 1408 | * |
| 1409 | * Enable asynchronous external private key operations in SSL. This allows |
| 1410 | * you to configure an SSL connection to call an external cryptographic |
| 1411 | * module to perform private key operations instead of performing the |
| 1412 | * operation inside the library. |
| 1413 | * |
Valerio Setti | 8841d6b | 2023-01-05 08:40:24 +0100 | [diff] [blame] | 1414 | * Requires: MBEDTLS_X509_CRT_PARSE_C |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 1415 | */ |
Jaeden Amero | d9c71da | 2018-06-15 20:31:26 +0100 | [diff] [blame] | 1416 | //#define MBEDTLS_SSL_ASYNC_PRIVATE |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 1417 | |
| 1418 | /** |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1419 | * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION |
| 1420 | * |
| 1421 | * Enable serialization of the TLS context structures, through use of the |
| 1422 | * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load(). |
| 1423 | * |
| 1424 | * This pair of functions allows one side of a connection to serialize the |
| 1425 | * context associated with the connection, then free or re-use that context |
| 1426 | * while the serialized state is persisted elsewhere, and finally deserialize |
| 1427 | * that state to a live context for resuming read/write operations on the |
| 1428 | * connection. From a protocol perspective, the state of the connection is |
| 1429 | * unaffected, in particular this is entirely transparent to the peer. |
| 1430 | * |
| 1431 | * Note: this is distinct from TLS session resumption, which is part of the |
| 1432 | * protocol and fully visible by the peer. TLS session resumption enables |
| 1433 | * establishing new connections associated to a saved session with shorter, |
| 1434 | * lighter handshakes, while context serialization is a local optimization in |
| 1435 | * handling a single, potentially long-lived connection. |
| 1436 | * |
| 1437 | * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are |
| 1438 | * saved after the handshake to allow for more efficient serialization, so if |
| 1439 | * you don't need this feature you'll save RAM by disabling it. |
| 1440 | * |
Przemek Stekiel | 460192e | 2022-10-03 08:55:29 +0200 | [diff] [blame] | 1441 | * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C |
| 1442 | * |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1443 | * Comment to disable the context serialization APIs. |
| 1444 | */ |
| 1445 | #define MBEDTLS_SSL_CONTEXT_SERIALIZATION |
| 1446 | |
| 1447 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1448 | * \def MBEDTLS_SSL_DEBUG_ALL |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 1449 | * |
| 1450 | * Enable the debug messages in SSL module for all issues. |
| 1451 | * Debug messages have been disabled in some places to prevent timing |
| 1452 | * attacks due to (unbalanced) debugging function calls. |
| 1453 | * |
| 1454 | * If you need all error reporting you should enable this during debugging, |
| 1455 | * but remove this for production servers that should log as well. |
| 1456 | * |
| 1457 | * Uncomment this macro to report all debug messages on errors introducing |
| 1458 | * a timing side-channel. |
| 1459 | * |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 1460 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1461 | //#define MBEDTLS_SSL_DEBUG_ALL |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 1462 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1463 | /** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 1464 | * |
| 1465 | * Enable support for Encrypt-then-MAC, RFC 7366. |
| 1466 | * |
| 1467 | * This allows peers that both support it to use a more robust protection for |
| 1468 | * ciphersuites using CBC, providing deep resistance against timing attacks |
| 1469 | * on the padding or underlying cipher. |
| 1470 | * |
| 1471 | * This only affects CBC ciphersuites, and is useless if none is defined. |
| 1472 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 1473 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 1474 | * |
| 1475 | * Comment this macro to disable support for Encrypt-then-MAC |
| 1476 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1477 | #define MBEDTLS_SSL_ENCRYPT_THEN_MAC |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 1478 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1479 | /** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 1480 | * |
Manuel Pégourié-Gonnard | bca8aa0 | 2020-03-24 12:11:49 +0100 | [diff] [blame] | 1481 | * Enable support for RFC 7627: Session Hash and Extended Master Secret |
| 1482 | * Extension. |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 1483 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 1484 | * This was introduced as "the proper fix" to the Triple Handshake family of |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 1485 | * attacks, but it is recommended to always use it (even if you disable |
| 1486 | * renegotiation), since it actually fixes a more fundamental issue in the |
| 1487 | * original SSL/TLS design, and has implications beyond Triple Handshake. |
| 1488 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 1489 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
Manuel Pégourié-Gonnard | 769c6b6 | 2014-10-28 14:13:55 +0100 | [diff] [blame] | 1490 | * |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 1491 | * Comment this macro to disable support for Extended Master Secret. |
| 1492 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1493 | #define MBEDTLS_SSL_EXTENDED_MASTER_SECRET |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 1494 | |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 1495 | /** |
Hanno Becker | bb278f5 | 2019-02-05 17:04:00 +0000 | [diff] [blame] | 1496 | * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE |
| 1497 | * |
Hanno Becker | fd7f298 | 2019-02-25 10:13:33 +0000 | [diff] [blame] | 1498 | * This option controls the availability of the API mbedtls_ssl_get_peer_cert() |
Hanno Becker | bb278f5 | 2019-02-05 17:04:00 +0000 | [diff] [blame] | 1499 | * giving access to the peer's certificate after completion of the handshake. |
| 1500 | * |
| 1501 | * Unless you need mbedtls_ssl_peer_cert() in your application, it is |
| 1502 | * recommended to disable this option for reduced RAM usage. |
| 1503 | * |
| 1504 | * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still |
| 1505 | * defined, but always returns \c NULL. |
| 1506 | * |
| 1507 | * \note This option has no influence on the protection against the |
| 1508 | * triple handshake attack. Even if it is disabled, Mbed TLS will |
| 1509 | * still ensure that certificates do not change during renegotiation, |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 1510 | * for example by keeping a hash of the peer's certificate. |
Hanno Becker | bb278f5 | 2019-02-05 17:04:00 +0000 | [diff] [blame] | 1511 | * |
Tom Cosgrove | afb2fe1 | 2022-06-29 16:36:12 +0100 | [diff] [blame] | 1512 | * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set. |
| 1513 | * |
Hanno Becker | bb278f5 | 2019-02-05 17:04:00 +0000 | [diff] [blame] | 1514 | * Comment this macro to disable storing the peer's certificate |
| 1515 | * after the handshake. |
| 1516 | */ |
| 1517 | #define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE |
| 1518 | |
| 1519 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1520 | * \def MBEDTLS_SSL_RENEGOTIATION |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 1521 | * |
Hanno Becker | 0eb8fb8 | 2018-10-26 09:53:16 +0100 | [diff] [blame] | 1522 | * Enable support for TLS renegotiation. |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 1523 | * |
| 1524 | * The two main uses of renegotiation are (1) refresh keys on long-lived |
| 1525 | * connections and (2) client authentication after the initial handshake. |
| 1526 | * If you don't need renegotiation, it's probably better to disable it, since |
| 1527 | * it has been associated with security issues in the past and is easy to |
| 1528 | * misuse/misunderstand. |
Manuel Pégourié-Gonnard | 0371704 | 2014-11-04 19:52:10 +0100 | [diff] [blame] | 1529 | * |
Manuel Pégourié-Gonnard | 55f968b | 2015-03-09 16:23:15 +0000 | [diff] [blame] | 1530 | * Comment this to disable support for renegotiation. |
Hanno Becker | 6851b10 | 2017-10-12 14:57:48 +0100 | [diff] [blame] | 1531 | * |
| 1532 | * \note Even if this option is disabled, both client and server are aware |
| 1533 | * of the Renegotiation Indication Extension (RFC 5746) used to |
| 1534 | * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1). |
| 1535 | * (See \c mbedtls_ssl_conf_legacy_renegotiation for the |
| 1536 | * configuration of this extension). |
| 1537 | * |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 1538 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1539 | #define MBEDTLS_SSL_RENEGOTIATION |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 1540 | |
| 1541 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1542 | * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 1543 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1544 | * Enable support for RFC 6066 max_fragment_length extension in SSL. |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 1545 | * |
| 1546 | * Comment this macro to disable support for the max_fragment_length extension |
| 1547 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1548 | #define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 1549 | |
| 1550 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1551 | * \def MBEDTLS_SSL_PROTO_TLS1_2 |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 1552 | * |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1553 | * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled). |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 1554 | * |
Manuel Pégourié-Gonnard | 72687b7 | 2022-09-15 12:23:58 +0200 | [diff] [blame] | 1555 | * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and |
| 1556 | * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C) |
| 1557 | * With MBEDTLS_USE_PSA_CRYPTO: |
| 1558 | * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or |
| 1559 | * PSA_WANT_ALG_SHA_512 |
Andrzej Kurek | e02da81 | 2022-08-17 17:04:49 -0400 | [diff] [blame] | 1560 | * |
Manuel Pégourié-Gonnard | 72687b7 | 2022-09-15 12:23:58 +0200 | [diff] [blame] | 1561 | * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call |
| 1562 | * psa_crypto_init() before doing any TLS operations. |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 1563 | * |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1564 | * Comment this macro to disable support for TLS 1.2 / DTLS 1.2 |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 1565 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1566 | #define MBEDTLS_SSL_PROTO_TLS1_2 |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 1567 | |
| 1568 | /** |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1569 | * \def MBEDTLS_SSL_PROTO_TLS1_3 |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 1570 | * |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1571 | * Enable support for TLS 1.3. |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 1572 | * |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1573 | * \note The support for TLS 1.3 is not comprehensive yet, in particular |
| 1574 | * pre-shared keys are not supported. |
| 1575 | * See docs/architecture/tls13-support.md for a description of the TLS |
| 1576 | * 1.3 support that this option enables. |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 1577 | * |
Tom Cosgrove | afb2fe1 | 2022-06-29 16:36:12 +0100 | [diff] [blame] | 1578 | * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE |
Manuel Pégourié-Gonnard | 3e83098 | 2022-05-11 13:27:44 +0200 | [diff] [blame] | 1579 | * Requires: MBEDTLS_PSA_CRYPTO_C |
| 1580 | * |
Gilles Peskine | 8c2830a | 2022-08-04 23:37:51 +0200 | [diff] [blame^] | 1581 | * \note TLS 1.3 uses PSA crypto for cryptographic operations that are |
| 1582 | * directly performed by TLS 1.3 code. As a consequence, you must |
| 1583 | * call psa_crypto_init() before the first TLS 1.3 handshake. |
| 1584 | * |
| 1585 | * \note Cryptographic operations performed indirectly via another module |
| 1586 | * (X.509, PK) or by code shared with TLS 1.2 (record protection, |
| 1587 | * running handshake hash) only use PSA crypto if |
| 1588 | * #MBEDTLS_USE_PSA_CRYPTO is enabled. |
Tom Cosgrove | afb2fe1 | 2022-06-29 16:36:12 +0100 | [diff] [blame] | 1589 | * |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1590 | * Uncomment this macro to enable the support for TLS 1.3. |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 1591 | */ |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1592 | //#define MBEDTLS_SSL_PROTO_TLS1_3 |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 1593 | |
| 1594 | /** |
Ronald Cron | ab65c52 | 2021-11-24 10:47:20 +0100 | [diff] [blame] | 1595 | * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE |
| 1596 | * |
| 1597 | * Enable TLS 1.3 middlebox compatibility mode. |
| 1598 | * |
| 1599 | * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility |
| 1600 | * mode to make a TLS 1.3 connection more likely to pass through middle boxes |
| 1601 | * expecting TLS 1.2 traffic. |
| 1602 | * |
| 1603 | * Turning on the compatibility mode comes at the cost of a few added bytes |
| 1604 | * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations |
| 1605 | * that don't use it. Therefore, unless transmission bandwidth is critical and |
| 1606 | * you know that middlebox compatibility issues won't occur, it is therefore |
| 1607 | * recommended to set this option. |
| 1608 | * |
| 1609 | * Comment to disable compatibility mode for TLS 1.3. If |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 1610 | * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any |
| 1611 | * effect on the build. |
Ronald Cron | ab65c52 | 2021-11-24 10:47:20 +0100 | [diff] [blame] | 1612 | * |
| 1613 | */ |
| 1614 | //#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE |
| 1615 | |
| 1616 | /** |
Ronald Cron | d8d2ea5 | 2022-10-04 15:48:06 +0200 | [diff] [blame] | 1617 | * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED |
| 1618 | * |
| 1619 | * Enable TLS 1.3 PSK key exchange mode. |
| 1620 | * |
| 1621 | * Comment to disable support for the PSK key exchange mode in TLS 1.3. If |
| 1622 | * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any |
| 1623 | * effect on the build. |
| 1624 | * |
| 1625 | */ |
| 1626 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED |
| 1627 | |
| 1628 | /** |
| 1629 | * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED |
| 1630 | * |
| 1631 | * Enable TLS 1.3 ephemeral key exchange mode. |
| 1632 | * |
| 1633 | * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or |
| 1634 | * MBEDTLS_PKCS1_V21 |
| 1635 | * |
| 1636 | * Comment to disable support for the ephemeral key exchange mode in TLS 1.3. |
| 1637 | * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any |
| 1638 | * effect on the build. |
| 1639 | * |
| 1640 | */ |
| 1641 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED |
| 1642 | |
| 1643 | /** |
| 1644 | * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED |
| 1645 | * |
| 1646 | * Enable TLS 1.3 PSK ephemeral key exchange mode. |
| 1647 | * |
| 1648 | * Requires: MBEDTLS_ECDH_C |
| 1649 | * |
| 1650 | * Comment to disable support for the PSK ephemeral key exchange mode in |
| 1651 | * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not |
| 1652 | * have any effect on the build. |
| 1653 | * |
| 1654 | */ |
| 1655 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED |
| 1656 | |
| 1657 | /** |
Jerry Yu | 6cf85a4 | 2022-09-13 11:14:42 +0800 | [diff] [blame] | 1658 | * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE |
Jerry Yu | 0038c5f | 2022-07-07 06:49:01 +0000 | [diff] [blame] | 1659 | * |
Jerry Yu | 6cf85a4 | 2022-09-13 11:14:42 +0800 | [diff] [blame] | 1660 | * Maximum time difference in milliseconds tolerated between the age of a |
| 1661 | * ticket from the server and client point of view. |
| 1662 | * From the client point of view, the age of a ticket is the time difference |
| 1663 | * between the time when the client proposes to the server to use the ticket |
| 1664 | * (time of writing of the Pre-Shared Key Extension including the ticket) and |
| 1665 | * the time the client received the ticket from the server. |
| 1666 | * From the server point of view, the age of a ticket is the time difference |
| 1667 | * between the time when the server receives a proposition from the client |
| 1668 | * to use the ticket and the time when the ticket was created by the server. |
| 1669 | * The server age is expected to be always greater than the client one and |
| 1670 | * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the |
| 1671 | * maximum difference tolerated for the server to accept the ticket. |
| 1672 | * This is not used in TLS 1.2. |
Jerry Yu | 89eb95a | 2022-08-21 19:21:45 +0800 | [diff] [blame] | 1673 | * |
| 1674 | */ |
| 1675 | #define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000 |
| 1676 | |
| 1677 | /** |
Jerry Yu | 0038c5f | 2022-07-07 06:49:01 +0000 | [diff] [blame] | 1678 | * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH |
| 1679 | * |
| 1680 | * Size in bytes of a ticket nonce. This is not used in TLS 1.2. |
| 1681 | * |
Jerry Yu | 08aed4d | 2022-07-20 10:36:12 +0800 | [diff] [blame] | 1682 | * This must be less than 256. |
Jerry Yu | 0038c5f | 2022-07-07 06:49:01 +0000 | [diff] [blame] | 1683 | */ |
Jerry Yu | 9750f81 | 2022-07-20 11:04:50 +0800 | [diff] [blame] | 1684 | #define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32 |
Jerry Yu | 0038c5f | 2022-07-07 06:49:01 +0000 | [diff] [blame] | 1685 | |
| 1686 | /** |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 1687 | * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS |
| 1688 | * |
Jerry Yu | f3bdf9d | 2022-09-22 23:30:49 +0800 | [diff] [blame] | 1689 | * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server |
| 1690 | * after handshake completion. This is not used in TLS 1.2 and relevant only if |
| 1691 | * the MBEDTLS_SSL_SESSION_TICKETS option is enabled. |
Jerry Yu | 1ad7ace | 2022-08-09 13:28:39 +0800 | [diff] [blame] | 1692 | * |
| 1693 | */ |
| 1694 | #define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1 |
| 1695 | |
| 1696 | /** |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1697 | * \def MBEDTLS_SSL_EARLY_DATA |
| 1698 | * |
| 1699 | * Enable support for RFC 8446 TLS 1.3 early data. |
| 1700 | * |
| 1701 | * Requires: MBEDTLS_SSL_SESSION_TICKETS and either |
| 1702 | * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or |
| 1703 | * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED |
| 1704 | * |
| 1705 | * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3 |
| 1706 | * is not enabled, this option does not have any effect on the build. |
| 1707 | * |
| 1708 | * This feature is experimental, not completed and thus not ready for |
| 1709 | * production. |
| 1710 | * |
| 1711 | */ |
Ronald Cron | c2e110f | 2022-11-22 09:01:46 +0100 | [diff] [blame] | 1712 | //#define MBEDTLS_SSL_EARLY_DATA |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 1713 | |
| 1714 | /** |
Jerry Yu | 16f6853 | 2022-11-05 10:50:06 +0800 | [diff] [blame] | 1715 | * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE |
| 1716 | * |
Jerry Yu | 12c46bd | 2022-12-06 11:02:51 +0800 | [diff] [blame] | 1717 | * The default maximum amount of 0-RTT data. See the documentation of |
| 1718 | * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information. |
| 1719 | * |
| 1720 | * It must be positive and smaller than UINT32_MAX. |
| 1721 | * |
| 1722 | * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not |
| 1723 | * have any impact on the build. |
Jerry Yu | 16f6853 | 2022-11-05 10:50:06 +0800 | [diff] [blame] | 1724 | * |
| 1725 | * This feature is experimental, not completed and thus not ready for |
| 1726 | * production. |
| 1727 | * |
| 1728 | */ |
| 1729 | #define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024 |
| 1730 | |
| 1731 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1732 | * \def MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1733 | * |
| 1734 | * Enable support for DTLS (all available versions). |
| 1735 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 1736 | * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2. |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1737 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 1738 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1739 | * |
| 1740 | * Comment this macro to disable support for DTLS |
| 1741 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1742 | #define MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 1743 | |
| 1744 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1745 | * \def MBEDTLS_SSL_ALPN |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 1746 | * |
Manuel Pégourié-Gonnard | 6b298e6 | 2014-11-20 18:28:50 +0100 | [diff] [blame] | 1747 | * Enable support for RFC 7301 Application Layer Protocol Negotiation. |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 1748 | * |
Paul Bakker | 27e36d3 | 2014-04-08 12:33:37 +0200 | [diff] [blame] | 1749 | * Comment this macro to disable support for ALPN. |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 1750 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1751 | #define MBEDTLS_SSL_ALPN |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 1752 | |
| 1753 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1754 | * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 1755 | * |
| 1756 | * Enable support for the anti-replay mechanism in DTLS. |
| 1757 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1758 | * Requires: MBEDTLS_SSL_TLS_C |
| 1759 | * MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 1760 | * |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 1761 | * \warning Disabling this is often a security risk! |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 1762 | * See mbedtls_ssl_conf_dtls_anti_replay() for details. |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 1763 | * |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 1764 | * Comment this to disable anti-replay in DTLS. |
| 1765 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1766 | #define MBEDTLS_SSL_DTLS_ANTI_REPLAY |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 1767 | |
| 1768 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1769 | * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY |
Manuel Pégourié-Gonnard | 82202f0 | 2014-07-23 00:28:58 +0200 | [diff] [blame] | 1770 | * |
| 1771 | * Enable support for HelloVerifyRequest on DTLS servers. |
| 1772 | * |
| 1773 | * This feature is highly recommended to prevent DTLS servers being used as |
| 1774 | * amplifiers in DoS attacks against other hosts. It should always be enabled |
| 1775 | * unless you know for sure amplification cannot be a problem in the |
| 1776 | * environment in which your server operates. |
| 1777 | * |
Andrzej Kurek | 5c65c57 | 2022-04-13 14:28:52 -0400 | [diff] [blame] | 1778 | * \warning Disabling this can be a security risk! (see above) |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 1779 | * |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 1780 | * Requires: MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 82202f0 | 2014-07-23 00:28:58 +0200 | [diff] [blame] | 1781 | * |
| 1782 | * Comment this to disable support for HelloVerifyRequest. |
| 1783 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1784 | #define MBEDTLS_SSL_DTLS_HELLO_VERIFY |
Manuel Pégourié-Gonnard | 82202f0 | 2014-07-23 00:28:58 +0200 | [diff] [blame] | 1785 | |
| 1786 | /** |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1787 | * \def MBEDTLS_SSL_DTLS_SRTP |
| 1788 | * |
Tobias Nießen | 1e8ca12 | 2021-05-10 19:53:15 +0200 | [diff] [blame] | 1789 | * Enable support for negotiation of DTLS-SRTP (RFC 5764) |
Johan Pascal | 842d671 | 2020-09-23 13:34:40 +0200 | [diff] [blame] | 1790 | * through the use_srtp extension. |
| 1791 | * |
| 1792 | * \note This feature provides the minimum functionality required |
| 1793 | * to negotiate the use of DTLS-SRTP and to allow the derivation of |
| 1794 | * the associated SRTP packet protection key material. |
| 1795 | * In particular, the SRTP packet protection itself, as well as the |
| 1796 | * demultiplexing of RTP and DTLS packets at the datagram layer |
| 1797 | * (see Section 5 of RFC 5764), are not handled by this feature. |
| 1798 | * Instead, after successful completion of a handshake negotiating |
| 1799 | * the use of DTLS-SRTP, the extended key exporter API |
Hanno Becker | 2d6e6f8 | 2021-05-24 10:58:31 +0100 | [diff] [blame] | 1800 | * mbedtls_ssl_conf_export_keys_cb() should be used to implement |
Johan Pascal | 842d671 | 2020-09-23 13:34:40 +0200 | [diff] [blame] | 1801 | * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705 |
| 1802 | * (this is implemented in the SSL example programs). |
| 1803 | * The resulting key should then be passed to an SRTP stack. |
| 1804 | * |
| 1805 | * Setting this option enables the runtime API |
| 1806 | * mbedtls_ssl_conf_dtls_srtp_protection_profiles() |
| 1807 | * through which the supported DTLS-SRTP protection |
| 1808 | * profiles can be configured. You must call this API at |
| 1809 | * runtime if you wish to negotiate the use of DTLS-SRTP. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1810 | * |
| 1811 | * Requires: MBEDTLS_SSL_PROTO_DTLS |
| 1812 | * |
Ron Eldor | 9cfb5eb | 2018-12-10 15:30:14 +0200 | [diff] [blame] | 1813 | * Uncomment this to enable support for use_srtp extension. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1814 | */ |
Ron Eldor | 9cfb5eb | 2018-12-10 15:30:14 +0200 | [diff] [blame] | 1815 | //#define MBEDTLS_SSL_DTLS_SRTP |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 1816 | |
| 1817 | /** |
Manuel Pégourié-Gonnard | 26d227d | 2015-09-04 10:53:25 +0200 | [diff] [blame] | 1818 | * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE |
| 1819 | * |
| 1820 | * Enable server-side support for clients that reconnect from the same port. |
| 1821 | * |
| 1822 | * Some clients unexpectedly close the connection and try to reconnect using the |
| 1823 | * same source port. This needs special support from the server to handle the |
Simon Butcher | 4f6882a | 2015-09-11 17:12:46 +0100 | [diff] [blame] | 1824 | * new connection securely, as described in section 4.2.8 of RFC 6347. This |
Manuel Pégourié-Gonnard | 26d227d | 2015-09-04 10:53:25 +0200 | [diff] [blame] | 1825 | * flag enables that support. |
| 1826 | * |
Manuel Pégourié-Gonnard | 62c74bb | 2015-09-08 17:50:29 +0200 | [diff] [blame] | 1827 | * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY |
Manuel Pégourié-Gonnard | 62c74bb | 2015-09-08 17:50:29 +0200 | [diff] [blame] | 1828 | * |
Manuel Pégourié-Gonnard | 26d227d | 2015-09-04 10:53:25 +0200 | [diff] [blame] | 1829 | * Comment this to disable support for clients reusing the source port. |
| 1830 | */ |
| 1831 | #define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE |
| 1832 | |
| 1833 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1834 | * \def MBEDTLS_SSL_SESSION_TICKETS |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 1835 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1836 | * Enable support for RFC 5077 session tickets in SSL. |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 1837 | * Client-side, provides full support for session tickets (maintenance of a |
Manuel Pégourié-Gonnard | 0c0f11f | 2015-05-20 09:55:50 +0200 | [diff] [blame] | 1838 | * session store remains the responsibility of the application, though). |
| 1839 | * Server-side, you also need to provide callbacks for writing and parsing |
| 1840 | * tickets, including authenticated encryption and key management. Example |
| 1841 | * callbacks are provided by MBEDTLS_SSL_TICKET_C. |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 1842 | * |
| 1843 | * Comment this macro to disable support for SSL session tickets |
| 1844 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1845 | #define MBEDTLS_SSL_SESSION_TICKETS |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 1846 | |
| 1847 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1848 | * \def MBEDTLS_SSL_SERVER_NAME_INDICATION |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 1849 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1850 | * Enable support for RFC 6066 server name indication (SNI) in SSL. |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 1851 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1852 | * Requires: MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | bbbb3cf | 2015-01-28 16:44:37 +0000 | [diff] [blame] | 1853 | * |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 1854 | * Comment this macro to disable support for server name indication in SSL |
| 1855 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1856 | #define MBEDTLS_SSL_SERVER_NAME_INDICATION |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 1857 | |
| 1858 | /** |
Gilles Peskine | f03bd81 | 2020-03-23 18:13:58 +0100 | [diff] [blame] | 1859 | * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH |
| 1860 | * |
Andrzej Kurek | 2a54a6f | 2021-01-07 08:13:49 -0500 | [diff] [blame] | 1861 | * When this option is enabled, the SSL buffer will be resized automatically |
| 1862 | * based on the negotiated maximum fragment length in each direction. |
Andrzej Kurek | 557289b | 2020-10-21 15:12:39 +0200 | [diff] [blame] | 1863 | * |
| 1864 | * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH |
Gilles Peskine | f03bd81 | 2020-03-23 18:13:58 +0100 | [diff] [blame] | 1865 | */ |
| 1866 | //#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH |
| 1867 | |
| 1868 | /** |
Manuel Pégourié-Gonnard | 6240def | 2020-07-10 09:35:54 +0200 | [diff] [blame] | 1869 | * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN |
| 1870 | * |
| 1871 | * Enable testing of the constant-flow nature of some sensitive functions with |
| 1872 | * clang's MemorySanitizer. This causes some existing tests to also test |
Manuel Pégourié-Gonnard | dd00bfc | 2020-08-24 12:58:36 +0200 | [diff] [blame] | 1873 | * this non-functional property of the code under test. |
Manuel Pégourié-Gonnard | 6240def | 2020-07-10 09:35:54 +0200 | [diff] [blame] | 1874 | * |
Manuel Pégourié-Gonnard | dd00bfc | 2020-08-24 12:58:36 +0200 | [diff] [blame] | 1875 | * This setting requires compiling with clang -fsanitize=memory. The test |
| 1876 | * suites can then be run normally. |
Manuel Pégourié-Gonnard | 6240def | 2020-07-10 09:35:54 +0200 | [diff] [blame] | 1877 | * |
Manuel Pégourié-Gonnard | 8ff863b | 2020-07-31 12:59:34 +0200 | [diff] [blame] | 1878 | * \warning This macro is only used for extended testing; it is not considered |
| 1879 | * part of the library's API, so it may change or disappear at any time. |
| 1880 | * |
Manuel Pégourié-Gonnard | 390fb4f | 2020-07-24 11:08:40 +0200 | [diff] [blame] | 1881 | * Uncomment to enable testing of the constant-flow nature of selected code. |
Manuel Pégourié-Gonnard | 6240def | 2020-07-10 09:35:54 +0200 | [diff] [blame] | 1882 | */ |
| 1883 | //#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN |
| 1884 | |
| 1885 | /** |
Manuel Pégourié-Gonnard | 73afa37 | 2020-08-19 10:27:38 +0200 | [diff] [blame] | 1886 | * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND |
| 1887 | * |
| 1888 | * Enable testing of the constant-flow nature of some sensitive functions with |
| 1889 | * valgrind's memcheck tool. This causes some existing tests to also test |
Manuel Pégourié-Gonnard | dd00bfc | 2020-08-24 12:58:36 +0200 | [diff] [blame] | 1890 | * this non-functional property of the code under test. |
Manuel Pégourié-Gonnard | 73afa37 | 2020-08-19 10:27:38 +0200 | [diff] [blame] | 1891 | * |
| 1892 | * This setting requires valgrind headers for building, and is only useful for |
Manuel Pégourié-Gonnard | dd00bfc | 2020-08-24 12:58:36 +0200 | [diff] [blame] | 1893 | * testing if the tests suites are run with valgrind's memcheck. This can be |
| 1894 | * done for an individual test suite with 'valgrind ./test_suite_xxx', or when |
| 1895 | * using CMake, this can be done for all test suites with 'make memcheck'. |
Manuel Pégourié-Gonnard | 73afa37 | 2020-08-19 10:27:38 +0200 | [diff] [blame] | 1896 | * |
| 1897 | * \warning This macro is only used for extended testing; it is not considered |
| 1898 | * part of the library's API, so it may change or disappear at any time. |
| 1899 | * |
| 1900 | * Uncomment to enable testing of the constant-flow nature of selected code. |
| 1901 | */ |
| 1902 | //#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND |
| 1903 | |
| 1904 | /** |
Gilles Peskine | fea6eaf | 2019-09-11 13:27:48 +0200 | [diff] [blame] | 1905 | * \def MBEDTLS_TEST_HOOKS |
| 1906 | * |
| 1907 | * Enable features for invasive testing such as introspection functions and |
| 1908 | * hooks for fault injection. This enables additional unit tests. |
| 1909 | * |
| 1910 | * Merely enabling this feature should not change the behavior of the product. |
| 1911 | * It only adds new code, and new branching points where the default behavior |
| 1912 | * is the same as when this feature is disabled. |
| 1913 | * However, this feature increases the attack surface: there is an added |
| 1914 | * risk of vulnerabilities, and more gadgets that can make exploits easier. |
| 1915 | * Therefore this feature must never be enabled in production. |
| 1916 | * |
| 1917 | * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more |
| 1918 | * information. |
| 1919 | * |
| 1920 | * Uncomment to enable invasive tests. |
| 1921 | */ |
| 1922 | //#define MBEDTLS_TEST_HOOKS |
| 1923 | |
| 1924 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1925 | * \def MBEDTLS_THREADING_ALT |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1926 | * |
| 1927 | * Provide your own alternate threading implementation. |
| 1928 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1929 | * Requires: MBEDTLS_THREADING_C |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1930 | * |
| 1931 | * Uncomment this to allow your own alternate threading implementation. |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1932 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1933 | //#define MBEDTLS_THREADING_ALT |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1934 | |
| 1935 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1936 | * \def MBEDTLS_THREADING_PTHREAD |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1937 | * |
| 1938 | * Enable the pthread wrapper layer for the threading layer. |
| 1939 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1940 | * Requires: MBEDTLS_THREADING_C |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1941 | * |
| 1942 | * Uncomment this to enable pthread mutexes. |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1943 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1944 | //#define MBEDTLS_THREADING_PTHREAD |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 1945 | |
| 1946 | /** |
Manuel Pégourié-Gonnard | aeefa49 | 2018-10-22 12:14:52 +0200 | [diff] [blame] | 1947 | * \def MBEDTLS_USE_PSA_CRYPTO |
| 1948 | * |
Manuel Pégourié-Gonnard | 971dea3 | 2019-02-01 12:38:40 +0100 | [diff] [blame] | 1949 | * Make the X.509 and TLS library use PSA for cryptographic operations, and |
| 1950 | * enable new APIs for using keys handled by PSA Crypto. |
Manuel Pégourié-Gonnard | aeefa49 | 2018-10-22 12:14:52 +0200 | [diff] [blame] | 1951 | * |
Jaeden Amero | 8dd1690 | 2019-07-22 16:39:49 +0100 | [diff] [blame] | 1952 | * \note Development of this option is currently in progress, and parts of Mbed |
| 1953 | * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts |
Andrzej Kurek | d65b11d | 2019-04-16 04:20:24 -0400 | [diff] [blame] | 1954 | * will still continue to work as usual, so enabling this option should not |
| 1955 | * break backwards compatibility. |
Manuel Pégourié-Gonnard | aeefa49 | 2018-10-22 12:14:52 +0200 | [diff] [blame] | 1956 | * |
Manuel Pégourié-Gonnard | 13b0beb | 2021-09-20 13:21:25 +0200 | [diff] [blame] | 1957 | * \note See docs/use-psa-crypto.md for a complete description of what this |
| 1958 | * option currently does, and of parts that are not affected by it so far. |
| 1959 | * |
Manuel Pégourié-Gonnard | ff43ff6 | 2022-04-20 15:32:01 +0200 | [diff] [blame] | 1960 | * \warning If you enable this option, you need to call `psa_crypto_init()` |
| 1961 | * before calling any function from the SSL/TLS, X.509 or PK modules. |
Hanno Becker | 51560b6 | 2018-11-19 09:46:26 +0000 | [diff] [blame] | 1962 | * |
Manuel Pégourié-Gonnard | aeefa49 | 2018-10-22 12:14:52 +0200 | [diff] [blame] | 1963 | * Requires: MBEDTLS_PSA_CRYPTO_C. |
Manuel Pégourié-Gonnard | 971dea3 | 2019-02-01 12:38:40 +0100 | [diff] [blame] | 1964 | * |
Andrzej Kurek | d3deb1d | 2019-04-16 04:14:48 -0400 | [diff] [blame] | 1965 | * Uncomment this to enable internal use of PSA Crypto and new associated APIs. |
Manuel Pégourié-Gonnard | aeefa49 | 2018-10-22 12:14:52 +0200 | [diff] [blame] | 1966 | */ |
| 1967 | //#define MBEDTLS_USE_PSA_CRYPTO |
| 1968 | |
| 1969 | /** |
John Durkop | 6e33dbe | 2020-09-17 21:15:13 -0700 | [diff] [blame] | 1970 | * \def MBEDTLS_PSA_CRYPTO_CONFIG |
| 1971 | * |
John Durkop | 185764f | 2020-10-12 21:32:12 -0700 | [diff] [blame] | 1972 | * This setting allows support for cryptographic mechanisms through the PSA |
| 1973 | * API to be configured separately from support through the mbedtls API. |
John Durkop | 6e33dbe | 2020-09-17 21:15:13 -0700 | [diff] [blame] | 1974 | * |
Gilles Peskine | db0421b | 2022-04-13 23:22:49 +0200 | [diff] [blame] | 1975 | * When this option is disabled, the PSA API exposes the cryptographic |
| 1976 | * mechanisms that can be implemented on top of the `mbedtls_xxx` API |
| 1977 | * configured with `MBEDTLS_XXX` symbols. |
Gilles Peskine | 750596e | 2022-03-16 17:03:55 +0100 | [diff] [blame] | 1978 | * |
| 1979 | * When this option is enabled, the PSA API exposes the cryptographic |
| 1980 | * mechanisms requested by the `PSA_WANT_XXX` symbols defined in |
| 1981 | * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are |
| 1982 | * automatically enabled if required (i.e. if no PSA driver provides the |
| 1983 | * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols |
| 1984 | * in mbedtls_config.h. |
Gilles Peskine | 58858b7 | 2020-11-09 15:26:09 +0100 | [diff] [blame] | 1985 | * |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 1986 | * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies |
Gilles Peskine | 0c4db1f | 2022-04-14 12:44:01 +0200 | [diff] [blame] | 1987 | * an alternative header to include instead of include/psa/crypto_config.h. |
Gilles Peskine | 58858b7 | 2020-11-09 15:26:09 +0100 | [diff] [blame] | 1988 | * |
John Durkop | 185764f | 2020-10-12 21:32:12 -0700 | [diff] [blame] | 1989 | * This feature is still experimental and is not ready for production since |
| 1990 | * it is not completed. |
John Durkop | 6e33dbe | 2020-09-17 21:15:13 -0700 | [diff] [blame] | 1991 | */ |
| 1992 | //#define MBEDTLS_PSA_CRYPTO_CONFIG |
| 1993 | |
| 1994 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1995 | * \def MBEDTLS_VERSION_FEATURES |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 1996 | * |
| 1997 | * Allow run-time checking of compile-time enabled features. Thus allowing users |
| 1998 | * to check at run-time if the library is for instance compiled with threading |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1999 | * support via mbedtls_version_check_feature(). |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 2000 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2001 | * Requires: MBEDTLS_VERSION_C |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 2002 | * |
| 2003 | * Comment this to disable run-time checking and save ROM space |
| 2004 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2005 | #define MBEDTLS_VERSION_FEATURES |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 2006 | |
| 2007 | /** |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 2008 | * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK |
| 2009 | * |
Jarno Lamsa | f49fedc | 2019-04-01 14:58:30 +0300 | [diff] [blame] | 2010 | * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()` |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 2011 | * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure |
| 2012 | * the set of trusted certificates through a callback instead of a linked |
| 2013 | * list. |
| 2014 | * |
| 2015 | * This is useful for example in environments where a large number of trusted |
| 2016 | * certificates is present and storing them in a linked list isn't efficient |
| 2017 | * enough, or when the set of trusted certificates changes frequently. |
| 2018 | * |
Jarno Lamsa | f49fedc | 2019-04-01 14:58:30 +0300 | [diff] [blame] | 2019 | * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 2020 | * `mbedtls_ssl_conf_ca_cb()` for more information. |
| 2021 | * |
Valerio Setti | 8e45cdd | 2023-01-05 09:32:29 +0100 | [diff] [blame] | 2022 | * Requires: MBEDTLS_X509_CRT_PARSE_C |
| 2023 | * |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 2024 | * Uncomment to enable trusted certificate callbacks. |
| 2025 | */ |
| 2026 | //#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK |
| 2027 | |
| 2028 | /** |
Hanno Becker | 612a2f1 | 2020-10-09 09:19:39 +0100 | [diff] [blame] | 2029 | * \def MBEDTLS_X509_REMOVE_INFO |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 2030 | * |
Chris Jones | 2c74586 | 2020-12-16 11:41:06 +0000 | [diff] [blame] | 2031 | * Disable mbedtls_x509_*_info() and related APIs. |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 2032 | * |
Chris Jones | 2c74586 | 2020-12-16 11:41:06 +0000 | [diff] [blame] | 2033 | * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt() |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 2034 | * and other functions/constants only used by these functions, thus reducing |
| 2035 | * the code footprint by several KB. |
| 2036 | */ |
Chris Jones | 2c74586 | 2020-12-16 11:41:06 +0000 | [diff] [blame] | 2037 | //#define MBEDTLS_X509_REMOVE_INFO |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 2038 | |
| 2039 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2040 | * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT |
Manuel Pégourié-Gonnard | d1539b1 | 2014-06-06 16:42:37 +0200 | [diff] [blame] | 2041 | * |
| 2042 | * Enable parsing and verification of X.509 certificates, CRLs and CSRS |
| 2043 | * signed with RSASSA-PSS (aka PKCS#1 v2.1). |
| 2044 | * |
| 2045 | * Comment this macro to disallow using RSASSA-PSS in certificates. |
| 2046 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2047 | #define MBEDTLS_X509_RSASSA_PSS_SUPPORT |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 2048 | /** \} name SECTION: mbed TLS feature support */ |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 2049 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2050 | /** |
Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 2051 | * \name SECTION: mbed TLS modules |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 2052 | * |
Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 2053 | * This section enables or disables entire modules in mbed TLS |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 2054 | * \{ |
| 2055 | */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2056 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2057 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2058 | * \def MBEDTLS_AESNI_C |
Manuel Pégourié-Gonnard | 92ac76f | 2013-12-16 17:12:53 +0100 | [diff] [blame] | 2059 | * |
| 2060 | * Enable AES-NI support on x86-64. |
| 2061 | * |
| 2062 | * Module: library/aesni.c |
| 2063 | * Caller: library/aes.c |
| 2064 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2065 | * Requires: MBEDTLS_HAVE_ASM |
Manuel Pégourié-Gonnard | 92ac76f | 2013-12-16 17:12:53 +0100 | [diff] [blame] | 2066 | * |
| 2067 | * This modules adds support for the AES-NI instructions on x86-64 |
| 2068 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2069 | #define MBEDTLS_AESNI_C |
Manuel Pégourié-Gonnard | 92ac76f | 2013-12-16 17:12:53 +0100 | [diff] [blame] | 2070 | |
| 2071 | /** |
Jerry Yu | 2fddfd7 | 2023-01-10 16:32:03 +0800 | [diff] [blame] | 2072 | * \def MBEDTLS_AESCE_C |
| 2073 | * |
Jerry Yu | 751e76b | 2023-02-16 10:48:15 +0800 | [diff] [blame] | 2074 | * Enable AES crypto extension support on Arm64. |
Jerry Yu | 2fddfd7 | 2023-01-10 16:32:03 +0800 | [diff] [blame] | 2075 | * |
| 2076 | * Module: library/aesce.c |
| 2077 | * Caller: library/aes.c |
| 2078 | * |
| 2079 | * Requires: MBEDTLS_HAVE_ASM, MBEDTLS_AES_C |
| 2080 | * |
| 2081 | * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum |
| 2082 | * of \c -march=armv8-a+crypto . |
| 2083 | * |
Jerry Yu | 608e109 | 2023-02-28 12:50:00 +0800 | [diff] [blame] | 2084 | * \warning If the target architecture is set to something that includes the |
| 2085 | * SHA3 feature (e.g. `-march=armv8.2-a+sha3`), for example because |
| 2086 | * `MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT` is desired, compilers |
| 2087 | * generate code for `MBEDTLS_AESCE_C` that includes instructions |
| 2088 | * only present with the (optional) SHA3 feature. This will lead to an |
| 2089 | * undefined instruction exception if the code is run on a CPU without |
| 2090 | * that feature. |
Jerry Yu | 2fddfd7 | 2023-01-10 16:32:03 +0800 | [diff] [blame] | 2091 | * |
Jerry Yu | 330e6ae | 2023-02-21 14:51:38 +0800 | [diff] [blame] | 2092 | * \warning Runtime detection only works on linux. For non-linux operation |
| 2093 | * system, crypto extension MUST be supported by CPU. |
| 2094 | * |
Jerry Yu | c8bcdc8 | 2023-02-21 14:49:02 +0800 | [diff] [blame] | 2095 | * This module adds support for the AES crypto instructions on Arm64 |
Jerry Yu | 2fddfd7 | 2023-01-10 16:32:03 +0800 | [diff] [blame] | 2096 | */ |
| 2097 | #define MBEDTLS_AESCE_C |
| 2098 | |
| 2099 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2100 | * \def MBEDTLS_AES_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2101 | * |
| 2102 | * Enable the AES block cipher. |
| 2103 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2104 | * Module: library/aes.c |
Manuel Pégourié-Gonnard | fdd4354 | 2018-02-28 10:49:02 +0100 | [diff] [blame] | 2105 | * Caller: library/cipher.c |
Paul Bakker | 96743fc | 2011-02-12 14:30:57 +0000 | [diff] [blame] | 2106 | * library/pem.c |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 2107 | * library/ctr_drbg.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2108 | * |
Paul Bakker | 645ce3a | 2012-10-31 12:32:41 +0000 | [diff] [blame] | 2109 | * This module enables the following ciphersuites (if other requisites are |
| 2110 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2111 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA |
| 2112 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA |
| 2113 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA |
| 2114 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA |
| 2115 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 |
| 2116 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 |
| 2117 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 |
| 2118 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 |
| 2119 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 |
| 2120 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 |
| 2121 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 |
| 2122 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 |
| 2123 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 |
| 2124 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 |
| 2125 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 |
| 2126 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 |
| 2127 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 |
| 2128 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 |
| 2129 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA |
| 2130 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA |
| 2131 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA |
| 2132 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 |
| 2133 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
| 2134 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 |
| 2135 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 |
| 2136 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
| 2137 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 |
| 2138 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA |
| 2139 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA |
| 2140 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA |
| 2141 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 |
| 2142 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 |
| 2143 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 |
| 2144 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA |
| 2145 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA |
| 2146 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 |
| 2147 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 |
| 2148 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 |
| 2149 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA |
| 2150 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA |
| 2151 | * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 |
| 2152 | * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 |
| 2153 | * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA |
| 2154 | * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 |
| 2155 | * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 |
| 2156 | * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA |
| 2157 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 |
| 2158 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 |
| 2159 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA |
| 2160 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 |
| 2161 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 |
| 2162 | * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA |
| 2163 | * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 |
| 2164 | * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 |
| 2165 | * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA |
| 2166 | * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 |
| 2167 | * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 |
| 2168 | * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA |
Paul Bakker | 6deb37e | 2013-02-19 13:17:08 +0100 | [diff] [blame] | 2169 | * |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2170 | * PEM_PARSE uses AES for decrypting encrypted keys. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2171 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2172 | #define MBEDTLS_AES_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2173 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2174 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2175 | * \def MBEDTLS_ASN1_PARSE_C |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 2176 | * |
| 2177 | * Enable the generic ASN1 parser. |
| 2178 | * |
| 2179 | * Module: library/asn1.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2180 | * Caller: library/x509.c |
| 2181 | * library/dhm.c |
| 2182 | * library/pkcs12.c |
| 2183 | * library/pkcs5.c |
| 2184 | * library/pkparse.c |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 2185 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2186 | #define MBEDTLS_ASN1_PARSE_C |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 2187 | |
| 2188 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2189 | * \def MBEDTLS_ASN1_WRITE_C |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 2190 | * |
| 2191 | * Enable the generic ASN1 writer. |
| 2192 | * |
| 2193 | * Module: library/asn1write.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2194 | * Caller: library/ecdsa.c |
| 2195 | * library/pkwrite.c |
| 2196 | * library/x509_create.c |
| 2197 | * library/x509write_crt.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2198 | * library/x509write_csr.c |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 2199 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2200 | #define MBEDTLS_ASN1_WRITE_C |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 2201 | |
| 2202 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2203 | * \def MBEDTLS_BASE64_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2204 | * |
| 2205 | * Enable the Base64 module. |
| 2206 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2207 | * Module: library/base64.c |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 2208 | * Caller: library/pem.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2209 | * |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 2210 | * This module is required for PEM support (required by X.509). |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2211 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2212 | #define MBEDTLS_BASE64_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2213 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2214 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2215 | * \def MBEDTLS_BIGNUM_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2216 | * |
Paul Bakker | 9a73632 | 2012-11-14 12:39:52 +0000 | [diff] [blame] | 2217 | * Enable the multi-precision integer library. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2218 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2219 | * Module: library/bignum.c |
Janos Follath | 3ca0775 | 2022-08-09 11:45:47 +0100 | [diff] [blame] | 2220 | * library/bignum_core.c |
Janos Follath | d1baedb | 2022-08-09 13:44:53 +0100 | [diff] [blame] | 2221 | * library/bignum_mod.c |
Gabor Mezei | d41f627 | 2022-08-12 15:20:21 +0200 | [diff] [blame] | 2222 | * library/bignum_mod_raw.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2223 | * Caller: library/dhm.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2224 | * library/ecp.c |
Manuel Pégourié-Gonnard | bf31977 | 2014-06-25 13:00:17 +0200 | [diff] [blame] | 2225 | * library/ecdsa.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2226 | * library/rsa.c |
Chris Jones | 3848e31 | 2021-03-11 16:17:59 +0000 | [diff] [blame] | 2227 | * library/rsa_alt_helpers.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2228 | * library/ssl_tls.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2229 | * |
Manuel Pégourié-Gonnard | bf31977 | 2014-06-25 13:00:17 +0200 | [diff] [blame] | 2230 | * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2231 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2232 | #define MBEDTLS_BIGNUM_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2233 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2234 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2235 | * \def MBEDTLS_CAMELLIA_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2236 | * |
| 2237 | * Enable the Camellia block cipher. |
| 2238 | * |
Paul Bakker | 38119b1 | 2009-01-10 23:31:23 +0000 | [diff] [blame] | 2239 | * Module: library/camellia.c |
Manuel Pégourié-Gonnard | fdd4354 | 2018-02-28 10:49:02 +0100 | [diff] [blame] | 2240 | * Caller: library/cipher.c |
Paul Bakker | 38119b1 | 2009-01-10 23:31:23 +0000 | [diff] [blame] | 2241 | * |
Paul Bakker | 645ce3a | 2012-10-31 12:32:41 +0000 | [diff] [blame] | 2242 | * This module enables the following ciphersuites (if other requisites are |
| 2243 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2244 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 2245 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 2246 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 2247 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 2248 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 2249 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 2250 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 2251 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 2252 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 2253 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 2254 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 2255 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 2256 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 2257 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 |
| 2258 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA |
| 2259 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 2260 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 2261 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 2262 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 2263 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 2264 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 2265 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA |
| 2266 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 2267 | * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 2268 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 2269 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 2270 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
| 2271 | * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
| 2272 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 2273 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 |
| 2274 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA |
| 2275 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 2276 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 2277 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA |
| 2278 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 2279 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 2280 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 2281 | * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
| 2282 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 2283 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 2284 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 2285 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Paul Bakker | 38119b1 | 2009-01-10 23:31:23 +0000 | [diff] [blame] | 2286 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2287 | #define MBEDTLS_CAMELLIA_C |
Paul Bakker | 38119b1 | 2009-01-10 23:31:23 +0000 | [diff] [blame] | 2288 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2289 | /** |
Markku-Juhani O. Saarinen | 3c0b53b | 2017-11-30 16:00:34 +0000 | [diff] [blame] | 2290 | * \def MBEDTLS_ARIA_C |
| 2291 | * |
Manuel Pégourié-Gonnard | 525168c | 2018-02-28 10:47:02 +0100 | [diff] [blame] | 2292 | * Enable the ARIA block cipher. |
Markku-Juhani O. Saarinen | 3c0b53b | 2017-11-30 16:00:34 +0000 | [diff] [blame] | 2293 | * |
| 2294 | * Module: library/aria.c |
Manuel Pégourié-Gonnard | 525168c | 2018-02-28 10:47:02 +0100 | [diff] [blame] | 2295 | * Caller: library/cipher.c |
| 2296 | * |
| 2297 | * This module enables the following ciphersuites (if other requisites are |
| 2298 | * enabled as well): |
| 2299 | * |
| 2300 | * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256 |
| 2301 | * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384 |
| 2302 | * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 |
| 2303 | * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 |
| 2304 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 |
| 2305 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 |
| 2306 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 |
| 2307 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 |
| 2308 | * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 |
| 2309 | * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 |
| 2310 | * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256 |
| 2311 | * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384 |
| 2312 | * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256 |
| 2313 | * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384 |
| 2314 | * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 |
| 2315 | * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 |
| 2316 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 |
| 2317 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 |
| 2318 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 |
| 2319 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 |
| 2320 | * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 |
| 2321 | * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 |
| 2322 | * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256 |
| 2323 | * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384 |
| 2324 | * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 |
| 2325 | * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 |
| 2326 | * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 |
| 2327 | * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 |
| 2328 | * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 |
| 2329 | * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 |
| 2330 | * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 |
| 2331 | * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 |
| 2332 | * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 |
| 2333 | * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 |
| 2334 | * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 |
| 2335 | * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 |
| 2336 | * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 |
| 2337 | * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 |
Markku-Juhani O. Saarinen | 3c0b53b | 2017-11-30 16:00:34 +0000 | [diff] [blame] | 2338 | */ |
TRodziewicz | 85aff9f | 2021-04-23 10:47:26 +0200 | [diff] [blame] | 2339 | #define MBEDTLS_ARIA_C |
Markku-Juhani O. Saarinen | 3c0b53b | 2017-11-30 16:00:34 +0000 | [diff] [blame] | 2340 | |
| 2341 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2342 | * \def MBEDTLS_CCM_C |
Manuel Pégourié-Gonnard | a6916fa | 2014-05-02 15:17:29 +0200 | [diff] [blame] | 2343 | * |
| 2344 | * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher. |
| 2345 | * |
| 2346 | * Module: library/ccm.c |
| 2347 | * |
Przemek Stekiel | ea805b4 | 2022-05-02 10:30:03 +0200 | [diff] [blame] | 2348 | * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or |
| 2349 | * MBEDTLS_ARIA_C |
Manuel Pégourié-Gonnard | a6916fa | 2014-05-02 15:17:29 +0200 | [diff] [blame] | 2350 | * |
| 2351 | * This module enables the AES-CCM ciphersuites, if other requisites are |
| 2352 | * enabled as well. |
| 2353 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2354 | #define MBEDTLS_CCM_C |
Manuel Pégourié-Gonnard | a6916fa | 2014-05-02 15:17:29 +0200 | [diff] [blame] | 2355 | |
| 2356 | /** |
Daniel King | 34b822c | 2016-05-15 17:28:08 -0300 | [diff] [blame] | 2357 | * \def MBEDTLS_CHACHA20_C |
| 2358 | * |
| 2359 | * Enable the ChaCha20 stream cipher. |
| 2360 | * |
| 2361 | * Module: library/chacha20.c |
| 2362 | */ |
| 2363 | #define MBEDTLS_CHACHA20_C |
| 2364 | |
| 2365 | /** |
Manuel Pégourié-Gonnard | e533b22 | 2018-06-04 12:23:19 +0200 | [diff] [blame] | 2366 | * \def MBEDTLS_CHACHAPOLY_C |
| 2367 | * |
| 2368 | * Enable the ChaCha20-Poly1305 AEAD algorithm. |
| 2369 | * |
| 2370 | * Module: library/chachapoly.c |
| 2371 | * |
| 2372 | * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C |
| 2373 | */ |
| 2374 | #define MBEDTLS_CHACHAPOLY_C |
| 2375 | |
| 2376 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2377 | * \def MBEDTLS_CIPHER_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2378 | * |
| 2379 | * Enable the generic cipher layer. |
| 2380 | * |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 2381 | * Module: library/cipher.c |
Przemek Stekiel | ea805b4 | 2022-05-02 10:30:03 +0200 | [diff] [blame] | 2382 | * Caller: library/ccm.c |
| 2383 | * library/cmac.c |
| 2384 | * library/gcm.c |
| 2385 | * library/nist_kw.c |
Przemek Stekiel | ea805b4 | 2022-05-02 10:30:03 +0200 | [diff] [blame] | 2386 | * library/pkcs12.c |
| 2387 | * library/pkcs5.c |
| 2388 | * library/psa_crypto_aead.c |
| 2389 | * library/psa_crypto_mac.c |
| 2390 | * library/ssl_ciphersuites.c |
| 2391 | * library/ssl_msg.c |
Przemek Stekiel | a09f835 | 2022-05-12 09:34:28 +0200 | [diff] [blame] | 2392 | * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled) |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 2393 | * |
| 2394 | * Uncomment to enable generic cipher wrappers. |
| 2395 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2396 | #define MBEDTLS_CIPHER_C |
Paul Bakker | 8123e9d | 2011-01-06 15:37:30 +0000 | [diff] [blame] | 2397 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2398 | /** |
Robert Cragie | dc5c7b9 | 2015-12-11 15:49:45 +0000 | [diff] [blame] | 2399 | * \def MBEDTLS_CMAC_C |
| 2400 | * |
Simon Butcher | 327398a | 2016-10-05 14:09:11 +0100 | [diff] [blame] | 2401 | * Enable the CMAC (Cipher-based Message Authentication Code) mode for block |
| 2402 | * ciphers. |
Robert Cragie | dc5c7b9 | 2015-12-11 15:49:45 +0000 | [diff] [blame] | 2403 | * |
Steven Cooreman | c338cef | 2021-04-26 11:24:44 +0200 | [diff] [blame] | 2404 | * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying |
| 2405 | * implementation of the CMAC algorithm is provided by an alternate |
| 2406 | * implementation, that alternate implementation may opt to not support |
| 2407 | * AES-192 or 3DES as underlying block ciphers for the CMAC operation. |
| 2408 | * |
Robert Cragie | dc5c7b9 | 2015-12-11 15:49:45 +0000 | [diff] [blame] | 2409 | * Module: library/cmac.c |
| 2410 | * |
Przemek Stekiel | ea805b4 | 2022-05-02 10:30:03 +0200 | [diff] [blame] | 2411 | * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C |
Robert Cragie | dc5c7b9 | 2015-12-11 15:49:45 +0000 | [diff] [blame] | 2412 | * |
| 2413 | */ |
TRodziewicz | 85aff9f | 2021-04-23 10:47:26 +0200 | [diff] [blame] | 2414 | #define MBEDTLS_CMAC_C |
Robert Cragie | dc5c7b9 | 2015-12-11 15:49:45 +0000 | [diff] [blame] | 2415 | |
| 2416 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2417 | * \def MBEDTLS_CTR_DRBG_C |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 2418 | * |
Nir Sonnenschein | ce266e4 | 2018-08-29 10:11:46 +0300 | [diff] [blame] | 2419 | * Enable the CTR_DRBG AES-based random generator. |
| 2420 | * The CTR_DRBG generator uses AES-256 by default. |
Gilles Peskine | 1540e5b | 2019-10-03 14:21:14 +0200 | [diff] [blame] | 2421 | * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 2422 | * |
Gilles Peskine | 7e27936 | 2019-10-03 14:21:39 +0200 | [diff] [blame] | 2423 | * \note To achieve a 256-bit security strength with CTR_DRBG, |
| 2424 | * you must use AES-256 *and* use sufficient entropy. |
| 2425 | * See ctr_drbg.h for more details. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 2426 | * |
| 2427 | * Module: library/ctr_drbg.c |
| 2428 | * Caller: |
| 2429 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2430 | * Requires: MBEDTLS_AES_C |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 2431 | * |
Nir Sonnenschein | 521e8a9 | 2018-09-03 14:10:52 +0300 | [diff] [blame] | 2432 | * This module provides the CTR_DRBG AES random number generator. |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 2433 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2434 | #define MBEDTLS_CTR_DRBG_C |
Paul Bakker | 0e04d0e | 2011-11-27 14:46:59 +0000 | [diff] [blame] | 2435 | |
| 2436 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2437 | * \def MBEDTLS_DEBUG_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2438 | * |
| 2439 | * Enable the debug functions. |
| 2440 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2441 | * Module: library/debug.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 2442 | * Caller: library/ssl_msg.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2443 | * library/ssl_tls.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 2444 | * library/ssl_tls12_*.c |
| 2445 | * library/ssl_tls13_*.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2446 | * |
| 2447 | * This module provides debugging functions. |
| 2448 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2449 | #define MBEDTLS_DEBUG_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2450 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2451 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2452 | * \def MBEDTLS_DES_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2453 | * |
| 2454 | * Enable the DES block cipher. |
| 2455 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2456 | * Module: library/des.c |
Paul Bakker | 6deb37e | 2013-02-19 13:17:08 +0100 | [diff] [blame] | 2457 | * Caller: library/pem.c |
Manuel Pégourié-Gonnard | fdd4354 | 2018-02-28 10:49:02 +0100 | [diff] [blame] | 2458 | * library/cipher.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2459 | * |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2460 | * PEM_PARSE uses DES/3DES for decrypting encrypted keys. |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 2461 | * |
Dave Rodgman | c04515b | 2023-02-02 10:47:58 +0000 | [diff] [blame] | 2462 | * \warning DES/3DES are considered weak ciphers and their use constitutes a |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 2463 | * security risk. We recommend considering stronger ciphers instead. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2464 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2465 | #define MBEDTLS_DES_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2466 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2467 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2468 | * \def MBEDTLS_DHM_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2469 | * |
Manuel Pégourié-Gonnard | 9d70373 | 2013-10-25 18:01:50 +0200 | [diff] [blame] | 2470 | * Enable the Diffie-Hellman-Merkle module. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2471 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2472 | * Module: library/dhm.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 2473 | * Caller: library/ssl_tls.c |
| 2474 | * library/ssl*_client.c |
| 2475 | * library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2476 | * |
Manuel Pégourié-Gonnard | 9d70373 | 2013-10-25 18:01:50 +0200 | [diff] [blame] | 2477 | * This module is used by the following key exchanges: |
| 2478 | * DHE-RSA, DHE-PSK |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 2479 | * |
Hanno Becker | f9734b3 | 2017-10-03 12:09:22 +0100 | [diff] [blame] | 2480 | * \warning Using DHE constitutes a security risk as it |
| 2481 | * is not possible to validate custom DH parameters. |
| 2482 | * If possible, it is recommended users should consider |
| 2483 | * preferring other methods of key exchange. |
| 2484 | * See dhm.h for more details. |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 2485 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2486 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2487 | #define MBEDTLS_DHM_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2488 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2489 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2490 | * \def MBEDTLS_ECDH_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2491 | * |
| 2492 | * Enable the elliptic curve Diffie-Hellman library. |
| 2493 | * |
| 2494 | * Module: library/ecdh.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 2495 | * Caller: library/psa_crypto.c |
| 2496 | * library/ssl_tls.c |
| 2497 | * library/ssl*_client.c |
| 2498 | * library/ssl*_server.c |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 2499 | * |
Manuel Pégourié-Gonnard | 9d70373 | 2013-10-25 18:01:50 +0200 | [diff] [blame] | 2500 | * This module is used by the following key exchanges: |
| 2501 | * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2502 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2503 | * Requires: MBEDTLS_ECP_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2504 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2505 | #define MBEDTLS_ECDH_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2506 | |
| 2507 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2508 | * \def MBEDTLS_ECDSA_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2509 | * |
| 2510 | * Enable the elliptic curve DSA library. |
| 2511 | * |
| 2512 | * Module: library/ecdsa.c |
| 2513 | * Caller: |
| 2514 | * |
Manuel Pégourié-Gonnard | 9d70373 | 2013-10-25 18:01:50 +0200 | [diff] [blame] | 2515 | * This module is used by the following key exchanges: |
| 2516 | * ECDHE-ECDSA |
| 2517 | * |
Gilles Peskine | 799e576 | 2018-09-14 17:34:00 +0200 | [diff] [blame] | 2518 | * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C, |
| 2519 | * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a |
| 2520 | * short Weierstrass curve. |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2521 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2522 | #define MBEDTLS_ECDSA_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2523 | |
| 2524 | /** |
Manuel Pégourié-Gonnard | 4d8685b | 2015-08-05 15:44:42 +0200 | [diff] [blame] | 2525 | * \def MBEDTLS_ECJPAKE_C |
| 2526 | * |
| 2527 | * Enable the elliptic curve J-PAKE library. |
| 2528 | * |
Tomasz Rodziewicz | 532ca93 | 2021-05-07 11:01:24 +0200 | [diff] [blame] | 2529 | * \note EC J-PAKE support is based on the Thread v1.0.0 specification. |
| 2530 | * It has not been reviewed for compliance with newer standards such as |
Tomasz Rodziewicz | 1fc7c4c | 2021-05-07 10:13:31 +0200 | [diff] [blame] | 2531 | * Thread v1.1 or RFC 8236. |
Manuel Pégourié-Gonnard | 75df902 | 2015-09-16 23:21:01 +0200 | [diff] [blame] | 2532 | * |
Manuel Pégourié-Gonnard | 4d8685b | 2015-08-05 15:44:42 +0200 | [diff] [blame] | 2533 | * Module: library/ecjpake.c |
| 2534 | * Caller: |
| 2535 | * |
| 2536 | * This module is used by the following key exchanges: |
| 2537 | * ECJPAKE |
| 2538 | * |
Manuel Pégourié-Gonnard | 72687b7 | 2022-09-15 12:23:58 +0200 | [diff] [blame] | 2539 | * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C |
Neil Armstrong | ecaba1c | 2022-08-11 10:47:08 +0200 | [diff] [blame] | 2540 | * |
| 2541 | * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init() |
| 2542 | * before doing any EC J-PAKE operations. |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 2543 | * |
| 2544 | * \warning When building with MBEDTLS_MD_C, all hashes used with this |
Manuel Pégourié-Gonnard | fecc6b2 | 2022-11-24 09:40:12 +0100 | [diff] [blame] | 2545 | * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C, |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 2546 | * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by |
| 2547 | * this module in builds where MBEDTLS_MD_C is disabled. |
Manuel Pégourié-Gonnard | 4d8685b | 2015-08-05 15:44:42 +0200 | [diff] [blame] | 2548 | */ |
Tomasz Rodziewicz | b133605 | 2021-04-22 15:14:17 +0200 | [diff] [blame] | 2549 | #define MBEDTLS_ECJPAKE_C |
Manuel Pégourié-Gonnard | 4d8685b | 2015-08-05 15:44:42 +0200 | [diff] [blame] | 2550 | |
| 2551 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2552 | * \def MBEDTLS_ECP_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2553 | * |
| 2554 | * Enable the elliptic curve over GF(p) library. |
| 2555 | * |
| 2556 | * Module: library/ecp.c |
| 2557 | * Caller: library/ecdh.c |
| 2558 | * library/ecdsa.c |
Manuel Pégourié-Gonnard | 4d8685b | 2015-08-05 15:44:42 +0200 | [diff] [blame] | 2559 | * library/ecjpake.c |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2560 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2561 | * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2562 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2563 | #define MBEDTLS_ECP_C |
Paul Bakker | d589a0d | 2013-03-13 16:30:17 +0100 | [diff] [blame] | 2564 | |
| 2565 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2566 | * \def MBEDTLS_ENTROPY_C |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 2567 | * |
| 2568 | * Enable the platform-specific entropy code. |
| 2569 | * |
| 2570 | * Module: library/entropy.c |
| 2571 | * Caller: |
| 2572 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2573 | * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 2574 | * |
| 2575 | * This module provides a generic entropy pool |
| 2576 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2577 | #define MBEDTLS_ENTROPY_C |
Paul Bakker | 6083fd2 | 2011-12-03 21:45:14 +0000 | [diff] [blame] | 2578 | |
| 2579 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2580 | * \def MBEDTLS_ERROR_C |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 2581 | * |
| 2582 | * Enable error code to error string conversion. |
| 2583 | * |
| 2584 | * Module: library/error.c |
| 2585 | * Caller: |
| 2586 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2587 | * This module enables mbedtls_strerror(). |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 2588 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2589 | #define MBEDTLS_ERROR_C |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 2590 | |
| 2591 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2592 | * \def MBEDTLS_GCM_C |
Paul Bakker | 89e80c9 | 2012-03-20 13:50:09 +0000 | [diff] [blame] | 2593 | * |
Jaeden Amero | 7accf44 | 2019-04-10 18:13:57 +0100 | [diff] [blame] | 2594 | * Enable the Galois/Counter Mode (GCM). |
Paul Bakker | 89e80c9 | 2012-03-20 13:50:09 +0000 | [diff] [blame] | 2595 | * |
| 2596 | * Module: library/gcm.c |
| 2597 | * |
Przemek Stekiel | ea805b4 | 2022-05-02 10:30:03 +0200 | [diff] [blame] | 2598 | * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or |
| 2599 | * MBEDTLS_ARIA_C |
Paul Bakker | 645ce3a | 2012-10-31 12:32:41 +0000 | [diff] [blame] | 2600 | * |
Manuel Pégourié-Gonnard | 9d70373 | 2013-10-25 18:01:50 +0200 | [diff] [blame] | 2601 | * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other |
| 2602 | * requisites are enabled as well. |
Paul Bakker | 89e80c9 | 2012-03-20 13:50:09 +0000 | [diff] [blame] | 2603 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2604 | #define MBEDTLS_GCM_C |
Paul Bakker | 89e80c9 | 2012-03-20 13:50:09 +0000 | [diff] [blame] | 2605 | |
| 2606 | /** |
Thomas Fossati | 656864b | 2016-07-17 08:51:22 +0100 | [diff] [blame] | 2607 | * \def MBEDTLS_HKDF_C |
| 2608 | * |
| 2609 | * Enable the HKDF algorithm (RFC 5869). |
| 2610 | * |
| 2611 | * Module: library/hkdf.c |
| 2612 | * Caller: |
| 2613 | * |
| 2614 | * Requires: MBEDTLS_MD_C |
| 2615 | * |
| 2616 | * This module adds support for the Hashed Message Authentication Code |
| 2617 | * (HMAC)-based key derivation function (HKDF). |
| 2618 | */ |
| 2619 | #define MBEDTLS_HKDF_C |
| 2620 | |
| 2621 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2622 | * \def MBEDTLS_HMAC_DRBG_C |
Manuel Pégourié-Gonnard | 490bdf3 | 2014-01-27 14:03:10 +0100 | [diff] [blame] | 2623 | * |
| 2624 | * Enable the HMAC_DRBG random generator. |
| 2625 | * |
| 2626 | * Module: library/hmac_drbg.c |
| 2627 | * Caller: |
| 2628 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2629 | * Requires: MBEDTLS_MD_C |
Manuel Pégourié-Gonnard | 490bdf3 | 2014-01-27 14:03:10 +0100 | [diff] [blame] | 2630 | * |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 2631 | * Uncomment to enable the HMAC_DRBG random number generator. |
Manuel Pégourié-Gonnard | 490bdf3 | 2014-01-27 14:03:10 +0100 | [diff] [blame] | 2632 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2633 | #define MBEDTLS_HMAC_DRBG_C |
Manuel Pégourié-Gonnard | 490bdf3 | 2014-01-27 14:03:10 +0100 | [diff] [blame] | 2634 | |
| 2635 | /** |
Raef Coles | 8ff6df5 | 2021-07-21 12:42:15 +0100 | [diff] [blame] | 2636 | * \def MBEDTLS_LMS_C |
| 2637 | * |
| 2638 | * Enable the LMS stateful-hash asymmetric signature algorithm. |
| 2639 | * |
| 2640 | * Module: library/lms.c |
| 2641 | * Caller: |
| 2642 | * |
Raef Coles | ab4f874 | 2022-09-01 12:24:31 +0100 | [diff] [blame] | 2643 | * Requires: MBEDTLS_PSA_CRYPTO_C |
Raef Coles | 8ff6df5 | 2021-07-21 12:42:15 +0100 | [diff] [blame] | 2644 | * |
Raef Coles | ab4f874 | 2022-09-01 12:24:31 +0100 | [diff] [blame] | 2645 | * Uncomment to enable the LMS verification algorithm and public key operations. |
Raef Coles | 8ff6df5 | 2021-07-21 12:42:15 +0100 | [diff] [blame] | 2646 | */ |
| 2647 | #define MBEDTLS_LMS_C |
| 2648 | |
| 2649 | /** |
Raef Coles | ab4f874 | 2022-09-01 12:24:31 +0100 | [diff] [blame] | 2650 | * \def MBEDTLS_LMS_PRIVATE |
| 2651 | * |
| 2652 | * Enable LMS private-key operations and signing code. Functions enabled by this |
| 2653 | * option are experimental, and should not be used in production. |
| 2654 | * |
| 2655 | * Requires: MBEDTLS_LMS_C |
| 2656 | * |
| 2657 | * Uncomment to enable the LMS signature algorithm and private key operations. |
| 2658 | */ |
Raef Coles | 5127e85 | 2022-10-07 10:35:56 +0100 | [diff] [blame] | 2659 | //#define MBEDTLS_LMS_PRIVATE |
Raef Coles | ab4f874 | 2022-09-01 12:24:31 +0100 | [diff] [blame] | 2660 | |
| 2661 | /** |
Ron Eldor | 466a57f | 2018-05-03 16:54:28 +0300 | [diff] [blame] | 2662 | * \def MBEDTLS_NIST_KW_C |
| 2663 | * |
| 2664 | * Enable the Key Wrapping mode for 128-bit block ciphers, |
| 2665 | * as defined in NIST SP 800-38F. Only KW and KWP modes |
| 2666 | * are supported. At the moment, only AES is approved by NIST. |
| 2667 | * |
| 2668 | * Module: library/nist_kw.c |
| 2669 | * |
| 2670 | * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C |
| 2671 | */ |
TRodziewicz | 85aff9f | 2021-04-23 10:47:26 +0200 | [diff] [blame] | 2672 | #define MBEDTLS_NIST_KW_C |
Ron Eldor | 466a57f | 2018-05-03 16:54:28 +0300 | [diff] [blame] | 2673 | |
| 2674 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2675 | * \def MBEDTLS_MD_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2676 | * |
| 2677 | * Enable the generic message digest layer. |
| 2678 | * |
Manuel Pégourié-Gonnard | 1f7f717 | 2022-07-18 12:04:05 +0200 | [diff] [blame] | 2679 | * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C, |
| 2680 | * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C, |
| 2681 | * MBEDTLS_SHA512_C. |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2682 | * Module: library/md.c |
Przemek Stekiel | 6aadf0b | 2022-04-27 14:46:52 +0200 | [diff] [blame] | 2683 | * Caller: library/constant_time.c |
| 2684 | * library/ecdsa.c |
| 2685 | * library/ecjpake.c |
| 2686 | * library/hkdf.c |
| 2687 | * library/hmac_drbg.c |
Przemek Stekiel | 6aadf0b | 2022-04-27 14:46:52 +0200 | [diff] [blame] | 2688 | * library/pk.c |
| 2689 | * library/pkcs5.c |
| 2690 | * library/pkcs12.c |
| 2691 | * library/psa_crypto_ecp.c |
| 2692 | * library/psa_crypto_rsa.c |
| 2693 | * library/rsa.c |
| 2694 | * library/ssl_cookie.c |
| 2695 | * library/ssl_msg.c |
| 2696 | * library/ssl_tls.c |
Przemek Stekiel | 6e71282 | 2022-05-06 11:40:20 +0200 | [diff] [blame] | 2697 | * library/x509.c |
Przemek Stekiel | 6aadf0b | 2022-04-27 14:46:52 +0200 | [diff] [blame] | 2698 | * library/x509_crt.c |
| 2699 | * library/x509write_crt.c |
| 2700 | * library/x509write_csr.c |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 2701 | * |
| 2702 | * Uncomment to enable generic message digest wrappers. |
| 2703 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2704 | #define MBEDTLS_MD_C |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 2705 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2706 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2707 | * \def MBEDTLS_MD5_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2708 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2709 | * Enable the MD5 hash algorithm. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2710 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2711 | * Module: library/md5.c |
| 2712 | * Caller: library/md.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2713 | * library/pem.c |
Paul Bakker | 6deb37e | 2013-02-19 13:17:08 +0100 | [diff] [blame] | 2714 | * library/ssl_tls.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2715 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 2716 | * This module is required for TLS 1.2 depending on the handshake parameters. |
| 2717 | * Further, it is used for checking MD5-signed certificates, and for PBKDF1 |
| 2718 | * when decrypting PEM-encoded encrypted keys. |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 2719 | * |
| 2720 | * \warning MD5 is considered a weak message digest and its use constitutes a |
| 2721 | * security risk. If possible, we recommend avoiding dependencies on |
| 2722 | * it, and considering stronger message digests instead. |
| 2723 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2724 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2725 | #define MBEDTLS_MD5_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2726 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2727 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2728 | * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2729 | * |
| 2730 | * Enable the buffer allocator implementation that makes use of a (stack) |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 2731 | * based buffer to 'allocate' dynamic memory. (replaces calloc() and free() |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2732 | * calls) |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 2733 | * |
| 2734 | * Module: library/memory_buffer_alloc.c |
| 2735 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2736 | * Requires: MBEDTLS_PLATFORM_C |
| 2737 | * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS) |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 2738 | * |
| 2739 | * Enable this module to enable the buffer memory allocator. |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 2740 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2741 | //#define MBEDTLS_MEMORY_BUFFER_ALLOC_C |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 2742 | |
| 2743 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2744 | * \def MBEDTLS_NET_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2745 | * |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 2746 | * Enable the TCP and UDP over IPv6/IPv4 networking routines. |
| 2747 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 2748 | * \note This module only works on POSIX/Unix (including Linux, BSD and OS X) |
| 2749 | * and Windows. For other platforms, you'll want to disable it, and write your |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 2750 | * own networking callbacks to be passed to \c mbedtls_ssl_set_bio(). |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2751 | * |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 2752 | * \note See also our Knowledge Base article about porting to a new |
| 2753 | * environment: |
Dave Rodgman | b319684 | 2022-10-12 16:47:08 +0100 | [diff] [blame] | 2754 | * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 2755 | * |
Andres AG | 788aa4a | 2016-09-14 14:32:09 +0100 | [diff] [blame] | 2756 | * Module: library/net_sockets.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2757 | * |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 2758 | * This module provides networking routines. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2759 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2760 | #define MBEDTLS_NET_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2761 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2762 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2763 | * \def MBEDTLS_OID_C |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 2764 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2765 | * Enable the OID database. |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 2766 | * |
| 2767 | * Module: library/oid.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2768 | * Caller: library/asn1write.c |
| 2769 | * library/pkcs5.c |
| 2770 | * library/pkparse.c |
| 2771 | * library/pkwrite.c |
| 2772 | * library/rsa.c |
| 2773 | * library/x509.c |
| 2774 | * library/x509_create.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2775 | * library/x509_crl.c |
| 2776 | * library/x509_crt.c |
| 2777 | * library/x509_csr.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2778 | * library/x509write_crt.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2779 | * library/x509write_csr.c |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 2780 | * |
| 2781 | * This modules translates between OIDs and internal values. |
| 2782 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2783 | #define MBEDTLS_OID_C |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 2784 | |
| 2785 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2786 | * \def MBEDTLS_PADLOCK_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2787 | * |
| 2788 | * Enable VIA Padlock support on x86. |
| 2789 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2790 | * Module: library/padlock.c |
| 2791 | * Caller: library/aes.c |
| 2792 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2793 | * Requires: MBEDTLS_HAVE_ASM |
Manuel Pégourié-Gonnard | 92ac76f | 2013-12-16 17:12:53 +0100 | [diff] [blame] | 2794 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2795 | * This modules adds support for the VIA PadLock on x86. |
| 2796 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2797 | #define MBEDTLS_PADLOCK_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 2798 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 2799 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2800 | * \def MBEDTLS_PEM_PARSE_C |
Paul Bakker | 96743fc | 2011-02-12 14:30:57 +0000 | [diff] [blame] | 2801 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2802 | * Enable PEM decoding / parsing. |
Paul Bakker | 96743fc | 2011-02-12 14:30:57 +0000 | [diff] [blame] | 2803 | * |
| 2804 | * Module: library/pem.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2805 | * Caller: library/dhm.c |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2806 | * library/pkparse.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2807 | * library/x509_crl.c |
| 2808 | * library/x509_crt.c |
| 2809 | * library/x509_csr.c |
Paul Bakker | 96743fc | 2011-02-12 14:30:57 +0000 | [diff] [blame] | 2810 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2811 | * Requires: MBEDTLS_BASE64_C |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 2812 | * |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2813 | * This modules adds support for decoding / parsing PEM files. |
Paul Bakker | 96743fc | 2011-02-12 14:30:57 +0000 | [diff] [blame] | 2814 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2815 | #define MBEDTLS_PEM_PARSE_C |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2816 | |
| 2817 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2818 | * \def MBEDTLS_PEM_WRITE_C |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2819 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2820 | * Enable PEM encoding / writing. |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2821 | * |
| 2822 | * Module: library/pem.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2823 | * Caller: library/pkwrite.c |
| 2824 | * library/x509write_crt.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2825 | * library/x509write_csr.c |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2826 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2827 | * Requires: MBEDTLS_BASE64_C |
Paul Bakker | cff6842 | 2013-09-15 20:43:33 +0200 | [diff] [blame] | 2828 | * |
| 2829 | * This modules adds support for encoding / writing PEM files. |
| 2830 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2831 | #define MBEDTLS_PEM_WRITE_C |
Paul Bakker | 96743fc | 2011-02-12 14:30:57 +0000 | [diff] [blame] | 2832 | |
| 2833 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2834 | * \def MBEDTLS_PK_C |
Manuel Pégourié-Gonnard | c40b4c3 | 2013-08-22 13:29:31 +0200 | [diff] [blame] | 2835 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 2836 | * Enable the generic public (asymmetric) key layer. |
Manuel Pégourié-Gonnard | c40b4c3 | 2013-08-22 13:29:31 +0200 | [diff] [blame] | 2837 | * |
| 2838 | * Module: library/pk.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 2839 | * Caller: library/psa_crypto_rsa.c |
| 2840 | * library/ssl_tls.c |
| 2841 | * library/ssl*_client.c |
| 2842 | * library/ssl*_server.c |
| 2843 | * library/x509.c |
Manuel Pégourié-Gonnard | c40b4c3 | 2013-08-22 13:29:31 +0200 | [diff] [blame] | 2844 | * |
Przemek Stekiel | 6aadf0b | 2022-04-27 14:46:52 +0200 | [diff] [blame] | 2845 | * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C |
Manuel Pégourié-Gonnard | 1a48383 | 2013-09-20 12:29:15 +0200 | [diff] [blame] | 2846 | * |
Manuel Pégourié-Gonnard | c40b4c3 | 2013-08-22 13:29:31 +0200 | [diff] [blame] | 2847 | * Uncomment to enable generic public key wrappers. |
| 2848 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2849 | #define MBEDTLS_PK_C |
Manuel Pégourié-Gonnard | c40b4c3 | 2013-08-22 13:29:31 +0200 | [diff] [blame] | 2850 | |
| 2851 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2852 | * \def MBEDTLS_PK_PARSE_C |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2853 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 2854 | * Enable the generic public (asymmetric) key parser. |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2855 | * |
| 2856 | * Module: library/pkparse.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 2857 | * Caller: library/x509_crt.c |
| 2858 | * library/x509_csr.c |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2859 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2860 | * Requires: MBEDTLS_PK_C |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2861 | * |
| 2862 | * Uncomment to enable generic public key parse functions. |
| 2863 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2864 | #define MBEDTLS_PK_PARSE_C |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2865 | |
| 2866 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2867 | * \def MBEDTLS_PK_WRITE_C |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2868 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 2869 | * Enable the generic public (asymmetric) key writer. |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2870 | * |
| 2871 | * Module: library/pkwrite.c |
| 2872 | * Caller: library/x509write.c |
| 2873 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2874 | * Requires: MBEDTLS_PK_C |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2875 | * |
| 2876 | * Uncomment to enable generic public key write functions. |
| 2877 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2878 | #define MBEDTLS_PK_WRITE_C |
Paul Bakker | 4606c73 | 2013-09-15 17:04:23 +0200 | [diff] [blame] | 2879 | |
| 2880 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2881 | * \def MBEDTLS_PKCS5_C |
Paul Bakker | b0c19a4 | 2013-06-24 19:26:38 +0200 | [diff] [blame] | 2882 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2883 | * Enable PKCS#5 functions. |
Paul Bakker | b0c19a4 | 2013-06-24 19:26:38 +0200 | [diff] [blame] | 2884 | * |
| 2885 | * Module: library/pkcs5.c |
| 2886 | * |
Manuel Pégourié-Gonnard | 72687b7 | 2022-09-15 12:23:58 +0200 | [diff] [blame] | 2887 | * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C. |
| 2888 | * |
| 2889 | * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init() |
| 2890 | * before doing any PKCS5 operation. |
Paul Bakker | b0c19a4 | 2013-06-24 19:26:38 +0200 | [diff] [blame] | 2891 | * |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 2892 | * \warning When building with MBEDTLS_MD_C, all hashes used with this |
Manuel Pégourié-Gonnard | fecc6b2 | 2022-11-24 09:40:12 +0100 | [diff] [blame] | 2893 | * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C, |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 2894 | * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by |
| 2895 | * this module in builds where MBEDTLS_MD_C is disabled. |
| 2896 | * |
Paul Bakker | b0c19a4 | 2013-06-24 19:26:38 +0200 | [diff] [blame] | 2897 | * This module adds support for the PKCS#5 functions. |
| 2898 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2899 | #define MBEDTLS_PKCS5_C |
Paul Bakker | b0c19a4 | 2013-06-24 19:26:38 +0200 | [diff] [blame] | 2900 | |
| 2901 | /** |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 2902 | * \def MBEDTLS_PKCS7_C |
| 2903 | * |
Dave Rodgman | dbcbf44 | 2022-12-05 11:15:10 +0000 | [diff] [blame] | 2904 | * This feature is a work in progress and not ready for production. Testing and |
| 2905 | * validation is incomplete, and handling of malformed inputs may not be robust. |
| 2906 | * The API may change. |
Dave Rodgman | 6ebaf7a | 2022-12-01 18:33:58 +0000 | [diff] [blame] | 2907 | * |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 2908 | * Enable PKCS7 core for using PKCS7 formatted signatures. |
| 2909 | * RFC Link - https://tools.ietf.org/html/rfc2315 |
| 2910 | * |
| 2911 | * Module: library/pkcs7.c |
| 2912 | * |
| 2913 | * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C, |
Nick Child | 89e82e1 | 2022-11-09 10:36:10 -0600 | [diff] [blame] | 2914 | * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C, |
| 2915 | * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 2916 | * |
| 2917 | * This module is required for the PKCS7 parsing modules. |
| 2918 | */ |
Dave Rodgman | bc5f03d | 2022-12-01 12:36:57 +0000 | [diff] [blame] | 2919 | //#define MBEDTLS_PKCS7_C |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 2920 | |
| 2921 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2922 | * \def MBEDTLS_PKCS12_C |
Paul Bakker | f1f21fe | 2013-06-24 19:17:19 +0200 | [diff] [blame] | 2923 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 2924 | * Enable PKCS#12 PBE functions. |
Paul Bakker | f1f21fe | 2013-06-24 19:17:19 +0200 | [diff] [blame] | 2925 | * Adds algorithms for parsing PKCS#8 encrypted private keys |
| 2926 | * |
| 2927 | * Module: library/pkcs12.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 2928 | * Caller: library/pkparse.c |
Paul Bakker | f1f21fe | 2013-06-24 19:17:19 +0200 | [diff] [blame] | 2929 | * |
Andrzej Kurek | 7bd12c5 | 2022-08-24 10:47:10 -0400 | [diff] [blame] | 2930 | * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either |
| 2931 | * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C. |
| 2932 | * |
| 2933 | * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init() |
| 2934 | * before doing any PKCS12 operation. |
Paul Bakker | f1f21fe | 2013-06-24 19:17:19 +0200 | [diff] [blame] | 2935 | * |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 2936 | * \warning When building with MBEDTLS_MD_C, all hashes used with this |
Manuel Pégourié-Gonnard | fecc6b2 | 2022-11-24 09:40:12 +0100 | [diff] [blame] | 2937 | * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C, |
Manuel Pégourié-Gonnard | 18a3856 | 2022-11-22 11:49:55 +0100 | [diff] [blame] | 2938 | * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by |
| 2939 | * this module in builds where MBEDTLS_MD_C is disabled. |
| 2940 | * |
Paul Bakker | f1f21fe | 2013-06-24 19:17:19 +0200 | [diff] [blame] | 2941 | * This module enables PKCS#12 functions. |
| 2942 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2943 | #define MBEDTLS_PKCS12_C |
Paul Bakker | f1f21fe | 2013-06-24 19:17:19 +0200 | [diff] [blame] | 2944 | |
| 2945 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2946 | * \def MBEDTLS_PLATFORM_C |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 2947 | * |
| 2948 | * Enable the platform abstraction layer that allows you to re-assign |
Manuel Pégourié-Gonnard | 6c0c8e0 | 2015-06-22 10:23:34 +0200 | [diff] [blame] | 2949 | * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit(). |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 2950 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 2951 | * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT |
| 2952 | * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned |
Rich Evans | 16f8cd8 | 2015-02-06 16:14:34 +0000 | [diff] [blame] | 2953 | * above to be specified at runtime or compile time respectively. |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 2954 | * |
Manuel Pégourié-Gonnard | 6c0c8e0 | 2015-06-22 10:23:34 +0200 | [diff] [blame] | 2955 | * \note This abstraction layer must be enabled on Windows (including MSYS2) |
Jan Bruckner | 9ff6f8c | 2022-08-22 16:05:58 +0200 | [diff] [blame] | 2956 | * as other modules rely on it for a fixed snprintf implementation. |
Manuel Pégourié-Gonnard | 6c0c8e0 | 2015-06-22 10:23:34 +0200 | [diff] [blame] | 2957 | * |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 2958 | * Module: library/platform.c |
| 2959 | * Caller: Most other .c files |
| 2960 | * |
| 2961 | * This module enables abstraction of common (libc) functions. |
| 2962 | */ |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 2963 | #define MBEDTLS_PLATFORM_C |
Paul Bakker | 747a83a | 2014-02-01 22:50:07 +0100 | [diff] [blame] | 2964 | |
| 2965 | /** |
Daniel King | adc32c0 | 2016-05-16 18:25:45 -0300 | [diff] [blame] | 2966 | * \def MBEDTLS_POLY1305_C |
| 2967 | * |
| 2968 | * Enable the Poly1305 MAC algorithm. |
| 2969 | * |
| 2970 | * Module: library/poly1305.c |
Manuel Pégourié-Gonnard | dca3a5d | 2018-05-07 10:43:27 +0200 | [diff] [blame] | 2971 | * Caller: library/chachapoly.c |
Daniel King | adc32c0 | 2016-05-16 18:25:45 -0300 | [diff] [blame] | 2972 | */ |
| 2973 | #define MBEDTLS_POLY1305_C |
| 2974 | |
| 2975 | /** |
Jaeden Amero | 484ee33 | 2018-10-25 17:38:05 +0100 | [diff] [blame] | 2976 | * \def MBEDTLS_PSA_CRYPTO_C |
| 2977 | * |
| 2978 | * Enable the Platform Security Architecture cryptography API. |
| 2979 | * |
Gilles Peskine | e59236f | 2018-01-27 23:32:46 +0100 | [diff] [blame] | 2980 | * Module: library/psa_crypto.c |
Jaeden Amero | 484ee33 | 2018-10-25 17:38:05 +0100 | [diff] [blame] | 2981 | * |
Przemek Stekiel | ea805b4 | 2022-05-02 10:30:03 +0200 | [diff] [blame] | 2982 | * Requires: MBEDTLS_CIPHER_C, |
| 2983 | * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C, |
Gilles Peskine | 82e57d1 | 2020-11-13 21:31:17 +0100 | [diff] [blame] | 2984 | * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C, |
Gilles Peskine | f08b3f8 | 2020-11-13 17:36:48 +0100 | [diff] [blame] | 2985 | * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG. |
Jaeden Amero | 484ee33 | 2018-10-25 17:38:05 +0100 | [diff] [blame] | 2986 | * |
| 2987 | */ |
Manuel Pégourié-Gonnard | de7636e | 2019-02-01 12:33:29 +0100 | [diff] [blame] | 2988 | #define MBEDTLS_PSA_CRYPTO_C |
Jaeden Amero | 484ee33 | 2018-10-25 17:38:05 +0100 | [diff] [blame] | 2989 | |
| 2990 | /** |
Gilles Peskine | a8ade16 | 2019-06-26 11:24:49 +0200 | [diff] [blame] | 2991 | * \def MBEDTLS_PSA_CRYPTO_SE_C |
| 2992 | * |
Gilles Peskine | 98473c4 | 2022-06-20 18:46:22 +0200 | [diff] [blame] | 2993 | * Enable dynamic secure element support in the Platform Security Architecture |
Gilles Peskine | a8ade16 | 2019-06-26 11:24:49 +0200 | [diff] [blame] | 2994 | * cryptography API. |
| 2995 | * |
Gilles Peskine | 98473c4 | 2022-06-20 18:46:22 +0200 | [diff] [blame] | 2996 | * \deprecated This feature is deprecated. Please switch to the driver |
| 2997 | * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS. |
Gilles Peskine | d0e66b0 | 2019-07-24 13:52:51 +0200 | [diff] [blame] | 2998 | * |
Gilles Peskine | a8ade16 | 2019-06-26 11:24:49 +0200 | [diff] [blame] | 2999 | * Module: library/psa_crypto_se.c |
| 3000 | * |
| 3001 | * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C |
| 3002 | * |
| 3003 | */ |
Gilles Peskine | d0e66b0 | 2019-07-24 13:52:51 +0200 | [diff] [blame] | 3004 | //#define MBEDTLS_PSA_CRYPTO_SE_C |
Gilles Peskine | a8ade16 | 2019-06-26 11:24:49 +0200 | [diff] [blame] | 3005 | |
| 3006 | /** |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3007 | * \def MBEDTLS_PSA_CRYPTO_STORAGE_C |
| 3008 | * |
| 3009 | * Enable the Platform Security Architecture persistent key storage. |
| 3010 | * |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 3011 | * Module: library/psa_crypto_storage.c |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3012 | * |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 3013 | * Requires: MBEDTLS_PSA_CRYPTO_C, |
| 3014 | * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of |
| 3015 | * the PSA ITS interface |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3016 | */ |
Darryl Green | db2b8db | 2018-06-15 13:06:04 +0100 | [diff] [blame] | 3017 | #define MBEDTLS_PSA_CRYPTO_STORAGE_C |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3018 | |
| 3019 | /** |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 3020 | * \def MBEDTLS_PSA_ITS_FILE_C |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3021 | * |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 3022 | * Enable the emulation of the Platform Security Architecture |
| 3023 | * Internal Trusted Storage (PSA ITS) over files. |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3024 | * |
Gilles Peskine | 6194dc2 | 2018-11-16 22:24:15 +0100 | [diff] [blame] | 3025 | * Module: library/psa_its_file.c |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3026 | * |
Jaeden Amero | 57f4d9e | 2019-03-15 16:14:19 +0000 | [diff] [blame] | 3027 | * Requires: MBEDTLS_FS_IO |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3028 | */ |
Gilles Peskine | 6194dc2 | 2018-11-16 22:24:15 +0100 | [diff] [blame] | 3029 | #define MBEDTLS_PSA_ITS_FILE_C |
Andrzej Kurek | c690523 | 2019-02-05 05:23:41 -0500 | [diff] [blame] | 3030 | |
| 3031 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3032 | * \def MBEDTLS_RIPEMD160_C |
Manuel Pégourié-Gonnard | cab4a88 | 2014-01-17 12:42:35 +0100 | [diff] [blame] | 3033 | * |
| 3034 | * Enable the RIPEMD-160 hash algorithm. |
| 3035 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3036 | * Module: library/ripemd160.c |
| 3037 | * Caller: library/md.c |
Manuel Pégourié-Gonnard | cab4a88 | 2014-01-17 12:42:35 +0100 | [diff] [blame] | 3038 | * |
| 3039 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3040 | #define MBEDTLS_RIPEMD160_C |
Manuel Pégourié-Gonnard | cab4a88 | 2014-01-17 12:42:35 +0100 | [diff] [blame] | 3041 | |
| 3042 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3043 | * \def MBEDTLS_RSA_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3044 | * |
| 3045 | * Enable the RSA public-key cryptosystem. |
| 3046 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3047 | * Module: library/rsa.c |
Chris Jones | 3848e31 | 2021-03-11 16:17:59 +0000 | [diff] [blame] | 3048 | * library/rsa_alt_helpers.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3049 | * Caller: library/pk.c |
| 3050 | * library/psa_crypto.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3051 | * library/ssl_tls.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3052 | * library/ssl*_client.c |
| 3053 | * library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3054 | * |
Manuel Pégourié-Gonnard | 9d70373 | 2013-10-25 18:01:50 +0200 | [diff] [blame] | 3055 | * This module is used by the following key exchanges: |
| 3056 | * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 3057 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3058 | * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3059 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3060 | #define MBEDTLS_RSA_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3061 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3062 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3063 | * \def MBEDTLS_SHA1_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3064 | * |
| 3065 | * Enable the SHA1 cryptographic hash algorithm. |
| 3066 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3067 | * Module: library/sha1.c |
| 3068 | * Caller: library/md.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3069 | * library/psa_crypto_hash.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3070 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 3071 | * This module is required for TLS 1.2 depending on the handshake parameters, |
| 3072 | * and for SHA1-signed certificates. |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 3073 | * |
| 3074 | * \warning SHA-1 is considered a weak message digest and its use constitutes |
| 3075 | * a security risk. If possible, we recommend avoiding dependencies |
| 3076 | * on it, and considering stronger message digests instead. |
| 3077 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3078 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3079 | #define MBEDTLS_SHA1_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3080 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3081 | /** |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3082 | * \def MBEDTLS_SHA224_C |
| 3083 | * |
| 3084 | * Enable the SHA-224 cryptographic hash algorithm. |
| 3085 | * |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3086 | * Module: library/sha256.c |
| 3087 | * Caller: library/md.c |
| 3088 | * library/ssl_cookie.c |
| 3089 | * |
| 3090 | * This module adds support for SHA-224. |
| 3091 | */ |
| 3092 | #define MBEDTLS_SHA224_C |
| 3093 | |
| 3094 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3095 | * \def MBEDTLS_SHA256_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3096 | * |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3097 | * Enable the SHA-256 cryptographic hash algorithm. |
| 3098 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3099 | * Module: library/sha256.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 3100 | * Caller: library/entropy.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3101 | * library/md.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 3102 | * library/ssl_tls.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3103 | * library/ssl*_client.c |
| 3104 | * library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3105 | * |
Mateusz Starzyk | e3c48b4 | 2021-04-19 16:46:28 +0200 | [diff] [blame] | 3106 | * This module adds support for SHA-256. |
Paul Bakker | 769075d | 2012-11-24 11:26:46 +0100 | [diff] [blame] | 3107 | * This module is required for the SSL/TLS 1.2 PRF function. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3108 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3109 | #define MBEDTLS_SHA256_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3110 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3111 | /** |
Tom Cosgrove | f3ebd90 | 2022-02-20 22:25:31 +0000 | [diff] [blame] | 3112 | * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT |
| 3113 | * |
Gilles Peskine | 9b3278b | 2022-06-09 19:09:38 +0200 | [diff] [blame] | 3114 | * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms |
| 3115 | * with the ARMv8 cryptographic extensions if they are available at runtime. |
| 3116 | * If not, the library will fall back to the C implementation. |
Tom Cosgrove | f3ebd90 | 2022-02-20 22:25:31 +0000 | [diff] [blame] | 3117 | * |
| 3118 | * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building |
| 3119 | * for a non-Aarch64 build it will be silently ignored. |
| 3120 | * |
| 3121 | * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum |
| 3122 | * of \c -march=armv8-a+crypto. |
| 3123 | * |
| 3124 | * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the |
| 3125 | * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY. |
| 3126 | * |
| 3127 | * Requires: MBEDTLS_SHA256_C. |
| 3128 | * |
| 3129 | * Module: library/sha256.c |
| 3130 | * |
| 3131 | * Uncomment to have the library check for the A64 SHA-256 crypto extensions |
| 3132 | * and use them if available. |
| 3133 | */ |
| 3134 | //#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT |
| 3135 | |
| 3136 | /** |
| 3137 | * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY |
| 3138 | * |
Gilles Peskine | 9b3278b | 2022-06-09 19:09:38 +0200 | [diff] [blame] | 3139 | * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms |
| 3140 | * with the ARMv8 cryptographic extensions, which must be available at runtime |
| 3141 | * or else an illegal instruction fault will occur. |
Tom Cosgrove | f3ebd90 | 2022-02-20 22:25:31 +0000 | [diff] [blame] | 3142 | * |
| 3143 | * \note This allows builds with a smaller code size than with |
| 3144 | * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT |
| 3145 | * |
| 3146 | * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum |
| 3147 | * of \c -march=armv8-a+crypto. |
| 3148 | * |
| 3149 | * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same |
| 3150 | * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT. |
| 3151 | * |
| 3152 | * Requires: MBEDTLS_SHA256_C. |
| 3153 | * |
| 3154 | * Module: library/sha256.c |
| 3155 | * |
| 3156 | * Uncomment to have the library use the A64 SHA-256 crypto extensions |
| 3157 | * unconditionally. |
| 3158 | */ |
| 3159 | //#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY |
| 3160 | |
| 3161 | /** |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3162 | * \def MBEDTLS_SHA384_C |
Mateusz Starzyk | e3c48b4 | 2021-04-19 16:46:28 +0200 | [diff] [blame] | 3163 | * |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3164 | * Enable the SHA-384 cryptographic hash algorithm. |
Mateusz Starzyk | e3c48b4 | 2021-04-19 16:46:28 +0200 | [diff] [blame] | 3165 | * |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3166 | * Module: library/sha512.c |
| 3167 | * Caller: library/md.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3168 | * library/psa_crypto_hash.c |
| 3169 | * library/ssl_tls.c |
| 3170 | * library/ssl*_client.c |
| 3171 | * library/ssl*_server.c |
Mateusz Starzyk | e3c48b4 | 2021-04-19 16:46:28 +0200 | [diff] [blame] | 3172 | * |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3173 | * Comment to disable SHA-384 |
Mateusz Starzyk | e3c48b4 | 2021-04-19 16:46:28 +0200 | [diff] [blame] | 3174 | */ |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3175 | #define MBEDTLS_SHA384_C |
Mateusz Starzyk | e3c48b4 | 2021-04-19 16:46:28 +0200 | [diff] [blame] | 3176 | |
| 3177 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3178 | * \def MBEDTLS_SHA512_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3179 | * |
Mateusz Starzyk | 3352a53 | 2021-04-06 14:28:22 +0200 | [diff] [blame] | 3180 | * Enable SHA-512 cryptographic hash algorithms. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3181 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3182 | * Module: library/sha512.c |
Manuel Pégourié-Gonnard | fe28646 | 2013-09-20 14:10:14 +0200 | [diff] [blame] | 3183 | * Caller: library/entropy.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3184 | * library/md.c |
Mateusz Starzyk | 6326a8d | 2021-05-10 13:51:53 +0200 | [diff] [blame] | 3185 | * library/ssl_tls.c |
| 3186 | * library/ssl_cookie.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3187 | * |
Mateusz Starzyk | 3352a53 | 2021-04-06 14:28:22 +0200 | [diff] [blame] | 3188 | * This module adds support for SHA-512. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3189 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3190 | #define MBEDTLS_SHA512_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3191 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3192 | /** |
Tom Cosgrove | 87fbfb5 | 2022-03-15 10:51:52 +0000 | [diff] [blame] | 3193 | * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT |
| 3194 | * |
Gilles Peskine | 9b3278b | 2022-06-09 19:09:38 +0200 | [diff] [blame] | 3195 | * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms |
| 3196 | * with the ARMv8 cryptographic extensions if they are available at runtime. |
| 3197 | * If not, the library will fall back to the C implementation. |
Tom Cosgrove | 87fbfb5 | 2022-03-15 10:51:52 +0000 | [diff] [blame] | 3198 | * |
| 3199 | * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building |
| 3200 | * for a non-Aarch64 build it will be silently ignored. |
| 3201 | * |
| 3202 | * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or |
| 3203 | * Clang >= 7, and \c CFLAGS must be set to a minimum of |
| 3204 | * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the |
| 3205 | * fastest code. |
| 3206 | * |
| 3207 | * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the |
| 3208 | * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY. |
| 3209 | * |
| 3210 | * Requires: MBEDTLS_SHA512_C. |
| 3211 | * |
| 3212 | * Module: library/sha512.c |
| 3213 | * |
| 3214 | * Uncomment to have the library check for the A64 SHA-512 crypto extensions |
| 3215 | * and use them if available. |
| 3216 | */ |
| 3217 | //#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT |
| 3218 | |
| 3219 | /** |
| 3220 | * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY |
| 3221 | * |
Gilles Peskine | 9b3278b | 2022-06-09 19:09:38 +0200 | [diff] [blame] | 3222 | * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms |
| 3223 | * with the ARMv8 cryptographic extensions, which must be available at runtime |
| 3224 | * or else an illegal instruction fault will occur. |
Tom Cosgrove | 87fbfb5 | 2022-03-15 10:51:52 +0000 | [diff] [blame] | 3225 | * |
| 3226 | * \note This allows builds with a smaller code size than with |
| 3227 | * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT |
| 3228 | * |
| 3229 | * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or |
| 3230 | * Clang >= 7, and \c CFLAGS must be set to a minimum of |
| 3231 | * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the |
| 3232 | * fastest code. |
| 3233 | * |
| 3234 | * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same |
| 3235 | * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT. |
| 3236 | * |
| 3237 | * Requires: MBEDTLS_SHA512_C. |
| 3238 | * |
| 3239 | * Module: library/sha512.c |
| 3240 | * |
| 3241 | * Uncomment to have the library use the A64 SHA-512 crypto extensions |
| 3242 | * unconditionally. |
| 3243 | */ |
| 3244 | //#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY |
| 3245 | |
| 3246 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3247 | * \def MBEDTLS_SSL_CACHE_C |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3248 | * |
| 3249 | * Enable simple SSL cache implementation. |
| 3250 | * |
| 3251 | * Module: library/ssl_cache.c |
| 3252 | * Caller: |
| 3253 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3254 | * Requires: MBEDTLS_SSL_CACHE_C |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3255 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3256 | #define MBEDTLS_SSL_CACHE_C |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 3257 | |
| 3258 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3259 | * \def MBEDTLS_SSL_COOKIE_C |
Manuel Pégourié-Gonnard | a64acd4 | 2014-07-23 18:30:45 +0200 | [diff] [blame] | 3260 | * |
| 3261 | * Enable basic implementation of DTLS cookies for hello verification. |
| 3262 | * |
| 3263 | * Module: library/ssl_cookie.c |
| 3264 | * Caller: |
Manuel Pégourié-Gonnard | a64acd4 | 2014-07-23 18:30:45 +0200 | [diff] [blame] | 3265 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3266 | #define MBEDTLS_SSL_COOKIE_C |
Manuel Pégourié-Gonnard | a64acd4 | 2014-07-23 18:30:45 +0200 | [diff] [blame] | 3267 | |
| 3268 | /** |
Manuel Pégourié-Gonnard | fd6d897 | 2015-05-15 12:09:00 +0200 | [diff] [blame] | 3269 | * \def MBEDTLS_SSL_TICKET_C |
| 3270 | * |
| 3271 | * Enable an implementation of TLS server-side callbacks for session tickets. |
| 3272 | * |
| 3273 | * Module: library/ssl_ticket.c |
| 3274 | * Caller: |
Manuel Pégourié-Gonnard | 0c0f11f | 2015-05-20 09:55:50 +0200 | [diff] [blame] | 3275 | * |
Przemek Stekiel | 52a428b | 2022-10-10 08:47:13 +0200 | [diff] [blame] | 3276 | * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) && |
| 3277 | * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C) |
Manuel Pégourié-Gonnard | fd6d897 | 2015-05-15 12:09:00 +0200 | [diff] [blame] | 3278 | */ |
| 3279 | #define MBEDTLS_SSL_TICKET_C |
| 3280 | |
| 3281 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3282 | * \def MBEDTLS_SSL_CLI_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3283 | * |
| 3284 | * Enable the SSL/TLS client code. |
| 3285 | * |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3286 | * Module: library/ssl*_client.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3287 | * Caller: |
| 3288 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3289 | * Requires: MBEDTLS_SSL_TLS_C |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 3290 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3291 | * This module is required for SSL/TLS client support. |
| 3292 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3293 | #define MBEDTLS_SSL_CLI_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3294 | |
Paul Bakker | 9a73632 | 2012-11-14 12:39:52 +0000 | [diff] [blame] | 3295 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3296 | * \def MBEDTLS_SSL_SRV_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3297 | * |
| 3298 | * Enable the SSL/TLS server code. |
| 3299 | * |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3300 | * Module: library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3301 | * Caller: |
| 3302 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3303 | * Requires: MBEDTLS_SSL_TLS_C |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 3304 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3305 | * This module is required for SSL/TLS server support. |
| 3306 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3307 | #define MBEDTLS_SSL_SRV_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3308 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3309 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3310 | * \def MBEDTLS_SSL_TLS_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3311 | * |
Paul Bakker | e29ab06 | 2011-05-18 13:26:54 +0000 | [diff] [blame] | 3312 | * Enable the generic SSL/TLS code. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3313 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3314 | * Module: library/ssl_tls.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3315 | * Caller: library/ssl*_client.c |
| 3316 | * library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3317 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3318 | * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C |
| 3319 | * and at least one of the MBEDTLS_SSL_PROTO_XXX defines |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 3320 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3321 | * This module is required for SSL/TLS. |
| 3322 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3323 | #define MBEDTLS_SSL_TLS_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3324 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3325 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3326 | * \def MBEDTLS_THREADING_C |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 3327 | * |
| 3328 | * Enable the threading abstraction layer. |
Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 3329 | * By default mbed TLS assumes it is used in a non-threaded environment or that |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 3330 | * contexts are not shared between threads. If you do intend to use contexts |
| 3331 | * between threads, you will need to enable this layer to prevent race |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 3332 | * conditions. See also our Knowledge Base article about threading: |
Dave Rodgman | b319684 | 2022-10-12 16:47:08 +0100 | [diff] [blame] | 3333 | * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 3334 | * |
| 3335 | * Module: library/threading.c |
| 3336 | * |
| 3337 | * This allows different threading implementations (self-implemented or |
| 3338 | * provided). |
| 3339 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3340 | * You will have to enable either MBEDTLS_THREADING_ALT or |
| 3341 | * MBEDTLS_THREADING_PTHREAD. |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 3342 | * |
Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 3343 | * Enable this layer to allow use of mutexes within mbed TLS |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 3344 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3345 | //#define MBEDTLS_THREADING_C |
Paul Bakker | 2466d93 | 2013-09-28 14:40:38 +0200 | [diff] [blame] | 3346 | |
| 3347 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3348 | * \def MBEDTLS_TIMING_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3349 | * |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 3350 | * Enable the semi-portable timing interface. |
| 3351 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 3352 | * \note The provided implementation only works on POSIX/Unix (including Linux, |
| 3353 | * BSD and OS X) and Windows. On other platforms, you can either disable that |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 3354 | * module and provide your own implementations of the callbacks needed by |
| 3355 | * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide |
| 3356 | * your own implementation of the whole module by setting |
| 3357 | * \c MBEDTLS_TIMING_ALT in the current file. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3358 | * |
Andrzej Kurek | 5735369 | 2022-04-07 08:08:21 -0400 | [diff] [blame] | 3359 | * \note The timing module will include time.h on suitable platforms |
| 3360 | * regardless of the setting of MBEDTLS_HAVE_TIME, unless |
| 3361 | * MBEDTLS_TIMING_ALT is used. See timing.c for more information. |
| 3362 | * |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 3363 | * \note See also our Knowledge Base article about porting to a new |
| 3364 | * environment: |
Dave Rodgman | b319684 | 2022-10-12 16:47:08 +0100 | [diff] [blame] | 3365 | * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 3366 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3367 | * Module: library/timing.c |
Paul Bakker | ecd54fb | 2013-07-03 14:48:29 +0200 | [diff] [blame] | 3368 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3369 | #define MBEDTLS_TIMING_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3370 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3371 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3372 | * \def MBEDTLS_VERSION_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3373 | * |
| 3374 | * Enable run-time version information. |
| 3375 | * |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 3376 | * Module: library/version.c |
| 3377 | * |
| 3378 | * This module provides run-time version information. |
| 3379 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3380 | #define MBEDTLS_VERSION_C |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 3381 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3382 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3383 | * \def MBEDTLS_X509_USE_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3384 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 3385 | * Enable X.509 core for using certificates. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3386 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3387 | * Module: library/x509.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3388 | * Caller: library/x509_crl.c |
| 3389 | * library/x509_crt.c |
| 3390 | * library/x509_csr.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3391 | * |
Przemek Stekiel | 10836a0 | 2022-08-19 08:45:34 +0200 | [diff] [blame] | 3392 | * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C, |
Przemek Stekiel | 278b667 | 2022-08-03 09:50:38 +0200 | [diff] [blame] | 3393 | * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO) |
| 3394 | * |
Manuel Pégourié-Gonnard | 72687b7 | 2022-09-15 12:23:58 +0200 | [diff] [blame] | 3395 | * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call |
| 3396 | * psa_crypto_init() before doing any X.509 operation. |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 3397 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3398 | * This module is required for the X.509 parsing modules. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3399 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3400 | #define MBEDTLS_X509_USE_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 3401 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 3402 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3403 | * \def MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 3404 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3405 | * Enable X.509 certificate parsing. |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 3406 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3407 | * Module: library/x509_crt.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 3408 | * Caller: library/ssl_tls.c |
| 3409 | * library/ssl*_client.c |
| 3410 | * library/ssl*_server.c |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3411 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3412 | * Requires: MBEDTLS_X509_USE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3413 | * |
| 3414 | * This module is required for X.509 certificate parsing. |
| 3415 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3416 | #define MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3417 | |
| 3418 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3419 | * \def MBEDTLS_X509_CRL_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3420 | * |
| 3421 | * Enable X.509 CRL parsing. |
| 3422 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3423 | * Module: library/x509_crl.c |
| 3424 | * Caller: library/x509_crt.c |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3425 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3426 | * Requires: MBEDTLS_X509_USE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3427 | * |
| 3428 | * This module is required for X.509 CRL parsing. |
| 3429 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3430 | #define MBEDTLS_X509_CRL_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3431 | |
| 3432 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3433 | * \def MBEDTLS_X509_CSR_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3434 | * |
| 3435 | * Enable X.509 Certificate Signing Request (CSR) parsing. |
| 3436 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 3437 | * Module: library/x509_csr.c |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3438 | * Caller: library/x509_crt_write.c |
| 3439 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3440 | * Requires: MBEDTLS_X509_USE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3441 | * |
| 3442 | * This module is used for reading X.509 certificate request. |
| 3443 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3444 | #define MBEDTLS_X509_CSR_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3445 | |
| 3446 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3447 | * \def MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3448 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 3449 | * Enable X.509 core for creating certificates. |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3450 | * |
| 3451 | * Module: library/x509_create.c |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 3452 | * |
Przemek Stekiel | 10836a0 | 2022-08-19 08:45:34 +0200 | [diff] [blame] | 3453 | * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C, |
Przemek Stekiel | 278b667 | 2022-08-03 09:50:38 +0200 | [diff] [blame] | 3454 | * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO) |
| 3455 | * |
Manuel Pégourié-Gonnard | 72687b7 | 2022-09-15 12:23:58 +0200 | [diff] [blame] | 3456 | * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call |
| 3457 | * psa_crypto_init() before doing any X.509 create operation. |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 3458 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3459 | * This module is the basis for creating X.509 certificates and CSRs. |
| 3460 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3461 | #define MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3462 | |
| 3463 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3464 | * \def MBEDTLS_X509_CRT_WRITE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3465 | * |
| 3466 | * Enable creating X.509 certificates. |
| 3467 | * |
| 3468 | * Module: library/x509_crt_write.c |
| 3469 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3470 | * Requires: MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3471 | * |
| 3472 | * This module is required for X.509 certificate creation. |
| 3473 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3474 | #define MBEDTLS_X509_CRT_WRITE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3475 | |
| 3476 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3477 | * \def MBEDTLS_X509_CSR_WRITE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3478 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 3479 | * Enable creating X.509 Certificate Signing Requests (CSR). |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3480 | * |
| 3481 | * Module: library/x509_csr_write.c |
| 3482 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3483 | * Requires: MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3484 | * |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 3485 | * This module is required for X.509 certificate request writing. |
| 3486 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3487 | #define MBEDTLS_X509_CSR_WRITE_C |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 3488 | |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 3489 | /** \} name SECTION: mbed TLS modules */ |
Paul Bakker | 7a7c78f | 2009-01-04 18:15:48 +0000 | [diff] [blame] | 3490 | |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3491 | /** |
Gilles Peskine | ba4162a | 2022-04-11 17:04:38 +0200 | [diff] [blame] | 3492 | * \name SECTION: General configuration options |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3493 | * |
Gilles Peskine | d5793ce | 2022-04-13 23:05:10 +0200 | [diff] [blame] | 3494 | * This section contains Mbed TLS build settings that are not associated |
| 3495 | * with a particular module. |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3496 | * |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3497 | * \{ |
| 3498 | */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3499 | |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3500 | /** |
| 3501 | * \def MBEDTLS_CONFIG_FILE |
| 3502 | * |
| 3503 | * If defined, this is a header which will be included instead of |
| 3504 | * `"mbedtls/mbedtls_config.h"`. |
| 3505 | * This header file specifies the compile-time configuration of Mbed TLS. |
Gilles Peskine | efffd64 | 2022-04-26 18:13:01 +0200 | [diff] [blame] | 3506 | * Unlike other configuration options, this one must be defined on the |
| 3507 | * compiler command line: a definition in `mbedtls_config.h` would have |
| 3508 | * no effect. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3509 | * |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3510 | * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3511 | * non-standard feature of the C language, so this feature is only available |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3512 | * with compilers that perform macro expansion on an <tt>\#include</tt> line. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3513 | * |
Gilles Peskine | 58ffcba | 2022-04-14 12:44:16 +0200 | [diff] [blame] | 3514 | * The value of this symbol is typically a path in double quotes, either |
| 3515 | * absolute or relative to a directory on the include search path. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3516 | */ |
| 3517 | //#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h" |
| 3518 | |
| 3519 | /** |
| 3520 | * \def MBEDTLS_USER_CONFIG_FILE |
| 3521 | * |
| 3522 | * If defined, this is a header which will be included after |
| 3523 | * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE. |
Gilles Peskine | f68f43a | 2022-04-13 23:22:20 +0200 | [diff] [blame] | 3524 | * This allows you to modify the default configuration, including the ability |
| 3525 | * to undefine options that are enabled by default. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3526 | * |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3527 | * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3528 | * non-standard feature of the C language, so this feature is only available |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3529 | * with compilers that perform macro expansion on an <tt>\#include</tt> line. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3530 | * |
Gilles Peskine | 58ffcba | 2022-04-14 12:44:16 +0200 | [diff] [blame] | 3531 | * The value of this symbol is typically a path in double quotes, either |
| 3532 | * absolute or relative to a directory on the include search path. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 3533 | */ |
| 3534 | //#define MBEDTLS_USER_CONFIG_FILE "/dev/null" |
| 3535 | |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3536 | /** |
| 3537 | * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE |
| 3538 | * |
| 3539 | * If defined, this is a header which will be included instead of |
| 3540 | * `"psa/crypto_config.h"`. |
| 3541 | * This header file specifies which cryptographic mechanisms are available |
| 3542 | * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and |
| 3543 | * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled. |
| 3544 | * |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3545 | * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3546 | * non-standard feature of the C language, so this feature is only available |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3547 | * with compilers that perform macro expansion on an <tt>\#include</tt> line. |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3548 | * |
Gilles Peskine | 58ffcba | 2022-04-14 12:44:16 +0200 | [diff] [blame] | 3549 | * The value of this symbol is typically a path in double quotes, either |
| 3550 | * absolute or relative to a directory on the include search path. |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3551 | */ |
| 3552 | //#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h" |
| 3553 | |
| 3554 | /** |
| 3555 | * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE |
| 3556 | * |
| 3557 | * If defined, this is a header which will be included after |
| 3558 | * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE. |
Gilles Peskine | f68f43a | 2022-04-13 23:22:20 +0200 | [diff] [blame] | 3559 | * This allows you to modify the default configuration, including the ability |
| 3560 | * to undefine options that are enabled by default. |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3561 | * |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3562 | * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3563 | * non-standard feature of the C language, so this feature is only available |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 3564 | * with compilers that perform macro expansion on an <tt>\#include</tt> line. |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3565 | * |
Gilles Peskine | 58ffcba | 2022-04-14 12:44:16 +0200 | [diff] [blame] | 3566 | * The value of this symbol is typically a path in double quotes, either |
| 3567 | * absolute or relative to a directory on the include search path. |
Gilles Peskine | f4c6eb0 | 2022-03-16 17:10:48 +0100 | [diff] [blame] | 3568 | */ |
| 3569 | //#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null" |
| 3570 | |
Gilles Peskine | ba4162a | 2022-04-11 17:04:38 +0200 | [diff] [blame] | 3571 | /** \} name SECTION: General configuration options */ |
| 3572 | |
| 3573 | /** |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3574 | * \name SECTION: Module configuration options |
| 3575 | * |
| 3576 | * This section allows for the setting of module specific sizes and |
| 3577 | * configuration options. The default values are already present in the |
| 3578 | * relevant header files and should suffice for the regular use cases. |
| 3579 | * |
| 3580 | * Our advice is to enable options and change their values here |
| 3581 | * only if you have a good reason and know the consequences. |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3582 | * \{ |
| 3583 | */ |
Gilles Peskine | 3f49cc1 | 2022-04-13 23:21:16 +0200 | [diff] [blame] | 3584 | /* The Doxygen documentation here is used when a user comments out a |
| 3585 | * setting and runs doxygen themselves. On the other hand, when we typeset |
| 3586 | * the full documentation including disabled settings, the documentation |
| 3587 | * in specific modules' header files is used if present. When editing this |
| 3588 | * file, make sure that each option is documented in exactly one place, |
| 3589 | * plus optionally a same-line Doxygen comment here if there is a Doxygen |
| 3590 | * comment in the specific module. */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3591 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3592 | /* MPI / BIGNUM options */ |
Andrzej Kurek | 86f30ff | 2023-02-24 07:44:57 -0500 | [diff] [blame] | 3593 | //#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3594 | //#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3595 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3596 | /* CTR_DRBG options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3597 | //#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */ |
| 3598 | //#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */ |
| 3599 | //#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */ |
| 3600 | //#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */ |
| 3601 | //#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3602 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3603 | /* HMAC_DRBG options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3604 | //#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */ |
| 3605 | //#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */ |
| 3606 | //#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */ |
| 3607 | //#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3608 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3609 | /* ECP options */ |
Gilles Peskine | 5752e59 | 2021-06-02 13:27:03 +0200 | [diff] [blame] | 3610 | //#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3611 | //#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */ |
Manuel Pégourié-Gonnard | 0520b60 | 2014-01-30 19:43:46 +0100 | [diff] [blame] | 3612 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3613 | /* Entropy options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3614 | //#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */ |
| 3615 | //#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */ |
Andres AG | 7abc974 | 2016-09-23 17:58:49 +0100 | [diff] [blame] | 3616 | //#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 Bakker | e1b665e | 2013-12-11 16:02:58 +0100 | [diff] [blame] | 3617 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3618 | /* Memory buffer allocator options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3619 | //#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3620 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3621 | /* Platform options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3622 | //#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é-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 3623 | //#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3624 | //#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */ |
Gilles Peskine | 6497b5a | 2022-06-30 17:01:40 +0200 | [diff] [blame] | 3625 | //#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3626 | //#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */ |
Andres Amaya Garcia | 1e4ec66 | 2016-07-20 10:16:25 +0100 | [diff] [blame] | 3627 | //#define MBEDTLS_PLATFORM_STD_TIME time /**< Default time to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3628 | //#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */ |
| 3629 | //#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */ |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 3630 | /* Note: your snprintf must correctly zero-terminate the buffer! */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3631 | //#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */ |
Janos Follath | 9194744 | 2016-03-18 13:49:27 +0000 | [diff] [blame] | 3632 | //#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */ |
| 3633 | //#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */ |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 3634 | //#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */ |
| 3635 | //#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */ |
| 3636 | //#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */ |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 3637 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3638 | /* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */ |
| 3639 | /* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */ |
Manuel Pégourié-Gonnard | b9ef118 | 2015-05-26 16:15:20 +0200 | [diff] [blame] | 3640 | //#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3641 | //#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */ |
| 3642 | //#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */ |
Gilles Peskine | 6497b5a | 2022-06-30 17:01:40 +0200 | [diff] [blame] | 3643 | //#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */ |
Andres Amaya Garcia | 1e4ec66 | 2016-07-20 10:16:25 +0100 | [diff] [blame] | 3644 | //#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */ |
| 3645 | //#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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3646 | //#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */ |
| 3647 | //#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */ |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 3648 | /* Note: your snprintf must correctly zero-terminate the buffer! */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3649 | //#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */ |
k-stachowiak | 723f867 | 2018-07-16 14:27:07 +0200 | [diff] [blame] | 3650 | //#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */ |
Paul Bakker | cf0a9f9 | 2016-06-01 11:25:44 +0100 | [diff] [blame] | 3651 | //#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */ |
| 3652 | //#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3653 | |
Gilles Peskine | 3f106f7 | 2021-09-23 17:42:39 +0200 | [diff] [blame] | 3654 | /** \def MBEDTLS_CHECK_RETURN |
| 3655 | * |
| 3656 | * This macro is used at the beginning of the declaration of a function |
| 3657 | * to indicate that its return value should be checked. It should |
| 3658 | * instruct the compiler to emit a warning or an error if the function |
| 3659 | * is called without checking its return value. |
| 3660 | * |
| 3661 | * There is a default implementation for popular compilers in platform_util.h. |
| 3662 | * You can override the default implementation by defining your own here. |
| 3663 | * |
| 3664 | * If the implementation here is empty, this will effectively disable the |
| 3665 | * checking of functions' return values. |
| 3666 | */ |
Gilles Peskine | cd79dfc | 2021-09-30 18:53:36 +0200 | [diff] [blame] | 3667 | //#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__)) |
Gilles Peskine | 3f106f7 | 2021-09-23 17:42:39 +0200 | [diff] [blame] | 3668 | |
Gilles Peskine | fcc93d7 | 2021-09-30 18:56:17 +0200 | [diff] [blame] | 3669 | /** \def MBEDTLS_IGNORE_RETURN |
| 3670 | * |
| 3671 | * This macro requires one argument, which should be a C function call. |
| 3672 | * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this |
| 3673 | * warning is suppressed. |
| 3674 | */ |
| 3675 | //#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result)) |
| 3676 | |
Gilles Peskine | ed03890 | 2020-11-13 21:33:21 +0100 | [diff] [blame] | 3677 | /* PSA options */ |
Gilles Peskine | 14c332b | 2020-11-14 12:26:53 +0100 | [diff] [blame] | 3678 | /** |
Gilles Peskine | ed03890 | 2020-11-13 21:33:21 +0100 | [diff] [blame] | 3679 | * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the |
| 3680 | * PSA crypto subsystem. |
| 3681 | * |
| 3682 | * If this option is unset: |
| 3683 | * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG. |
Gilles Peskine | b0a748e | 2020-11-30 12:01:54 +0100 | [diff] [blame] | 3684 | * - Otherwise, the PSA subsystem uses HMAC_DRBG with either |
Gilles Peskine | ed03890 | 2020-11-13 21:33:21 +0100 | [diff] [blame] | 3685 | * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and |
| 3686 | * on unspecified heuristics. |
| 3687 | */ |
| 3688 | //#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256 |
| 3689 | |
Steven Cooreman | 863470a | 2021-02-15 14:03:19 +0100 | [diff] [blame] | 3690 | /** \def MBEDTLS_PSA_KEY_SLOT_COUNT |
Steven Cooreman | 1f968fd | 2021-02-15 14:00:24 +0100 | [diff] [blame] | 3691 | * Restrict the PSA library to supporting a maximum amount of simultaneously |
| 3692 | * loaded keys. A loaded key is a key stored by the PSA Crypto core as a |
| 3693 | * volatile key, or a persistent key which is loaded temporarily by the |
| 3694 | * library as part of a crypto operation in flight. |
| 3695 | * |
| 3696 | * If this option is unset, the library will fall back to a default value of |
| 3697 | * 32 keys. |
| 3698 | */ |
Steven Cooreman | 863470a | 2021-02-15 14:03:19 +0100 | [diff] [blame] | 3699 | //#define MBEDTLS_PSA_KEY_SLOT_COUNT 32 |
Steven Cooreman | 1f968fd | 2021-02-15 14:00:24 +0100 | [diff] [blame] | 3700 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3701 | /* SSL Cache options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3702 | //#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */ |
| 3703 | //#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3704 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 3705 | /* SSL options */ |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3706 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3707 | /** \def MBEDTLS_SSL_IN_CONTENT_LEN |
| 3708 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 3709 | * Maximum length (in bytes) of incoming plaintext fragments. |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3710 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 3711 | * This determines the size of the incoming TLS I/O buffer in such a way |
| 3712 | * that it is capable of holding the specified amount of plaintext data, |
| 3713 | * regardless of the protection mechanism used. |
| 3714 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 3715 | * \note When using a value less than the default of 16KB on the client, it is |
| 3716 | * recommended to use the Maximum Fragment Length (MFL) extension to |
| 3717 | * inform the server about this limitation. On the server, there |
| 3718 | * is no supported, standardized way of informing the client about |
| 3719 | * restriction on the maximum size of incoming messages, and unless |
| 3720 | * the limitation has been communicated by other means, it is recommended |
| 3721 | * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN |
| 3722 | * while keeping the default value of 16KB for the incoming buffer. |
| 3723 | * |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 3724 | * Uncomment to set the maximum plaintext size of the incoming I/O buffer. |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3725 | */ |
| 3726 | //#define MBEDTLS_SSL_IN_CONTENT_LEN 16384 |
| 3727 | |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 3728 | /** \def MBEDTLS_SSL_CID_IN_LEN_MAX |
| 3729 | * |
| 3730 | * The maximum length of CIDs used for incoming DTLS messages. |
| 3731 | * |
| 3732 | */ |
| 3733 | //#define MBEDTLS_SSL_CID_IN_LEN_MAX 32 |
| 3734 | |
| 3735 | /** \def MBEDTLS_SSL_CID_OUT_LEN_MAX |
| 3736 | * |
| 3737 | * The maximum length of CIDs used for outgoing DTLS messages. |
| 3738 | * |
| 3739 | */ |
| 3740 | //#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32 |
| 3741 | |
TRodziewicz | e8dd709 | 2021-05-12 14:19:11 +0200 | [diff] [blame] | 3742 | /** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 3743 | * |
| 3744 | * This option controls the use of record plaintext padding |
TRodziewicz | 1e660ed | 2021-05-26 17:08:54 +0200 | [diff] [blame] | 3745 | * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2. |
Hanno Becker | 1399692 | 2020-05-28 16:15:19 +0100 | [diff] [blame] | 3746 | * |
| 3747 | * The padding will always be chosen so that the length of the |
| 3748 | * padded plaintext is a multiple of the value of this option. |
| 3749 | * |
| 3750 | * Note: A value of \c 1 means that no padding will be used |
| 3751 | * for outgoing records. |
| 3752 | * |
| 3753 | * Note: On systems lacking division instructions, |
| 3754 | * a power of two should be preferred. |
| 3755 | */ |
TRodziewicz | e8dd709 | 2021-05-12 14:19:11 +0200 | [diff] [blame] | 3756 | //#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16 |
Hanno Becker | 1399692 | 2020-05-28 16:15:19 +0100 | [diff] [blame] | 3757 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3758 | /** \def MBEDTLS_SSL_OUT_CONTENT_LEN |
| 3759 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 3760 | * Maximum length (in bytes) of outgoing plaintext fragments. |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3761 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 3762 | * This determines the size of the outgoing TLS I/O buffer in such a way |
| 3763 | * that it is capable of holding the specified amount of plaintext data, |
| 3764 | * regardless of the protection mechanism used. |
| 3765 | * |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3766 | * It is possible to save RAM by setting a smaller outward buffer, while keeping |
| 3767 | * the default inward 16384 byte buffer to conform to the TLS specification. |
| 3768 | * |
| 3769 | * The minimum required outward buffer size is determined by the handshake |
| 3770 | * protocol's usage. Handshaking will fail if the outward buffer is too small. |
| 3771 | * The specific size requirement depends on the configured ciphers and any |
| 3772 | * certificate data which is sent during the handshake. |
| 3773 | * |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 3774 | * Uncomment to set the maximum plaintext size of the outgoing I/O buffer. |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 3775 | */ |
| 3776 | //#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384 |
| 3777 | |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 3778 | /** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING |
| 3779 | * |
| 3780 | * Maximum number of heap-allocated bytes for the purpose of |
| 3781 | * DTLS handshake message reassembly and future message buffering. |
| 3782 | * |
Yuto Takano | 7828ca2 | 2021-08-10 11:26:15 +0100 | [diff] [blame] | 3783 | * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN |
Hanno Becker | 2800751 | 2018-08-28 09:46:44 +0100 | [diff] [blame] | 3784 | * to account for a reassembled handshake message of maximum size, |
| 3785 | * together with its reassembly bitmap. |
| 3786 | * |
Hanno Becker | 97a1c13 | 2018-08-28 14:42:15 +0100 | [diff] [blame] | 3787 | * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default) |
Hanno Becker | 2800751 | 2018-08-28 09:46:44 +0100 | [diff] [blame] | 3788 | * should be sufficient for all practical situations as it allows |
| 3789 | * to reassembly a large handshake message (such as a certificate) |
| 3790 | * while buffering multiple smaller handshake messages. |
| 3791 | * |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 3792 | */ |
Hanno Becker | 159a37f | 2018-08-24 15:07:29 +0100 | [diff] [blame] | 3793 | //#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768 |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 3794 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3795 | //#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */ |
| 3796 | //#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 3797 | |
Manuel Pégourié-Gonnard | dfc7df0 | 2014-06-30 17:59:55 +0200 | [diff] [blame] | 3798 | /** |
| 3799 | * Complete list of ciphersuites to use, in order of preference. |
| 3800 | * |
| 3801 | * \warning No dependency checking is done on that field! This option can only |
| 3802 | * be used to restrict the set of available ciphersuites. It is your |
| 3803 | * responsibility to make sure the needed modules are active. |
| 3804 | * |
| 3805 | * Use this to save a few hundred bytes of ROM (default ordering of all |
| 3806 | * available ciphersuites) and a few to a few hundred bytes of RAM. |
| 3807 | * |
| 3808 | * The value below is only an example, not the default. |
| 3809 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3810 | //#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é-Gonnard | dfc7df0 | 2014-06-30 17:59:55 +0200 | [diff] [blame] | 3811 | |
Manuel Pégourié-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 3812 | /* X509 options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 3813 | //#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */ |
Andres AG | f911319 | 2016-09-02 14:06:04 +0100 | [diff] [blame] | 3814 | //#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é-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 3815 | |
Gilles Peskine | 5e79cb3 | 2017-05-04 16:17:21 +0200 | [diff] [blame] | 3816 | /** |
Andres Amaya Garcia | b1262a3 | 2017-10-25 09:51:14 +0100 | [diff] [blame] | 3817 | * Uncomment the macro to let mbed TLS use your alternate implementation of |
Andres Amaya Garcia | c58787f | 2018-04-17 10:21:45 -0500 | [diff] [blame] | 3818 | * mbedtls_platform_zeroize(). This replaces the default implementation in |
| 3819 | * platform_util.c. |
Andres Amaya Garcia | 6606d5c | 2018-03-08 20:25:29 +0000 | [diff] [blame] | 3820 | * |
Andres Amaya Garcia | c58787f | 2018-04-17 10:21:45 -0500 | [diff] [blame] | 3821 | * mbedtls_platform_zeroize() is a widely used function across the library to |
| 3822 | * zero a block of memory. The implementation is expected to be secure in the |
| 3823 | * sense that it has been written to prevent the compiler from removing calls |
| 3824 | * to mbedtls_platform_zeroize() as part of redundant code elimination |
| 3825 | * optimizations. However, it is difficult to guarantee that calls to |
| 3826 | * mbedtls_platform_zeroize() will not be optimized by the compiler as older |
| 3827 | * versions of the C language standards do not provide a secure implementation |
| 3828 | * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to |
| 3829 | * configure their own implementation of mbedtls_platform_zeroize(), for |
Andres Amaya Garcia | d0ef468 | 2018-04-24 08:31:34 -0500 | [diff] [blame] | 3830 | * example by using directives specific to their compiler, features from newer |
| 3831 | * C standards (e.g using memset_s() in C11) or calling a secure memset() from |
Andres Amaya Garcia | c58787f | 2018-04-17 10:21:45 -0500 | [diff] [blame] | 3832 | * their system (e.g explicit_bzero() in BSD). |
Andres Amaya Garcia | b1262a3 | 2017-10-25 09:51:14 +0100 | [diff] [blame] | 3833 | */ |
Andres Amaya Garcia | c58787f | 2018-04-17 10:21:45 -0500 | [diff] [blame] | 3834 | //#define MBEDTLS_PLATFORM_ZEROIZE_ALT |
Andres Amaya Garcia | b1262a3 | 2017-10-25 09:51:14 +0100 | [diff] [blame] | 3835 | |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3836 | /** |
| 3837 | * Uncomment the macro to let Mbed TLS use your alternate implementation of |
Hanno Becker | 6a73978 | 2018-09-05 15:06:19 +0100 | [diff] [blame] | 3838 | * mbedtls_platform_gmtime_r(). This replaces the default implementation in |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3839 | * platform_util.c. |
| 3840 | * |
Hanno Becker | 921b76d | 2018-09-05 16:21:36 +0100 | [diff] [blame] | 3841 | * gmtime() is not a thread-safe function as defined in the C standard. The |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3842 | * library will try to use safer implementations of this function, such as |
| 3843 | * gmtime_r() when available. However, if Mbed TLS cannot identify the target |
Hanno Becker | 6a73978 | 2018-09-05 15:06:19 +0100 | [diff] [blame] | 3844 | * system, the implementation of mbedtls_platform_gmtime_r() will default to |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3845 | * using the standard gmtime(). In this case, calls from the library to |
| 3846 | * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex |
Hanno Becker | 9fbbf1c | 2018-09-05 16:23:02 +0100 | [diff] [blame] | 3847 | * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3848 | * library are also guarded with this mutex to avoid race conditions. However, |
Hanno Becker | 6a73978 | 2018-09-05 15:06:19 +0100 | [diff] [blame] | 3849 | * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will |
| 3850 | * unconditionally use the implementation for mbedtls_platform_gmtime_r() |
| 3851 | * supplied at compile time. |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3852 | */ |
Hanno Becker | 6a73978 | 2018-09-05 15:06:19 +0100 | [diff] [blame] | 3853 | //#define MBEDTLS_PLATFORM_GMTIME_R_ALT |
Andres Amaya Garcia | 1abb368 | 2018-08-16 21:42:09 +0100 | [diff] [blame] | 3854 | |
Christoph M. Wintersteiger | e50b970 | 2018-12-14 11:03:02 +0000 | [diff] [blame] | 3855 | /** |
Christoph M. Wintersteiger | 50d9f09 | 2019-02-15 12:49:27 +0000 | [diff] [blame] | 3856 | * Enable the verified implementations of ECDH primitives from Project Everest |
| 3857 | * (currently only Curve25519). This feature changes the layout of ECDH |
| 3858 | * contexts and therefore is a compatibility break for applications that access |
| 3859 | * fields of a mbedtls_ecdh_context structure directly. See also |
| 3860 | * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h. |
Christoph M. Wintersteiger | 02b8048 | 2018-10-25 12:41:04 +0100 | [diff] [blame] | 3861 | */ |
Christoph M. Wintersteiger | 6cddd30 | 2019-01-17 12:17:54 +0000 | [diff] [blame] | 3862 | //#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED |
Christoph M. Wintersteiger | 02b8048 | 2018-10-25 12:41:04 +0100 | [diff] [blame] | 3863 | |
Gilles Peskine | 611179c | 2022-04-13 23:04:48 +0200 | [diff] [blame] | 3864 | /** \} name SECTION: Module configuration options */ |