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