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