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 |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 12 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Manuel Pégourié-Gonnard | e2b0efe | 2015-08-11 10:38:37 +0200 | [diff] [blame] | 13 | */ |
| 14 | |
Bence Szépkúti | 2bb7456 | 2021-06-21 16:19:00 +0200 | [diff] [blame] | 15 | /** |
Tom Cosgrove | 1e21144 | 2022-05-26 11:51:00 +0100 | [diff] [blame] | 16 | * 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] | 17 | * config files. |
| 18 | * |
Bence Szépkúti | 1b2a883 | 2021-06-28 10:26:11 +0100 | [diff] [blame] | 19 | * 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] | 20 | * introduced the config format we want to be compatible with. |
| 21 | */ |
Bence Szépkúti | 1cafe5c | 2021-06-22 09:30:08 +0200 | [diff] [blame] | 22 | //#define MBEDTLS_CONFIG_VERSION 0x03000000 |
Bence Szépkúti | ba7248a | 2021-05-31 16:53:56 +0200 | [diff] [blame] | 23 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 24 | /** |
Gilles Peskine | e820c0a | 2023-08-03 17:45:20 +0200 | [diff] [blame] | 25 | * \name SECTION: Mbed TLS feature support |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 26 | * |
| 27 | * This section sets support for features that are or are not needed |
| 28 | * within the modules that are enabled. |
| 29 | * \{ |
| 30 | */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 31 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 32 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 33 | * \def MBEDTLS_TIMING_ALT |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 34 | * |
TRodziewicz | d854083 | 2021-06-10 15:16:50 +0200 | [diff] [blame] | 35 | * Uncomment to provide your own alternate implementation for |
Manuel Pégourié-Gonnard | a63bc94 | 2015-05-14 18:22:47 +0200 | [diff] [blame] | 36 | * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay() |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 37 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 38 | * Only works if you have MBEDTLS_TIMING_C enabled. |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 39 | * |
| 40 | * You will need to provide a header "timing_alt.h" and an implementation at |
| 41 | * compile time. |
| 42 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 43 | //#define MBEDTLS_TIMING_ALT |
Paul Bakker | f2561b3 | 2014-02-06 15:11:55 +0100 | [diff] [blame] | 44 | |
Paul Bakker | 90995b5 | 2013-06-24 19:20:35 +0200 | [diff] [blame] | 45 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 46 | * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 47 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 48 | * Enable the PSK based ciphersuite modes in SSL / TLS. |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 49 | * |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 50 | * This enables the following ciphersuites (if other requisites are |
| 51 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 52 | * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 |
| 53 | * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 |
| 54 | * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA |
| 55 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 56 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 57 | * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 |
| 58 | * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 |
| 59 | * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA |
| 60 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 61 | * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 62 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 63 | #define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 64 | |
| 65 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 66 | * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 67 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 68 | * Enable the DHE-PSK based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 69 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 70 | * Requires: MBEDTLS_DHM_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 71 | * |
| 72 | * This enables the following ciphersuites (if other requisites are |
| 73 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 74 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 |
| 75 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 |
| 76 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA |
| 77 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 |
| 78 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 79 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 |
| 80 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 |
| 81 | * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA |
| 82 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 |
| 83 | * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 84 | * |
Hanno Becker | f9734b3 | 2017-10-03 12:09:22 +0100 | [diff] [blame] | 85 | * \warning Using DHE constitutes a security risk as it |
| 86 | * is not possible to validate custom DH parameters. |
| 87 | * If possible, it is recommended users should consider |
| 88 | * preferring other methods of key exchange. |
| 89 | * See dhm.h for more details. |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 90 | * |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 91 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 92 | #define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 93 | |
| 94 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 95 | * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 96 | * |
| 97 | * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS. |
| 98 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 99 | * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 100 | * |
| 101 | * This enables the following ciphersuites (if other requisites are |
| 102 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 103 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 |
| 104 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA |
| 105 | * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 |
| 106 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 |
| 107 | * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA |
| 108 | * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 109 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 110 | #define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED |
Manuel Pégourié-Gonnard | 3ce3bbd | 2013-10-11 16:53:50 +0200 | [diff] [blame] | 111 | |
| 112 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 113 | * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 114 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 115 | * Enable the RSA-only based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 116 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 117 | * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, |
| 118 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 119 | * |
| 120 | * This enables the following ciphersuites (if other requisites are |
| 121 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 122 | * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 |
| 123 | * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 |
| 124 | * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA |
| 125 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 126 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 |
| 127 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA |
| 128 | * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 |
| 129 | * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 |
| 130 | * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA |
| 131 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 132 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 133 | * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 134 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 135 | #define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 136 | |
| 137 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 138 | * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 139 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 140 | * Enable the DHE-RSA based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 141 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 142 | * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, |
| 143 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 144 | * |
| 145 | * This enables the following ciphersuites (if other requisites are |
| 146 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 147 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 |
| 148 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 |
| 149 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA |
| 150 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 151 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 |
| 152 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA |
| 153 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 |
| 154 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 |
| 155 | * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA |
| 156 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 157 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 158 | * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 159 | * |
Hanno Becker | f9734b3 | 2017-10-03 12:09:22 +0100 | [diff] [blame] | 160 | * \warning Using DHE constitutes a security risk as it |
| 161 | * is not possible to validate custom DH parameters. |
| 162 | * If possible, it is recommended users should consider |
| 163 | * preferring other methods of key exchange. |
| 164 | * See dhm.h for more details. |
Hanno Becker | a2f6b72 | 2017-09-28 10:33:29 +0100 | [diff] [blame] | 165 | * |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 166 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 167 | #define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 168 | |
| 169 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 170 | * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 171 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 172 | * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS. |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 173 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 174 | * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH |
Manuel Pégourié-Gonnard | 4fa702a | 2023-03-29 12:15:24 +0200 | [diff] [blame] | 175 | * MBEDTLS_RSA_C |
| 176 | * MBEDTLS_PKCS1_V15 |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 177 | * MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 178 | * |
| 179 | * This enables the following ciphersuites (if other requisites are |
| 180 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 181 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 |
| 182 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 |
| 183 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA |
| 184 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 185 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 186 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
| 187 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
| 188 | * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA |
| 189 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 190 | * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 191 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 192 | #define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED |
Paul Bakker | e07f41d | 2013-04-19 09:08:57 +0200 | [diff] [blame] | 193 | |
| 194 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 195 | * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 196 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 197 | * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS. |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 198 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 199 | * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH |
| 200 | * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA |
Manuel Pégourié-Gonnard | 4fa702a | 2023-03-29 12:15:24 +0200 | [diff] [blame] | 201 | * MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 202 | * |
| 203 | * This enables the following ciphersuites (if other requisites are |
| 204 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 205 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 |
| 206 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 |
| 207 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA |
| 208 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 |
| 209 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 210 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 |
| 211 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 |
| 212 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA |
| 213 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 214 | * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 215 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 216 | #define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 32ea60a | 2013-08-17 17:39:04 +0200 | [diff] [blame] | 217 | |
| 218 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 219 | * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 220 | * |
| 221 | * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS. |
| 222 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 223 | * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH |
| 224 | * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA |
Manuel Pégourié-Gonnard | 4fa702a | 2023-03-29 12:15:24 +0200 | [diff] [blame] | 225 | * MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 226 | * |
| 227 | * This enables the following ciphersuites (if other requisites are |
| 228 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 229 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA |
| 230 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA |
| 231 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 |
| 232 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 |
| 233 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 |
| 234 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 |
| 235 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 236 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 237 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 238 | * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 239 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 240 | #define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 241 | |
| 242 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 243 | * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 244 | * |
| 245 | * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS. |
| 246 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 247 | * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH |
Manuel Pégourié-Gonnard | 4fa702a | 2023-03-29 12:15:24 +0200 | [diff] [blame] | 248 | * MBEDTLS_RSA_C |
| 249 | * MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 250 | * |
| 251 | * This enables the following ciphersuites (if other requisites are |
| 252 | * enabled as well): |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 253 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA |
| 254 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA |
| 255 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 |
| 256 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 |
| 257 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 |
| 258 | * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 |
| 259 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 |
| 260 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 |
| 261 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 |
| 262 | * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 263 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 264 | #define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED |
Manuel Pégourié-Gonnard | 25781b2 | 2013-12-11 16:17:10 +0100 | [diff] [blame] | 265 | |
| 266 | /** |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 267 | * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED |
| 268 | * |
| 269 | * Enable the ECJPAKE based ciphersuite modes in SSL / TLS. |
| 270 | * |
Manuel Pégourié-Gonnard | 75df902 | 2015-09-16 23:21:01 +0200 | [diff] [blame] | 271 | * \warning This is currently experimental. EC J-PAKE support is based on the |
| 272 | * Thread v1.0.0 specification; incompatible changes to the specification |
| 273 | * 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] | 274 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 275 | * Requires: MBEDTLS_ECJPAKE_C or PSA_WANT_ALG_JPAKE |
Manuel Pégourié-Gonnard | 41bc8b6 | 2023-03-14 23:59:24 +0100 | [diff] [blame] | 276 | * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver) |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 277 | * MBEDTLS_ECP_DP_SECP256R1_ENABLED |
| 278 | * |
| 279 | * This enables the following ciphersuites (if other requisites are |
| 280 | * enabled as well): |
| 281 | * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 |
| 282 | */ |
Manuel Pégourié-Gonnard | cf82893 | 2015-10-20 14:57:00 +0200 | [diff] [blame] | 283 | //#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED |
Manuel Pégourié-Gonnard | 557535d | 2015-09-15 17:53:32 +0200 | [diff] [blame] | 284 | |
| 285 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 286 | * \def MBEDTLS_ERROR_STRERROR_DUMMY |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 287 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 288 | * Enable a dummy error function to make use of mbedtls_strerror() in |
| 289 | * third party libraries easier when MBEDTLS_ERROR_C is disabled |
| 290 | * (no effect when MBEDTLS_ERROR_C is enabled). |
Manuel Pégourié-Gonnard | dc16aa7 | 2014-06-25 12:55:12 +0200 | [diff] [blame] | 291 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 292 | * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're |
| 293 | * not using mbedtls_strerror() or error_strerror() in your application. |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 294 | * |
| 295 | * 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] | 296 | * mbedtls_strerror() |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 297 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 298 | #define MBEDTLS_ERROR_STRERROR_DUMMY |
Paul Bakker | 8fe40dc | 2013-02-02 12:43:08 +0100 | [diff] [blame] | 299 | |
| 300 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 301 | * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES |
Paul Bakker | 40865c8 | 2013-01-31 17:13:13 +0100 | [diff] [blame] | 302 | * |
| 303 | * Enable sending of alert messages in case of encountered errors as per RFC. |
Gilles Peskine | e820c0a | 2023-08-03 17:45:20 +0200 | [diff] [blame] | 304 | * 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] | 305 | * with other servers, only debugging of failures is harder. |
| 306 | * |
| 307 | * The advantage of not sending alert messages, is that no information is given |
| 308 | * about reasons for failures thus preventing adversaries of gaining intel. |
| 309 | * |
| 310 | * Enable sending of all alert messages |
| 311 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 312 | #define MBEDTLS_SSL_ALL_ALERT_MESSAGES |
Paul Bakker | 40865c8 | 2013-01-31 17:13:13 +0100 | [diff] [blame] | 313 | |
| 314 | /** |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 315 | * \def MBEDTLS_SSL_DTLS_CONNECTION_ID |
| 316 | * |
Hannes Tschofenig | e2c46e0 | 2022-11-23 10:44:11 +0100 | [diff] [blame] | 317 | * Enable support for the DTLS Connection ID (CID) extension, |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 318 | * which allows to identify DTLS connections across changes |
Hannes Tschofenig | e2c46e0 | 2022-11-23 10:44:11 +0100 | [diff] [blame] | 319 | * in the underlying transport. The CID functionality is described |
| 320 | * in RFC 9146. |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 321 | * |
| 322 | * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`, |
Paul Elliott | 0113cf1 | 2022-03-11 20:26:47 +0000 | [diff] [blame] | 323 | * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and |
| 324 | * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for |
| 325 | * more information. |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 326 | * |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 327 | * The maximum lengths of outgoing and incoming CIDs can be configured |
| 328 | * through the options |
| 329 | * - MBEDTLS_SSL_CID_OUT_LEN_MAX |
| 330 | * - MBEDTLS_SSL_CID_IN_LEN_MAX. |
| 331 | * |
| 332 | * Requires: MBEDTLS_SSL_PROTO_DTLS |
| 333 | * |
| 334 | * Uncomment to enable the Connection ID extension. |
| 335 | */ |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 336 | #define MBEDTLS_SSL_DTLS_CONNECTION_ID |
| 337 | |
| 338 | |
| 339 | /** |
| 340 | * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT |
| 341 | * |
| 342 | * Defines whether RFC 9146 (default) or the legacy version |
| 343 | * (version draft-ietf-tls-dtls-connection-id-05, |
| 344 | * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) |
| 345 | * is used. |
| 346 | * |
| 347 | * Set the value to 0 for the standard version, and |
| 348 | * 1 for the legacy draft version. |
| 349 | * |
Hannes Tschofenig | e2c46e0 | 2022-11-23 10:44:11 +0100 | [diff] [blame] | 350 | * \deprecated Support for the legacy version of the DTLS |
| 351 | * Connection ID feature is deprecated. Please |
| 352 | * switch to the standardized version defined |
| 353 | * in RFC 9146 enabled by utilizing |
| 354 | * MBEDTLS_SSL_DTLS_CONNECTION_ID without use |
| 355 | * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT. |
| 356 | * |
Hannes Tschofenig | fd6cca4 | 2021-10-12 09:22:33 +0200 | [diff] [blame] | 357 | * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID |
| 358 | */ |
| 359 | #define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0 |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 360 | |
| 361 | /** |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 362 | * \def MBEDTLS_SSL_ASYNC_PRIVATE |
| 363 | * |
| 364 | * Enable asynchronous external private key operations in SSL. This allows |
| 365 | * you to configure an SSL connection to call an external cryptographic |
| 366 | * module to perform private key operations instead of performing the |
| 367 | * operation inside the library. |
| 368 | * |
Valerio Setti | 8841d6b | 2023-01-05 08:40:24 +0100 | [diff] [blame] | 369 | * Requires: MBEDTLS_X509_CRT_PARSE_C |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 370 | */ |
Jaeden Amero | d9c71da | 2018-06-15 20:31:26 +0100 | [diff] [blame] | 371 | //#define MBEDTLS_SSL_ASYNC_PRIVATE |
Gilles Peskine | b74a1c7 | 2018-04-24 13:09:22 +0200 | [diff] [blame] | 372 | |
| 373 | /** |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 374 | * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION |
| 375 | * |
| 376 | * Enable serialization of the TLS context structures, through use of the |
| 377 | * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load(). |
| 378 | * |
| 379 | * This pair of functions allows one side of a connection to serialize the |
| 380 | * context associated with the connection, then free or re-use that context |
| 381 | * while the serialized state is persisted elsewhere, and finally deserialize |
| 382 | * that state to a live context for resuming read/write operations on the |
| 383 | * connection. From a protocol perspective, the state of the connection is |
| 384 | * unaffected, in particular this is entirely transparent to the peer. |
| 385 | * |
| 386 | * Note: this is distinct from TLS session resumption, which is part of the |
| 387 | * protocol and fully visible by the peer. TLS session resumption enables |
| 388 | * establishing new connections associated to a saved session with shorter, |
| 389 | * lighter handshakes, while context serialization is a local optimization in |
| 390 | * handling a single, potentially long-lived connection. |
| 391 | * |
| 392 | * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are |
| 393 | * saved after the handshake to allow for more efficient serialization, so if |
| 394 | * you don't need this feature you'll save RAM by disabling it. |
| 395 | * |
Przemek Stekiel | 460192e | 2022-10-03 08:55:29 +0200 | [diff] [blame] | 396 | * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C |
| 397 | * |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 398 | * Comment to disable the context serialization APIs. |
| 399 | */ |
| 400 | #define MBEDTLS_SSL_CONTEXT_SERIALIZATION |
| 401 | |
| 402 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 403 | * \def MBEDTLS_SSL_DEBUG_ALL |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 404 | * |
| 405 | * Enable the debug messages in SSL module for all issues. |
| 406 | * Debug messages have been disabled in some places to prevent timing |
| 407 | * attacks due to (unbalanced) debugging function calls. |
| 408 | * |
| 409 | * If you need all error reporting you should enable this during debugging, |
| 410 | * but remove this for production servers that should log as well. |
| 411 | * |
| 412 | * Uncomment this macro to report all debug messages on errors introducing |
| 413 | * a timing side-channel. |
| 414 | * |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 415 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 416 | //#define MBEDTLS_SSL_DEBUG_ALL |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 417 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 418 | /** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 419 | * |
| 420 | * Enable support for Encrypt-then-MAC, RFC 7366. |
| 421 | * |
| 422 | * This allows peers that both support it to use a more robust protection for |
| 423 | * ciphersuites using CBC, providing deep resistance against timing attacks |
| 424 | * on the padding or underlying cipher. |
| 425 | * |
| 426 | * This only affects CBC ciphersuites, and is useless if none is defined. |
| 427 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 428 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 429 | * |
| 430 | * Comment this macro to disable support for Encrypt-then-MAC |
| 431 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 432 | #define MBEDTLS_SSL_ENCRYPT_THEN_MAC |
Manuel Pégourié-Gonnard | 699cafa | 2014-10-27 13:57:03 +0100 | [diff] [blame] | 433 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 434 | /** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 435 | * |
Manuel Pégourié-Gonnard | bca8aa0 | 2020-03-24 12:11:49 +0100 | [diff] [blame] | 436 | * Enable support for RFC 7627: Session Hash and Extended Master Secret |
| 437 | * Extension. |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 438 | * |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 439 | * 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] | 440 | * attacks, but it is recommended to always use it (even if you disable |
| 441 | * renegotiation), since it actually fixes a more fundamental issue in the |
| 442 | * original SSL/TLS design, and has implications beyond Triple Handshake. |
| 443 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 444 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
Manuel Pégourié-Gonnard | 769c6b6 | 2014-10-28 14:13:55 +0100 | [diff] [blame] | 445 | * |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 446 | * Comment this macro to disable support for Extended Master Secret. |
| 447 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 448 | #define MBEDTLS_SSL_EXTENDED_MASTER_SECRET |
Manuel Pégourié-Gonnard | 367381f | 2014-10-20 18:40:56 +0200 | [diff] [blame] | 449 | |
Paul Bakker | d66f070 | 2013-01-31 16:57:45 +0100 | [diff] [blame] | 450 | /** |
Hanno Becker | bb278f5 | 2019-02-05 17:04:00 +0000 | [diff] [blame] | 451 | * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE |
| 452 | * |
Hanno Becker | fd7f298 | 2019-02-25 10:13:33 +0000 | [diff] [blame] | 453 | * 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] | 454 | * giving access to the peer's certificate after completion of the handshake. |
| 455 | * |
| 456 | * Unless you need mbedtls_ssl_peer_cert() in your application, it is |
| 457 | * recommended to disable this option for reduced RAM usage. |
| 458 | * |
| 459 | * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still |
| 460 | * defined, but always returns \c NULL. |
| 461 | * |
| 462 | * \note This option has no influence on the protection against the |
| 463 | * triple handshake attack. Even if it is disabled, Mbed TLS will |
| 464 | * still ensure that certificates do not change during renegotiation, |
Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 465 | * for example by keeping a hash of the peer's certificate. |
Hanno Becker | bb278f5 | 2019-02-05 17:04:00 +0000 | [diff] [blame] | 466 | * |
Tom Cosgrove | afb2fe1 | 2022-06-29 16:36:12 +0100 | [diff] [blame] | 467 | * \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] | 468 | * |
| 469 | * Comment this macro to disable storing the peer's certificate |
| 470 | * after the handshake. |
| 471 | */ |
| 472 | #define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE |
| 473 | |
| 474 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 475 | * \def MBEDTLS_SSL_RENEGOTIATION |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 476 | * |
Hanno Becker | 0eb8fb8 | 2018-10-26 09:53:16 +0100 | [diff] [blame] | 477 | * Enable support for TLS renegotiation. |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 478 | * |
| 479 | * The two main uses of renegotiation are (1) refresh keys on long-lived |
| 480 | * connections and (2) client authentication after the initial handshake. |
| 481 | * If you don't need renegotiation, it's probably better to disable it, since |
| 482 | * it has been associated with security issues in the past and is easy to |
| 483 | * misuse/misunderstand. |
Manuel Pégourié-Gonnard | 0371704 | 2014-11-04 19:52:10 +0100 | [diff] [blame] | 484 | * |
jnmeurisse | 83f0a65 | 2023-09-16 18:12:18 +0200 | [diff] [blame] | 485 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
| 486 | * |
Manuel Pégourié-Gonnard | 55f968b | 2015-03-09 16:23:15 +0000 | [diff] [blame] | 487 | * Comment this to disable support for renegotiation. |
Hanno Becker | 6851b10 | 2017-10-12 14:57:48 +0100 | [diff] [blame] | 488 | * |
| 489 | * \note Even if this option is disabled, both client and server are aware |
| 490 | * of the Renegotiation Indication Extension (RFC 5746) used to |
| 491 | * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1). |
| 492 | * (See \c mbedtls_ssl_conf_legacy_renegotiation for the |
| 493 | * configuration of this extension). |
| 494 | * |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 495 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 496 | #define MBEDTLS_SSL_RENEGOTIATION |
Manuel Pégourié-Gonnard | 615e677 | 2014-11-03 08:23:14 +0100 | [diff] [blame] | 497 | |
| 498 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 499 | * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 500 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 501 | * Enable support for RFC 6066 max_fragment_length extension in SSL. |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 502 | * |
| 503 | * Comment this macro to disable support for the max_fragment_length extension |
| 504 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 505 | #define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 506 | |
| 507 | /** |
Jan Bruckner | 151f642 | 2023-02-10 12:45:19 +0100 | [diff] [blame] | 508 | * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT |
| 509 | * |
Jan Bruckner | a0589e7 | 2023-03-15 11:04:45 +0100 | [diff] [blame] | 510 | * 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] | 511 | * |
Jan Bruckner | 151f642 | 2023-02-10 12:45:19 +0100 | [diff] [blame] | 512 | * Requires: MBEDTLS_SSL_PROTO_TLS1_3 |
| 513 | * |
| 514 | * Uncomment this macro to enable support for the record_size_limit extension |
| 515 | */ |
| 516 | //#define MBEDTLS_SSL_RECORD_SIZE_LIMIT |
| 517 | |
| 518 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 519 | * \def MBEDTLS_SSL_PROTO_TLS1_2 |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 520 | * |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 521 | * 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] | 522 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 523 | * Requires: PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384 |
Andrzej Kurek | e02da81 | 2022-08-17 17:04:49 -0400 | [diff] [blame] | 524 | * |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 525 | * 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] | 526 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 527 | #define MBEDTLS_SSL_PROTO_TLS1_2 |
Paul Bakker | d2f068e | 2013-08-27 21:19:20 +0200 | [diff] [blame] | 528 | |
| 529 | /** |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 530 | * \def MBEDTLS_SSL_PROTO_TLS1_3 |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 531 | * |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 532 | * Enable support for TLS 1.3. |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 533 | * |
Gilles Peskine | da69eaa | 2023-09-05 20:54:17 +0200 | [diff] [blame] | 534 | * \note See docs/architecture/tls13-support.md for a description of the TLS |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 535 | * 1.3 support that this option enables. |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 536 | * |
Tom Cosgrove | afb2fe1 | 2022-06-29 16:36:12 +0100 | [diff] [blame] | 537 | * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE |
Manuel Pégourié-Gonnard | 3e83098 | 2022-05-11 13:27:44 +0200 | [diff] [blame] | 538 | * Requires: MBEDTLS_PSA_CRYPTO_C |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 539 | * |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 540 | * Uncomment this macro to enable the support for TLS 1.3. |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 541 | */ |
Ronald Cron | 27eb68d | 2024-03-15 16:13:37 +0100 | [diff] [blame] | 542 | #define MBEDTLS_SSL_PROTO_TLS1_3 |
Hanno Becker | 9fc15ea | 2020-05-04 12:00:47 +0100 | [diff] [blame] | 543 | |
| 544 | /** |
Ronald Cron | ab65c52 | 2021-11-24 10:47:20 +0100 | [diff] [blame] | 545 | * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE |
| 546 | * |
| 547 | * Enable TLS 1.3 middlebox compatibility mode. |
| 548 | * |
| 549 | * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility |
| 550 | * mode to make a TLS 1.3 connection more likely to pass through middle boxes |
| 551 | * expecting TLS 1.2 traffic. |
| 552 | * |
| 553 | * Turning on the compatibility mode comes at the cost of a few added bytes |
| 554 | * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations |
| 555 | * that don't use it. Therefore, unless transmission bandwidth is critical and |
| 556 | * you know that middlebox compatibility issues won't occur, it is therefore |
| 557 | * recommended to set this option. |
| 558 | * |
| 559 | * Comment to disable compatibility mode for TLS 1.3. If |
Ronald Cron | 6f135e1 | 2021-12-08 16:57:54 +0100 | [diff] [blame] | 560 | * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any |
| 561 | * effect on the build. |
Ronald Cron | ab65c52 | 2021-11-24 10:47:20 +0100 | [diff] [blame] | 562 | * |
| 563 | */ |
Ronald Cron | 27eb68d | 2024-03-15 16:13:37 +0100 | [diff] [blame] | 564 | #define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE |
Ronald Cron | ab65c52 | 2021-11-24 10:47:20 +0100 | [diff] [blame] | 565 | |
| 566 | /** |
Ronald Cron | d8d2ea5 | 2022-10-04 15:48:06 +0200 | [diff] [blame] | 567 | * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED |
| 568 | * |
| 569 | * Enable TLS 1.3 PSK key exchange mode. |
| 570 | * |
| 571 | * Comment to disable support for the PSK key exchange mode in TLS 1.3. If |
| 572 | * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any |
| 573 | * effect on the build. |
| 574 | * |
| 575 | */ |
| 576 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED |
| 577 | |
| 578 | /** |
| 579 | * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED |
| 580 | * |
| 581 | * Enable TLS 1.3 ephemeral key exchange mode. |
| 582 | * |
Przemek Stekiel | ce05f54 | 2023-06-15 16:44:08 +0200 | [diff] [blame] | 583 | * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH |
Manuel Pégourié-Gonnard | 4fa702a | 2023-03-29 12:15:24 +0200 | [diff] [blame] | 584 | * MBEDTLS_X509_CRT_PARSE_C |
| 585 | * and at least one of: |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 586 | * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA |
Manuel Pégourié-Gonnard | 4fa702a | 2023-03-29 12:15:24 +0200 | [diff] [blame] | 587 | * MBEDTLS_PKCS1_V21 |
Ronald Cron | d8d2ea5 | 2022-10-04 15:48:06 +0200 | [diff] [blame] | 588 | * |
| 589 | * Comment to disable support for the ephemeral key exchange mode in TLS 1.3. |
| 590 | * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any |
| 591 | * effect on the build. |
| 592 | * |
| 593 | */ |
| 594 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED |
| 595 | |
| 596 | /** |
| 597 | * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED |
| 598 | * |
| 599 | * Enable TLS 1.3 PSK ephemeral key exchange mode. |
| 600 | * |
Przemek Stekiel | ce05f54 | 2023-06-15 16:44:08 +0200 | [diff] [blame] | 601 | * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH |
Ronald Cron | d8d2ea5 | 2022-10-04 15:48:06 +0200 | [diff] [blame] | 602 | * |
| 603 | * Comment to disable support for the PSK ephemeral key exchange mode in |
| 604 | * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not |
| 605 | * have any effect on the build. |
| 606 | * |
| 607 | */ |
| 608 | #define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED |
| 609 | |
| 610 | /** |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 611 | * \def MBEDTLS_SSL_EARLY_DATA |
| 612 | * |
| 613 | * Enable support for RFC 8446 TLS 1.3 early data. |
| 614 | * |
| 615 | * Requires: MBEDTLS_SSL_SESSION_TICKETS and either |
| 616 | * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or |
| 617 | * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED |
| 618 | * |
| 619 | * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3 |
| 620 | * is not enabled, this option does not have any effect on the build. |
| 621 | * |
Tom Cosgrove | a63775b | 2023-09-14 13:31:19 +0100 | [diff] [blame] | 622 | * \note The maximum amount of early data can be set with |
| 623 | * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE. |
| 624 | * |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 625 | */ |
Ronald Cron | c2e110f | 2022-11-22 09:01:46 +0100 | [diff] [blame] | 626 | //#define MBEDTLS_SSL_EARLY_DATA |
Xiaokang Qian | 54413b1 | 2022-10-20 05:57:03 +0000 | [diff] [blame] | 627 | |
| 628 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 629 | * \def MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 630 | * |
| 631 | * Enable support for DTLS (all available versions). |
| 632 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 633 | * 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] | 634 | * |
TRodziewicz | 0f82ec6 | 2021-05-12 17:49:18 +0200 | [diff] [blame] | 635 | * Requires: MBEDTLS_SSL_PROTO_TLS1_2 |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 636 | * |
| 637 | * Comment this macro to disable support for DTLS |
| 638 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 639 | #define MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 0b1ff29 | 2014-02-06 13:04:16 +0100 | [diff] [blame] | 640 | |
| 641 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 642 | * \def MBEDTLS_SSL_ALPN |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 643 | * |
Manuel Pégourié-Gonnard | 6b298e6 | 2014-11-20 18:28:50 +0100 | [diff] [blame] | 644 | * Enable support for RFC 7301 Application Layer Protocol Negotiation. |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 645 | * |
Paul Bakker | 27e36d3 | 2014-04-08 12:33:37 +0200 | [diff] [blame] | 646 | * Comment this macro to disable support for ALPN. |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 647 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 648 | #define MBEDTLS_SSL_ALPN |
Manuel Pégourié-Gonnard | 7e250d4 | 2014-04-04 16:08:41 +0200 | [diff] [blame] | 649 | |
| 650 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 651 | * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 652 | * |
| 653 | * Enable support for the anti-replay mechanism in DTLS. |
| 654 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 655 | * Requires: MBEDTLS_SSL_TLS_C |
| 656 | * MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 657 | * |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 658 | * \warning Disabling this is often a security risk! |
Manuel Pégourié-Gonnard | 6729e79 | 2015-05-11 09:50:24 +0200 | [diff] [blame] | 659 | * See mbedtls_ssl_conf_dtls_anti_replay() for details. |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 660 | * |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 661 | * Comment this to disable anti-replay in DTLS. |
| 662 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 663 | #define MBEDTLS_SSL_DTLS_ANTI_REPLAY |
Manuel Pégourié-Gonnard | 8464a46 | 2014-09-24 14:05:32 +0200 | [diff] [blame] | 664 | |
| 665 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 666 | * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY |
Manuel Pégourié-Gonnard | 82202f0 | 2014-07-23 00:28:58 +0200 | [diff] [blame] | 667 | * |
| 668 | * Enable support for HelloVerifyRequest on DTLS servers. |
| 669 | * |
| 670 | * This feature is highly recommended to prevent DTLS servers being used as |
| 671 | * amplifiers in DoS attacks against other hosts. It should always be enabled |
| 672 | * unless you know for sure amplification cannot be a problem in the |
| 673 | * environment in which your server operates. |
| 674 | * |
Andrzej Kurek | 5c65c57 | 2022-04-13 14:28:52 -0400 | [diff] [blame] | 675 | * \warning Disabling this can be a security risk! (see above) |
Manuel Pégourié-Gonnard | a6fcffe | 2014-10-13 18:15:52 +0200 | [diff] [blame] | 676 | * |
Manuel Pégourié-Gonnard | e057d3b | 2015-05-20 10:59:43 +0200 | [diff] [blame] | 677 | * Requires: MBEDTLS_SSL_PROTO_DTLS |
Manuel Pégourié-Gonnard | 82202f0 | 2014-07-23 00:28:58 +0200 | [diff] [blame] | 678 | * |
| 679 | * Comment this to disable support for HelloVerifyRequest. |
| 680 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 681 | #define MBEDTLS_SSL_DTLS_HELLO_VERIFY |
Manuel Pégourié-Gonnard | 82202f0 | 2014-07-23 00:28:58 +0200 | [diff] [blame] | 682 | |
| 683 | /** |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 684 | * \def MBEDTLS_SSL_DTLS_SRTP |
| 685 | * |
Tobias Nießen | 1e8ca12 | 2021-05-10 19:53:15 +0200 | [diff] [blame] | 686 | * Enable support for negotiation of DTLS-SRTP (RFC 5764) |
Johan Pascal | 842d671 | 2020-09-23 13:34:40 +0200 | [diff] [blame] | 687 | * through the use_srtp extension. |
| 688 | * |
| 689 | * \note This feature provides the minimum functionality required |
| 690 | * to negotiate the use of DTLS-SRTP and to allow the derivation of |
| 691 | * the associated SRTP packet protection key material. |
| 692 | * In particular, the SRTP packet protection itself, as well as the |
| 693 | * demultiplexing of RTP and DTLS packets at the datagram layer |
| 694 | * (see Section 5 of RFC 5764), are not handled by this feature. |
| 695 | * Instead, after successful completion of a handshake negotiating |
| 696 | * the use of DTLS-SRTP, the extended key exporter API |
Hanno Becker | 2d6e6f8 | 2021-05-24 10:58:31 +0100 | [diff] [blame] | 697 | * mbedtls_ssl_conf_export_keys_cb() should be used to implement |
Johan Pascal | 842d671 | 2020-09-23 13:34:40 +0200 | [diff] [blame] | 698 | * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705 |
| 699 | * (this is implemented in the SSL example programs). |
| 700 | * The resulting key should then be passed to an SRTP stack. |
| 701 | * |
| 702 | * Setting this option enables the runtime API |
| 703 | * mbedtls_ssl_conf_dtls_srtp_protection_profiles() |
| 704 | * through which the supported DTLS-SRTP protection |
| 705 | * profiles can be configured. You must call this API at |
| 706 | * runtime if you wish to negotiate the use of DTLS-SRTP. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 707 | * |
| 708 | * Requires: MBEDTLS_SSL_PROTO_DTLS |
| 709 | * |
Ron Eldor | 9cfb5eb | 2018-12-10 15:30:14 +0200 | [diff] [blame] | 710 | * Uncomment this to enable support for use_srtp extension. |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 711 | */ |
Ron Eldor | 9cfb5eb | 2018-12-10 15:30:14 +0200 | [diff] [blame] | 712 | //#define MBEDTLS_SSL_DTLS_SRTP |
Johan Pascal | b62bb51 | 2015-12-03 21:56:45 +0100 | [diff] [blame] | 713 | |
| 714 | /** |
Manuel Pégourié-Gonnard | 26d227d | 2015-09-04 10:53:25 +0200 | [diff] [blame] | 715 | * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE |
| 716 | * |
| 717 | * Enable server-side support for clients that reconnect from the same port. |
| 718 | * |
| 719 | * Some clients unexpectedly close the connection and try to reconnect using the |
| 720 | * 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] | 721 | * 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] | 722 | * flag enables that support. |
| 723 | * |
Manuel Pégourié-Gonnard | 62c74bb | 2015-09-08 17:50:29 +0200 | [diff] [blame] | 724 | * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY |
Manuel Pégourié-Gonnard | 62c74bb | 2015-09-08 17:50:29 +0200 | [diff] [blame] | 725 | * |
Manuel Pégourié-Gonnard | 26d227d | 2015-09-04 10:53:25 +0200 | [diff] [blame] | 726 | * Comment this to disable support for clients reusing the source port. |
| 727 | */ |
| 728 | #define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE |
| 729 | |
| 730 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 731 | * \def MBEDTLS_SSL_SESSION_TICKETS |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 732 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 733 | * Enable support for RFC 5077 session tickets in SSL. |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 734 | * 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] | 735 | * session store remains the responsibility of the application, though). |
| 736 | * Server-side, you also need to provide callbacks for writing and parsing |
| 737 | * tickets, including authenticated encryption and key management. Example |
| 738 | * callbacks are provided by MBEDTLS_SSL_TICKET_C. |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 739 | * |
| 740 | * Comment this macro to disable support for SSL session tickets |
| 741 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 742 | #define MBEDTLS_SSL_SESSION_TICKETS |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 743 | |
| 744 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 745 | * \def MBEDTLS_SSL_SERVER_NAME_INDICATION |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 746 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 747 | * Enable support for RFC 6066 server name indication (SNI) in SSL. |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 748 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 749 | * Requires: MBEDTLS_X509_CRT_PARSE_C |
Manuel Pégourié-Gonnard | bbbb3cf | 2015-01-28 16:44:37 +0000 | [diff] [blame] | 750 | * |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 751 | * Comment this macro to disable support for server name indication in SSL |
| 752 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 753 | #define MBEDTLS_SSL_SERVER_NAME_INDICATION |
Paul Bakker | 0be444a | 2013-08-27 21:55:01 +0200 | [diff] [blame] | 754 | |
| 755 | /** |
Gilles Peskine | f03bd81 | 2020-03-23 18:13:58 +0100 | [diff] [blame] | 756 | * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH |
| 757 | * |
Andrzej Kurek | 2a54a6f | 2021-01-07 08:13:49 -0500 | [diff] [blame] | 758 | * When this option is enabled, the SSL buffer will be resized automatically |
| 759 | * based on the negotiated maximum fragment length in each direction. |
Andrzej Kurek | 557289b | 2020-10-21 15:12:39 +0200 | [diff] [blame] | 760 | * |
| 761 | * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH |
Gilles Peskine | f03bd81 | 2020-03-23 18:13:58 +0100 | [diff] [blame] | 762 | */ |
| 763 | //#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH |
| 764 | |
| 765 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 766 | * \def MBEDTLS_VERSION_FEATURES |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 767 | * |
| 768 | * Allow run-time checking of compile-time enabled features. Thus allowing users |
| 769 | * to check at run-time if the library is for instance compiled with threading |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 770 | * support via mbedtls_version_check_feature(). |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 771 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 772 | * Requires: MBEDTLS_VERSION_C |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 773 | * |
| 774 | * Comment this to disable run-time checking and save ROM space |
| 775 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 776 | #define MBEDTLS_VERSION_FEATURES |
Paul Bakker | 0f90d7d | 2014-04-30 11:49:44 +0200 | [diff] [blame] | 777 | |
| 778 | /** |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 779 | * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK |
| 780 | * |
Jarno Lamsa | f49fedc | 2019-04-01 14:58:30 +0300 | [diff] [blame] | 781 | * 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] | 782 | * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure |
| 783 | * the set of trusted certificates through a callback instead of a linked |
| 784 | * list. |
| 785 | * |
| 786 | * This is useful for example in environments where a large number of trusted |
| 787 | * certificates is present and storing them in a linked list isn't efficient |
| 788 | * enough, or when the set of trusted certificates changes frequently. |
| 789 | * |
Jarno Lamsa | f49fedc | 2019-04-01 14:58:30 +0300 | [diff] [blame] | 790 | * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 791 | * `mbedtls_ssl_conf_ca_cb()` for more information. |
| 792 | * |
Valerio Setti | 8e45cdd | 2023-01-05 09:32:29 +0100 | [diff] [blame] | 793 | * Requires: MBEDTLS_X509_CRT_PARSE_C |
| 794 | * |
Hanno Becker | 288dedc | 2019-03-27 11:00:53 +0000 | [diff] [blame] | 795 | * Uncomment to enable trusted certificate callbacks. |
| 796 | */ |
| 797 | //#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK |
| 798 | |
| 799 | /** |
Hanno Becker | 612a2f1 | 2020-10-09 09:19:39 +0100 | [diff] [blame] | 800 | * \def MBEDTLS_X509_REMOVE_INFO |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 801 | * |
Chris Jones | 2c74586 | 2020-12-16 11:41:06 +0000 | [diff] [blame] | 802 | * Disable mbedtls_x509_*_info() and related APIs. |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 803 | * |
Chris Jones | 2c74586 | 2020-12-16 11:41:06 +0000 | [diff] [blame] | 804 | * 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] | 805 | * and other functions/constants only used by these functions, thus reducing |
| 806 | * the code footprint by several KB. |
| 807 | */ |
Chris Jones | 2c74586 | 2020-12-16 11:41:06 +0000 | [diff] [blame] | 808 | //#define MBEDTLS_X509_REMOVE_INFO |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 809 | |
| 810 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 811 | * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT |
Manuel Pégourié-Gonnard | d1539b1 | 2014-06-06 16:42:37 +0200 | [diff] [blame] | 812 | * |
| 813 | * Enable parsing and verification of X.509 certificates, CRLs and CSRS |
| 814 | * signed with RSASSA-PSS (aka PKCS#1 v2.1). |
| 815 | * |
Tomi Fontanilles | a70b3c2 | 2023-07-16 12:06:13 +0300 | [diff] [blame] | 816 | * Requires: MBEDTLS_PKCS1_V21 |
| 817 | * |
Manuel Pégourié-Gonnard | d1539b1 | 2014-06-06 16:42:37 +0200 | [diff] [blame] | 818 | * Comment this macro to disallow using RSASSA-PSS in certificates. |
| 819 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 820 | #define MBEDTLS_X509_RSASSA_PSS_SUPPORT |
Gilles Peskine | e820c0a | 2023-08-03 17:45:20 +0200 | [diff] [blame] | 821 | /** \} name SECTION: Mbed TLS feature support */ |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 822 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 823 | /** |
Gilles Peskine | e820c0a | 2023-08-03 17:45:20 +0200 | [diff] [blame] | 824 | * \name SECTION: Mbed TLS modules |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 825 | * |
Gilles Peskine | e820c0a | 2023-08-03 17:45:20 +0200 | [diff] [blame] | 826 | * This section enables or disables entire modules in Mbed TLS |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 827 | * \{ |
| 828 | */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 829 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 830 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 831 | * \def MBEDTLS_DEBUG_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 832 | * |
| 833 | * Enable the debug functions. |
| 834 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 835 | * Module: library/debug.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 836 | * Caller: library/ssl_msg.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 837 | * library/ssl_tls.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 838 | * library/ssl_tls12_*.c |
| 839 | * library/ssl_tls13_*.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 840 | * |
| 841 | * This module provides debugging functions. |
| 842 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 843 | #define MBEDTLS_DEBUG_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 844 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 845 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 846 | * \def MBEDTLS_ERROR_C |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 847 | * |
| 848 | * Enable error code to error string conversion. |
| 849 | * |
| 850 | * Module: library/error.c |
| 851 | * Caller: |
| 852 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 853 | * This module enables mbedtls_strerror(). |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 854 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 855 | #define MBEDTLS_ERROR_C |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 856 | |
| 857 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 858 | * \def MBEDTLS_NET_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 859 | * |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 860 | * Enable the TCP and UDP over IPv6/IPv4 networking routines. |
| 861 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 862 | * \note This module only works on POSIX/Unix (including Linux, BSD and OS X) |
| 863 | * 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] | 864 | * own networking callbacks to be passed to \c mbedtls_ssl_set_bio(). |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 865 | * |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 866 | * \note See also our Knowledge Base article about porting to a new |
| 867 | * environment: |
Dave Rodgman | b319684 | 2022-10-12 16:47:08 +0100 | [diff] [blame] | 868 | * 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] | 869 | * |
Andres AG | 788aa4a | 2016-09-14 14:32:09 +0100 | [diff] [blame] | 870 | * Module: library/net_sockets.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 871 | * |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 872 | * This module provides networking routines. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 873 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 874 | #define MBEDTLS_NET_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 875 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 876 | /** |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 877 | * \def MBEDTLS_PKCS7_C |
| 878 | * |
Dave Rodgman | 3fe2abf | 2023-03-10 17:05:54 +0000 | [diff] [blame] | 879 | * Enable PKCS #7 core for using PKCS #7-formatted signatures. |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 880 | * RFC Link - https://tools.ietf.org/html/rfc2315 |
| 881 | * |
| 882 | * Module: library/pkcs7.c |
| 883 | * |
| 884 | * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C, |
Nick Child | 89e82e1 | 2022-11-09 10:36:10 -0600 | [diff] [blame] | 885 | * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C, |
| 886 | * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 887 | * |
Dave Rodgman | efbc5f7 | 2023-03-13 12:15:49 +0000 | [diff] [blame] | 888 | * This module is required for the PKCS #7 parsing modules. |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 889 | */ |
Dave Rodgman | 7c33b0c | 2023-03-10 15:07:15 +0000 | [diff] [blame] | 890 | #define MBEDTLS_PKCS7_C |
Nayna Jain | c9deb18 | 2020-11-16 19:03:12 +0000 | [diff] [blame] | 891 | |
| 892 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 893 | * \def MBEDTLS_SSL_CACHE_C |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 894 | * |
| 895 | * Enable simple SSL cache implementation. |
| 896 | * |
| 897 | * Module: library/ssl_cache.c |
| 898 | * Caller: |
| 899 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 900 | * Requires: MBEDTLS_SSL_CACHE_C |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 901 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 902 | #define MBEDTLS_SSL_CACHE_C |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 903 | |
| 904 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 905 | * \def MBEDTLS_SSL_COOKIE_C |
Manuel Pégourié-Gonnard | a64acd4 | 2014-07-23 18:30:45 +0200 | [diff] [blame] | 906 | * |
| 907 | * Enable basic implementation of DTLS cookies for hello verification. |
| 908 | * |
| 909 | * Module: library/ssl_cookie.c |
| 910 | * Caller: |
Manuel Pégourié-Gonnard | a64acd4 | 2014-07-23 18:30:45 +0200 | [diff] [blame] | 911 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 912 | #define MBEDTLS_SSL_COOKIE_C |
Manuel Pégourié-Gonnard | a64acd4 | 2014-07-23 18:30:45 +0200 | [diff] [blame] | 913 | |
| 914 | /** |
Manuel Pégourié-Gonnard | fd6d897 | 2015-05-15 12:09:00 +0200 | [diff] [blame] | 915 | * \def MBEDTLS_SSL_TICKET_C |
| 916 | * |
| 917 | * Enable an implementation of TLS server-side callbacks for session tickets. |
| 918 | * |
| 919 | * Module: library/ssl_ticket.c |
| 920 | * Caller: |
Manuel Pégourié-Gonnard | 0c0f11f | 2015-05-20 09:55:50 +0200 | [diff] [blame] | 921 | * |
Przemek Stekiel | 52a428b | 2022-10-10 08:47:13 +0200 | [diff] [blame] | 922 | * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) && |
| 923 | * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C) |
Manuel Pégourié-Gonnard | fd6d897 | 2015-05-15 12:09:00 +0200 | [diff] [blame] | 924 | */ |
| 925 | #define MBEDTLS_SSL_TICKET_C |
| 926 | |
| 927 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 928 | * \def MBEDTLS_SSL_CLI_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 929 | * |
| 930 | * Enable the SSL/TLS client code. |
| 931 | * |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 932 | * Module: library/ssl*_client.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 933 | * Caller: |
| 934 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 935 | * Requires: MBEDTLS_SSL_TLS_C |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 936 | * |
Janos Follath | 745e561 | 2024-12-02 13:22:34 +0000 | [diff] [blame] | 937 | * \warning You must call psa_crypto_init() before doing any TLS operations. |
| 938 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 939 | * This module is required for SSL/TLS client support. |
| 940 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 941 | #define MBEDTLS_SSL_CLI_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 942 | |
Paul Bakker | 9a73632 | 2012-11-14 12:39:52 +0000 | [diff] [blame] | 943 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 944 | * \def MBEDTLS_SSL_SRV_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 945 | * |
| 946 | * Enable the SSL/TLS server code. |
| 947 | * |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 948 | * Module: library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 949 | * Caller: |
| 950 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 951 | * Requires: MBEDTLS_SSL_TLS_C |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 952 | * |
Janos Follath | 745e561 | 2024-12-02 13:22:34 +0000 | [diff] [blame] | 953 | * \warning You must call psa_crypto_init() before doing any TLS operations. |
| 954 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 955 | * This module is required for SSL/TLS server support. |
| 956 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 957 | #define MBEDTLS_SSL_SRV_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 958 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 959 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 960 | * \def MBEDTLS_SSL_TLS_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 961 | * |
Paul Bakker | e29ab06 | 2011-05-18 13:26:54 +0000 | [diff] [blame] | 962 | * Enable the generic SSL/TLS code. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 963 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 964 | * Module: library/ssl_tls.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 965 | * Caller: library/ssl*_client.c |
| 966 | * library/ssl*_server.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 967 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 968 | * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C |
| 969 | * and at least one of the MBEDTLS_SSL_PROTO_XXX defines |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 970 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 971 | * This module is required for SSL/TLS. |
| 972 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 973 | #define MBEDTLS_SSL_TLS_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 974 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 975 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 976 | * \def MBEDTLS_TIMING_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 977 | * |
Manuel Pégourié-Gonnard | 325ce09 | 2016-02-22 10:33:34 +0100 | [diff] [blame] | 978 | * Enable the semi-portable timing interface. |
| 979 | * |
Simon Butcher | d567a23 | 2016-03-09 20:19:21 +0000 | [diff] [blame] | 980 | * \note The provided implementation only works on POSIX/Unix (including Linux, |
| 981 | * 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] | 982 | * module and provide your own implementations of the callbacks needed by |
| 983 | * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide |
| 984 | * your own implementation of the whole module by setting |
| 985 | * \c MBEDTLS_TIMING_ALT in the current file. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 986 | * |
Andrzej Kurek | 5735369 | 2022-04-07 08:08:21 -0400 | [diff] [blame] | 987 | * \note The timing module will include time.h on suitable platforms |
| 988 | * regardless of the setting of MBEDTLS_HAVE_TIME, unless |
| 989 | * MBEDTLS_TIMING_ALT is used. See timing.c for more information. |
| 990 | * |
Manuel Pégourié-Gonnard | 02049dc | 2016-02-22 16:42:51 +0000 | [diff] [blame] | 991 | * \note See also our Knowledge Base article about porting to a new |
| 992 | * environment: |
Dave Rodgman | b319684 | 2022-10-12 16:47:08 +0100 | [diff] [blame] | 993 | * 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] | 994 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 995 | * Module: library/timing.c |
Paul Bakker | ecd54fb | 2013-07-03 14:48:29 +0200 | [diff] [blame] | 996 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 997 | #define MBEDTLS_TIMING_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 998 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 999 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1000 | * \def MBEDTLS_VERSION_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1001 | * |
| 1002 | * Enable run-time version information. |
| 1003 | * |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 1004 | * Module: library/version.c |
| 1005 | * |
| 1006 | * This module provides run-time version information. |
| 1007 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1008 | #define MBEDTLS_VERSION_C |
Paul Bakker | 0a62cd1 | 2011-01-21 11:00:08 +0000 | [diff] [blame] | 1009 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1010 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1011 | * \def MBEDTLS_X509_USE_C |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1012 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1013 | * Enable X.509 core for using certificates. |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1014 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1015 | * Module: library/x509.c |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 1016 | * Caller: library/x509_crl.c |
| 1017 | * library/x509_crt.c |
| 1018 | * library/x509_csr.c |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1019 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 1020 | * 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] | 1021 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 1022 | * \warning You must call psa_crypto_init() before doing any X.509 operation. |
Paul Bakker | 5690efc | 2011-05-26 13:16:06 +0000 | [diff] [blame] | 1023 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1024 | * This module is required for the X.509 parsing modules. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1025 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1026 | #define MBEDTLS_X509_USE_C |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1027 | |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 1028 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1029 | * \def MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 1030 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1031 | * Enable X.509 certificate parsing. |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 1032 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 1033 | * Module: library/x509_crt.c |
Ronald Cron | de1adee | 2022-03-07 16:20:30 +0100 | [diff] [blame] | 1034 | * Caller: library/ssl_tls.c |
| 1035 | * library/ssl*_client.c |
| 1036 | * library/ssl*_server.c |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1037 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1038 | * Requires: MBEDTLS_X509_USE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1039 | * |
| 1040 | * This module is required for X.509 certificate parsing. |
| 1041 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1042 | #define MBEDTLS_X509_CRT_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1043 | |
| 1044 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1045 | * \def MBEDTLS_X509_CRL_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1046 | * |
| 1047 | * Enable X.509 CRL parsing. |
| 1048 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 1049 | * Module: library/x509_crl.c |
| 1050 | * Caller: library/x509_crt.c |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1051 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1052 | * Requires: MBEDTLS_X509_USE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1053 | * |
| 1054 | * This module is required for X.509 CRL parsing. |
| 1055 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1056 | #define MBEDTLS_X509_CRL_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1057 | |
| 1058 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1059 | * \def MBEDTLS_X509_CSR_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1060 | * |
| 1061 | * Enable X.509 Certificate Signing Request (CSR) parsing. |
| 1062 | * |
Simon Butcher | 2cb4739 | 2016-11-04 12:23:11 +0000 | [diff] [blame] | 1063 | * Module: library/x509_csr.c |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1064 | * Caller: library/x509_crt_write.c |
| 1065 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1066 | * Requires: MBEDTLS_X509_USE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1067 | * |
| 1068 | * This module is used for reading X.509 certificate request. |
| 1069 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1070 | #define MBEDTLS_X509_CSR_PARSE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1071 | |
| 1072 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1073 | * \def MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1074 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1075 | * Enable X.509 core for creating certificates. |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1076 | * |
| 1077 | * Module: library/x509_create.c |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 1078 | * |
Przemek Stekiel | 10836a0 | 2022-08-19 08:45:34 +0200 | [diff] [blame] | 1079 | * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C, |
Przemek Stekiel | 278b667 | 2022-08-03 09:50:38 +0200 | [diff] [blame] | 1080 | * |
Janos Follath | 277bba8 | 2024-11-19 16:14:00 +0000 | [diff] [blame] | 1081 | * \warning You must call psa_crypto_init() before doing any X.509 operation. |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 1082 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1083 | * This module is the basis for creating X.509 certificates and CSRs. |
| 1084 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1085 | #define MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1086 | |
| 1087 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1088 | * \def MBEDTLS_X509_CRT_WRITE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1089 | * |
| 1090 | * Enable creating X.509 certificates. |
| 1091 | * |
| 1092 | * Module: library/x509_crt_write.c |
| 1093 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1094 | * Requires: MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1095 | * |
| 1096 | * This module is required for X.509 certificate creation. |
| 1097 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1098 | #define MBEDTLS_X509_CRT_WRITE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1099 | |
| 1100 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1101 | * \def MBEDTLS_X509_CSR_WRITE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1102 | * |
Manuel Pégourié-Gonnard | 09fff7e | 2013-09-20 13:45:36 +0200 | [diff] [blame] | 1103 | * Enable creating X.509 Certificate Signing Requests (CSR). |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1104 | * |
| 1105 | * Module: library/x509_csr_write.c |
| 1106 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1107 | * Requires: MBEDTLS_X509_CREATE_C |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1108 | * |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 1109 | * This module is required for X.509 certificate request writing. |
| 1110 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1111 | #define MBEDTLS_X509_CSR_WRITE_C |
Paul Bakker | bdb912d | 2012-02-13 23:11:30 +0000 | [diff] [blame] | 1112 | |
Gilles Peskine | e820c0a | 2023-08-03 17:45:20 +0200 | [diff] [blame] | 1113 | /** \} name SECTION: Mbed TLS modules */ |
Paul Bakker | 7a7c78f | 2009-01-04 18:15:48 +0000 | [diff] [blame] | 1114 | |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1115 | /** |
Gilles Peskine | ba4162a | 2022-04-11 17:04:38 +0200 | [diff] [blame] | 1116 | * \name SECTION: General configuration options |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1117 | * |
Gilles Peskine | d5793ce | 2022-04-13 23:05:10 +0200 | [diff] [blame] | 1118 | * This section contains Mbed TLS build settings that are not associated |
| 1119 | * with a particular module. |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1120 | * |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1121 | * \{ |
| 1122 | */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1123 | |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1124 | /** |
| 1125 | * \def MBEDTLS_CONFIG_FILE |
| 1126 | * |
| 1127 | * If defined, this is a header which will be included instead of |
| 1128 | * `"mbedtls/mbedtls_config.h"`. |
| 1129 | * This header file specifies the compile-time configuration of Mbed TLS. |
Gilles Peskine | efffd64 | 2022-04-26 18:13:01 +0200 | [diff] [blame] | 1130 | * Unlike other configuration options, this one must be defined on the |
| 1131 | * compiler command line: a definition in `mbedtls_config.h` would have |
| 1132 | * no effect. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1133 | * |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 1134 | * 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] | 1135 | * 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] | 1136 | * with compilers that perform macro expansion on an <tt>\#include</tt> line. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1137 | * |
Gilles Peskine | 58ffcba | 2022-04-14 12:44:16 +0200 | [diff] [blame] | 1138 | * The value of this symbol is typically a path in double quotes, either |
| 1139 | * absolute or relative to a directory on the include search path. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1140 | */ |
| 1141 | //#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h" |
| 1142 | |
| 1143 | /** |
| 1144 | * \def MBEDTLS_USER_CONFIG_FILE |
| 1145 | * |
| 1146 | * If defined, this is a header which will be included after |
| 1147 | * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE. |
Gilles Peskine | f68f43a | 2022-04-13 23:22:20 +0200 | [diff] [blame] | 1148 | * This allows you to modify the default configuration, including the ability |
| 1149 | * to undefine options that are enabled by default. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1150 | * |
Gilles Peskine | 6457ef9 | 2022-04-11 16:42:37 +0200 | [diff] [blame] | 1151 | * 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] | 1152 | * 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] | 1153 | * with compilers that perform macro expansion on an <tt>\#include</tt> line. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1154 | * |
Gilles Peskine | 58ffcba | 2022-04-14 12:44:16 +0200 | [diff] [blame] | 1155 | * The value of this symbol is typically a path in double quotes, either |
| 1156 | * absolute or relative to a directory on the include search path. |
Gilles Peskine | a02c124 | 2022-03-16 17:03:19 +0100 | [diff] [blame] | 1157 | */ |
| 1158 | //#define MBEDTLS_USER_CONFIG_FILE "/dev/null" |
| 1159 | |
Gilles Peskine | ba4162a | 2022-04-11 17:04:38 +0200 | [diff] [blame] | 1160 | /** \} name SECTION: General configuration options */ |
| 1161 | |
| 1162 | /** |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1163 | * \name SECTION: Module configuration options |
| 1164 | * |
| 1165 | * This section allows for the setting of module specific sizes and |
| 1166 | * configuration options. The default values are already present in the |
| 1167 | * relevant header files and should suffice for the regular use cases. |
| 1168 | * |
| 1169 | * Our advice is to enable options and change their values here |
| 1170 | * only if you have a good reason and know the consequences. |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1171 | * \{ |
| 1172 | */ |
Gilles Peskine | 3f49cc1 | 2022-04-13 23:21:16 +0200 | [diff] [blame] | 1173 | /* The Doxygen documentation here is used when a user comments out a |
| 1174 | * setting and runs doxygen themselves. On the other hand, when we typeset |
| 1175 | * the full documentation including disabled settings, the documentation |
| 1176 | * in specific modules' header files is used if present. When editing this |
| 1177 | * file, make sure that each option is documented in exactly one place, |
| 1178 | * plus optionally a same-line Doxygen comment here if there is a Doxygen |
| 1179 | * comment in the specific module. */ |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 1180 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 1181 | /* SSL Cache options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1182 | //#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */ |
| 1183 | //#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */ |
Paul Bakker | 6e339b5 | 2013-07-03 13:37:05 +0200 | [diff] [blame] | 1184 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 1185 | /* SSL options */ |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 1186 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 1187 | /** \def MBEDTLS_SSL_IN_CONTENT_LEN |
| 1188 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 1189 | * Maximum length (in bytes) of incoming plaintext fragments. |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 1190 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 1191 | * This determines the size of the incoming TLS I/O buffer in such a way |
| 1192 | * that it is capable of holding the specified amount of plaintext data, |
| 1193 | * regardless of the protection mechanism used. |
| 1194 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 1195 | * \note When using a value less than the default of 16KB on the client, it is |
| 1196 | * recommended to use the Maximum Fragment Length (MFL) extension to |
| 1197 | * inform the server about this limitation. On the server, there |
| 1198 | * is no supported, standardized way of informing the client about |
| 1199 | * restriction on the maximum size of incoming messages, and unless |
| 1200 | * the limitation has been communicated by other means, it is recommended |
| 1201 | * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN |
| 1202 | * while keeping the default value of 16KB for the incoming buffer. |
| 1203 | * |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 1204 | * 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] | 1205 | */ |
| 1206 | //#define MBEDTLS_SSL_IN_CONTENT_LEN 16384 |
| 1207 | |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1208 | /** \def MBEDTLS_SSL_CID_IN_LEN_MAX |
| 1209 | * |
| 1210 | * The maximum length of CIDs used for incoming DTLS messages. |
| 1211 | * |
| 1212 | */ |
| 1213 | //#define MBEDTLS_SSL_CID_IN_LEN_MAX 32 |
| 1214 | |
| 1215 | /** \def MBEDTLS_SSL_CID_OUT_LEN_MAX |
| 1216 | * |
| 1217 | * The maximum length of CIDs used for outgoing DTLS messages. |
| 1218 | * |
| 1219 | */ |
| 1220 | //#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32 |
| 1221 | |
TRodziewicz | e8dd709 | 2021-05-12 14:19:11 +0200 | [diff] [blame] | 1222 | /** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY |
Gilles Peskine | d3d0290 | 2020-03-04 21:35:27 +0100 | [diff] [blame] | 1223 | * |
| 1224 | * This option controls the use of record plaintext padding |
TRodziewicz | 1e660ed | 2021-05-26 17:08:54 +0200 | [diff] [blame] | 1225 | * 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] | 1226 | * |
| 1227 | * The padding will always be chosen so that the length of the |
| 1228 | * padded plaintext is a multiple of the value of this option. |
| 1229 | * |
| 1230 | * Note: A value of \c 1 means that no padding will be used |
| 1231 | * for outgoing records. |
| 1232 | * |
| 1233 | * Note: On systems lacking division instructions, |
| 1234 | * a power of two should be preferred. |
| 1235 | */ |
TRodziewicz | e8dd709 | 2021-05-12 14:19:11 +0200 | [diff] [blame] | 1236 | //#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16 |
Hanno Becker | 1399692 | 2020-05-28 16:15:19 +0100 | [diff] [blame] | 1237 | |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 1238 | /** \def MBEDTLS_SSL_OUT_CONTENT_LEN |
| 1239 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 1240 | * Maximum length (in bytes) of outgoing plaintext fragments. |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 1241 | * |
Andrzej Kurek | c470b6b | 2019-01-31 08:20:20 -0500 | [diff] [blame] | 1242 | * This determines the size of the outgoing TLS I/O buffer in such a way |
| 1243 | * that it is capable of holding the specified amount of plaintext data, |
| 1244 | * regardless of the protection mechanism used. |
| 1245 | * |
Angus Gratton | d8213d0 | 2016-05-25 20:56:48 +1000 | [diff] [blame] | 1246 | * It is possible to save RAM by setting a smaller outward buffer, while keeping |
| 1247 | * the default inward 16384 byte buffer to conform to the TLS specification. |
| 1248 | * |
| 1249 | * The minimum required outward buffer size is determined by the handshake |
| 1250 | * protocol's usage. Handshaking will fail if the outward buffer is too small. |
| 1251 | * The specific size requirement depends on the configured ciphers and any |
| 1252 | * certificate data which is sent during the handshake. |
| 1253 | * |
David Horstmann | 95d516f | 2021-05-04 18:36:56 +0100 | [diff] [blame] | 1254 | * 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] | 1255 | */ |
| 1256 | //#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384 |
| 1257 | |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 1258 | /** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING |
| 1259 | * |
| 1260 | * Maximum number of heap-allocated bytes for the purpose of |
| 1261 | * DTLS handshake message reassembly and future message buffering. |
| 1262 | * |
Yuto Takano | 7828ca2 | 2021-08-10 11:26:15 +0100 | [diff] [blame] | 1263 | * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN |
Hanno Becker | 2800751 | 2018-08-28 09:46:44 +0100 | [diff] [blame] | 1264 | * to account for a reassembled handshake message of maximum size, |
| 1265 | * together with its reassembly bitmap. |
| 1266 | * |
Hanno Becker | 97a1c13 | 2018-08-28 14:42:15 +0100 | [diff] [blame] | 1267 | * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default) |
Hanno Becker | 2800751 | 2018-08-28 09:46:44 +0100 | [diff] [blame] | 1268 | * should be sufficient for all practical situations as it allows |
| 1269 | * to reassembly a large handshake message (such as a certificate) |
| 1270 | * while buffering multiple smaller handshake messages. |
| 1271 | * |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 1272 | */ |
Hanno Becker | 159a37f | 2018-08-24 15:07:29 +0100 | [diff] [blame] | 1273 | //#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768 |
Hanno Becker | e0b150f | 2018-08-21 15:51:03 +0100 | [diff] [blame] | 1274 | |
Ronald Cron | 1aa6e8d | 2023-02-23 09:46:54 +0100 | [diff] [blame] | 1275 | //#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] | 1276 | //#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] | 1277 | |
Manuel Pégourié-Gonnard | dfc7df0 | 2014-06-30 17:59:55 +0200 | [diff] [blame] | 1278 | /** |
| 1279 | * Complete list of ciphersuites to use, in order of preference. |
| 1280 | * |
| 1281 | * \warning No dependency checking is done on that field! This option can only |
| 1282 | * be used to restrict the set of available ciphersuites. It is your |
| 1283 | * responsibility to make sure the needed modules are active. |
| 1284 | * |
| 1285 | * Use this to save a few hundred bytes of ROM (default ordering of all |
| 1286 | * available ciphersuites) and a few to a few hundred bytes of RAM. |
| 1287 | * |
| 1288 | * The value below is only an example, not the default. |
| 1289 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1290 | //#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] | 1291 | |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1292 | /** |
Tom Cosgrove | a63775b | 2023-09-14 13:31:19 +0100 | [diff] [blame] | 1293 | * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE |
| 1294 | * |
| 1295 | * The default maximum amount of 0-RTT data. See the documentation of |
Yanray Wang | 0751761 | 2023-11-07 11:47:36 +0800 | [diff] [blame] | 1296 | * \c mbedtls_ssl_conf_max_early_data_size() for more information. |
Tom Cosgrove | a63775b | 2023-09-14 13:31:19 +0100 | [diff] [blame] | 1297 | * |
| 1298 | * It must be positive and smaller than UINT32_MAX. |
| 1299 | * |
| 1300 | * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not |
| 1301 | * have any impact on the build. |
Tom Cosgrove | a63775b | 2023-09-14 13:31:19 +0100 | [diff] [blame] | 1302 | */ |
| 1303 | //#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024 |
| 1304 | |
| 1305 | /** |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1306 | * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE |
| 1307 | * |
Jerry Yu | cf91351 | 2023-11-14 11:06:52 +0800 | [diff] [blame] | 1308 | * Maximum allowed ticket age difference in milliseconds tolerated between |
Jerry Yu | 034a8b7 | 2023-11-10 12:20:19 +0800 | [diff] [blame] | 1309 | * server and client. Default value is 6000. This is not used in TLS 1.2. |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1310 | * |
Jerry Yu | 034a8b7 | 2023-11-10 12:20:19 +0800 | [diff] [blame] | 1311 | * - The client ticket age is the time difference between the time when the |
| 1312 | * client proposes to the server to use the ticket and the time the client |
| 1313 | * received the ticket from the server. |
| 1314 | * - The server ticket age is the time difference between the time when the |
| 1315 | * server receives a proposition from the client to use the ticket and the |
| 1316 | * time when the ticket was created by the server. |
| 1317 | * |
Jerry Yu | cf91351 | 2023-11-14 11:06:52 +0800 | [diff] [blame] | 1318 | * The ages might be different due to the client and server clocks not running |
| 1319 | * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts |
| 1320 | * per million (360 to 72 milliseconds per hour). Default tolerance window is |
| 1321 | * 6s, thus in the worst case clients and servers must sync up their system time |
| 1322 | * every 6000/360/2~=8 hours. |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1323 | * |
Jerry Yu | 04fceb7 | 2023-11-15 09:52:46 +0800 | [diff] [blame] | 1324 | * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information. |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1325 | */ |
Gilles Peskine | d65ea42 | 2023-09-05 21:07:32 +0200 | [diff] [blame] | 1326 | //#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000 |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1327 | |
| 1328 | /** |
| 1329 | * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH |
| 1330 | * |
| 1331 | * Size in bytes of a ticket nonce. This is not used in TLS 1.2. |
| 1332 | * |
| 1333 | * This must be less than 256. |
| 1334 | */ |
Gilles Peskine | d65ea42 | 2023-09-05 21:07:32 +0200 | [diff] [blame] | 1335 | //#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32 |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1336 | |
| 1337 | /** |
| 1338 | * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS |
| 1339 | * |
| 1340 | * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server |
| 1341 | * after handshake completion. This is not used in TLS 1.2 and relevant only if |
| 1342 | * the MBEDTLS_SSL_SESSION_TICKETS option is enabled. |
| 1343 | * |
| 1344 | */ |
Gilles Peskine | d65ea42 | 2023-09-05 21:07:32 +0200 | [diff] [blame] | 1345 | //#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1 |
Gilles Peskine | a8d7e43 | 2022-08-04 23:39:41 +0200 | [diff] [blame] | 1346 | |
Manuel Pégourié-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 1347 | /* X509 options */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1348 | //#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] | 1349 | //#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] | 1350 | |
Gilles Peskine | 611179c | 2022-04-13 23:04:48 +0200 | [diff] [blame] | 1351 | /** \} name SECTION: Module configuration options */ |