blob: af1b91440ecce9bf68b83378e56efddaa07dd551 [file] [log] [blame]
Minos Galanakis6aab5b72024-07-25 14:24:37 +01001# components-configuration-crypto.sh
2#
3# Copyright The Mbed TLS Contributors
4# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
5
Minos Galanakis609f7492024-07-31 16:39:28 +01006# This file contains test components that are executed by all.sh
Minos Galanakis6aab5b72024-07-25 14:24:37 +01007
8################################################################
9#### Configuration Testing - Crypto
10################################################################
11
Minos Galanakis471b34c2024-07-26 15:39:24 +010012component_test_psa_crypto_key_id_encodes_owner () {
13 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
14 scripts/config.py full
15 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
16 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
17 make
18
19 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
20 make test
21}
22
23component_test_psa_assume_exclusive_buffers () {
24 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
25 scripts/config.py full
26 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
27 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
28 make
29
30 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
31 make test
32}
33
Valerio Settidbb646b2024-06-20 14:40:54 +020034component_test_crypto_with_static_key_slots() {
35 msg "build: crypto full + MBEDTLS_PSA_STATIC_KEY_SLOTS"
36 scripts/config.py crypto_full
37 scripts/config.py set MBEDTLS_PSA_STATIC_KEY_SLOTS
Valerio Setti4d9a8212024-08-16 12:35:24 +020038 # Intentionally set MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE to a value that
39 # is enough to contain:
40 # - all RSA public keys up to 4096 bits (max of PSA_VENDOR_RSA_MAX_KEY_BITS).
41 # - RSA key pairs up to 1024 bits, but not 2048 or larger.
42 # - all FFDH key pairs and public keys up to 8192 bits (max of PSA_VENDOR_FFDH_MAX_KEY_BITS).
43 # - all EC key pairs and public keys up to 521 bits (max of PSA_VENDOR_ECC_MAX_CURVE_BITS).
44 scripts/config.py set MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 1212
Valerio Setti8bc81722024-08-28 05:50:45 +020045 # Disable the fully dynamic key store (default on) since it conflicts
46 # with the static behavior that we're testing here.
47 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
Valerio Settidbb646b2024-06-20 14:40:54 +020048
Valerio Setti13aadd72024-08-13 13:13:23 +020049 msg "test: crypto full + MBEDTLS_PSA_STATIC_KEY_SLOTS"
Valerio Setti2a3c9b32024-08-14 06:37:02 +020050 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test
Valerio Settidbb646b2024-06-20 14:40:54 +020051}
52
Minos Galanakis471b34c2024-07-26 15:39:24 +010053# check_renamed_symbols HEADER LIB
54# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
Minos Galanakis609f7492024-07-31 16:39:28 +010055# name in LIB.
Minos Galanakis471b34c2024-07-26 15:39:24 +010056check_renamed_symbols () {
57 ! nm "$2" | sed 's/.* //' |
58 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
59}
60
61component_build_psa_crypto_spm () {
62 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
63 scripts/config.py full
64 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
65 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
66 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
67 # We can only compile, not link, since our test and sample programs
68 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
69 # is active.
David Horstmann5b93d972024-10-31 15:36:05 +000070 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../framework/tests/include/spe' lib
Minos Galanakis471b34c2024-07-26 15:39:24 +010071
72 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
73 # version is not present.
74 echo "Checking for renamed symbols in the library"
David Horstmann5b93d972024-10-31 15:36:05 +000075 check_renamed_symbols framework/tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Minos Galanakis471b34c2024-07-26 15:39:24 +010076}
77
Valerio Settia47b0452024-06-25 18:31:36 +020078# The goal of this component is to build a configuration where:
79# - test code and libtestdriver1 can make use of calloc/free and
80# - core library (including PSA core) cannot use calloc/free.
81component_test_psa_crypto_without_heap() {
Valerio Setti13aadd72024-08-13 13:13:23 +020082 msg "crypto without heap: build libtestdriver1"
Valerio Settia47b0452024-06-25 18:31:36 +020083 # Disable PSA features that cannot be accelerated and whose builtin support
84 # requires calloc/free.
Minos Galanakis00b641c2024-11-28 23:05:10 +000085 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
86 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "^PSA_WANT_ALG_HKDF"
87 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "^PSA_WANT_ALG_PBKDF2_"
88 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "^PSA_WANT_ALG_TLS12_"
Valerio Settia47b0452024-06-25 18:31:36 +020089 # RSA key support requires ASN1 parse/write support for testing, but ASN1
90 # is disabled below.
Minos Galanakis00b641c2024-11-28 23:05:10 +000091 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "^PSA_WANT_KEY_TYPE_RSA_"
92 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "^PSA_WANT_ALG_RSA_"
Valerio Settia47b0452024-06-25 18:31:36 +020093 # DES requires built-in support for key generation (parity check) so it
94 # cannot be accelerated
Minos Galanakis00b641c2024-11-28 23:05:10 +000095 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Settia47b0452024-06-25 18:31:36 +020096 # EC-JPAKE use calloc/free in PSA core
Minos Galanakis00b641c2024-11-28 23:05:10 +000097 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
Valerio Settia47b0452024-06-25 18:31:36 +020098
99 # Accelerate all PSA features (which are still enabled in CRYPTO_CONFIG_H).
Minos Galanakis00b641c2024-11-28 23:05:10 +0000100 PSA_SYM_LIST=$(./scripts/config.py -c $CRYPTO_CONFIG_H get-all-enabled PSA_WANT)
Valerio Settia47b0452024-06-25 18:31:36 +0200101 loc_accel_list=$(echo $PSA_SYM_LIST | sed 's/PSA_WANT_//g')
102
Valerio Settia47b0452024-06-25 18:31:36 +0200103 helper_libtestdriver1_adjust_config crypto
104 helper_libtestdriver1_make_drivers "$loc_accel_list"
105
Valerio Setti13aadd72024-08-13 13:13:23 +0200106 msg "crypto without heap: build main library"
Valerio Setti35b0b022024-08-13 13:36:50 +0200107 # Disable all legacy MBEDTLS_xxx symbols.
108 scripts/config.py unset-all "^MBEDTLS_"
109 # Build the PSA core using the proper config file.
110 scripts/config.py set MBEDTLS_PSA_CRYPTO_C
Valerio Settia47b0452024-06-25 18:31:36 +0200111 # Enable fully-static key slots in PSA core.
112 scripts/config.py set MBEDTLS_PSA_STATIC_KEY_SLOTS
Valerio Setti35b0b022024-08-13 13:36:50 +0200113 # Prevent PSA core from creating a copy of input/output buffers.
Valerio Settia47b0452024-06-25 18:31:36 +0200114 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
115 # Prevent PSA core from using CTR-DRBG or HMAC-DRBG for random generation.
116 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Valerio Setti13aadd72024-08-13 13:13:23 +0200117 # Set calloc/free as null pointer functions. Calling them would crash
Valerio Settia47b0452024-06-25 18:31:36 +0200118 # the program so we can use this as a "sentinel" for being sure no module
119 # is making use of these functions in the library.
Valerio Setti35b0b022024-08-13 13:36:50 +0200120 scripts/config.py set MBEDTLS_PLATFORM_C
Valerio Settia47b0452024-06-25 18:31:36 +0200121 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
122 scripts/config.py set MBEDTLS_PLATFORM_STD_CALLOC NULL
123 scripts/config.py set MBEDTLS_PLATFORM_STD_FREE NULL
124
Valerio Settia47b0452024-06-25 18:31:36 +0200125 helper_libtestdriver1_make_main "$loc_accel_list" lib
126
Valerio Setti13aadd72024-08-13 13:13:23 +0200127 msg "crypto without heap: build test suites and helpers"
128 # Reset calloc/free functions to normal operations so that test code can
Valerio Settia47b0452024-06-25 18:31:36 +0200129 # freely use them.
130 scripts/config.py unset MBEDTLS_PLATFORM_MEMORY
131 scripts/config.py unset MBEDTLS_PLATFORM_STD_CALLOC
132 scripts/config.py unset MBEDTLS_PLATFORM_STD_FREE
133 helper_libtestdriver1_make_main "$loc_accel_list" tests
134
Valerio Setti13aadd72024-08-13 13:13:23 +0200135 msg "crypto without heap: test"
Valerio Settia47b0452024-06-25 18:31:36 +0200136 make test
137}
138
Minos Galanakisf78447f2024-07-26 20:49:51 +0100139component_test_no_rsa_key_pair_generation () {
Minos Galanakisdc0f73a2024-07-26 20:41:42 +0100140 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Minos Galanakis00b641c2024-11-28 23:05:10 +0000141 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Minos Galanakisdc0f73a2024-07-26 20:41:42 +0100142 make
143
144 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
145 make test
146}
147
Minos Galanakisc06fd302024-08-01 12:16:59 +0100148component_test_no_pem_no_fs () {
149 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
150 scripts/config.py unset MBEDTLS_PEM_PARSE_C
151 scripts/config.py unset MBEDTLS_FS_IO
152 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
153 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
154 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
155 make
156
157 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
158 make test
159
160 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
161 tests/ssl-opt.sh
162}
163
164component_test_rsa_no_crt () {
165 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
166 scripts/config.py set MBEDTLS_RSA_NO_CRT
167 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
168 make
169
170 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
171 make test
172
173 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
174 tests/ssl-opt.sh -f RSA
175
176 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
177 tests/compat.sh -t RSA
178
179 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
180 tests/context-info.sh
181}
182
Minos Galanakisc06fd302024-08-01 12:16:59 +0100183component_test_no_ctr_drbg_use_psa () {
184 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
185 scripts/config.py full
186 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Minos Galanakisc06fd302024-08-01 12:16:59 +0100187
188 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
189 make
190
191 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
192 make test
193
194 # In this configuration, the TLS test programs use HMAC_DRBG.
195 # The SSL tests are slow, so run a small subset, just enough to get
196 # confidence that the SSL code copes with HMAC_DRBG.
197 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
198 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
199
200 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
201 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
202}
203
Minos Galanakisc06fd302024-08-01 12:16:59 +0100204component_test_no_hmac_drbg_use_psa () {
205 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
206 scripts/config.py full
207 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
208 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Minos Galanakisc06fd302024-08-01 12:16:59 +0100209
210 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
211 make
212
213 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
214 make test
215
216 # Normally our ECDSA implementation uses deterministic ECDSA. But since
217 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
218 # instead.
219 # Test SSL with non-deterministic ECDSA. Only test features that
220 # might be affected by how ECDSA signature is performed.
221 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
222 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
223
224 # To save time, only test one protocol version, since this part of
225 # the protocol is identical in (D)TLS up to 1.2.
226 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
227 tests/compat.sh -m tls12 -t 'ECDSA'
228}
229
Minos Galanakisc06fd302024-08-01 12:16:59 +0100230component_test_psa_external_rng_no_drbg_use_psa () {
231 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
232 scripts/config.py full
233 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
234 scripts/config.py unset MBEDTLS_ENTROPY_C
235 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
236 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
237 scripts/config.py unset MBEDTLS_CTR_DRBG_C
238 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
239 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
240 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
241
242 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
243 make test
244
245 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
246 tests/ssl-opt.sh -f 'Default\|opaque'
247}
248
Minos Galanakis471b34c2024-07-26 15:39:24 +0100249component_test_psa_external_rng_use_psa_crypto () {
250 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
251 scripts/config.py full
252 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Minos Galanakis471b34c2024-07-26 15:39:24 +0100253 scripts/config.py unset MBEDTLS_CTR_DRBG_C
254 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
255
256 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
257 make test
258
259 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
260 tests/ssl-opt.sh -f 'Default\|opaque'
261}
262
Minos Galanakisf78447f2024-07-26 20:49:51 +0100263component_full_no_pkparse_pkwrite () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100264 msg "build: full without pkparse and pkwrite"
265
266 scripts/config.py crypto_full
267 scripts/config.py unset MBEDTLS_PK_PARSE_C
268 scripts/config.py unset MBEDTLS_PK_WRITE_C
269
270 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
271
272 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
273 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
274 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
275
276 msg "test: full without pkparse and pkwrite"
277 make test
278}
279
280component_test_crypto_full_md_light_only () {
281 msg "build: crypto_full with only the light subset of MD"
282 scripts/config.py crypto_full
283
284 # Disable MD
285 scripts/config.py unset MBEDTLS_MD_C
286 # Disable direct dependencies of MD_C
287 scripts/config.py unset MBEDTLS_HKDF_C
288 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
289 scripts/config.py unset MBEDTLS_PKCS7_C
290 # Disable indirect dependencies of MD_C
291 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Minos Galanakis00b641c2024-11-28 23:05:10 +0000292 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Minos Galanakis471b34c2024-07-26 15:39:24 +0100293 # Disable things that would auto-enable MD_C
294 scripts/config.py unset MBEDTLS_PKCS5_C
295
296 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
297 # which we haven't disabled, so no need to explicitly enable it.
298 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
299
300 # Make sure we don't have the HMAC functions, but the hashing functions
301 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
302 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
303
304 msg "test: crypto_full with only the light subset of MD"
305 make test
306}
307
Minos Galanakiscd5668f2024-07-26 20:36:23 +0100308component_test_full_no_cipher () {
309 msg "build: full no CIPHER"
310
311 scripts/config.py full
Minos Galanakiscd5668f2024-07-26 20:36:23 +0100312
313 # The built-in implementation of the following algs/key-types depends
314 # on CIPHER_C so we disable them.
315 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
316 # so we keep them enabled.
Minos Galanakis00b641c2024-11-28 23:05:10 +0000317 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
318 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
319 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
320 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
321 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
322 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
323 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
324 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
325 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
326 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
327 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Minos Galanakiscd5668f2024-07-26 20:36:23 +0100328
329 # The following modules directly depends on CIPHER_C
Minos Galanakiscd5668f2024-07-26 20:36:23 +0100330 scripts/config.py unset MBEDTLS_NIST_KW_C
331
332 make
333
334 # Ensure that CIPHER_C was not re-enabled
335 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
336
337 msg "test: full no CIPHER"
338 make test
339}
340
Minos Galanakisf78447f2024-07-26 20:49:51 +0100341component_test_full_no_ccm () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100342 msg "build: full no PSA_WANT_ALG_CCM"
343
344 # Full config enables:
345 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
346 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
347 scripts/config.py full
348
349 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
350 # enabled, but not used from TLS since USE_PSA is set.
351 # This is helpful to ensure that TLS tests below have proper dependencies.
352 #
353 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
354 # PSA_WANT_ALG_CCM to be re-enabled.
355 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
356
357 make
358
359 msg "test: full no PSA_WANT_ALG_CCM"
360 make test
361}
362
Minos Galanakisf78447f2024-07-26 20:49:51 +0100363component_test_full_no_ccm_star_no_tag () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100364 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
365
366 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
367 scripts/config.py full
368
369 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
370 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
371 # This basically disables all unauthenticated ciphers on the PSA side, while
372 # keeping AEADs enabled.
373 #
374 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
375 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
376 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
377 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
378 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
379 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
380 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
381 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
Ben Taylor1948c942025-03-04 09:11:11 +0000382 # NOTE unsettting PSA_WANT_ALG_ECB_NO_PADDING without unsetting NIST_KW_C will
383 # mean PSA_WANT_ALG_ECB_NO_PADDING is re-enabled, so disabling it also.
384 scripts/config.py -f "$CRYPTO_CONFIG_H" unset MBEDTLS_NIST_KW_C
Minos Galanakis471b34c2024-07-26 15:39:24 +0100385 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
386 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
387
388 make
389
390 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
391 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
392
393 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
394 make test
395}
396
Gilles Peskineea5de2b2024-09-19 18:41:55 +0200397component_test_config_symmetric_only () {
398 msg "build: configs/config-symmetric-only.h"
Minos Galanakis5da58e52024-11-07 15:35:33 +0000399 MBEDTLS_CONFIG="configs/config-symmetric-only.h"
Harry Ramsey94c386a2025-01-16 16:08:34 +0000400 CRYPTO_CONFIG="tf-psa-crypto/configs/crypto-config-symmetric-only.h"
Ronald Cronfaadfc22024-12-07 17:24:28 +0100401 CC=$ASAN_CC cmake -DMBEDTLS_CONFIG_FILE="$MBEDTLS_CONFIG" -DTF_PSA_CRYPTO_CONFIG_FILE="$CRYPTO_CONFIG" -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskineaf5a8992024-09-14 11:27:44 +0200402 make
403
Gilles Peskineea5de2b2024-09-19 18:41:55 +0200404 msg "test: configs/config-symmetric-only.h - unit tests"
Gilles Peskineaf5a8992024-09-14 11:27:44 +0200405 make test
406}
407
Minos Galanakisc06fd302024-08-01 12:16:59 +0100408component_test_everest () {
409 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
410 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
411 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
412 make
413
414 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
415 make test
416
417 msg "test: metatests (clang, ASan)"
418 tests/scripts/run-metatests.sh any asan poison
419
420 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
421 tests/ssl-opt.sh -f ECDH
422
423 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
424 # Exclude some symmetric ciphers that are redundant here to gain time.
425 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
426}
427
428component_test_everest_curve25519_only () {
429 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Minos Galanakisc06fd302024-08-01 12:16:59 +0100430 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
431 scripts/config.py unset MBEDTLS_ECDSA_C
Minos Galanakis00b641c2024-11-28 23:05:10 +0000432 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
433 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
434 scripts/config.py -c $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Minos Galanakisc06fd302024-08-01 12:16:59 +0100435 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
436 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
437 scripts/config.py unset MBEDTLS_ECJPAKE_C
Minos Galanakis00b641c2024-11-28 23:05:10 +0000438 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
Minos Galanakisc06fd302024-08-01 12:16:59 +0100439
440 # Disable all curves
441 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Minos Galanakis00b641c2024-11-28 23:05:10 +0000442 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
443 scripts/config.py -c $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Minos Galanakisc06fd302024-08-01 12:16:59 +0100444
445 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
446
447 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
448 make test
449}
450
Minos Galanakis471b34c2024-07-26 15:39:24 +0100451component_test_psa_collect_statuses () {
452 msg "build+test: psa_collect_statuses" # ~30s
453 scripts/config.py full
454 tests/scripts/psa_collect_statuses.py
455 # Check that psa_crypto_init() succeeded at least once
456 grep -q '^0:psa_crypto_init:' tests/statuses.log
457 rm -f tests/statuses.log
458}
459
460# Check that the specified libraries exist and are empty.
461are_empty_libraries () {
462 nm "$@" >/dev/null 2>/dev/null
463 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
464}
465
Minos Galanakis471b34c2024-07-26 15:39:24 +0100466component_test_crypto_for_psa_service () {
467 msg "build: make, config for PSA crypto service"
468 scripts/config.py crypto
469 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
470 # Disable things that are not needed for just cryptography, to
471 # reach a configuration that would be typical for a PSA cryptography
472 # service providing all implemented PSA algorithms.
473 # System stuff
474 scripts/config.py unset MBEDTLS_ERROR_C
475 scripts/config.py unset MBEDTLS_TIMING_C
476 scripts/config.py unset MBEDTLS_VERSION_FEATURES
477 # Crypto stuff with no PSA interface
478 scripts/config.py unset MBEDTLS_BASE64_C
Minos Galanakis471b34c2024-07-26 15:39:24 +0100479 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
480 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
481 scripts/config.py unset MBEDTLS_NIST_KW_C
482 scripts/config.py unset MBEDTLS_PEM_PARSE_C
483 scripts/config.py unset MBEDTLS_PEM_WRITE_C
484 scripts/config.py unset MBEDTLS_PKCS12_C
485 scripts/config.py unset MBEDTLS_PKCS5_C
486 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
487 # in PSA code to work with RSA keys. We don't require users to set those:
488 # they will be reenabled in build_info.h.
489 scripts/config.py unset MBEDTLS_PK_C
490 scripts/config.py unset MBEDTLS_PK_PARSE_C
491 scripts/config.py unset MBEDTLS_PK_WRITE_C
492 make CFLAGS='-O1 -Werror' all test
493 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
494}
495
496component_build_crypto_baremetal () {
497 msg "build: make, crypto only, baremetal config"
498 scripts/config.py crypto_baremetal
David Horstmann5b93d972024-10-31 15:36:05 +0000499 make CFLAGS="-O1 -Werror -I$PWD/framework/tests/include/baremetal-override/"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100500 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
501}
502
503support_build_crypto_baremetal () {
504 support_build_baremetal "$@"
505}
506
507# depends.py family of tests
508component_test_depends_py_cipher_id () {
509 msg "test/build: depends.py cipher_id (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200510 tests/scripts/depends.py cipher_id
Minos Galanakis471b34c2024-07-26 15:39:24 +0100511}
512
513component_test_depends_py_cipher_chaining () {
514 msg "test/build: depends.py cipher_chaining (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200515 tests/scripts/depends.py cipher_chaining
Minos Galanakis471b34c2024-07-26 15:39:24 +0100516}
517
Minos Galanakis471b34c2024-07-26 15:39:24 +0100518component_test_depends_py_curves () {
519 msg "test/build: depends.py curves (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200520 tests/scripts/depends.py curves
Minos Galanakis471b34c2024-07-26 15:39:24 +0100521}
522
523component_test_depends_py_hashes () {
524 msg "test/build: depends.py hashes (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200525 tests/scripts/depends.py hashes
Minos Galanakis471b34c2024-07-26 15:39:24 +0100526}
527
Minos Galanakis471b34c2024-07-26 15:39:24 +0100528component_test_depends_py_pkalgs () {
529 msg "test/build: depends.py pkalgs (gcc)"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100530 tests/scripts/depends.py pkalgs
531}
532
533component_test_psa_crypto_config_ffdh_2048_only () {
534 msg "build: full config - only DH 2048"
535
536 scripts/config.py full
537
538 # Disable all DH groups other than 2048.
539 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
540 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
541 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
542 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
543
544 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
545
546 msg "test: full config - only DH 2048"
547 make test
548
549 msg "ssl-opt: full config - only DH 2048"
550 tests/ssl-opt.sh -f "ffdh"
551}
552
Minos Galanakis471b34c2024-07-26 15:39:24 +0100553component_test_psa_crypto_config_accel_ecdsa () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200554 msg "build: accelerated ECDSA"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100555
556 # Algorithms and key types to accelerate
557 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
558 $(helper_get_psa_key_type_list "ECC") \
559 $(helper_get_psa_curve_list)"
560
561 # Configure
562 # ---------
563
Elena Uziunaite91d83862024-09-04 14:51:31 +0100564 # Start from default config + TLS 1.3
Minos Galanakis471b34c2024-07-26 15:39:24 +0100565 helper_libtestdriver1_adjust_config "default"
566
567 # Disable the module that's accelerated
568 scripts/config.py unset MBEDTLS_ECDSA_C
569
570 # Disable things that depend on it
571 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
572 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
573
574 # Build
575 # -----
576
577 # These hashes are needed for some ECDSA signature tests.
Elena Uziunaiteffce45c2024-09-12 14:58:52 +0100578 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
Minos Galanakis471b34c2024-07-26 15:39:24 +0100579 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
580
581 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
582
583 helper_libtestdriver1_make_main "$loc_accel_list"
584
585 # Make sure this was not re-enabled by accident (additive config)
586 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
587
588 # Run the tests
589 # -------------
590
Ronald Cron93ba6252024-09-05 10:37:14 +0200591 msg "test: accelerated ECDSA"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100592 make test
593}
594
595component_test_psa_crypto_config_accel_ecdh () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200596 msg "build: accelerated ECDH"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100597
598 # Algorithms and key types to accelerate
599 loc_accel_list="ALG_ECDH \
600 $(helper_get_psa_key_type_list "ECC") \
601 $(helper_get_psa_curve_list)"
602
603 # Configure
604 # ---------
605
606 # Start from default config (no USE_PSA)
607 helper_libtestdriver1_adjust_config "default"
608
609 # Disable the module that's accelerated
610 scripts/config.py unset MBEDTLS_ECDH_C
611
612 # Disable things that depend on it
613 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
614 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
615 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
616 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
617 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
618
619 # Build
620 # -----
621
622 helper_libtestdriver1_make_drivers "$loc_accel_list"
623
624 helper_libtestdriver1_make_main "$loc_accel_list"
625
626 # Make sure this was not re-enabled by accident (additive config)
627 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
628
629 # Run the tests
630 # -------------
631
Ronald Cron93ba6252024-09-05 10:37:14 +0200632 msg "test: accelerated ECDH"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100633 make test
634}
635
636component_test_psa_crypto_config_accel_ffdh () {
637 msg "build: full with accelerated FFDH"
638
639 # Algorithms and key types to accelerate
640 loc_accel_list="ALG_FFDH \
641 $(helper_get_psa_key_type_list "DH") \
642 $(helper_get_psa_dh_group_list)"
643
644 # Configure
645 # ---------
646
647 # start with full (USE_PSA and TLS 1.3)
648 helper_libtestdriver1_adjust_config "full"
649
Minos Galanakis471b34c2024-07-26 15:39:24 +0100650 # Build
651 # -----
652
653 helper_libtestdriver1_make_drivers "$loc_accel_list"
654
655 helper_libtestdriver1_make_main "$loc_accel_list"
656
657 # Make sure this was not re-enabled by accident (additive config)
Valerio Settieb63eb22025-02-12 13:32:49 +0100658 not grep mbedtls_psa_ffdh_key_agreement ${BUILTIN_SRC_PATH}/psa_crypto_ffdh.o
Minos Galanakis471b34c2024-07-26 15:39:24 +0100659
660 # Run the tests
661 # -------------
662
663 msg "test: full with accelerated FFDH"
664 make test
665
666 msg "ssl-opt: full with accelerated FFDH alg"
667 tests/ssl-opt.sh -f "ffdh"
668}
669
670component_test_psa_crypto_config_reference_ffdh () {
671 msg "build: full with non-accelerated FFDH"
672
673 # Start with full (USE_PSA and TLS 1.3)
674 helper_libtestdriver1_adjust_config "full"
675
Minos Galanakis471b34c2024-07-26 15:39:24 +0100676 make
677
678 msg "test suites: full with non-accelerated FFDH alg"
679 make test
680
681 msg "ssl-opt: full with non-accelerated FFDH alg"
682 tests/ssl-opt.sh -f "ffdh"
683}
684
Minos Galanakisf78447f2024-07-26 20:49:51 +0100685component_test_psa_crypto_config_accel_pake () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100686 msg "build: full with accelerated PAKE"
687
688 loc_accel_list="ALG_JPAKE \
689 $(helper_get_psa_key_type_list "ECC") \
690 $(helper_get_psa_curve_list)"
691
692 # Configure
693 # ---------
694
695 helper_libtestdriver1_adjust_config "full"
696
697 # Make built-in fallback not available
698 scripts/config.py unset MBEDTLS_ECJPAKE_C
699 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
700
701 # Build
702 # -----
703
704 helper_libtestdriver1_make_drivers "$loc_accel_list"
705
706 helper_libtestdriver1_make_main "$loc_accel_list"
707
708 # Make sure this was not re-enabled by accident (additive config)
709 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
710
711 # Run the tests
712 # -------------
713
714 msg "test: full with accelerated PAKE"
715 make test
716}
717
718component_test_psa_crypto_config_accel_ecc_some_key_types () {
719 msg "build: full with accelerated EC algs and some key types"
720
721 # Algorithms and key types to accelerate
722 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
723 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
724 ALG_ECDH \
725 ALG_JPAKE \
726 KEY_TYPE_ECC_PUBLIC_KEY \
727 KEY_TYPE_ECC_KEY_PAIR_BASIC \
728 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
729 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
730 $(helper_get_psa_curve_list)"
731
732 # Configure
733 # ---------
734
735 # start with config full for maximum coverage (also enables USE_PSA)
736 helper_libtestdriver1_adjust_config "full"
737
738 # Disable modules that are accelerated - some will be re-enabled
739 scripts/config.py unset MBEDTLS_ECDSA_C
740 scripts/config.py unset MBEDTLS_ECDH_C
741 scripts/config.py unset MBEDTLS_ECJPAKE_C
742 scripts/config.py unset MBEDTLS_ECP_C
743
744 # Disable all curves - those that aren't accelerated should be re-enabled
745 helper_disable_builtin_curves
746
747 # Restartable feature is not yet supported by PSA. Once it will in
748 # the future, the following line could be removed (see issues
749 # 6061, 6332 and following ones)
750 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
751
752 # this is not supported by the driver API yet
753 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
754
755 # Build
756 # -----
757
758 # These hashes are needed for some ECDSA signature tests.
759 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
760 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
761 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
762
763 helper_libtestdriver1_make_main "$loc_accel_list"
764
765 # ECP should be re-enabled but not the others
766 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
767 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
768 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
769 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
770
771 # Run the tests
772 # -------------
773
774 msg "test suites: full with accelerated EC algs and some key types"
775 make test
776}
777
778# Run tests with only (non-)Weierstrass accelerated
779# Common code used in:
780# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
781# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Minos Galanakis471b34c2024-07-26 15:39:24 +0100782common_test_psa_crypto_config_accel_ecc_some_curves () {
783 weierstrass=$1
784 if [ $weierstrass -eq 1 ]; then
785 desc="Weierstrass"
786 else
787 desc="non-Weierstrass"
788 fi
789
790 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
791
792 # Note: Curves are handled in a special way by the libtestdriver machinery,
793 # so we only want to include them in the accel list when building the main
794 # libraries, hence the use of a separate variable.
795 # Note: the following loop is a modified version of
796 # helper_get_psa_curve_list that only keeps Weierstrass families.
797 loc_weierstrass_list=""
798 loc_non_weierstrass_list=""
799 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
800 case $item in
801 ECC_BRAINPOOL*|ECC_SECP*)
802 loc_weierstrass_list="$loc_weierstrass_list $item"
803 ;;
804 *)
805 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
806 ;;
807 esac
808 done
809 if [ $weierstrass -eq 1 ]; then
810 loc_curve_list=$loc_weierstrass_list
811 else
812 loc_curve_list=$loc_non_weierstrass_list
813 fi
814
815 # Algorithms and key types to accelerate
816 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
817 ALG_ECDH \
818 ALG_JPAKE \
819 $(helper_get_psa_key_type_list "ECC") \
820 $loc_curve_list"
821
822 # Configure
823 # ---------
824
825 # Start with config crypto_full and remove PK_C:
826 # that's what's supported now, see docs/driver-only-builds.md.
827 helper_libtestdriver1_adjust_config "crypto_full"
828 scripts/config.py unset MBEDTLS_PK_C
829 scripts/config.py unset MBEDTLS_PK_PARSE_C
830 scripts/config.py unset MBEDTLS_PK_WRITE_C
831
832 # Disable modules that are accelerated - some will be re-enabled
833 scripts/config.py unset MBEDTLS_ECDSA_C
834 scripts/config.py unset MBEDTLS_ECDH_C
835 scripts/config.py unset MBEDTLS_ECJPAKE_C
836 scripts/config.py unset MBEDTLS_ECP_C
837
838 # Disable all curves - those that aren't accelerated should be re-enabled
839 helper_disable_builtin_curves
840
841 # Restartable feature is not yet supported by PSA. Once it will in
842 # the future, the following line could be removed (see issues
843 # 6061, 6332 and following ones)
844 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
845
846 # this is not supported by the driver API yet
847 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
848
849 # Build
850 # -----
851
852 # These hashes are needed for some ECDSA signature tests.
853 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
854 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
855 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
856
857 helper_libtestdriver1_make_main "$loc_accel_list"
858
859 # We expect ECDH to be re-enabled for the missing curves
860 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
861 # We expect ECP to be re-enabled, however the parts specific to the
862 # families of curves that are accelerated should be ommited.
863 # - functions with mxz in the name are specific to Montgomery curves
864 # - ecp_muladd is specific to Weierstrass curves
865 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
866 if [ $weierstrass -eq 1 ]; then
867 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
868 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
869 else
870 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
871 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
872 fi
873 # We expect ECDSA and ECJPAKE to be re-enabled only when
874 # Weierstrass curves are not accelerated
875 if [ $weierstrass -eq 1 ]; then
876 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
877 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
878 else
879 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
880 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
881 fi
882
883 # Run the tests
884 # -------------
885
886 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
887 make test
888}
889
890component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
891 common_test_psa_crypto_config_accel_ecc_some_curves 1
892}
893
894component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
895 common_test_psa_crypto_config_accel_ecc_some_curves 0
896}
897
898# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
899# ECDH, ECDSA) with and without drivers.
900# The input parameter is a boolean value which indicates:
901# - 0 keep built-in EC algs,
902# - 1 exclude built-in EC algs (driver only).
903#
904# This is used by the two following components to ensure they always use the
905# same config, except for the use of driver or built-in EC algorithms:
906# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
907# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
908# This supports comparing their test coverage with analyze_outcomes.py.
Minos Galanakis471b34c2024-07-26 15:39:24 +0100909config_psa_crypto_config_ecp_light_only () {
910 driver_only="$1"
911 # start with config full for maximum coverage (also enables USE_PSA)
912 helper_libtestdriver1_adjust_config "full"
913 if [ "$driver_only" -eq 1 ]; then
914 # Disable modules that are accelerated
915 scripts/config.py unset MBEDTLS_ECDSA_C
916 scripts/config.py unset MBEDTLS_ECDH_C
917 scripts/config.py unset MBEDTLS_ECJPAKE_C
918 scripts/config.py unset MBEDTLS_ECP_C
919 fi
920
921 # Restartable feature is not yet supported by PSA. Once it will in
922 # the future, the following line could be removed (see issues
923 # 6061, 6332 and following ones)
924 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
925}
926
927# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
Minos Galanakis471b34c2024-07-26 15:39:24 +0100928component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
929 msg "build: full with accelerated EC algs"
930
931 # Algorithms and key types to accelerate
932 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
933 ALG_ECDH \
934 ALG_JPAKE \
935 $(helper_get_psa_key_type_list "ECC") \
936 $(helper_get_psa_curve_list)"
937
938 # Configure
939 # ---------
940
941 # Use the same config as reference, only without built-in EC algs
942 config_psa_crypto_config_ecp_light_only 1
943
944 # Do not disable builtin curves because that support is required for:
945 # - MBEDTLS_PK_PARSE_EC_EXTENDED
946 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
947
948 # Build
949 # -----
950
951 # These hashes are needed for some ECDSA signature tests.
952 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
953 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
954 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
955
956 helper_libtestdriver1_make_main "$loc_accel_list"
957
958 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
959 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
960 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
961 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
962 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
963
964 # Run the tests
965 # -------------
966
967 msg "test suites: full with accelerated EC algs"
968 make test
969
970 msg "ssl-opt: full with accelerated EC algs"
971 tests/ssl-opt.sh
972}
973
974# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
Minos Galanakis471b34c2024-07-26 15:39:24 +0100975component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200976 msg "build: non-accelerated EC algs"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100977
978 config_psa_crypto_config_ecp_light_only 0
979
980 make
981
982 msg "test suites: full with non-accelerated EC algs"
983 make test
984
985 msg "ssl-opt: full with non-accelerated EC algs"
986 tests/ssl-opt.sh
987}
988
989# This helper function is used by:
990# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
991# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
992# to ensure that both tests use the same underlying configuration when testing
993# driver's coverage with analyze_outcomes.py.
994#
995# This functions accepts 1 boolean parameter as follows:
996# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
997# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
998# - 0: include built-in implementation of EC algorithms.
999#
1000# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
1001# on the ECP module.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001002config_psa_crypto_no_ecp_at_all () {
1003 driver_only="$1"
1004 # start with full config for maximum coverage (also enables USE_PSA)
1005 helper_libtestdriver1_adjust_config "full"
1006
1007 if [ "$driver_only" -eq 1 ]; then
1008 # Disable modules that are accelerated
1009 scripts/config.py unset MBEDTLS_ECDSA_C
1010 scripts/config.py unset MBEDTLS_ECDH_C
1011 scripts/config.py unset MBEDTLS_ECJPAKE_C
1012 # Disable ECP module (entirely)
1013 scripts/config.py unset MBEDTLS_ECP_C
1014 fi
1015
1016 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
1017 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1018 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
1019 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
1020
1021 # Restartable feature is not yet supported by PSA. Once it will in
1022 # the future, the following line could be removed (see issues
1023 # 6061, 6332 and following ones)
1024 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
1025}
1026
1027# Build and test a configuration where driver accelerates all EC algs while
1028# all support and dependencies from ECP and ECP_LIGHT are removed on the library
1029# side.
1030#
1031# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Minos Galanakis471b34c2024-07-26 15:39:24 +01001032component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
1033 msg "build: full + accelerated EC algs - ECP"
1034
1035 # Algorithms and key types to accelerate
1036 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
1037 ALG_ECDH \
1038 ALG_JPAKE \
1039 $(helper_get_psa_key_type_list "ECC") \
1040 $(helper_get_psa_curve_list)"
1041
1042 # Configure
1043 # ---------
1044
1045 # Set common configurations between library's and driver's builds
1046 config_psa_crypto_no_ecp_at_all 1
1047 # Disable all the builtin curves. All the required algs are accelerated.
1048 helper_disable_builtin_curves
1049
1050 # Build
1051 # -----
1052
1053 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
1054 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
1055 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1056 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1057
1058 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1059
1060 helper_libtestdriver1_make_main "$loc_accel_list"
1061
1062 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1063 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1064 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1065 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
1066 # Also ensure that ECP module was not re-enabled
1067 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1068
1069 # Run the tests
1070 # -------------
1071
1072 msg "test: full + accelerated EC algs - ECP"
1073 make test
1074
1075 msg "ssl-opt: full + accelerated EC algs - ECP"
1076 tests/ssl-opt.sh
1077}
1078
1079# Reference function used for driver's coverage analysis in analyze_outcomes.py
1080# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
1081# Keep in sync with its accelerated counterpart.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001082component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
1083 msg "build: full + non accelerated EC algs"
1084
1085 config_psa_crypto_no_ecp_at_all 0
1086
1087 make
1088
1089 msg "test: full + non accelerated EC algs"
1090 make test
1091
1092 msg "ssl-opt: full + non accelerated EC algs"
1093 tests/ssl-opt.sh
1094}
1095
1096# This is a common configuration helper used directly from:
1097# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1098# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1099# and indirectly from:
1100# - component_test_psa_crypto_config_accel_ecc_no_bignum
1101# - accelerate all EC algs, disable RSA and FFDH
1102# - component_test_psa_crypto_config_reference_ecc_no_bignum
1103# - this is the reference component of the above
1104# - it still disables RSA and FFDH, but it uses builtin EC algs
1105# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1106# - accelerate all EC and FFDH algs, disable only RSA
1107# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1108# - this is the reference component of the above
1109# - it still disables RSA, but it uses builtin EC and FFDH algs
1110#
1111# This function accepts 2 parameters:
1112# $1: a boolean value which states if we are testing an accelerated scenario
1113# or not.
1114# $2: a string value which states which components are tested. Allowed values
1115# are "ECC" or "ECC_DH".
Minos Galanakisf78447f2024-07-26 20:49:51 +01001116config_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001117 driver_only="$1"
1118 test_target="$2"
1119 # start with full config for maximum coverage (also enables USE_PSA)
1120 helper_libtestdriver1_adjust_config "full"
1121
1122 if [ "$driver_only" -eq 1 ]; then
1123 # Disable modules that are accelerated
1124 scripts/config.py unset MBEDTLS_ECDSA_C
1125 scripts/config.py unset MBEDTLS_ECDH_C
1126 scripts/config.py unset MBEDTLS_ECJPAKE_C
1127 # Disable ECP module (entirely)
1128 scripts/config.py unset MBEDTLS_ECP_C
1129 # Also disable bignum
1130 scripts/config.py unset MBEDTLS_BIGNUM_C
1131 fi
1132
1133 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
1134 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1135 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
1136 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
1137
1138 # RSA support is intentionally disabled on this test because RSA_C depends
1139 # on BIGNUM_C.
1140 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
1141 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_ALG_RSA_[0-9A-Z_a-z]*"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001142 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1143 # Also disable key exchanges that depend on RSA
Minos Galanakis471b34c2024-07-26 15:39:24 +01001144 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1145 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1146
1147 if [ "$test_target" = "ECC" ]; then
1148 # When testing ECC only, we disable FFDH support, both from builtin and
Valerio Setti8438c632025-01-22 11:56:40 +01001149 # PSA sides.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
1151 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
1152 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001153 fi
1154
1155 # Restartable feature is not yet supported by PSA. Once it will in
1156 # the future, the following line could be removed (see issues
1157 # 6061, 6332 and following ones)
1158 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
1159}
1160
1161# Common helper used by:
1162# - component_test_psa_crypto_config_accel_ecc_no_bignum
1163# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1164#
1165# The goal is to build and test accelerating either:
1166# - ECC only or
1167# - both ECC and FFDH
1168#
1169# It is meant to be used in conjunction with
1170# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
1171# coverage analysis in the "analyze_outcomes.py" script.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001172common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
1173 test_target="$1"
1174
1175 # This is an internal helper to simplify text message handling
1176 if [ "$test_target" = "ECC_DH" ]; then
1177 accel_text="ECC/FFDH"
1178 removed_text="ECP - DH"
1179 else
1180 accel_text="ECC"
1181 removed_text="ECP"
1182 fi
1183
1184 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
1185
1186 # By default we accelerate all EC keys/algs
1187 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
1188 ALG_ECDH \
1189 ALG_JPAKE \
1190 $(helper_get_psa_key_type_list "ECC") \
1191 $(helper_get_psa_curve_list)"
1192 # Optionally we can also add DH to the list of accelerated items
1193 if [ "$test_target" = "ECC_DH" ]; then
1194 loc_accel_list="$loc_accel_list \
1195 ALG_FFDH \
1196 $(helper_get_psa_key_type_list "DH") \
1197 $(helper_get_psa_dh_group_list)"
1198 fi
1199
1200 # Configure
1201 # ---------
1202
1203 # Set common configurations between library's and driver's builds
1204 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
1205 # Disable all the builtin curves. All the required algs are accelerated.
1206 helper_disable_builtin_curves
1207
1208 # Build
1209 # -----
1210
1211 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
1212 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
1213 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1214 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1215
1216 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1217
1218 helper_libtestdriver1_make_main "$loc_accel_list"
1219
1220 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1221 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1222 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1223 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settieb63eb22025-02-12 13:32:49 +01001224 # Also ensure that ECP, RSA or BIGNUM modules were not re-enabled
Minos Galanakis471b34c2024-07-26 15:39:24 +01001225 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1226 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
1227 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001228
1229 # Run the tests
1230 # -------------
1231
Valerio Settieb63eb22025-02-12 13:32:49 +01001232 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001233
1234 make test
1235
1236 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
1237 tests/ssl-opt.sh
1238}
1239
1240# Common helper used by:
1241# - component_test_psa_crypto_config_reference_ecc_no_bignum
1242# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1243#
1244# The goal is to build and test a reference scenario (i.e. with builtin
1245# components) compared to the ones used in
1246# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
1247#
1248# It is meant to be used in conjunction with
1249# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
1250# coverage analysis in "analyze_outcomes.py" script.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001251common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
1252 test_target="$1"
1253
1254 # This is an internal helper to simplify text message handling
1255 if [ "$test_target" = "ECC_DH" ]; then
1256 accel_text="ECC/FFDH"
1257 else
1258 accel_text="ECC"
1259 fi
1260
1261 msg "build: full + non accelerated $accel_text algs + USE_PSA"
1262
1263 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
1264
1265 make
1266
1267 msg "test suites: full + non accelerated EC algs + USE_PSA"
1268 make test
1269
1270 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
1271 tests/ssl-opt.sh
1272}
1273
1274component_test_psa_crypto_config_accel_ecc_no_bignum () {
1275 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
1276}
1277
1278component_test_psa_crypto_config_reference_ecc_no_bignum () {
1279 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
1280}
1281
1282component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
1283 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
1284}
1285
1286component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
1287 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
1288}
1289
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001290component_test_tfm_config_as_is () {
1291 msg "build: configs/config-tfm.h"
Minos Galanakis5da58e52024-11-07 15:35:33 +00001292 MBEDTLS_CONFIG="configs/config-tfm.h"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001293 CRYPTO_CONFIG="tf-psa-crypto/configs/ext/crypto_config_profile_medium.h"
Minos Galanakis4f619e12024-11-14 14:56:47 +00001294 CC=$ASAN_CC cmake -DMBEDTLS_CONFIG_FILE="$MBEDTLS_CONFIG" -DTF_PSA_CRYPTO_CONFIG_FILE="$CRYPTO_CONFIG" -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001295 make
1296
1297 msg "test: configs/config-tfm.h - unit tests"
1298 make test
1299}
1300
Minos Galanakis471b34c2024-07-26 15:39:24 +01001301# Helper for setting common configurations between:
1302# - component_test_tfm_config_p256m_driver_accel_ec()
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001303# - component_test_tfm_config_no_p256m()
Minos Galanakis471b34c2024-07-26 15:39:24 +01001304common_tfm_config () {
1305 # Enable TF-M config
1306 cp configs/config-tfm.h "$CONFIG_H"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001307 cp tf-psa-crypto/configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001308
Minos Galanakis471b34c2024-07-26 15:39:24 +01001309 # Config adjustment for better test coverage in our environment.
1310 # This is not needed just to build and pass tests.
1311 #
1312 # Enable filesystem I/O for the benefit of PK parse/write tests.
Minos Galanakis5da58e52024-11-07 15:35:33 +00001313 sed -i '/PROFILE_M_PSA_CRYPTO_CONFIG_H/i #define MBEDTLS_FS_IO' "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001314}
1315
1316# Keep this in sync with component_test_tfm_config() as they are both meant
1317# to be used in analyze_outcomes.py for driver's coverage analysis.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001318component_test_tfm_config_p256m_driver_accel_ec () {
1319 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
1320
1321 common_tfm_config
1322
1323 # Build crypto library
David Horstmann5b93d972024-10-31 15:36:05 +00001324 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../framework/tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001325
1326 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1327 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1328 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1329 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settieb63eb22025-02-12 13:32:49 +01001330 # Also ensure that ECP, RSA or BIGNUM modules were not re-enabled
Minos Galanakis471b34c2024-07-26 15:39:24 +01001331 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1332 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001333 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
1334 # Check that p256m was built
1335 grep -q p256_ecdsa_ library/libmbedcrypto.a
1336
1337 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
1338 # files, so we want to ensure that it has not be re-enabled accidentally.
1339 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
1340
1341 # Run the tests
1342 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
1343 make test
1344}
1345
1346# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
1347# they are both meant to be used in analyze_outcomes.py for driver's coverage
1348# analysis.
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001349component_test_tfm_config_no_p256m () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001350 common_tfm_config
1351
1352 # Disable P256M driver, which is on by default, so that analyze_outcomes
1353 # can compare this test with test_tfm_config_p256m_driver_accel_ec
Minos Galanakis5da58e52024-11-07 15:35:33 +00001354 sed -i '/PROFILE_M_PSA_CRYPTO_CONFIG_H/i #undef MBEDTLS_PSA_P256M_DRIVER_ENABLED' "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001355
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001356 msg "build: TF-M config without p256m"
David Horstmann5b93d972024-10-31 15:36:05 +00001357 make CFLAGS='-Werror -Wall -Wextra -I../framework/tests/include/spe' tests
Minos Galanakis471b34c2024-07-26 15:39:24 +01001358
1359 # Check that p256m was not built
1360 not grep p256_ecdsa_ library/libmbedcrypto.a
1361
1362 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
1363 # files, so we want to ensure that it has not be re-enabled accidentally.
1364 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
1365
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001366 msg "test: TF-M config without p256m"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001367 make test
1368}
1369
Minos Galanakis471b34c2024-07-26 15:39:24 +01001370# This is an helper used by:
1371# - component_test_psa_ecc_key_pair_no_derive
1372# - component_test_psa_ecc_key_pair_no_generate
1373# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
1374# enabled, but one. Input arguments are as follows:
Gilles Peskinefef912c2024-09-20 16:07:09 +02001375# - $1 is the configuration to start from
1376# - $2 is the key type under test, i.e. ECC/RSA/DH
1377# - $3 is the key option to be unset (i.e. generate, derive, etc)
Minos Galanakisf78447f2024-07-26 20:49:51 +01001378build_and_test_psa_want_key_pair_partial () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001379 base_config=$1
1380 key_type=$2
1381 unset_option=$3
Minos Galanakis471b34c2024-07-26 15:39:24 +01001382 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
1383
Gilles Peskinefef912c2024-09-20 16:07:09 +02001384 msg "build: $base_config - ${disabled_psa_want}"
1385 scripts/config.py "$base_config"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001386
1387 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
1388 # crypto_config.h so we just disable the one we don't want.
1389 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
1390
1391 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1392
Gilles Peskinefef912c2024-09-20 16:07:09 +02001393 msg "test: $base_config - ${disabled_psa_want}"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001394 make test
1395}
1396
Minos Galanakisf78447f2024-07-26 20:49:51 +01001397component_test_psa_ecc_key_pair_no_derive () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001398 build_and_test_psa_want_key_pair_partial full "ECC" "DERIVE"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001399}
1400
Minos Galanakisf78447f2024-07-26 20:49:51 +01001401component_test_psa_ecc_key_pair_no_generate () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001402 # TLS needs ECC key generation whenever ephemeral ECDH is enabled.
1403 # We don't have proper guards for configurations with ECC key generation
1404 # disabled (https://github.com/Mbed-TLS/mbedtls/issues/9481). Until
1405 # then (if ever), just test the crypto part of the library.
1406 build_and_test_psa_want_key_pair_partial crypto_full "ECC" "GENERATE"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001407}
1408
1409config_psa_crypto_accel_rsa () {
1410 driver_only=$1
1411
1412 # Start from crypto_full config (no X.509, no TLS)
1413 helper_libtestdriver1_adjust_config "crypto_full"
1414
1415 if [ "$driver_only" -eq 1 ]; then
Minos Galanakis471b34c2024-07-26 15:39:24 +01001416 # We need PEM parsing in the test library as well to support the import
1417 # of PEM encoded RSA keys.
Minos Galanakis23452f52024-11-28 17:48:14 +00001418 scripts/config.py -c "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
1419 scripts/config.py -c "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
Minos Galanakis471b34c2024-07-26 15:39:24 +01001420 fi
1421}
1422
1423component_test_psa_crypto_config_accel_rsa_crypto () {
1424 msg "build: crypto_full with accelerated RSA"
1425
1426 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
1427 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
1428 KEY_TYPE_RSA_PUBLIC_KEY \
1429 KEY_TYPE_RSA_KEY_PAIR_BASIC \
1430 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
1431 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
1432 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
1433
1434 # Configure
1435 # ---------
1436
1437 config_psa_crypto_accel_rsa 1
1438
1439 # Build
1440 # -----
1441
1442 # These hashes are needed for unit tests.
1443 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1444 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
1445 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1446
1447 helper_libtestdriver1_make_main "$loc_accel_list"
1448
1449 # Make sure this was not re-enabled by accident (additive config)
1450 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
1451
1452 # Run the tests
1453 # -------------
1454
1455 msg "test: crypto_full with accelerated RSA"
1456 make test
1457}
1458
1459component_test_psa_crypto_config_reference_rsa_crypto () {
1460 msg "build: crypto_full with non-accelerated RSA"
1461
1462 # Configure
1463 # ---------
1464 config_psa_crypto_accel_rsa 0
1465
1466 # Build
1467 # -----
1468 make
1469
1470 # Run the tests
1471 # -------------
1472 msg "test: crypto_full with non-accelerated RSA"
1473 make test
1474}
1475
1476# This is a temporary test to verify that full RSA support is present even when
1477# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001478component_test_new_psa_want_key_pair_symbol () {
Ronald Cron892bb612025-07-21 14:26:27 +02001479 msg "Build: crypto config - PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001480
1481 # Create a temporary output file unless there is already one set
1482 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
1483 REMOVE_OUTCOME_ON_EXIT="no"
1484 else
1485 REMOVE_OUTCOME_ON_EXIT="yes"
1486 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
1487 export MBEDTLS_TEST_OUTCOME_FILE
1488 fi
1489
1490 # Start from crypto configuration
1491 scripts/config.py crypto
1492
1493 # Remove RSA support and its dependencies
Minos Galanakis471b34c2024-07-26 15:39:24 +01001494 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1495 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Minos Galanakis471b34c2024-07-26 15:39:24 +01001496 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1497
Minos Galanakis471b34c2024-07-26 15:39:24 +01001498 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
1499 # that proper translations is done in crypto_legacy.h.
1500 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
1501 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
1502 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
1503
1504 make
1505
Ronald Cron892bb612025-07-21 14:26:27 +02001506 msg "Test: crypto config - PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001507 make test
1508
1509 # Parse only 1 relevant line from the outcome file, i.e. a test which is
1510 # performing RSA signature.
1511 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
1512 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
1513
1514 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
1515 rm $MBEDTLS_TEST_OUTCOME_FILE
1516 fi
1517}
1518
1519component_test_psa_crypto_config_accel_hash () {
Ronald Cron93ba6252024-09-05 10:37:14 +02001520 msg "test: accelerated hash"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001521
1522 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1523 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1524 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1525
1526 # Configure
1527 # ---------
1528
1529 # Start from default config (no USE_PSA)
1530 helper_libtestdriver1_adjust_config "default"
1531
Minos Galanakis471b34c2024-07-26 15:39:24 +01001532 # Build
1533 # -----
1534
1535 helper_libtestdriver1_make_drivers "$loc_accel_list"
1536
1537 helper_libtestdriver1_make_main "$loc_accel_list"
1538
1539 # There's a risk of something getting re-enabled via config_psa.h;
1540 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
1541 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
1542 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
1543 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
1544 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
1545 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
1546
1547 # Run the tests
1548 # -------------
1549
Ronald Cron93ba6252024-09-05 10:37:14 +02001550 msg "test: accelerated hash"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001551 make test
1552}
1553
1554# Auxiliary function to build config for hashes with and without drivers
Minos Galanakis471b34c2024-07-26 15:39:24 +01001555config_psa_crypto_hash_use_psa () {
1556 driver_only="$1"
1557 # start with config full for maximum coverage (also enables USE_PSA)
1558 helper_libtestdriver1_adjust_config "full"
1559 if [ "$driver_only" -eq 1 ]; then
1560 # disable the built-in implementation of hashes
Minos Galanakis471b34c2024-07-26 15:39:24 +01001561 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Minos Galanakis471b34c2024-07-26 15:39:24 +01001562 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Minos Galanakis471b34c2024-07-26 15:39:24 +01001563 fi
1564}
1565
1566# Note that component_test_psa_crypto_config_reference_hash_use_psa
1567# is related to this component and both components need to be kept in sync.
1568# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001569component_test_psa_crypto_config_accel_hash_use_psa () {
1570 msg "test: full with accelerated hashes"
1571
1572 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1573 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1574 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1575
1576 # Configure
1577 # ---------
1578
1579 config_psa_crypto_hash_use_psa 1
1580
1581 # Build
1582 # -----
1583
1584 helper_libtestdriver1_make_drivers "$loc_accel_list"
1585
1586 helper_libtestdriver1_make_main "$loc_accel_list"
1587
1588 # There's a risk of something getting re-enabled via config_psa.h;
1589 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
1590 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
1591 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
1592 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
1593 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
1594 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
1595
1596 # Run the tests
1597 # -------------
1598
1599 msg "test: full with accelerated hashes"
1600 make test
1601
1602 # This is mostly useful so that we can later compare outcome files with
1603 # the reference config in analyze_outcomes.py, to check that the
1604 # dependency declarations in ssl-opt.sh and in TLS code are correct.
1605 msg "test: ssl-opt.sh, full with accelerated hashes"
1606 tests/ssl-opt.sh
1607
1608 # This is to make sure all ciphersuites are exercised, but we don't need
1609 # interop testing (besides, we already got some from ssl-opt.sh).
1610 msg "test: compat.sh, full with accelerated hashes"
1611 tests/compat.sh -p mbedTLS -V YES
1612}
1613
1614# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
1615# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
1616# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
1617# Both components need to be kept in sync.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001618component_test_psa_crypto_config_reference_hash_use_psa () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001619 msg "test: full without accelerated hashes"
1620
1621 config_psa_crypto_hash_use_psa 0
1622
1623 make
1624
1625 msg "test: full without accelerated hashes"
1626 make test
1627
1628 msg "test: ssl-opt.sh, full without accelerated hashes"
1629 tests/ssl-opt.sh
1630}
1631
1632# Auxiliary function to build config for hashes with and without drivers
Minos Galanakis471b34c2024-07-26 15:39:24 +01001633config_psa_crypto_hmac_use_psa () {
1634 driver_only="$1"
1635 # start with config full for maximum coverage (also enables USE_PSA)
1636 helper_libtestdriver1_adjust_config "full"
1637
1638 if [ "$driver_only" -eq 1 ]; then
1639 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
1640 # is still enabled though (for ENTROPY_C among others).
1641 scripts/config.py unset MBEDTLS_MD_C
Ronald Cron772a8ad2025-07-21 12:36:29 +02001642 # Also disable the configuration options that tune the builtin hashes,
1643 # since those hashes are disabled.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001644 scripts/config.py unset-all MBEDTLS_SHA
Minos Galanakis471b34c2024-07-26 15:39:24 +01001645 fi
1646
1647 # Direct dependencies of MD_C. We disable them also in the reference
1648 # component to work with the same set of features.
1649 scripts/config.py unset MBEDTLS_PKCS7_C
1650 scripts/config.py unset MBEDTLS_PKCS5_C
1651 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1652 scripts/config.py unset MBEDTLS_HKDF_C
1653 # Dependencies of HMAC_DRBG
1654 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
1655 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1656}
1657
Minos Galanakisf78447f2024-07-26 20:49:51 +01001658component_test_psa_crypto_config_accel_hmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001659 msg "test: full with accelerated hmac"
1660
1661 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
1662 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1663 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1664 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1665
1666 # Configure
1667 # ---------
1668
1669 config_psa_crypto_hmac_use_psa 1
1670
1671 # Build
1672 # -----
1673
1674 helper_libtestdriver1_make_drivers "$loc_accel_list"
1675
1676 helper_libtestdriver1_make_main "$loc_accel_list"
1677
1678 # Ensure that built-in support for HMAC is disabled.
1679 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1680
1681 # Run the tests
1682 # -------------
1683
1684 msg "test: full with accelerated hmac"
1685 make test
1686}
1687
Minos Galanakisf78447f2024-07-26 20:49:51 +01001688component_test_psa_crypto_config_reference_hmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001689 msg "test: full without accelerated hmac"
1690
1691 config_psa_crypto_hmac_use_psa 0
1692
1693 make
1694
1695 msg "test: full without accelerated hmac"
1696 make test
1697}
1698
Minos Galanakis471b34c2024-07-26 15:39:24 +01001699component_test_psa_crypto_config_accel_aead () {
Ronald Cron93ba6252024-09-05 10:37:14 +02001700 msg "test: accelerated AEAD"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001701
1702 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
1703 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1704
1705 # Configure
1706 # ---------
1707
1708 # Start from full config
1709 helper_libtestdriver1_adjust_config "full"
1710
Minos Galanakis471b34c2024-07-26 15:39:24 +01001711 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
1712 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1713
1714 # Build
1715 # -----
1716
1717 helper_libtestdriver1_make_drivers "$loc_accel_list"
1718
1719 helper_libtestdriver1_make_main "$loc_accel_list"
1720
1721 # Make sure this was not re-enabled by accident (additive config)
1722 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
1723 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
1724 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
1725
1726 # Run the tests
1727 # -------------
1728
Ronald Cron93ba6252024-09-05 10:37:14 +02001729 msg "test: accelerated AEAD"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001730 make test
1731}
1732
1733# This is a common configuration function used in:
1734# - component_test_psa_crypto_config_accel_cipher_aead_cmac
1735# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Minos Galanakisf78447f2024-07-26 20:49:51 +01001736common_psa_crypto_config_accel_cipher_aead_cmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001737 # Start from the full config
1738 helper_libtestdriver1_adjust_config "full"
1739
1740 scripts/config.py unset MBEDTLS_NIST_KW_C
1741}
1742
1743# The 2 following test components, i.e.
1744# - component_test_psa_crypto_config_accel_cipher_aead_cmac
1745# - component_test_psa_crypto_config_reference_cipher_aead_cmac
1746# are meant to be used together in analyze_outcomes.py script in order to test
1747# driver's coverage for ciphers and AEADs.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001748component_test_psa_crypto_config_accel_cipher_aead_cmac () {
1749 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
1750
1751 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 ALG_CTR ALG_CFB \
1752 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
1753 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Ari Weiler-Ofek86422e52025-07-04 14:43:30 +01001754 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001755
1756 # Configure
1757 # ---------
1758
1759 common_psa_crypto_config_accel_cipher_aead_cmac
1760
Ari Weiler-Ofek5d8d2992025-07-07 23:20:29 +01001761 # Disable DES, if it still exists.
1762 # This can be removed once we remove DES from the library.
1763 scripts/config.py unset PSA_WANT_KEY_TYPE_DES
1764
Minos Galanakis471b34c2024-07-26 15:39:24 +01001765 # Build
1766 # -----
1767
1768 helper_libtestdriver1_make_drivers "$loc_accel_list"
1769
1770 helper_libtestdriver1_make_main "$loc_accel_list"
1771
1772 # Make sure this was not re-enabled by accident (additive config)
1773 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001774 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
1775 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
1776 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
1777 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
1778 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
1779 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
1780 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Ronald Cronb5c6fcc2025-07-10 13:40:00 +02001781 not grep mbedtls_poly1305 ${BUILTIN_SRC_PATH}/poly1305.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001782
1783 # Run the tests
1784 # -------------
1785
1786 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
1787 make test
1788
1789 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Ronald Cronbd28acf2025-07-10 09:53:50 +02001790 # Exclude password-protected key tests — they require built-in CBC and AES.
1791 tests/ssl-opt.sh -e "TLS: password protected"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001792
1793 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
1794 tests/compat.sh -V NO -p mbedTLS
1795}
1796
1797component_test_psa_crypto_config_reference_cipher_aead_cmac () {
1798 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
1799 common_psa_crypto_config_accel_cipher_aead_cmac
1800
Ari Weiler-Ofek5d8d2992025-07-07 23:20:29 +01001801 # Disable DES, if it still exists.
1802 # This can be removed once we remove DES from the library.
1803 scripts/config.py unset PSA_WANT_KEY_TYPE_DES
1804
Minos Galanakis471b34c2024-07-26 15:39:24 +01001805 make
1806
1807 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
1808 make test
1809
1810 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Ronald Cronbd28acf2025-07-10 09:53:50 +02001811 # Exclude password-protected key tests as in test_psa_crypto_config_accel_cipher_aead_cmac.
1812 tests/ssl-opt.sh -e "TLS: password protected"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001813
1814 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
1815 tests/compat.sh -V NO -p mbedTLS
1816}
1817
Minos Galanakisf78447f2024-07-26 20:49:51 +01001818common_block_cipher_dispatch () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001819 TEST_WITH_DRIVER="$1"
1820
1821 # Start from the full config
1822 helper_libtestdriver1_adjust_config "full"
1823
Minos Galanakis471b34c2024-07-26 15:39:24 +01001824 # Disable cipher's modes that, when not accelerated, cause
1825 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
1826 # Keep this also in the reference component in order to skip the same tests
1827 # that were skipped in the accelerated one.
1828 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1829 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1830 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1831 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1832 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1836
1837 # Disable direct dependency on AES_C
1838 scripts/config.py unset MBEDTLS_NIST_KW_C
1839
1840 # Prevent the cipher module from using deprecated PSA path. The reason is
1841 # that otherwise there will be tests relying on "aes_info" (defined in
1842 # "cipher_wrap.c") whose functions are not available when AES_C is
1843 # not defined. ARIA and Camellia are not a problem in this case because
1844 # the PSA path is not tested for these key types.
1845 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
1846}
1847
Gilles Peskinea9dda7e2024-06-21 11:25:01 +02001848component_test_full_block_cipher_psa_dispatch_static_keystore () {
1849 msg "build: full + PSA dispatch in block_cipher with static keystore"
1850 # Check that the static key store works well when CTR_DRBG uses a
1851 # PSA key for AES.
1852 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
1853
1854 loc_accel_list="ALG_ECB_NO_PADDING \
1855 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1856
1857 # Configure
1858 # ---------
1859
1860 common_block_cipher_dispatch 1
1861
1862 # Build
1863 # -----
1864
1865 helper_libtestdriver1_make_drivers "$loc_accel_list"
1866
1867 helper_libtestdriver1_make_main "$loc_accel_list"
1868
1869 # Make sure disabled components were not re-enabled by accident (additive
1870 # config)
1871 not grep mbedtls_aes_ library/aes.o
1872 not grep mbedtls_aria_ library/aria.o
1873 not grep mbedtls_camellia_ library/camellia.o
1874
1875 # Run the tests
1876 # -------------
1877
1878 msg "test: full + PSA dispatch in block_cipher with static keystore"
1879 make test
1880}
1881
Minos Galanakis471b34c2024-07-26 15:39:24 +01001882component_test_full_block_cipher_psa_dispatch () {
1883 msg "build: full + PSA dispatch in block_cipher"
1884
1885 loc_accel_list="ALG_ECB_NO_PADDING \
1886 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1887
1888 # Configure
1889 # ---------
1890
1891 common_block_cipher_dispatch 1
1892
1893 # Build
1894 # -----
1895
1896 helper_libtestdriver1_make_drivers "$loc_accel_list"
1897
1898 helper_libtestdriver1_make_main "$loc_accel_list"
1899
1900 # Make sure disabled components were not re-enabled by accident (additive
1901 # config)
1902 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
1903 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
1904 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
1905
1906 # Run the tests
1907 # -------------
1908
1909 msg "test: full + PSA dispatch in block_cipher"
1910 make test
1911}
1912
1913# This is the reference component of component_test_full_block_cipher_psa_dispatch
Minos Galanakis471b34c2024-07-26 15:39:24 +01001914component_test_full_block_cipher_legacy_dispatch () {
1915 msg "build: full + legacy dispatch in block_cipher"
1916
1917 common_block_cipher_dispatch 0
1918
1919 make
1920
1921 msg "test: full + legacy dispatch in block_cipher"
1922 make test
1923}
1924
Minos Galanakisf78447f2024-07-26 20:49:51 +01001925component_test_aead_chachapoly_disabled () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001926 msg "build: full minus CHACHAPOLY"
1927 scripts/config.py full
Minos Galanakis471b34c2024-07-26 15:39:24 +01001928 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
1929 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1930
1931 msg "test: full minus CHACHAPOLY"
1932 make test
1933}
1934
Minos Galanakisf78447f2024-07-26 20:49:51 +01001935component_test_aead_only_ccm () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001936 msg "build: full minus CHACHAPOLY and GCM"
1937 scripts/config.py full
Minos Galanakis471b34c2024-07-26 15:39:24 +01001938 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
1939 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
1940 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1941
1942 msg "test: full minus CHACHAPOLY and GCM"
1943 make test
1944}
1945
Minos Galanakisf78447f2024-07-26 20:49:51 +01001946component_test_ccm_aes_sha256 () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001947 msg "build: CCM + AES + SHA256 configuration"
1948
Minos Galanakisa17ffc72024-12-02 23:57:30 +00001949 # Setting a blank config disables everyhing in the library side.
1950 echo '#define MBEDTLS_CONFIG_H ' >"$CONFIG_H"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001951 cp tf-psa-crypto/configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Cron9d262d72024-12-06 17:41:26 +01001952
Minos Galanakis471b34c2024-07-26 15:39:24 +01001953 make
Minos Galanakis471b34c2024-07-26 15:39:24 +01001954 msg "test: CCM + AES + SHA256 configuration"
1955 make test
1956}
1957
1958# Test that the given .o file builds with all (valid) combinations of the given options.
1959#
1960# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
1961#
1962# The validator function is the name of a function to validate the combination of options.
1963# It may be "" if all combinations are valid.
1964# It receives a string containing a combination of options, as passed to the compiler,
1965# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001966build_test_config_combos () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001967 file=$1
1968 shift
1969 validate_options=$1
1970 shift
1971 options=("$@")
1972
1973 # clear all of the options so that they can be overridden on the clang commandline
1974 for opt in "${options[@]}"; do
1975 ./scripts/config.py unset ${opt}
1976 done
1977
1978 # enter the library directory
1979 cd library
1980
1981 # The most common issue is unused variables/functions, so ensure -Wunused is set.
1982 warning_flags="-Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wasm-operand-widths -Wunused"
1983
1984 # Extract the command generated by the Makefile to build the target file.
1985 # This ensures that we have any include paths, macro definitions, etc
1986 # that may be applied by make.
1987 # Add -fsyntax-only as we only want a syntax check and don't need to generate a file.
1988 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
1989
1990 makefile=$(TMPDIR=. mktemp)
1991 deps=""
1992
1993 len=${#options[@]}
1994 source_file=../${file%.o}.c
1995
1996 targets=0
1997 echo 'include Makefile' >${makefile}
1998
1999 for ((i = 0; i < $((2**${len})); i++)); do
2000 # generate each of 2^n combinations of options
2001 # each bit of $i is used to determine if options[i] will be set or not
2002 target="t"
2003 clang_args=""
2004 for ((j = 0; j < ${len}; j++)); do
2005 if (((i >> j) & 1)); then
2006 opt=-D${options[$j]}
2007 clang_args="${clang_args} ${opt}"
2008 target="${target}${opt}"
2009 fi
2010 done
2011
2012 # if combination is not known to be invalid, add it to the makefile
2013 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
2014 cmd="${compile_cmd} ${clang_args}"
2015 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
2016
2017 deps="${deps} ${target}"
2018 ((++targets))
2019 fi
2020 done
2021
2022 echo "build_test_config_combos: ${deps}" >> ${makefile}
2023
2024 # execute all of the commands via Make (probably in parallel)
2025 make -s -f ${makefile} build_test_config_combos
2026 echo "$targets targets checked"
2027
2028 # clean up the temporary makefile
2029 rm ${makefile}
2030}
2031
Minos Galanakisf78447f2024-07-26 20:49:51 +01002032validate_aes_config_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002033 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
2034 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
2035 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
2036 return 1
2037 fi
2038 fi
2039 return 0
2040}
2041
Minos Galanakisf78447f2024-07-26 20:49:51 +01002042component_build_aes_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002043 # 18s - around 90ms per clang invocation on M1 Pro
2044 #
2045 # aes.o has many #if defined(...) guards that intersect in complex ways.
2046 # Test that all the combinations build cleanly.
2047
2048 MBEDTLS_ROOT_DIR="$PWD"
2049 msg "build: aes.o for all combinations of relevant config options"
2050
2051 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Thomas Daubney6cf05f92024-07-18 11:30:22 +01002052 "MBEDTLS_AES_ROM_TABLES" \
Minos Galanakis471b34c2024-07-26 15:39:24 +01002053 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
2054 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
2055
2056 cd "$MBEDTLS_ROOT_DIR"
2057 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
2058
Ari Weiler-Ofek86422e52025-07-04 14:43:30 +01002059 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW,
Minos Galanakis471b34c2024-07-26 15:39:24 +01002060 # manually set or unset those configurations to check
2061 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
2062 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Minos Galanakis471b34c2024-07-26 15:39:24 +01002063 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron54d1eec2024-09-06 09:55:38 +02002064
Minos Galanakis00b641c2024-11-28 23:05:10 +00002065 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
2066 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
2067 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
2068 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Ronald Cron54d1eec2024-09-06 09:55:38 +02002069
Minos Galanakis471b34c2024-07-26 15:39:24 +01002070 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Thomas Daubney6cf05f92024-07-18 11:30:22 +01002071 "MBEDTLS_AES_ROM_TABLES" \
Minos Galanakis471b34c2024-07-26 15:39:24 +01002072 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
2073 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
2074}
2075
Minos Galanakisf78447f2024-07-26 20:49:51 +01002076component_test_sha3_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002077 msg "sha3 loop unroll variations"
2078
2079 # define minimal config sufficient to test SHA3
Ronald Crone7f289e2024-09-06 11:02:47 +02002080 cat > include/mbedtls/mbedtls_config.h << END
Ronald Crone7f289e2024-09-06 11:02:47 +02002081END
2082
2083 cat > tf-psa-crypto/include/psa/crypto_config.h << END
2084 #define PSA_WANT_ALG_SHA_256 1
2085 #define PSA_WANT_ALG_SHA3_224 1
2086 #define PSA_WANT_ALG_SHA3_256 1
2087 #define PSA_WANT_ALG_SHA3_384 1
2088 #define PSA_WANT_ALG_SHA3_512 1
Ronald Cron06680362025-07-21 15:21:22 +02002089 #define PSA_WANT_KEY_TYPE_AES 1
Ronald Cron3dd1d3d2024-12-05 15:12:06 +01002090 #define MBEDTLS_CTR_DRBG_C
2091 #define MBEDTLS_ENTROPY_C
2092 #define MBEDTLS_PSA_CRYPTO_C
2093 #define MBEDTLS_SELF_TEST
Minos Galanakis471b34c2024-07-26 15:39:24 +01002094END
2095
2096 msg "all loops unrolled"
2097 make clean
2098 make -C tests ../tf-psa-crypto/tests/test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=1 -DMBEDTLS_SHA3_PI_UNROLL=1 -DMBEDTLS_SHA3_CHI_UNROLL=1 -DMBEDTLS_SHA3_RHO_UNROLL=1"
2099 ./tf-psa-crypto/tests/test_suite_shax
2100
2101 msg "all loops rolled up"
2102 make clean
2103 make -C tests ../tf-psa-crypto/tests/test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=0 -DMBEDTLS_SHA3_PI_UNROLL=0 -DMBEDTLS_SHA3_CHI_UNROLL=0 -DMBEDTLS_SHA3_RHO_UNROLL=0"
2104 ./tf-psa-crypto/tests/test_suite_shax
2105}
2106
Minos Galanakisf699d512024-08-01 11:32:30 +01002107support_build_aes_aesce_armcc () {
2108 support_build_armcc
2109}
2110
Minos Galanakis471b34c2024-07-26 15:39:24 +01002111# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
2112component_build_aes_aesce_armcc () {
2113 msg "Build: AESCE test on arm64 platform without plain C."
2114 scripts/config.py baremetal
2115
2116 # armc[56] don't support SHA-512 intrinsics
2117 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2118
2119 # Stop armclang warning about feature detection for A64_CRYPTO.
2120 # With this enabled, the library does build correctly under armclang,
2121 # but in baremetal builds (as tested here), feature detection is
2122 # unavailable, and the user is notified via a #warning. So enabling
2123 # this feature would prevent us from building with -Werror on
2124 # armclang. Tracked in #7198.
2125 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2126 scripts/config.py set MBEDTLS_HAVE_ASM
2127
2128 msg "AESCE, build with default configuration."
2129 scripts/config.py set MBEDTLS_AESCE_C
2130 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002131 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002132
2133 msg "AESCE, build AESCE only"
2134 scripts/config.py set MBEDTLS_AESCE_C
2135 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002136 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002137}
2138
Minos Galanakis471b34c2024-07-26 15:39:24 +01002139component_test_aes_only_128_bit_keys () {
2140 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
2141 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Minos Galanakis2fc59942025-07-09 18:20:48 +03002142 scripts/config.py set MBEDTLS_PSA_CRYPTO_RNG_STRENGTH 128
Minos Galanakis471b34c2024-07-26 15:39:24 +01002143
2144 make CFLAGS='-O2 -Werror -Wall -Wextra'
2145
2146 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
2147 make test
2148}
2149
2150component_test_no_ctr_drbg_aes_only_128_bit_keys () {
2151 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
2152 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Minos Galanakis2fc59942025-07-09 18:20:48 +03002153 scripts/config.py set MBEDTLS_PSA_CRYPTO_RNG_STRENGTH 128
Minos Galanakis471b34c2024-07-26 15:39:24 +01002154 scripts/config.py unset MBEDTLS_CTR_DRBG_C
2155
2156 make CC=clang CFLAGS='-Werror -Wall -Wextra'
2157
2158 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
2159 make test
2160}
2161
2162component_test_aes_only_128_bit_keys_have_builtins () {
2163 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2164 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Minos Galanakis2fc59942025-07-09 18:20:48 +03002165 scripts/config.py set MBEDTLS_PSA_CRYPTO_RNG_STRENGTH 128
Minos Galanakis471b34c2024-07-26 15:39:24 +01002166 scripts/config.py unset MBEDTLS_AESNI_C
2167 scripts/config.py unset MBEDTLS_AESCE_C
2168
2169 make CFLAGS='-O2 -Werror -Wall -Wextra'
2170
2171 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2172 make test
2173
2174 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2175 programs/test/selftest
2176}
2177
2178component_test_gcm_largetable () {
2179 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
2180 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
2181 scripts/config.py unset MBEDTLS_AESNI_C
2182 scripts/config.py unset MBEDTLS_AESCE_C
2183
2184 make CFLAGS='-O2 -Werror -Wall -Wextra'
2185
2186 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
2187 make test
2188}
2189
2190component_test_aes_fewer_tables () {
2191 msg "build: default config with AES_FEWER_TABLES enabled"
2192 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
2193 make CFLAGS='-O2 -Werror -Wall -Wextra'
2194
2195 msg "test: AES_FEWER_TABLES"
2196 make test
2197}
2198
2199component_test_aes_rom_tables () {
2200 msg "build: default config with AES_ROM_TABLES enabled"
2201 scripts/config.py set MBEDTLS_AES_ROM_TABLES
2202 make CFLAGS='-O2 -Werror -Wall -Wextra'
2203
2204 msg "test: AES_ROM_TABLES"
2205 make test
2206}
2207
2208component_test_aes_fewer_tables_and_rom_tables () {
2209 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
2210 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
2211 scripts/config.py set MBEDTLS_AES_ROM_TABLES
2212 make CFLAGS='-O2 -Werror -Wall -Wextra'
2213
2214 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
2215 make test
2216}
2217
Ronald Cron66040472024-09-06 10:14:38 +02002218# helper for component_test_block_cipher_no_decrypt_aesni() which:
Minos Galanakis471b34c2024-07-26 15:39:24 +01002219# - enable/disable the list of config options passed from -s/-u respectively.
2220# - build
2221# - test for tests_suite_xxx
2222# - selftest
2223#
2224# Usage: helper_block_cipher_no_decrypt_build_test
2225# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
2226# Options: -s set_opts the list of config options to enable
2227# -u unset_opts the list of config options to disable
2228# -c cflags the list of options passed to CFLAGS
2229# -l ldflags the list of options passed to LDFLAGS
Minos Galanakis471b34c2024-07-26 15:39:24 +01002230helper_block_cipher_no_decrypt_build_test () {
2231 while [ $# -gt 0 ]; do
2232 case "$1" in
2233 -s)
2234 shift; local set_opts="$1";;
2235 -u)
2236 shift; local unset_opts="$1";;
2237 -c)
2238 shift; local cflags="-Werror -Wall -Wextra $1";;
2239 -l)
2240 shift; local ldflags="$1";;
2241 esac
2242 shift
2243 done
2244 set_opts="${set_opts:-}"
2245 unset_opts="${unset_opts:-}"
2246 cflags="${cflags:-}"
2247 ldflags="${ldflags:-}"
2248
2249 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
2250 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
2251
2252 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2253 make clean
2254 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
2255
2256 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
2257 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
2258 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
2259 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
2260 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
2261 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
2262 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
2263 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
2264
2265 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2266 make test
2267
2268 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2269 programs/test/selftest
2270}
2271
Ronald Cron66040472024-09-06 10:14:38 +02002272# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
2273config_block_cipher_no_decrypt () {
2274 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Ronald Cron66040472024-09-06 10:14:38 +02002275 scripts/config.py unset MBEDTLS_NIST_KW_C
2276
2277 # Enable support for cryptographic mechanisms through the PSA API.
2278 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
Ronald Cron66040472024-09-06 10:14:38 +02002279 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
2280 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
2281 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
2282 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
Ronald Cron66040472024-09-06 10:14:38 +02002283}
2284
2285component_test_block_cipher_no_decrypt_aesni () {
2286 # Test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics, AESNI assembly and
2287 # AES C implementation on x86_64 and with AESNI intrinsics on x86.
2288
2289 # This consistently causes an llvm crash on clang 3.8, so use gcc
2290 export CC=gcc
2291 config_block_cipher_no_decrypt
2292
Minos Galanakis471b34c2024-07-26 15:39:24 +01002293 # test AESNI intrinsics
2294 helper_block_cipher_no_decrypt_build_test \
2295 -s "MBEDTLS_AESNI_C" \
2296 -c "-mpclmul -msse2 -maes"
2297
2298 # test AESNI assembly
2299 helper_block_cipher_no_decrypt_build_test \
2300 -s "MBEDTLS_AESNI_C" \
2301 -c "-mno-pclmul -mno-sse2 -mno-aes"
2302
2303 # test AES C implementation
2304 helper_block_cipher_no_decrypt_build_test \
2305 -u "MBEDTLS_AESNI_C"
2306
2307 # test AESNI intrinsics for i386 target
2308 helper_block_cipher_no_decrypt_build_test \
2309 -s "MBEDTLS_AESNI_C" \
2310 -c "-m32 -mpclmul -msse2 -maes" \
2311 -l "-m32"
2312}
2313
Minos Galanakisf699d512024-08-01 11:32:30 +01002314support_test_block_cipher_no_decrypt_aesce_armcc () {
2315 support_build_armcc
2316}
2317
Minos Galanakis471b34c2024-07-26 15:39:24 +01002318component_test_block_cipher_no_decrypt_aesce_armcc () {
2319 scripts/config.py baremetal
2320
2321 # armc[56] don't support SHA-512 intrinsics
2322 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2323
2324 # Stop armclang warning about feature detection for A64_CRYPTO.
2325 # With this enabled, the library does build correctly under armclang,
2326 # but in baremetal builds (as tested here), feature detection is
2327 # unavailable, and the user is notified via a #warning. So enabling
2328 # this feature would prevent us from building with -Werror on
2329 # armclang. Tracked in #7198.
2330 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2331 scripts/config.py set MBEDTLS_HAVE_ASM
2332
Ronald Cron66040472024-09-06 10:14:38 +02002333 config_block_cipher_no_decrypt
Minos Galanakis471b34c2024-07-26 15:39:24 +01002334
2335 # test AESCE baremetal build
2336 scripts/config.py set MBEDTLS_AESCE_C
2337 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002338 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002339
2340 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
2341 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
2342 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
2343 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
2344 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
2345 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
2346 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
2347 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
2348 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
2349}
2350
2351component_test_ctr_drbg_aes_256_sha_256 () {
2352 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2353 scripts/config.py full
2354 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2355 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
2356 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2357 make
2358
2359 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2360 make test
2361}
2362
2363component_test_ctr_drbg_aes_128_sha_512 () {
2364 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
2365 scripts/config.py full
2366 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2367 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
2368 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2369 make
2370
2371 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
2372 make test
2373}
2374
2375component_test_ctr_drbg_aes_128_sha_256 () {
2376 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2377 scripts/config.py full
2378 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2379 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
2380 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
2381 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2382 make
2383
2384 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2385 make test
2386}
2387
Gilles Peskinea9dda7e2024-06-21 11:25:01 +02002388component_test_full_static_keystore () {
2389 msg "build: full config - MBEDTLS_PSA_KEY_STORE_DYNAMIC"
2390 scripts/config.py full
2391 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
2392 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
2393
2394 msg "test: full config - MBEDTLS_PSA_KEY_STORE_DYNAMIC"
2395 make test
2396}
2397
Minos Galanakis471b34c2024-07-26 15:39:24 +01002398component_test_psa_crypto_drivers () {
Ronald Crona0afbfb2024-10-15 13:20:31 +02002399 # Test dispatch to drivers and fallbacks with
2400 # test_suite_psa_crypto_driver_wrappers test suite. The test drivers that
2401 # are wrappers around the builtin drivers are activated by
2402 # PSA_CRYPTO_DRIVER_TEST.
2403 #
2404 # For the time being, some test cases in test_suite_block_cipher and
2405 # test_suite_md.psa rely on this component to be run at least once by the
2406 # CI. This should disappear as we progress the 4.x work. See
2407 # config_adjust_test_accelerators.h for more information.
Minos Galanakis471b34c2024-07-26 15:39:24 +01002408 msg "build: full + test drivers dispatching to builtins"
2409 scripts/config.py full
Ronald Cron67cc6a72024-10-14 10:55:24 +02002410 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_CONFIG_ADJUST_TEST_ACCELERATORS"
David Horstmann5b93d972024-10-31 15:36:05 +00002411 loc_cflags="${loc_cflags} -I../framework/tests/include"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002412
2413 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
2414
2415 msg "test: full + test drivers dispatching to builtins"
2416 make test
2417}
2418
2419component_build_psa_config_file () {
Minos Galanakis4f619e12024-11-14 14:56:47 +00002420 msg "build: make with TF_PSA_CRYPTO_CONFIG_FILE" # ~40s
Minos Galanakis471b34c2024-07-26 15:39:24 +01002421 cp "$CRYPTO_CONFIG_H" psa_test_config.h
Minos Galanakis4f619e12024-11-14 14:56:47 +00002422 echo '#error "TF_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
2423 make CFLAGS="-I '$PWD' -DTF_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002424 # Make sure this feature is enabled. We'll disable it in the next phase.
Ronald Cron3f120062025-07-03 14:45:51 +02002425 programs/test/query_compile_time_config PSA_WANT_ALG_CMAC
Minos Galanakis471b34c2024-07-26 15:39:24 +01002426 make clean
2427
Minos Galanakis4f619e12024-11-14 14:56:47 +00002428 msg "build: make with TF_PSA_CRYPTO_CONFIG_FILE + TF_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Minos Galanakis471b34c2024-07-26 15:39:24 +01002429 # In the user config, disable one feature and its dependencies, which will
2430 # reflect on the mbedtls configuration so we can query it with
2431 # query_compile_time_config.
2432 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
2433 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Minos Galanakis4f619e12024-11-14 14:56:47 +00002434 make CFLAGS="-I '$PWD' -DTF_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DTF_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
Ronald Cron3f120062025-07-03 14:45:51 +02002435 not programs/test/query_compile_time_config PSA_WANT_ALG_CMAC
Minos Galanakis471b34c2024-07-26 15:39:24 +01002436
2437 rm -f psa_test_config.h psa_user_config.h
2438}
2439
2440component_build_psa_alt_headers () {
2441 msg "build: make with PSA alt headers" # ~20s
2442
2443 # Generate alternative versions of the substitutable headers with the
2444 # same content except different include guards.
David Horstmanndc459512024-11-07 17:08:11 +00002445 make -C tests ../framework/tests/include/alt-extra/psa/crypto_platform_alt.h ../framework/tests/include/alt-extra/psa/crypto_struct_alt.h
Minos Galanakis471b34c2024-07-26 15:39:24 +01002446
2447 # Build the library and some programs.
2448 # Don't build the fuzzers to avoid having to go through hoops to set
2449 # a correct include path for programs/fuzz/Makefile.
David Horstmann5b93d972024-10-31 15:36:05 +00002450 make CFLAGS="-I ../framework/tests/include/alt-extra -DMBEDTLS_PSA_CRYPTO_PLATFORM_FILE='\"psa/crypto_platform_alt.h\"' -DMBEDTLS_PSA_CRYPTO_STRUCT_FILE='\"psa/crypto_struct_alt.h\"'" lib
2451 make -C programs -o fuzz CFLAGS="-I ../framework/tests/include/alt-extra -DMBEDTLS_PSA_CRYPTO_PLATFORM_FILE='\"psa/crypto_platform_alt.h\"' -DMBEDTLS_PSA_CRYPTO_STRUCT_FILE='\"psa/crypto_struct_alt.h\"'"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002452
2453 # Check that we're getting the alternative include guards and not the
2454 # original include guards.
2455 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
2456 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
2457 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
2458 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
2459}
2460
2461component_test_min_mpi_window_size () {
2462 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
2463 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
2464 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2465 make
2466
2467 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
2468 make test
2469}
Ronald Cronf256f8a2025-07-10 17:37:18 +02002470
2471component_test_xts () {
2472 # Component dedicated to run XTS unit test cases while XTS is not
2473 # supported through the PSA API.
2474 msg "build: Default + MBEDTLS_CIPHER_MODE_XTS"
2475
2476 echo "#define MBEDTLS_CIPHER_MODE_XTS" > psa_user_config.h
2477 cmake -DTF_PSA_CRYPTO_USER_CONFIG_FILE="psa_user_config.h"
2478 make
2479
Ronald Crone0b06eb2025-07-15 08:58:32 +02002480 rm -f psa_user_config.h
2481
Ronald Cronf256f8a2025-07-10 17:37:18 +02002482 msg "test: Default + MBEDTLS_CIPHER_MODE_XTS"
2483 make test
Ronald Cronf256f8a2025-07-10 17:37:18 +02002484}