blob: 860f36092584ba7e3b993f46ed7f29586ab7be80 [file] [log] [blame]
Gilles Peskine9d6a63b2023-09-04 17:49:07 +02001/**
2 * \file mbedtls/config_adjust_legacy_crypto.h
3 * \brief Adjust legacy configuration configuration
4 *
Gilles Peskine975e74c2024-04-26 14:18:10 +02005 * This is an internal header. Do not include it directly.
6 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08007 * Automatically enable certain dependencies. Generally, MBEDTLS_xxx
Gilles Peskine9d6a63b2023-09-04 17:49:07 +02008 * configurations need to be explicitly enabled by the user: enabling
9 * MBEDTLS_xxx_A but not MBEDTLS_xxx_B when A requires B results in a
10 * compilation error. However, we do automatically enable certain options
11 * in some circumstances. One case is if MBEDTLS_xxx_B is an internal option
12 * used to identify parts of a module that are used by other module, and we
13 * don't want to make the symbol MBEDTLS_xxx_B part of the public API.
14 * Another case is if A didn't depend on B in earlier versions, and we
15 * want to use B in A but we need to preserve backward compatibility with
16 * configurations that explicitly activate MBEDTLS_xxx_A but not
17 * MBEDTLS_xxx_B.
18 */
19/*
20 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000021 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine9d6a63b2023-09-04 17:49:07 +020022 */
23
24#ifndef MBEDTLS_CONFIG_ADJUST_LEGACY_CRYPTO_H
25#define MBEDTLS_CONFIG_ADJUST_LEGACY_CRYPTO_H
26
Gilles Peskine0b8ece62024-05-16 14:46:09 +020027#if !defined(MBEDTLS_CONFIG_FILES_READ)
28#error "Do not include mbedtls/config_adjust_*.h manually! This can lead to problems, " \
29 "up to and including runtime errors such as buffer overflows. " \
30 "If you're trying to fix a complaint from check_config.h, just remove " \
31 "it from your configuration file: since Mbed TLS 3.0, it is included " \
Gilles Peskine9df78062024-05-29 09:33:04 +020032 "automatically at the right point."
Gilles Peskine0b8ece62024-05-16 14:46:09 +020033#endif /* */
34
Manuel Pégourié-Gonnard1463e492024-02-08 12:28:30 +010035/* Ideally, we'd set those as defaults in mbedtls_config.h, but
36 * putting an #ifdef _WIN32 in mbedtls_config.h would confuse config.py.
37 *
38 * So, adjust it here.
39 * Not related to crypto, but this is the bottom of the stack. */
40#if defined(__MINGW32__) || (defined(_MSC_VER) && _MSC_VER <= 1900)
41#if !defined(MBEDTLS_PLATFORM_SNPRINTF_ALT) && \
42 !defined(MBEDTLS_PLATFORM_SNPRINTF_MACRO)
43#define MBEDTLS_PLATFORM_SNPRINTF_ALT
44#endif
45#if !defined(MBEDTLS_PLATFORM_VSNPRINTF_ALT) && \
46 !defined(MBEDTLS_PLATFORM_VSNPRINTF_MACRO)
47#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
48#endif
49#endif /* _MINGW32__ || (_MSC_VER && (_MSC_VER <= 1900)) */
50
Valerio Setti97726422023-12-28 09:55:09 +010051/* Auto-enable CIPHER_C when any of the unauthenticated ciphers is builtin
52 * in PSA. */
53#if defined(MBEDTLS_PSA_CRYPTO_C) && \
54 (defined(MBEDTLS_PSA_BUILTIN_ALG_STREAM_CIPHER) || \
55 defined(MBEDTLS_PSA_BUILTIN_ALG_CTR) || \
56 defined(MBEDTLS_PSA_BUILTIN_ALG_CFB) || \
57 defined(MBEDTLS_PSA_BUILTIN_ALG_OFB) || \
58 defined(MBEDTLS_PSA_BUILTIN_ALG_ECB_NO_PADDING) || \
59 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_NO_PADDING) || \
60 defined(MBEDTLS_PSA_BUILTIN_ALG_CBC_PKCS7) || \
Valerio Settia37ea262024-05-24 14:37:05 +020061 defined(MBEDTLS_PSA_BUILTIN_ALG_CCM_STAR_NO_TAG) || \
62 defined(MBEDTLS_PSA_BUILTIN_ALG_CMAC))
Valerio Setti97726422023-12-28 09:55:09 +010063#define MBEDTLS_CIPHER_C
64#endif
65
Gilles Peskine9d6a63b2023-09-04 17:49:07 +020066/* Auto-enable MBEDTLS_MD_LIGHT based on MBEDTLS_MD_C.
67 * This allows checking for MD_LIGHT rather than MD_LIGHT || MD_C.
68 */
69#if defined(MBEDTLS_MD_C)
70#define MBEDTLS_MD_LIGHT
71#endif
72
73/* Auto-enable MBEDTLS_MD_LIGHT if needed by a module that didn't require it
74 * in a previous release, to ensure backwards compatibility.
75 */
76#if defined(MBEDTLS_ECJPAKE_C) || \
77 defined(MBEDTLS_PEM_PARSE_C) || \
78 defined(MBEDTLS_ENTROPY_C) || \
79 defined(MBEDTLS_PK_C) || \
80 defined(MBEDTLS_PKCS12_C) || \
81 defined(MBEDTLS_RSA_C) || \
82 defined(MBEDTLS_SSL_TLS_C) || \
83 defined(MBEDTLS_X509_USE_C) || \
84 defined(MBEDTLS_X509_CREATE_C)
85#define MBEDTLS_MD_LIGHT
86#endif
87
Valerio Setti85d2a982023-10-06 16:04:49 +020088#if defined(MBEDTLS_MD_LIGHT)
89/*
90 * - MBEDTLS_MD_CAN_xxx is defined if the md module can perform xxx.
91 * - MBEDTLS_MD_xxx_VIA_PSA is defined if the md module may perform xxx via PSA
92 * (see below).
93 * - MBEDTLS_MD_SOME_PSA is defined if at least one algorithm may be performed
94 * via PSA (see below).
95 * - MBEDTLS_MD_SOME_LEGACY is defined if at least one algorithm may be performed
96 * via a direct legacy call (see below).
97 *
98 * The md module performs an algorithm via PSA if there is a PSA hash
99 * accelerator and the PSA driver subsytem is initialized at the time the
100 * operation is started, and makes a direct legacy call otherwise.
101 */
102
103/* PSA accelerated implementations */
104#if defined(MBEDTLS_PSA_CRYPTO_C)
105
106#if defined(MBEDTLS_PSA_ACCEL_ALG_MD5)
Valerio Setti85d2a982023-10-06 16:04:49 +0200107#define MBEDTLS_MD_MD5_VIA_PSA
108#define MBEDTLS_MD_SOME_PSA
109#endif
110#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_1)
Valerio Setti85d2a982023-10-06 16:04:49 +0200111#define MBEDTLS_MD_SHA1_VIA_PSA
112#define MBEDTLS_MD_SOME_PSA
113#endif
114#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_224)
Valerio Setti85d2a982023-10-06 16:04:49 +0200115#define MBEDTLS_MD_SHA224_VIA_PSA
116#define MBEDTLS_MD_SOME_PSA
117#endif
118#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_256)
Valerio Setti85d2a982023-10-06 16:04:49 +0200119#define MBEDTLS_MD_SHA256_VIA_PSA
120#define MBEDTLS_MD_SOME_PSA
121#endif
122#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_384)
Valerio Setti85d2a982023-10-06 16:04:49 +0200123#define MBEDTLS_MD_SHA384_VIA_PSA
124#define MBEDTLS_MD_SOME_PSA
125#endif
126#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_512)
127#define MBEDTLS_MD_CAN_SHA512
128#define MBEDTLS_MD_SHA512_VIA_PSA
129#define MBEDTLS_MD_SOME_PSA
130#endif
131#if defined(MBEDTLS_PSA_ACCEL_ALG_RIPEMD160)
Valerio Setti85d2a982023-10-06 16:04:49 +0200132#define MBEDTLS_MD_RIPEMD160_VIA_PSA
133#define MBEDTLS_MD_SOME_PSA
134#endif
135#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA3_224)
Valerio Setti85d2a982023-10-06 16:04:49 +0200136#define MBEDTLS_MD_SHA3_224_VIA_PSA
137#define MBEDTLS_MD_SOME_PSA
138#endif
139#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA3_256)
Valerio Setti85d2a982023-10-06 16:04:49 +0200140#define MBEDTLS_MD_SHA3_256_VIA_PSA
141#define MBEDTLS_MD_SOME_PSA
142#endif
143#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA3_384)
Valerio Setti85d2a982023-10-06 16:04:49 +0200144#define MBEDTLS_MD_SHA3_384_VIA_PSA
145#define MBEDTLS_MD_SOME_PSA
146#endif
147#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA3_512)
Valerio Setti85d2a982023-10-06 16:04:49 +0200148#define MBEDTLS_MD_SHA3_512_VIA_PSA
149#define MBEDTLS_MD_SOME_PSA
150#endif
151#endif /* MBEDTLS_PSA_CRYPTO_C */
152
153/* Built-in implementations */
154#if defined(MBEDTLS_MD5_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200155#define MBEDTLS_MD_SOME_LEGACY
156#endif
157#if defined(MBEDTLS_SHA1_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200158#define MBEDTLS_MD_SOME_LEGACY
159#endif
160#if defined(MBEDTLS_SHA224_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200161#define MBEDTLS_MD_SOME_LEGACY
162#endif
163#if defined(MBEDTLS_SHA256_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200164#define MBEDTLS_MD_SOME_LEGACY
165#endif
166#if defined(MBEDTLS_SHA384_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200167#define MBEDTLS_MD_SOME_LEGACY
168#endif
169#if defined(MBEDTLS_SHA512_C)
170#define MBEDTLS_MD_CAN_SHA512
171#define MBEDTLS_MD_SOME_LEGACY
172#endif
173#if defined(MBEDTLS_SHA3_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200174#define MBEDTLS_MD_SOME_LEGACY
175#endif
176#if defined(MBEDTLS_RIPEMD160_C)
Valerio Setti85d2a982023-10-06 16:04:49 +0200177#define MBEDTLS_MD_SOME_LEGACY
178#endif
179
180#endif /* MBEDTLS_MD_LIGHT */
181
Valerio Setti8bba0872023-12-12 11:49:02 +0100182/* BLOCK_CIPHER module can dispatch to PSA when:
183 * - PSA is enabled and drivers have been initialized
184 * - desired key type is supported on the PSA side
185 * If the above conditions are not met, but the legacy support is enabled, then
Valerio Setti2684e3f2023-12-13 16:53:02 +0100186 * BLOCK_CIPHER will dynamically fallback to it.
Valerio Setti4a5d57d2023-12-14 09:34:15 +0100187 *
188 * In case BLOCK_CIPHER is defined (see below) the following symbols/helpers
189 * can be used to define its capabilities:
190 * - MBEDTLS_BLOCK_CIPHER_SOME_PSA: there is at least 1 key type between AES,
191 * ARIA and Camellia which is supported through a driver;
192 * - MBEDTLS_BLOCK_CIPHER_xxx_VIA_PSA: xxx key type is supported through a
193 * driver;
194 * - MBEDTLS_BLOCK_CIPHER_xxx_VIA_LEGACY: xxx key type is supported through
195 * a legacy module (i.e. MBEDTLS_xxx_C)
Valerio Setti8bba0872023-12-12 11:49:02 +0100196 */
Valerio Setti8bba0872023-12-12 11:49:02 +0100197#if defined(MBEDTLS_PSA_CRYPTO_C)
198#if defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_AES)
199#define MBEDTLS_BLOCK_CIPHER_AES_VIA_PSA
200#define MBEDTLS_BLOCK_CIPHER_SOME_PSA
201#endif
202#if defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_ARIA)
203#define MBEDTLS_BLOCK_CIPHER_ARIA_VIA_PSA
204#define MBEDTLS_BLOCK_CIPHER_SOME_PSA
205#endif
206#if defined(MBEDTLS_PSA_ACCEL_KEY_TYPE_CAMELLIA)
207#define MBEDTLS_BLOCK_CIPHER_CAMELLIA_VIA_PSA
208#define MBEDTLS_BLOCK_CIPHER_SOME_PSA
209#endif
210#endif /* MBEDTLS_PSA_CRYPTO_C */
211
212#if defined(MBEDTLS_AES_C)
213#define MBEDTLS_BLOCK_CIPHER_AES_VIA_LEGACY
214#endif
215#if defined(MBEDTLS_ARIA_C)
216#define MBEDTLS_BLOCK_CIPHER_ARIA_VIA_LEGACY
217#endif
218#if defined(MBEDTLS_CAMELLIA_C)
219#define MBEDTLS_BLOCK_CIPHER_CAMELLIA_VIA_LEGACY
220#endif
221
Valerio Setti4a5d57d2023-12-14 09:34:15 +0100222/* Helpers to state that BLOCK_CIPHER module supports AES, ARIA and/or Camellia
223 * block ciphers via either PSA or legacy. */
Valerio Setti8bba0872023-12-12 11:49:02 +0100224#if defined(MBEDTLS_BLOCK_CIPHER_AES_VIA_PSA) || \
225 defined(MBEDTLS_BLOCK_CIPHER_AES_VIA_LEGACY)
226#define MBEDTLS_BLOCK_CIPHER_CAN_AES
227#endif
228#if defined(MBEDTLS_BLOCK_CIPHER_ARIA_VIA_PSA) || \
229 defined(MBEDTLS_BLOCK_CIPHER_ARIA_VIA_LEGACY)
230#define MBEDTLS_BLOCK_CIPHER_CAN_ARIA
231#endif
232#if defined(MBEDTLS_BLOCK_CIPHER_CAMELLIA_VIA_PSA) || \
233 defined(MBEDTLS_BLOCK_CIPHER_CAMELLIA_VIA_LEGACY)
234#define MBEDTLS_BLOCK_CIPHER_CAN_CAMELLIA
235#endif
236
Valerio Setti4a5d57d2023-12-14 09:34:15 +0100237/* GCM_C and CCM_C can either depend on (in order of preference) BLOCK_CIPHER_C
238 * or CIPHER_C. The former is auto-enabled when:
239 * - CIPHER_C is not defined, which is also the legacy solution;
240 * - BLOCK_CIPHER_SOME_PSA because in this case BLOCK_CIPHER can take advantage
241 * of the driver's acceleration.
242 */
243#if (defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C)) && \
244 (!defined(MBEDTLS_CIPHER_C) || defined(MBEDTLS_BLOCK_CIPHER_SOME_PSA))
245#define MBEDTLS_BLOCK_CIPHER_C
246#endif
247
Valerio Settibfa675f2023-12-20 09:52:08 +0100248/* Helpers for GCM/CCM capabilities */
249#if (defined(MBEDTLS_CIPHER_C) && defined(MBEDTLS_AES_C)) || \
250 (defined(MBEDTLS_BLOCK_CIPHER_C) && defined(MBEDTLS_BLOCK_CIPHER_CAN_AES))
251#define MBEDTLS_CCM_GCM_CAN_AES
252#endif
253
254#if (defined(MBEDTLS_CIPHER_C) && defined(MBEDTLS_ARIA_C)) || \
255 (defined(MBEDTLS_BLOCK_CIPHER_C) && defined(MBEDTLS_BLOCK_CIPHER_CAN_ARIA))
256#define MBEDTLS_CCM_GCM_CAN_ARIA
257#endif
258
259#if (defined(MBEDTLS_CIPHER_C) && defined(MBEDTLS_CAMELLIA_C)) || \
260 (defined(MBEDTLS_BLOCK_CIPHER_C) && defined(MBEDTLS_BLOCK_CIPHER_CAN_CAMELLIA))
261#define MBEDTLS_CCM_GCM_CAN_CAMELLIA
262#endif
263
Gilles Peskine9d6a63b2023-09-04 17:49:07 +0200264/* MBEDTLS_ECP_LIGHT is auto-enabled by the following symbols:
265 * - MBEDTLS_ECP_C because now it consists of MBEDTLS_ECP_LIGHT plus functions
266 * for curve arithmetic. As a consequence if MBEDTLS_ECP_C is required for
267 * some reason, then MBEDTLS_ECP_LIGHT should be enabled as well.
268 * - MBEDTLS_PK_PARSE_EC_EXTENDED and MBEDTLS_PK_PARSE_EC_COMPRESSED because
269 * these features are not supported in PSA so the only way to have them is
270 * to enable the built-in solution.
271 * Both of them are temporary dependencies:
272 * - PK_PARSE_EC_EXTENDED will be removed after #7779 and #7789
273 * - support for compressed points should also be added to PSA, but in this
274 * case there is no associated issue to track it yet.
275 * - PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE because Weierstrass key derivation
276 * still depends on ECP_LIGHT.
277 * - PK_C + USE_PSA + PSA_WANT_ALG_ECDSA is a temporary dependency which will
278 * be fixed by #7453.
279 */
280#if defined(MBEDTLS_ECP_C) || \
281 defined(MBEDTLS_PK_PARSE_EC_EXTENDED) || \
282 defined(MBEDTLS_PK_PARSE_EC_COMPRESSED) || \
283 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
284#define MBEDTLS_ECP_LIGHT
285#endif
286
Valerio Setti89f5af82024-04-18 06:54:32 +0200287/* Backward compatibility: after #8740 the RSA module offers functions to parse
288 * and write RSA private/public keys without relying on the PK one. Of course
289 * this needs ASN1 support to do so, so we enable it here. */
290#if defined(MBEDTLS_RSA_C)
291#define MBEDTLS_ASN1_PARSE_C
292#define MBEDTLS_ASN1_WRITE_C
293#endif
294
Thomas Daubney540324c2023-10-06 17:07:24 +0100295/* MBEDTLS_PK_PARSE_EC_COMPRESSED is introduced in Mbed TLS version 3.5, while
Gilles Peskine9d6a63b2023-09-04 17:49:07 +0200296 * in previous version compressed points were automatically supported as long
297 * as PK_PARSE_C and ECP_C were enabled. As a consequence, for backward
298 * compatibility, we auto-enable PK_PARSE_EC_COMPRESSED when these conditions
299 * are met. */
300#if defined(MBEDTLS_PK_PARSE_C) && defined(MBEDTLS_ECP_C)
301#define MBEDTLS_PK_PARSE_EC_COMPRESSED
302#endif
303
304/* Helper symbol to state that there is support for ECDH, either through
305 * library implementation (ECDH_C) or through PSA. */
306#if (defined(MBEDTLS_USE_PSA_CRYPTO) && defined(PSA_WANT_ALG_ECDH)) || \
307 (!defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C))
308#define MBEDTLS_CAN_ECDH
309#endif
310
Gilles Peskine9d6a63b2023-09-04 17:49:07 +0200311/* If MBEDTLS_PSA_CRYPTO_C is defined, make sure MBEDTLS_PSA_CRYPTO_CLIENT
312 * is defined as well to include all PSA code.
313 */
314#if defined(MBEDTLS_PSA_CRYPTO_C)
315#define MBEDTLS_PSA_CRYPTO_CLIENT
316#endif /* MBEDTLS_PSA_CRYPTO_C */
317
Gilles Peskineca1e6052023-09-25 16:16:26 +0200318/* Historically pkparse did not check the CBC padding when decrypting
319 * a key. This was a bug, which is now fixed. As a consequence, pkparse
320 * now needs PKCS7 padding support, but existing configurations might not
321 * enable it, so we enable it here. */
322#if defined(MBEDTLS_PK_PARSE_C) && defined(MBEDTLS_PKCS5_C) && defined(MBEDTLS_CIPHER_MODE_CBC)
323#define MBEDTLS_CIPHER_PADDING_PKCS7
324#endif
325
Dave Rodgman94a634d2023-10-10 12:59:29 +0100326/* Backwards compatibility for some macros which were renamed to reflect that
327 * they are related to Armv8, not aarch64. */
Dave Rodgmanc5861d52023-10-10 14:01:54 +0100328#if defined(MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT) && \
Dave Rodgman5b89c552023-10-10 14:59:02 +0100329 !defined(MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT)
330#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +0100331#endif
Dave Rodgman5b89c552023-10-10 14:59:02 +0100332#if defined(MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY) && !defined(MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY)
333#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +0100334#endif
Dave Rodgman94a634d2023-10-10 12:59:29 +0100335
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800336/* Some internal helpers to determine which operation modes are available. */
Yanray Wang4ed86912023-11-16 15:20:56 +0800337
Elena Uziunaitec0d69432024-08-20 14:53:19 +0100338#if defined(PSA_WANT_ALG_GCM) || defined(PSA_WANT_ALG_CCM) || \
339 defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Valerio Settie5707042023-10-11 11:54:42 +0200340#define MBEDTLS_SSL_HAVE_AEAD
341#endif
342
Gilles Peskine9d6a63b2023-09-04 17:49:07 +0200343#endif /* MBEDTLS_CONFIG_ADJUST_LEGACY_CRYPTO_H */