blob: 834eb1f3ab7f257eca6666fd6868a8eaf680c3a0 [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
518component_test_depends_py_cipher_padding () {
519 msg "test/build: depends.py cipher_padding (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200520 tests/scripts/depends.py cipher_padding
Minos Galanakis471b34c2024-07-26 15:39:24 +0100521}
522
523component_test_depends_py_curves () {
524 msg "test/build: depends.py curves (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200525 tests/scripts/depends.py curves
Minos Galanakis471b34c2024-07-26 15:39:24 +0100526}
527
528component_test_depends_py_hashes () {
529 msg "test/build: depends.py hashes (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200530 tests/scripts/depends.py hashes
Minos Galanakis471b34c2024-07-26 15:39:24 +0100531}
532
Minos Galanakis471b34c2024-07-26 15:39:24 +0100533component_test_depends_py_pkalgs () {
534 msg "test/build: depends.py pkalgs (gcc)"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100535 tests/scripts/depends.py pkalgs
536}
537
538component_test_psa_crypto_config_ffdh_2048_only () {
539 msg "build: full config - only DH 2048"
540
541 scripts/config.py full
542
543 # Disable all DH groups other than 2048.
544 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
545 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
546 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
547 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
548
549 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
550
551 msg "test: full config - only DH 2048"
552 make test
553
554 msg "ssl-opt: full config - only DH 2048"
555 tests/ssl-opt.sh -f "ffdh"
556}
557
Minos Galanakis471b34c2024-07-26 15:39:24 +0100558component_test_psa_crypto_config_accel_ecdsa () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200559 msg "build: accelerated ECDSA"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100560
561 # Algorithms and key types to accelerate
562 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
563 $(helper_get_psa_key_type_list "ECC") \
564 $(helper_get_psa_curve_list)"
565
566 # Configure
567 # ---------
568
Elena Uziunaite91d83862024-09-04 14:51:31 +0100569 # Start from default config + TLS 1.3
Minos Galanakis471b34c2024-07-26 15:39:24 +0100570 helper_libtestdriver1_adjust_config "default"
571
572 # Disable the module that's accelerated
573 scripts/config.py unset MBEDTLS_ECDSA_C
574
575 # Disable things that depend on it
576 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
577 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
578
579 # Build
580 # -----
581
582 # These hashes are needed for some ECDSA signature tests.
Elena Uziunaiteffce45c2024-09-12 14:58:52 +0100583 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 +0100584 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
585
586 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
587
588 helper_libtestdriver1_make_main "$loc_accel_list"
589
590 # Make sure this was not re-enabled by accident (additive config)
591 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
592
593 # Run the tests
594 # -------------
595
Ronald Cron93ba6252024-09-05 10:37:14 +0200596 msg "test: accelerated ECDSA"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100597 make test
598}
599
600component_test_psa_crypto_config_accel_ecdh () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200601 msg "build: accelerated ECDH"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100602
603 # Algorithms and key types to accelerate
604 loc_accel_list="ALG_ECDH \
605 $(helper_get_psa_key_type_list "ECC") \
606 $(helper_get_psa_curve_list)"
607
608 # Configure
609 # ---------
610
611 # Start from default config (no USE_PSA)
612 helper_libtestdriver1_adjust_config "default"
613
614 # Disable the module that's accelerated
615 scripts/config.py unset MBEDTLS_ECDH_C
616
617 # Disable things that depend on it
618 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
619 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
620 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
621 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
622 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
623
624 # Build
625 # -----
626
627 helper_libtestdriver1_make_drivers "$loc_accel_list"
628
629 helper_libtestdriver1_make_main "$loc_accel_list"
630
631 # Make sure this was not re-enabled by accident (additive config)
632 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
633
634 # Run the tests
635 # -------------
636
Ronald Cron93ba6252024-09-05 10:37:14 +0200637 msg "test: accelerated ECDH"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100638 make test
639}
640
641component_test_psa_crypto_config_accel_ffdh () {
642 msg "build: full with accelerated FFDH"
643
644 # Algorithms and key types to accelerate
645 loc_accel_list="ALG_FFDH \
646 $(helper_get_psa_key_type_list "DH") \
647 $(helper_get_psa_dh_group_list)"
648
649 # Configure
650 # ---------
651
652 # start with full (USE_PSA and TLS 1.3)
653 helper_libtestdriver1_adjust_config "full"
654
Minos Galanakis471b34c2024-07-26 15:39:24 +0100655 # Build
656 # -----
657
658 helper_libtestdriver1_make_drivers "$loc_accel_list"
659
660 helper_libtestdriver1_make_main "$loc_accel_list"
661
662 # Make sure this was not re-enabled by accident (additive config)
Valerio Settieb63eb22025-02-12 13:32:49 +0100663 not grep mbedtls_psa_ffdh_key_agreement ${BUILTIN_SRC_PATH}/psa_crypto_ffdh.o
Minos Galanakis471b34c2024-07-26 15:39:24 +0100664
665 # Run the tests
666 # -------------
667
668 msg "test: full with accelerated FFDH"
669 make test
670
671 msg "ssl-opt: full with accelerated FFDH alg"
672 tests/ssl-opt.sh -f "ffdh"
673}
674
675component_test_psa_crypto_config_reference_ffdh () {
676 msg "build: full with non-accelerated FFDH"
677
678 # Start with full (USE_PSA and TLS 1.3)
679 helper_libtestdriver1_adjust_config "full"
680
Minos Galanakis471b34c2024-07-26 15:39:24 +0100681 make
682
683 msg "test suites: full with non-accelerated FFDH alg"
684 make test
685
686 msg "ssl-opt: full with non-accelerated FFDH alg"
687 tests/ssl-opt.sh -f "ffdh"
688}
689
Minos Galanakisf78447f2024-07-26 20:49:51 +0100690component_test_psa_crypto_config_accel_pake () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100691 msg "build: full with accelerated PAKE"
692
693 loc_accel_list="ALG_JPAKE \
694 $(helper_get_psa_key_type_list "ECC") \
695 $(helper_get_psa_curve_list)"
696
697 # Configure
698 # ---------
699
700 helper_libtestdriver1_adjust_config "full"
701
702 # Make built-in fallback not available
703 scripts/config.py unset MBEDTLS_ECJPAKE_C
704 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
705
706 # Build
707 # -----
708
709 helper_libtestdriver1_make_drivers "$loc_accel_list"
710
711 helper_libtestdriver1_make_main "$loc_accel_list"
712
713 # Make sure this was not re-enabled by accident (additive config)
714 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
715
716 # Run the tests
717 # -------------
718
719 msg "test: full with accelerated PAKE"
720 make test
721}
722
723component_test_psa_crypto_config_accel_ecc_some_key_types () {
724 msg "build: full with accelerated EC algs and some key types"
725
726 # Algorithms and key types to accelerate
727 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
728 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
729 ALG_ECDH \
730 ALG_JPAKE \
731 KEY_TYPE_ECC_PUBLIC_KEY \
732 KEY_TYPE_ECC_KEY_PAIR_BASIC \
733 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
734 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
735 $(helper_get_psa_curve_list)"
736
737 # Configure
738 # ---------
739
740 # start with config full for maximum coverage (also enables USE_PSA)
741 helper_libtestdriver1_adjust_config "full"
742
743 # Disable modules that are accelerated - some will be re-enabled
744 scripts/config.py unset MBEDTLS_ECDSA_C
745 scripts/config.py unset MBEDTLS_ECDH_C
746 scripts/config.py unset MBEDTLS_ECJPAKE_C
747 scripts/config.py unset MBEDTLS_ECP_C
748
749 # Disable all curves - those that aren't accelerated should be re-enabled
750 helper_disable_builtin_curves
751
752 # Restartable feature is not yet supported by PSA. Once it will in
753 # the future, the following line could be removed (see issues
754 # 6061, 6332 and following ones)
755 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
756
757 # this is not supported by the driver API yet
758 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
759
760 # Build
761 # -----
762
763 # These hashes are needed for some ECDSA signature tests.
764 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
765 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
766 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
767
768 helper_libtestdriver1_make_main "$loc_accel_list"
769
770 # ECP should be re-enabled but not the others
771 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
772 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
773 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
774 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
775
776 # Run the tests
777 # -------------
778
779 msg "test suites: full with accelerated EC algs and some key types"
780 make test
781}
782
783# Run tests with only (non-)Weierstrass accelerated
784# Common code used in:
785# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
786# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Minos Galanakis471b34c2024-07-26 15:39:24 +0100787common_test_psa_crypto_config_accel_ecc_some_curves () {
788 weierstrass=$1
789 if [ $weierstrass -eq 1 ]; then
790 desc="Weierstrass"
791 else
792 desc="non-Weierstrass"
793 fi
794
795 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
796
797 # Note: Curves are handled in a special way by the libtestdriver machinery,
798 # so we only want to include them in the accel list when building the main
799 # libraries, hence the use of a separate variable.
800 # Note: the following loop is a modified version of
801 # helper_get_psa_curve_list that only keeps Weierstrass families.
802 loc_weierstrass_list=""
803 loc_non_weierstrass_list=""
804 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
805 case $item in
806 ECC_BRAINPOOL*|ECC_SECP*)
807 loc_weierstrass_list="$loc_weierstrass_list $item"
808 ;;
809 *)
810 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
811 ;;
812 esac
813 done
814 if [ $weierstrass -eq 1 ]; then
815 loc_curve_list=$loc_weierstrass_list
816 else
817 loc_curve_list=$loc_non_weierstrass_list
818 fi
819
820 # Algorithms and key types to accelerate
821 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
822 ALG_ECDH \
823 ALG_JPAKE \
824 $(helper_get_psa_key_type_list "ECC") \
825 $loc_curve_list"
826
827 # Configure
828 # ---------
829
830 # Start with config crypto_full and remove PK_C:
831 # that's what's supported now, see docs/driver-only-builds.md.
832 helper_libtestdriver1_adjust_config "crypto_full"
833 scripts/config.py unset MBEDTLS_PK_C
834 scripts/config.py unset MBEDTLS_PK_PARSE_C
835 scripts/config.py unset MBEDTLS_PK_WRITE_C
836
837 # Disable modules that are accelerated - some will be re-enabled
838 scripts/config.py unset MBEDTLS_ECDSA_C
839 scripts/config.py unset MBEDTLS_ECDH_C
840 scripts/config.py unset MBEDTLS_ECJPAKE_C
841 scripts/config.py unset MBEDTLS_ECP_C
842
843 # Disable all curves - those that aren't accelerated should be re-enabled
844 helper_disable_builtin_curves
845
846 # Restartable feature is not yet supported by PSA. Once it will in
847 # the future, the following line could be removed (see issues
848 # 6061, 6332 and following ones)
849 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
850
851 # this is not supported by the driver API yet
852 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
853
854 # Build
855 # -----
856
857 # These hashes are needed for some ECDSA signature tests.
858 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
859 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
860 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
861
862 helper_libtestdriver1_make_main "$loc_accel_list"
863
864 # We expect ECDH to be re-enabled for the missing curves
865 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
866 # We expect ECP to be re-enabled, however the parts specific to the
867 # families of curves that are accelerated should be ommited.
868 # - functions with mxz in the name are specific to Montgomery curves
869 # - ecp_muladd is specific to Weierstrass curves
870 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
871 if [ $weierstrass -eq 1 ]; then
872 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
873 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
874 else
875 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
876 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
877 fi
878 # We expect ECDSA and ECJPAKE to be re-enabled only when
879 # Weierstrass curves are not accelerated
880 if [ $weierstrass -eq 1 ]; then
881 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
882 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
883 else
884 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
885 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
886 fi
887
888 # Run the tests
889 # -------------
890
891 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
892 make test
893}
894
895component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
896 common_test_psa_crypto_config_accel_ecc_some_curves 1
897}
898
899component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
900 common_test_psa_crypto_config_accel_ecc_some_curves 0
901}
902
903# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
904# ECDH, ECDSA) with and without drivers.
905# The input parameter is a boolean value which indicates:
906# - 0 keep built-in EC algs,
907# - 1 exclude built-in EC algs (driver only).
908#
909# This is used by the two following components to ensure they always use the
910# same config, except for the use of driver or built-in EC algorithms:
911# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
912# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
913# This supports comparing their test coverage with analyze_outcomes.py.
Minos Galanakis471b34c2024-07-26 15:39:24 +0100914config_psa_crypto_config_ecp_light_only () {
915 driver_only="$1"
916 # start with config full for maximum coverage (also enables USE_PSA)
917 helper_libtestdriver1_adjust_config "full"
918 if [ "$driver_only" -eq 1 ]; then
919 # Disable modules that are accelerated
920 scripts/config.py unset MBEDTLS_ECDSA_C
921 scripts/config.py unset MBEDTLS_ECDH_C
922 scripts/config.py unset MBEDTLS_ECJPAKE_C
923 scripts/config.py unset MBEDTLS_ECP_C
924 fi
925
926 # Restartable feature is not yet supported by PSA. Once it will in
927 # the future, the following line could be removed (see issues
928 # 6061, 6332 and following ones)
929 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
930}
931
932# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
Minos Galanakis471b34c2024-07-26 15:39:24 +0100933component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
934 msg "build: full with accelerated EC algs"
935
936 # Algorithms and key types to accelerate
937 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
938 ALG_ECDH \
939 ALG_JPAKE \
940 $(helper_get_psa_key_type_list "ECC") \
941 $(helper_get_psa_curve_list)"
942
943 # Configure
944 # ---------
945
946 # Use the same config as reference, only without built-in EC algs
947 config_psa_crypto_config_ecp_light_only 1
948
949 # Do not disable builtin curves because that support is required for:
950 # - MBEDTLS_PK_PARSE_EC_EXTENDED
951 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
952
953 # Build
954 # -----
955
956 # These hashes are needed for some ECDSA signature tests.
957 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
958 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
959 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
960
961 helper_libtestdriver1_make_main "$loc_accel_list"
962
963 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
964 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
965 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
966 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
967 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
968
969 # Run the tests
970 # -------------
971
972 msg "test suites: full with accelerated EC algs"
973 make test
974
975 msg "ssl-opt: full with accelerated EC algs"
976 tests/ssl-opt.sh
977}
978
979# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
Minos Galanakis471b34c2024-07-26 15:39:24 +0100980component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200981 msg "build: non-accelerated EC algs"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100982
983 config_psa_crypto_config_ecp_light_only 0
984
985 make
986
987 msg "test suites: full with non-accelerated EC algs"
988 make test
989
990 msg "ssl-opt: full with non-accelerated EC algs"
991 tests/ssl-opt.sh
992}
993
994# This helper function is used by:
995# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
996# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
997# to ensure that both tests use the same underlying configuration when testing
998# driver's coverage with analyze_outcomes.py.
999#
1000# This functions accepts 1 boolean parameter as follows:
1001# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
1002# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
1003# - 0: include built-in implementation of EC algorithms.
1004#
1005# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
1006# on the ECP module.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001007config_psa_crypto_no_ecp_at_all () {
1008 driver_only="$1"
1009 # start with full config for maximum coverage (also enables USE_PSA)
1010 helper_libtestdriver1_adjust_config "full"
1011
1012 if [ "$driver_only" -eq 1 ]; then
1013 # Disable modules that are accelerated
1014 scripts/config.py unset MBEDTLS_ECDSA_C
1015 scripts/config.py unset MBEDTLS_ECDH_C
1016 scripts/config.py unset MBEDTLS_ECJPAKE_C
1017 # Disable ECP module (entirely)
1018 scripts/config.py unset MBEDTLS_ECP_C
1019 fi
1020
1021 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
1022 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1023 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
1024 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
1025
1026 # Restartable feature is not yet supported by PSA. Once it will in
1027 # the future, the following line could be removed (see issues
1028 # 6061, 6332 and following ones)
1029 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
1030}
1031
1032# Build and test a configuration where driver accelerates all EC algs while
1033# all support and dependencies from ECP and ECP_LIGHT are removed on the library
1034# side.
1035#
1036# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Minos Galanakis471b34c2024-07-26 15:39:24 +01001037component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
1038 msg "build: full + accelerated EC algs - ECP"
1039
1040 # Algorithms and key types to accelerate
1041 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
1042 ALG_ECDH \
1043 ALG_JPAKE \
1044 $(helper_get_psa_key_type_list "ECC") \
1045 $(helper_get_psa_curve_list)"
1046
1047 # Configure
1048 # ---------
1049
1050 # Set common configurations between library's and driver's builds
1051 config_psa_crypto_no_ecp_at_all 1
1052 # Disable all the builtin curves. All the required algs are accelerated.
1053 helper_disable_builtin_curves
1054
1055 # Build
1056 # -----
1057
1058 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
1059 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
1060 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1061 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1062
1063 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1064
1065 helper_libtestdriver1_make_main "$loc_accel_list"
1066
1067 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1068 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1069 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1070 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
1071 # Also ensure that ECP module was not re-enabled
1072 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1073
1074 # Run the tests
1075 # -------------
1076
1077 msg "test: full + accelerated EC algs - ECP"
1078 make test
1079
1080 msg "ssl-opt: full + accelerated EC algs - ECP"
1081 tests/ssl-opt.sh
1082}
1083
1084# Reference function used for driver's coverage analysis in analyze_outcomes.py
1085# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
1086# Keep in sync with its accelerated counterpart.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001087component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
1088 msg "build: full + non accelerated EC algs"
1089
1090 config_psa_crypto_no_ecp_at_all 0
1091
1092 make
1093
1094 msg "test: full + non accelerated EC algs"
1095 make test
1096
1097 msg "ssl-opt: full + non accelerated EC algs"
1098 tests/ssl-opt.sh
1099}
1100
1101# This is a common configuration helper used directly from:
1102# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1103# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1104# and indirectly from:
1105# - component_test_psa_crypto_config_accel_ecc_no_bignum
1106# - accelerate all EC algs, disable RSA and FFDH
1107# - component_test_psa_crypto_config_reference_ecc_no_bignum
1108# - this is the reference component of the above
1109# - it still disables RSA and FFDH, but it uses builtin EC algs
1110# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1111# - accelerate all EC and FFDH algs, disable only RSA
1112# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1113# - this is the reference component of the above
1114# - it still disables RSA, but it uses builtin EC and FFDH algs
1115#
1116# This function accepts 2 parameters:
1117# $1: a boolean value which states if we are testing an accelerated scenario
1118# or not.
1119# $2: a string value which states which components are tested. Allowed values
1120# are "ECC" or "ECC_DH".
Minos Galanakisf78447f2024-07-26 20:49:51 +01001121config_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001122 driver_only="$1"
1123 test_target="$2"
1124 # start with full config for maximum coverage (also enables USE_PSA)
1125 helper_libtestdriver1_adjust_config "full"
1126
1127 if [ "$driver_only" -eq 1 ]; then
1128 # Disable modules that are accelerated
1129 scripts/config.py unset MBEDTLS_ECDSA_C
1130 scripts/config.py unset MBEDTLS_ECDH_C
1131 scripts/config.py unset MBEDTLS_ECJPAKE_C
1132 # Disable ECP module (entirely)
1133 scripts/config.py unset MBEDTLS_ECP_C
1134 # Also disable bignum
1135 scripts/config.py unset MBEDTLS_BIGNUM_C
1136 fi
1137
1138 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
1139 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1140 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
1141 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
1142
1143 # RSA support is intentionally disabled on this test because RSA_C depends
1144 # on BIGNUM_C.
1145 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
1146 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 +01001147 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1148 # Also disable key exchanges that depend on RSA
Minos Galanakis471b34c2024-07-26 15:39:24 +01001149 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1150 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1151
1152 if [ "$test_target" = "ECC" ]; then
1153 # When testing ECC only, we disable FFDH support, both from builtin and
Valerio Setti8438c632025-01-22 11:56:40 +01001154 # PSA sides.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001155 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
1156 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
1157 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001158 fi
1159
1160 # Restartable feature is not yet supported by PSA. Once it will in
1161 # the future, the following line could be removed (see issues
1162 # 6061, 6332 and following ones)
1163 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
1164}
1165
1166# Common helper used by:
1167# - component_test_psa_crypto_config_accel_ecc_no_bignum
1168# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1169#
1170# The goal is to build and test accelerating either:
1171# - ECC only or
1172# - both ECC and FFDH
1173#
1174# It is meant to be used in conjunction with
1175# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
1176# coverage analysis in the "analyze_outcomes.py" script.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001177common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
1178 test_target="$1"
1179
1180 # This is an internal helper to simplify text message handling
1181 if [ "$test_target" = "ECC_DH" ]; then
1182 accel_text="ECC/FFDH"
1183 removed_text="ECP - DH"
1184 else
1185 accel_text="ECC"
1186 removed_text="ECP"
1187 fi
1188
1189 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
1190
1191 # By default we accelerate all EC keys/algs
1192 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
1193 ALG_ECDH \
1194 ALG_JPAKE \
1195 $(helper_get_psa_key_type_list "ECC") \
1196 $(helper_get_psa_curve_list)"
1197 # Optionally we can also add DH to the list of accelerated items
1198 if [ "$test_target" = "ECC_DH" ]; then
1199 loc_accel_list="$loc_accel_list \
1200 ALG_FFDH \
1201 $(helper_get_psa_key_type_list "DH") \
1202 $(helper_get_psa_dh_group_list)"
1203 fi
1204
1205 # Configure
1206 # ---------
1207
1208 # Set common configurations between library's and driver's builds
1209 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
1210 # Disable all the builtin curves. All the required algs are accelerated.
1211 helper_disable_builtin_curves
1212
1213 # Build
1214 # -----
1215
1216 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
1217 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
1218 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1219 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1220
1221 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1222
1223 helper_libtestdriver1_make_main "$loc_accel_list"
1224
1225 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1226 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1227 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1228 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settieb63eb22025-02-12 13:32:49 +01001229 # Also ensure that ECP, RSA or BIGNUM modules were not re-enabled
Minos Galanakis471b34c2024-07-26 15:39:24 +01001230 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1231 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
1232 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001233
1234 # Run the tests
1235 # -------------
1236
Valerio Settieb63eb22025-02-12 13:32:49 +01001237 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001238
1239 make test
1240
1241 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
1242 tests/ssl-opt.sh
1243}
1244
1245# Common helper used by:
1246# - component_test_psa_crypto_config_reference_ecc_no_bignum
1247# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1248#
1249# The goal is to build and test a reference scenario (i.e. with builtin
1250# components) compared to the ones used in
1251# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
1252#
1253# It is meant to be used in conjunction with
1254# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
1255# coverage analysis in "analyze_outcomes.py" script.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001256common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
1257 test_target="$1"
1258
1259 # This is an internal helper to simplify text message handling
1260 if [ "$test_target" = "ECC_DH" ]; then
1261 accel_text="ECC/FFDH"
1262 else
1263 accel_text="ECC"
1264 fi
1265
1266 msg "build: full + non accelerated $accel_text algs + USE_PSA"
1267
1268 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
1269
1270 make
1271
1272 msg "test suites: full + non accelerated EC algs + USE_PSA"
1273 make test
1274
1275 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
1276 tests/ssl-opt.sh
1277}
1278
1279component_test_psa_crypto_config_accel_ecc_no_bignum () {
1280 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
1281}
1282
1283component_test_psa_crypto_config_reference_ecc_no_bignum () {
1284 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
1285}
1286
1287component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
1288 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
1289}
1290
1291component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
1292 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
1293}
1294
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001295component_test_tfm_config_as_is () {
1296 msg "build: configs/config-tfm.h"
Minos Galanakis5da58e52024-11-07 15:35:33 +00001297 MBEDTLS_CONFIG="configs/config-tfm.h"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001298 CRYPTO_CONFIG="tf-psa-crypto/configs/ext/crypto_config_profile_medium.h"
Minos Galanakis4f619e12024-11-14 14:56:47 +00001299 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 +02001300 make
1301
1302 msg "test: configs/config-tfm.h - unit tests"
1303 make test
1304}
1305
Minos Galanakis471b34c2024-07-26 15:39:24 +01001306# Helper for setting common configurations between:
1307# - component_test_tfm_config_p256m_driver_accel_ec()
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001308# - component_test_tfm_config_no_p256m()
Minos Galanakis471b34c2024-07-26 15:39:24 +01001309common_tfm_config () {
1310 # Enable TF-M config
1311 cp configs/config-tfm.h "$CONFIG_H"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001312 cp tf-psa-crypto/configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001313
Minos Galanakis471b34c2024-07-26 15:39:24 +01001314 # Config adjustment for better test coverage in our environment.
1315 # This is not needed just to build and pass tests.
1316 #
1317 # Enable filesystem I/O for the benefit of PK parse/write tests.
Minos Galanakis5da58e52024-11-07 15:35:33 +00001318 sed -i '/PROFILE_M_PSA_CRYPTO_CONFIG_H/i #define MBEDTLS_FS_IO' "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001319}
1320
1321# Keep this in sync with component_test_tfm_config() as they are both meant
1322# to be used in analyze_outcomes.py for driver's coverage analysis.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001323component_test_tfm_config_p256m_driver_accel_ec () {
1324 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
1325
1326 common_tfm_config
1327
1328 # Build crypto library
David Horstmann5b93d972024-10-31 15:36:05 +00001329 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../framework/tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001330
1331 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1332 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1333 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1334 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settieb63eb22025-02-12 13:32:49 +01001335 # Also ensure that ECP, RSA or BIGNUM modules were not re-enabled
Minos Galanakis471b34c2024-07-26 15:39:24 +01001336 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1337 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001338 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
1339 # Check that p256m was built
1340 grep -q p256_ecdsa_ library/libmbedcrypto.a
1341
1342 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
1343 # files, so we want to ensure that it has not be re-enabled accidentally.
1344 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
1345
1346 # Run the tests
1347 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
1348 make test
1349}
1350
1351# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
1352# they are both meant to be used in analyze_outcomes.py for driver's coverage
1353# analysis.
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001354component_test_tfm_config_no_p256m () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001355 common_tfm_config
1356
1357 # Disable P256M driver, which is on by default, so that analyze_outcomes
1358 # can compare this test with test_tfm_config_p256m_driver_accel_ec
Minos Galanakis5da58e52024-11-07 15:35:33 +00001359 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 +01001360
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001361 msg "build: TF-M config without p256m"
David Horstmann5b93d972024-10-31 15:36:05 +00001362 make CFLAGS='-Werror -Wall -Wextra -I../framework/tests/include/spe' tests
Minos Galanakis471b34c2024-07-26 15:39:24 +01001363
1364 # Check that p256m was not built
1365 not grep p256_ecdsa_ library/libmbedcrypto.a
1366
1367 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
1368 # files, so we want to ensure that it has not be re-enabled accidentally.
1369 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
1370
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001371 msg "test: TF-M config without p256m"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001372 make test
1373}
1374
Minos Galanakis471b34c2024-07-26 15:39:24 +01001375# This is an helper used by:
1376# - component_test_psa_ecc_key_pair_no_derive
1377# - component_test_psa_ecc_key_pair_no_generate
1378# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
1379# enabled, but one. Input arguments are as follows:
Gilles Peskinefef912c2024-09-20 16:07:09 +02001380# - $1 is the configuration to start from
1381# - $2 is the key type under test, i.e. ECC/RSA/DH
1382# - $3 is the key option to be unset (i.e. generate, derive, etc)
Minos Galanakisf78447f2024-07-26 20:49:51 +01001383build_and_test_psa_want_key_pair_partial () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001384 base_config=$1
1385 key_type=$2
1386 unset_option=$3
Minos Galanakis471b34c2024-07-26 15:39:24 +01001387 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
1388
Gilles Peskinefef912c2024-09-20 16:07:09 +02001389 msg "build: $base_config - ${disabled_psa_want}"
1390 scripts/config.py "$base_config"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001391
1392 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
1393 # crypto_config.h so we just disable the one we don't want.
1394 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
1395
1396 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1397
Gilles Peskinefef912c2024-09-20 16:07:09 +02001398 msg "test: $base_config - ${disabled_psa_want}"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001399 make test
1400}
1401
Minos Galanakisf78447f2024-07-26 20:49:51 +01001402component_test_psa_ecc_key_pair_no_derive () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001403 build_and_test_psa_want_key_pair_partial full "ECC" "DERIVE"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001404}
1405
Minos Galanakisf78447f2024-07-26 20:49:51 +01001406component_test_psa_ecc_key_pair_no_generate () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001407 # TLS needs ECC key generation whenever ephemeral ECDH is enabled.
1408 # We don't have proper guards for configurations with ECC key generation
1409 # disabled (https://github.com/Mbed-TLS/mbedtls/issues/9481). Until
1410 # then (if ever), just test the crypto part of the library.
1411 build_and_test_psa_want_key_pair_partial crypto_full "ECC" "GENERATE"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001412}
1413
1414config_psa_crypto_accel_rsa () {
1415 driver_only=$1
1416
1417 # Start from crypto_full config (no X.509, no TLS)
1418 helper_libtestdriver1_adjust_config "crypto_full"
1419
1420 if [ "$driver_only" -eq 1 ]; then
Minos Galanakis471b34c2024-07-26 15:39:24 +01001421 # We need PEM parsing in the test library as well to support the import
1422 # of PEM encoded RSA keys.
Minos Galanakis23452f52024-11-28 17:48:14 +00001423 scripts/config.py -c "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
1424 scripts/config.py -c "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
Minos Galanakis471b34c2024-07-26 15:39:24 +01001425 fi
1426}
1427
1428component_test_psa_crypto_config_accel_rsa_crypto () {
1429 msg "build: crypto_full with accelerated RSA"
1430
1431 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
1432 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
1433 KEY_TYPE_RSA_PUBLIC_KEY \
1434 KEY_TYPE_RSA_KEY_PAIR_BASIC \
1435 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
1436 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
1437 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
1438
1439 # Configure
1440 # ---------
1441
1442 config_psa_crypto_accel_rsa 1
1443
1444 # Build
1445 # -----
1446
1447 # These hashes are needed for unit tests.
1448 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1449 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
1450 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1451
1452 helper_libtestdriver1_make_main "$loc_accel_list"
1453
1454 # Make sure this was not re-enabled by accident (additive config)
1455 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
1456
1457 # Run the tests
1458 # -------------
1459
1460 msg "test: crypto_full with accelerated RSA"
1461 make test
1462}
1463
1464component_test_psa_crypto_config_reference_rsa_crypto () {
1465 msg "build: crypto_full with non-accelerated RSA"
1466
1467 # Configure
1468 # ---------
1469 config_psa_crypto_accel_rsa 0
1470
1471 # Build
1472 # -----
1473 make
1474
1475 # Run the tests
1476 # -------------
1477 msg "test: crypto_full with non-accelerated RSA"
1478 make test
1479}
1480
1481# This is a temporary test to verify that full RSA support is present even when
1482# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001483component_test_new_psa_want_key_pair_symbol () {
Ronald Cron892bb612025-07-21 14:26:27 +02001484 msg "Build: crypto config - PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001485
1486 # Create a temporary output file unless there is already one set
1487 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
1488 REMOVE_OUTCOME_ON_EXIT="no"
1489 else
1490 REMOVE_OUTCOME_ON_EXIT="yes"
1491 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
1492 export MBEDTLS_TEST_OUTCOME_FILE
1493 fi
1494
1495 # Start from crypto configuration
1496 scripts/config.py crypto
1497
1498 # Remove RSA support and its dependencies
Minos Galanakis471b34c2024-07-26 15:39:24 +01001499 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1500 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Minos Galanakis471b34c2024-07-26 15:39:24 +01001501 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1502
Minos Galanakis471b34c2024-07-26 15:39:24 +01001503 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
1504 # that proper translations is done in crypto_legacy.h.
1505 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
1506 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
1507 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
1508
1509 make
1510
Ronald Cron892bb612025-07-21 14:26:27 +02001511 msg "Test: crypto config - PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001512 make test
1513
1514 # Parse only 1 relevant line from the outcome file, i.e. a test which is
1515 # performing RSA signature.
1516 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
1517 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
1518
1519 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
1520 rm $MBEDTLS_TEST_OUTCOME_FILE
1521 fi
1522}
1523
1524component_test_psa_crypto_config_accel_hash () {
Ronald Cron93ba6252024-09-05 10:37:14 +02001525 msg "test: accelerated hash"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001526
1527 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1528 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1529 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1530
1531 # Configure
1532 # ---------
1533
1534 # Start from default config (no USE_PSA)
1535 helper_libtestdriver1_adjust_config "default"
1536
Minos Galanakis471b34c2024-07-26 15:39:24 +01001537 # Build
1538 # -----
1539
1540 helper_libtestdriver1_make_drivers "$loc_accel_list"
1541
1542 helper_libtestdriver1_make_main "$loc_accel_list"
1543
1544 # There's a risk of something getting re-enabled via config_psa.h;
1545 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
1546 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
1547 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
1548 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
1549 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
1550 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
1551
1552 # Run the tests
1553 # -------------
1554
Ronald Cron93ba6252024-09-05 10:37:14 +02001555 msg "test: accelerated hash"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001556 make test
1557}
1558
1559# Auxiliary function to build config for hashes with and without drivers
Minos Galanakis471b34c2024-07-26 15:39:24 +01001560config_psa_crypto_hash_use_psa () {
1561 driver_only="$1"
1562 # start with config full for maximum coverage (also enables USE_PSA)
1563 helper_libtestdriver1_adjust_config "full"
1564 if [ "$driver_only" -eq 1 ]; then
1565 # disable the built-in implementation of hashes
Minos Galanakis471b34c2024-07-26 15:39:24 +01001566 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Minos Galanakis471b34c2024-07-26 15:39:24 +01001567 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Minos Galanakis471b34c2024-07-26 15:39:24 +01001568 fi
1569}
1570
1571# Note that component_test_psa_crypto_config_reference_hash_use_psa
1572# is related to this component and both components need to be kept in sync.
1573# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001574component_test_psa_crypto_config_accel_hash_use_psa () {
1575 msg "test: full with accelerated hashes"
1576
1577 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1578 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1579 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1580
1581 # Configure
1582 # ---------
1583
1584 config_psa_crypto_hash_use_psa 1
1585
1586 # Build
1587 # -----
1588
1589 helper_libtestdriver1_make_drivers "$loc_accel_list"
1590
1591 helper_libtestdriver1_make_main "$loc_accel_list"
1592
1593 # There's a risk of something getting re-enabled via config_psa.h;
1594 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
1595 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
1596 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
1597 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
1598 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
1599 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
1600
1601 # Run the tests
1602 # -------------
1603
1604 msg "test: full with accelerated hashes"
1605 make test
1606
1607 # This is mostly useful so that we can later compare outcome files with
1608 # the reference config in analyze_outcomes.py, to check that the
1609 # dependency declarations in ssl-opt.sh and in TLS code are correct.
1610 msg "test: ssl-opt.sh, full with accelerated hashes"
1611 tests/ssl-opt.sh
1612
1613 # This is to make sure all ciphersuites are exercised, but we don't need
1614 # interop testing (besides, we already got some from ssl-opt.sh).
1615 msg "test: compat.sh, full with accelerated hashes"
1616 tests/compat.sh -p mbedTLS -V YES
1617}
1618
1619# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
1620# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
1621# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
1622# Both components need to be kept in sync.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001623component_test_psa_crypto_config_reference_hash_use_psa () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001624 msg "test: full without accelerated hashes"
1625
1626 config_psa_crypto_hash_use_psa 0
1627
1628 make
1629
1630 msg "test: full without accelerated hashes"
1631 make test
1632
1633 msg "test: ssl-opt.sh, full without accelerated hashes"
1634 tests/ssl-opt.sh
1635}
1636
1637# Auxiliary function to build config for hashes with and without drivers
Minos Galanakis471b34c2024-07-26 15:39:24 +01001638config_psa_crypto_hmac_use_psa () {
1639 driver_only="$1"
1640 # start with config full for maximum coverage (also enables USE_PSA)
1641 helper_libtestdriver1_adjust_config "full"
1642
1643 if [ "$driver_only" -eq 1 ]; then
1644 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
1645 # is still enabled though (for ENTROPY_C among others).
1646 scripts/config.py unset MBEDTLS_MD_C
Ronald Cron772a8ad2025-07-21 12:36:29 +02001647 # Also disable the configuration options that tune the builtin hashes,
1648 # since those hashes are disabled.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001649 scripts/config.py unset-all MBEDTLS_SHA
Minos Galanakis471b34c2024-07-26 15:39:24 +01001650 fi
1651
1652 # Direct dependencies of MD_C. We disable them also in the reference
1653 # component to work with the same set of features.
1654 scripts/config.py unset MBEDTLS_PKCS7_C
1655 scripts/config.py unset MBEDTLS_PKCS5_C
1656 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1657 scripts/config.py unset MBEDTLS_HKDF_C
1658 # Dependencies of HMAC_DRBG
1659 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
1660 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1661}
1662
Minos Galanakisf78447f2024-07-26 20:49:51 +01001663component_test_psa_crypto_config_accel_hmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001664 msg "test: full with accelerated hmac"
1665
1666 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
1667 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1668 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1669 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1670
1671 # Configure
1672 # ---------
1673
1674 config_psa_crypto_hmac_use_psa 1
1675
1676 # Build
1677 # -----
1678
1679 helper_libtestdriver1_make_drivers "$loc_accel_list"
1680
1681 helper_libtestdriver1_make_main "$loc_accel_list"
1682
1683 # Ensure that built-in support for HMAC is disabled.
1684 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1685
1686 # Run the tests
1687 # -------------
1688
1689 msg "test: full with accelerated hmac"
1690 make test
1691}
1692
Minos Galanakisf78447f2024-07-26 20:49:51 +01001693component_test_psa_crypto_config_reference_hmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001694 msg "test: full without accelerated hmac"
1695
1696 config_psa_crypto_hmac_use_psa 0
1697
1698 make
1699
1700 msg "test: full without accelerated hmac"
1701 make test
1702}
1703
Minos Galanakis471b34c2024-07-26 15:39:24 +01001704component_test_psa_crypto_config_accel_aead () {
Ronald Cron93ba6252024-09-05 10:37:14 +02001705 msg "test: accelerated AEAD"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001706
1707 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
1708 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1709
1710 # Configure
1711 # ---------
1712
1713 # Start from full config
1714 helper_libtestdriver1_adjust_config "full"
1715
Minos Galanakis471b34c2024-07-26 15:39:24 +01001716 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
1717 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1718
1719 # Build
1720 # -----
1721
1722 helper_libtestdriver1_make_drivers "$loc_accel_list"
1723
1724 helper_libtestdriver1_make_main "$loc_accel_list"
1725
1726 # Make sure this was not re-enabled by accident (additive config)
1727 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
1728 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
1729 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
1730
1731 # Run the tests
1732 # -------------
1733
Ronald Cron93ba6252024-09-05 10:37:14 +02001734 msg "test: accelerated AEAD"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001735 make test
1736}
1737
1738# This is a common configuration function used in:
1739# - component_test_psa_crypto_config_accel_cipher_aead_cmac
1740# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Minos Galanakisf78447f2024-07-26 20:49:51 +01001741common_psa_crypto_config_accel_cipher_aead_cmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001742 # Start from the full config
1743 helper_libtestdriver1_adjust_config "full"
1744
1745 scripts/config.py unset MBEDTLS_NIST_KW_C
1746}
1747
1748# The 2 following test components, i.e.
1749# - component_test_psa_crypto_config_accel_cipher_aead_cmac
1750# - component_test_psa_crypto_config_reference_cipher_aead_cmac
1751# are meant to be used together in analyze_outcomes.py script in order to test
1752# driver's coverage for ciphers and AEADs.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001753component_test_psa_crypto_config_accel_cipher_aead_cmac () {
1754 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
1755
1756 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 ALG_CTR ALG_CFB \
1757 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
1758 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Ari Weiler-Ofek86422e52025-07-04 14:43:30 +01001759 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001760
1761 # Configure
1762 # ---------
1763
1764 common_psa_crypto_config_accel_cipher_aead_cmac
1765
Ari Weiler-Ofek5d8d2992025-07-07 23:20:29 +01001766 # Disable DES, if it still exists.
1767 # This can be removed once we remove DES from the library.
1768 scripts/config.py unset PSA_WANT_KEY_TYPE_DES
1769
Minos Galanakis471b34c2024-07-26 15:39:24 +01001770 # Build
1771 # -----
1772
1773 helper_libtestdriver1_make_drivers "$loc_accel_list"
1774
1775 helper_libtestdriver1_make_main "$loc_accel_list"
1776
1777 # Make sure this was not re-enabled by accident (additive config)
1778 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001779 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
1780 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
1781 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
1782 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
1783 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
1784 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
1785 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Ronald Cronb5c6fcc2025-07-10 13:40:00 +02001786 not grep mbedtls_poly1305 ${BUILTIN_SRC_PATH}/poly1305.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001787
1788 # Run the tests
1789 # -------------
1790
1791 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
1792 make test
1793
1794 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Ronald Cronbd28acf2025-07-10 09:53:50 +02001795 # Exclude password-protected key tests — they require built-in CBC and AES.
1796 tests/ssl-opt.sh -e "TLS: password protected"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001797
1798 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
1799 tests/compat.sh -V NO -p mbedTLS
1800}
1801
1802component_test_psa_crypto_config_reference_cipher_aead_cmac () {
1803 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
1804 common_psa_crypto_config_accel_cipher_aead_cmac
1805
Ari Weiler-Ofek5d8d2992025-07-07 23:20:29 +01001806 # Disable DES, if it still exists.
1807 # This can be removed once we remove DES from the library.
1808 scripts/config.py unset PSA_WANT_KEY_TYPE_DES
1809
Minos Galanakis471b34c2024-07-26 15:39:24 +01001810 make
1811
1812 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
1813 make test
1814
1815 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Ronald Cronbd28acf2025-07-10 09:53:50 +02001816 # Exclude password-protected key tests as in test_psa_crypto_config_accel_cipher_aead_cmac.
1817 tests/ssl-opt.sh -e "TLS: password protected"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001818
1819 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
1820 tests/compat.sh -V NO -p mbedTLS
1821}
1822
Minos Galanakisf78447f2024-07-26 20:49:51 +01001823common_block_cipher_dispatch () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001824 TEST_WITH_DRIVER="$1"
1825
1826 # Start from the full config
1827 helper_libtestdriver1_adjust_config "full"
1828
Minos Galanakis471b34c2024-07-26 15:39:24 +01001829 # Disable cipher's modes that, when not accelerated, cause
1830 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
1831 # Keep this also in the reference component in order to skip the same tests
1832 # that were skipped in the accelerated one.
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1836 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1841
1842 # Disable direct dependency on AES_C
1843 scripts/config.py unset MBEDTLS_NIST_KW_C
1844
1845 # Prevent the cipher module from using deprecated PSA path. The reason is
1846 # that otherwise there will be tests relying on "aes_info" (defined in
1847 # "cipher_wrap.c") whose functions are not available when AES_C is
1848 # not defined. ARIA and Camellia are not a problem in this case because
1849 # the PSA path is not tested for these key types.
1850 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
1851}
1852
Gilles Peskinea9dda7e2024-06-21 11:25:01 +02001853component_test_full_block_cipher_psa_dispatch_static_keystore () {
1854 msg "build: full + PSA dispatch in block_cipher with static keystore"
1855 # Check that the static key store works well when CTR_DRBG uses a
1856 # PSA key for AES.
1857 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
1858
1859 loc_accel_list="ALG_ECB_NO_PADDING \
1860 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1861
1862 # Configure
1863 # ---------
1864
1865 common_block_cipher_dispatch 1
1866
1867 # Build
1868 # -----
1869
1870 helper_libtestdriver1_make_drivers "$loc_accel_list"
1871
1872 helper_libtestdriver1_make_main "$loc_accel_list"
1873
1874 # Make sure disabled components were not re-enabled by accident (additive
1875 # config)
1876 not grep mbedtls_aes_ library/aes.o
1877 not grep mbedtls_aria_ library/aria.o
1878 not grep mbedtls_camellia_ library/camellia.o
1879
1880 # Run the tests
1881 # -------------
1882
1883 msg "test: full + PSA dispatch in block_cipher with static keystore"
1884 make test
1885}
1886
Minos Galanakis471b34c2024-07-26 15:39:24 +01001887component_test_full_block_cipher_psa_dispatch () {
1888 msg "build: full + PSA dispatch in block_cipher"
1889
1890 loc_accel_list="ALG_ECB_NO_PADDING \
1891 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1892
1893 # Configure
1894 # ---------
1895
1896 common_block_cipher_dispatch 1
1897
1898 # Build
1899 # -----
1900
1901 helper_libtestdriver1_make_drivers "$loc_accel_list"
1902
1903 helper_libtestdriver1_make_main "$loc_accel_list"
1904
1905 # Make sure disabled components were not re-enabled by accident (additive
1906 # config)
1907 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
1908 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
1909 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
1910
1911 # Run the tests
1912 # -------------
1913
1914 msg "test: full + PSA dispatch in block_cipher"
1915 make test
1916}
1917
1918# This is the reference component of component_test_full_block_cipher_psa_dispatch
Minos Galanakis471b34c2024-07-26 15:39:24 +01001919component_test_full_block_cipher_legacy_dispatch () {
1920 msg "build: full + legacy dispatch in block_cipher"
1921
1922 common_block_cipher_dispatch 0
1923
1924 make
1925
1926 msg "test: full + legacy dispatch in block_cipher"
1927 make test
1928}
1929
Minos Galanakisf78447f2024-07-26 20:49:51 +01001930component_test_aead_chachapoly_disabled () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001931 msg "build: full minus CHACHAPOLY"
1932 scripts/config.py full
Minos Galanakis471b34c2024-07-26 15:39:24 +01001933 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
1934 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1935
1936 msg "test: full minus CHACHAPOLY"
1937 make test
1938}
1939
Minos Galanakisf78447f2024-07-26 20:49:51 +01001940component_test_aead_only_ccm () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001941 msg "build: full minus CHACHAPOLY and GCM"
1942 scripts/config.py full
Minos Galanakis471b34c2024-07-26 15:39:24 +01001943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
1944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
1945 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1946
1947 msg "test: full minus CHACHAPOLY and GCM"
1948 make test
1949}
1950
Minos Galanakisf78447f2024-07-26 20:49:51 +01001951component_test_ccm_aes_sha256 () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001952 msg "build: CCM + AES + SHA256 configuration"
1953
Minos Galanakisa17ffc72024-12-02 23:57:30 +00001954 # Setting a blank config disables everyhing in the library side.
1955 echo '#define MBEDTLS_CONFIG_H ' >"$CONFIG_H"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001956 cp tf-psa-crypto/configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Cron9d262d72024-12-06 17:41:26 +01001957
Minos Galanakis471b34c2024-07-26 15:39:24 +01001958 make
Minos Galanakis471b34c2024-07-26 15:39:24 +01001959 msg "test: CCM + AES + SHA256 configuration"
1960 make test
1961}
1962
1963# Test that the given .o file builds with all (valid) combinations of the given options.
1964#
1965# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
1966#
1967# The validator function is the name of a function to validate the combination of options.
1968# It may be "" if all combinations are valid.
1969# It receives a string containing a combination of options, as passed to the compiler,
1970# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001971build_test_config_combos () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001972 file=$1
1973 shift
1974 validate_options=$1
1975 shift
1976 options=("$@")
1977
1978 # clear all of the options so that they can be overridden on the clang commandline
1979 for opt in "${options[@]}"; do
1980 ./scripts/config.py unset ${opt}
1981 done
1982
1983 # enter the library directory
1984 cd library
1985
1986 # The most common issue is unused variables/functions, so ensure -Wunused is set.
1987 warning_flags="-Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wasm-operand-widths -Wunused"
1988
1989 # Extract the command generated by the Makefile to build the target file.
1990 # This ensures that we have any include paths, macro definitions, etc
1991 # that may be applied by make.
1992 # Add -fsyntax-only as we only want a syntax check and don't need to generate a file.
1993 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
1994
1995 makefile=$(TMPDIR=. mktemp)
1996 deps=""
1997
1998 len=${#options[@]}
1999 source_file=../${file%.o}.c
2000
2001 targets=0
2002 echo 'include Makefile' >${makefile}
2003
2004 for ((i = 0; i < $((2**${len})); i++)); do
2005 # generate each of 2^n combinations of options
2006 # each bit of $i is used to determine if options[i] will be set or not
2007 target="t"
2008 clang_args=""
2009 for ((j = 0; j < ${len}; j++)); do
2010 if (((i >> j) & 1)); then
2011 opt=-D${options[$j]}
2012 clang_args="${clang_args} ${opt}"
2013 target="${target}${opt}"
2014 fi
2015 done
2016
2017 # if combination is not known to be invalid, add it to the makefile
2018 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
2019 cmd="${compile_cmd} ${clang_args}"
2020 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
2021
2022 deps="${deps} ${target}"
2023 ((++targets))
2024 fi
2025 done
2026
2027 echo "build_test_config_combos: ${deps}" >> ${makefile}
2028
2029 # execute all of the commands via Make (probably in parallel)
2030 make -s -f ${makefile} build_test_config_combos
2031 echo "$targets targets checked"
2032
2033 # clean up the temporary makefile
2034 rm ${makefile}
2035}
2036
Minos Galanakisf78447f2024-07-26 20:49:51 +01002037validate_aes_config_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002038 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
2039 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
2040 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
2041 return 1
2042 fi
2043 fi
2044 return 0
2045}
2046
Minos Galanakisf78447f2024-07-26 20:49:51 +01002047component_build_aes_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002048 # 18s - around 90ms per clang invocation on M1 Pro
2049 #
2050 # aes.o has many #if defined(...) guards that intersect in complex ways.
2051 # Test that all the combinations build cleanly.
2052
2053 MBEDTLS_ROOT_DIR="$PWD"
2054 msg "build: aes.o for all combinations of relevant config options"
2055
2056 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Thomas Daubney6cf05f92024-07-18 11:30:22 +01002057 "MBEDTLS_AES_ROM_TABLES" \
Minos Galanakis471b34c2024-07-26 15:39:24 +01002058 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
2059 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
2060
2061 cd "$MBEDTLS_ROOT_DIR"
2062 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
2063
Ari Weiler-Ofek86422e52025-07-04 14:43:30 +01002064 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW,
Minos Galanakis471b34c2024-07-26 15:39:24 +01002065 # manually set or unset those configurations to check
2066 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
2067 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Minos Galanakis471b34c2024-07-26 15:39:24 +01002068 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron54d1eec2024-09-06 09:55:38 +02002069
Minos Galanakis00b641c2024-11-28 23:05:10 +00002070 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
2071 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
2072 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
2073 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Ronald Cron54d1eec2024-09-06 09:55:38 +02002074
Minos Galanakis471b34c2024-07-26 15:39:24 +01002075 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Thomas Daubney6cf05f92024-07-18 11:30:22 +01002076 "MBEDTLS_AES_ROM_TABLES" \
Minos Galanakis471b34c2024-07-26 15:39:24 +01002077 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
2078 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
2079}
2080
Minos Galanakisf78447f2024-07-26 20:49:51 +01002081component_test_sha3_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002082 msg "sha3 loop unroll variations"
2083
2084 # define minimal config sufficient to test SHA3
Ronald Crone7f289e2024-09-06 11:02:47 +02002085 cat > include/mbedtls/mbedtls_config.h << END
Ronald Crone7f289e2024-09-06 11:02:47 +02002086END
2087
2088 cat > tf-psa-crypto/include/psa/crypto_config.h << END
2089 #define PSA_WANT_ALG_SHA_256 1
2090 #define PSA_WANT_ALG_SHA3_224 1
2091 #define PSA_WANT_ALG_SHA3_256 1
2092 #define PSA_WANT_ALG_SHA3_384 1
2093 #define PSA_WANT_ALG_SHA3_512 1
Ronald Cron06680362025-07-21 15:21:22 +02002094 #define PSA_WANT_KEY_TYPE_AES 1
Ronald Cron3dd1d3d2024-12-05 15:12:06 +01002095 #define MBEDTLS_CTR_DRBG_C
2096 #define MBEDTLS_ENTROPY_C
2097 #define MBEDTLS_PSA_CRYPTO_C
2098 #define MBEDTLS_SELF_TEST
Minos Galanakis471b34c2024-07-26 15:39:24 +01002099END
2100
2101 msg "all loops unrolled"
2102 make clean
2103 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"
2104 ./tf-psa-crypto/tests/test_suite_shax
2105
2106 msg "all loops rolled up"
2107 make clean
2108 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"
2109 ./tf-psa-crypto/tests/test_suite_shax
2110}
2111
Minos Galanakisf699d512024-08-01 11:32:30 +01002112support_build_aes_aesce_armcc () {
2113 support_build_armcc
2114}
2115
Minos Galanakis471b34c2024-07-26 15:39:24 +01002116# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
2117component_build_aes_aesce_armcc () {
2118 msg "Build: AESCE test on arm64 platform without plain C."
2119 scripts/config.py baremetal
2120
2121 # armc[56] don't support SHA-512 intrinsics
2122 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2123
2124 # Stop armclang warning about feature detection for A64_CRYPTO.
2125 # With this enabled, the library does build correctly under armclang,
2126 # but in baremetal builds (as tested here), feature detection is
2127 # unavailable, and the user is notified via a #warning. So enabling
2128 # this feature would prevent us from building with -Werror on
2129 # armclang. Tracked in #7198.
2130 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2131 scripts/config.py set MBEDTLS_HAVE_ASM
2132
2133 msg "AESCE, build with default configuration."
2134 scripts/config.py set MBEDTLS_AESCE_C
2135 scripts/config.py unset 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 msg "AESCE, build AESCE only"
2139 scripts/config.py set MBEDTLS_AESCE_C
2140 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002141 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002142}
2143
Minos Galanakis471b34c2024-07-26 15:39:24 +01002144component_test_aes_only_128_bit_keys () {
2145 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
2146 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
2147
2148 make CFLAGS='-O2 -Werror -Wall -Wextra'
2149
2150 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
2151 make test
2152}
2153
2154component_test_no_ctr_drbg_aes_only_128_bit_keys () {
2155 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
2156 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
2157 scripts/config.py unset MBEDTLS_CTR_DRBG_C
2158
2159 make CC=clang CFLAGS='-Werror -Wall -Wextra'
2160
2161 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
2162 make test
2163}
2164
2165component_test_aes_only_128_bit_keys_have_builtins () {
2166 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2167 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
2168 scripts/config.py unset MBEDTLS_AESNI_C
2169 scripts/config.py unset MBEDTLS_AESCE_C
2170
2171 make CFLAGS='-O2 -Werror -Wall -Wextra'
2172
2173 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2174 make test
2175
2176 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2177 programs/test/selftest
2178}
2179
2180component_test_gcm_largetable () {
2181 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
2182 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
2183 scripts/config.py unset MBEDTLS_AESNI_C
2184 scripts/config.py unset MBEDTLS_AESCE_C
2185
2186 make CFLAGS='-O2 -Werror -Wall -Wextra'
2187
2188 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
2189 make test
2190}
2191
2192component_test_aes_fewer_tables () {
2193 msg "build: default config with AES_FEWER_TABLES enabled"
2194 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
2195 make CFLAGS='-O2 -Werror -Wall -Wextra'
2196
2197 msg "test: AES_FEWER_TABLES"
2198 make test
2199}
2200
2201component_test_aes_rom_tables () {
2202 msg "build: default config with AES_ROM_TABLES enabled"
2203 scripts/config.py set MBEDTLS_AES_ROM_TABLES
2204 make CFLAGS='-O2 -Werror -Wall -Wextra'
2205
2206 msg "test: AES_ROM_TABLES"
2207 make test
2208}
2209
2210component_test_aes_fewer_tables_and_rom_tables () {
2211 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
2212 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
2213 scripts/config.py set MBEDTLS_AES_ROM_TABLES
2214 make CFLAGS='-O2 -Werror -Wall -Wextra'
2215
2216 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
2217 make test
2218}
2219
Ronald Cron66040472024-09-06 10:14:38 +02002220# helper for component_test_block_cipher_no_decrypt_aesni() which:
Minos Galanakis471b34c2024-07-26 15:39:24 +01002221# - enable/disable the list of config options passed from -s/-u respectively.
2222# - build
2223# - test for tests_suite_xxx
2224# - selftest
2225#
2226# Usage: helper_block_cipher_no_decrypt_build_test
2227# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
2228# Options: -s set_opts the list of config options to enable
2229# -u unset_opts the list of config options to disable
2230# -c cflags the list of options passed to CFLAGS
2231# -l ldflags the list of options passed to LDFLAGS
Minos Galanakis471b34c2024-07-26 15:39:24 +01002232helper_block_cipher_no_decrypt_build_test () {
2233 while [ $# -gt 0 ]; do
2234 case "$1" in
2235 -s)
2236 shift; local set_opts="$1";;
2237 -u)
2238 shift; local unset_opts="$1";;
2239 -c)
2240 shift; local cflags="-Werror -Wall -Wextra $1";;
2241 -l)
2242 shift; local ldflags="$1";;
2243 esac
2244 shift
2245 done
2246 set_opts="${set_opts:-}"
2247 unset_opts="${unset_opts:-}"
2248 cflags="${cflags:-}"
2249 ldflags="${ldflags:-}"
2250
2251 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
2252 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
2253
2254 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2255 make clean
2256 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
2257
2258 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
2259 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
2260 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
2261 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
2262 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
2263 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
2264 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
2265 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
2266
2267 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2268 make test
2269
2270 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2271 programs/test/selftest
2272}
2273
Ronald Cron66040472024-09-06 10:14:38 +02002274# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
2275config_block_cipher_no_decrypt () {
2276 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Ronald Cron66040472024-09-06 10:14:38 +02002277 scripts/config.py unset MBEDTLS_NIST_KW_C
2278
2279 # Enable support for cryptographic mechanisms through the PSA API.
2280 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
Ronald Cron66040472024-09-06 10:14:38 +02002281 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
2282 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
2283 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
2284 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
Ronald Cron66040472024-09-06 10:14:38 +02002285}
2286
2287component_test_block_cipher_no_decrypt_aesni () {
2288 # Test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics, AESNI assembly and
2289 # AES C implementation on x86_64 and with AESNI intrinsics on x86.
2290
2291 # This consistently causes an llvm crash on clang 3.8, so use gcc
2292 export CC=gcc
2293 config_block_cipher_no_decrypt
2294
Minos Galanakis471b34c2024-07-26 15:39:24 +01002295 # test AESNI intrinsics
2296 helper_block_cipher_no_decrypt_build_test \
2297 -s "MBEDTLS_AESNI_C" \
2298 -c "-mpclmul -msse2 -maes"
2299
2300 # test AESNI assembly
2301 helper_block_cipher_no_decrypt_build_test \
2302 -s "MBEDTLS_AESNI_C" \
2303 -c "-mno-pclmul -mno-sse2 -mno-aes"
2304
2305 # test AES C implementation
2306 helper_block_cipher_no_decrypt_build_test \
2307 -u "MBEDTLS_AESNI_C"
2308
2309 # test AESNI intrinsics for i386 target
2310 helper_block_cipher_no_decrypt_build_test \
2311 -s "MBEDTLS_AESNI_C" \
2312 -c "-m32 -mpclmul -msse2 -maes" \
2313 -l "-m32"
2314}
2315
Minos Galanakisf699d512024-08-01 11:32:30 +01002316support_test_block_cipher_no_decrypt_aesce_armcc () {
2317 support_build_armcc
2318}
2319
Minos Galanakis471b34c2024-07-26 15:39:24 +01002320component_test_block_cipher_no_decrypt_aesce_armcc () {
2321 scripts/config.py baremetal
2322
2323 # armc[56] don't support SHA-512 intrinsics
2324 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2325
2326 # Stop armclang warning about feature detection for A64_CRYPTO.
2327 # With this enabled, the library does build correctly under armclang,
2328 # but in baremetal builds (as tested here), feature detection is
2329 # unavailable, and the user is notified via a #warning. So enabling
2330 # this feature would prevent us from building with -Werror on
2331 # armclang. Tracked in #7198.
2332 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2333 scripts/config.py set MBEDTLS_HAVE_ASM
2334
Ronald Cron66040472024-09-06 10:14:38 +02002335 config_block_cipher_no_decrypt
Minos Galanakis471b34c2024-07-26 15:39:24 +01002336
2337 # test AESCE baremetal build
2338 scripts/config.py set MBEDTLS_AESCE_C
2339 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002340 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002341
2342 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
2343 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
2344 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
2345 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
2346 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
2347 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
2348 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
2349 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
2350 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
2351}
2352
2353component_test_ctr_drbg_aes_256_sha_256 () {
2354 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2355 scripts/config.py full
2356 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2357 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
2358 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2359 make
2360
2361 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2362 make test
2363}
2364
2365component_test_ctr_drbg_aes_128_sha_512 () {
2366 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
2367 scripts/config.py full
2368 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2369 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
2370 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2371 make
2372
2373 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
2374 make test
2375}
2376
2377component_test_ctr_drbg_aes_128_sha_256 () {
2378 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2379 scripts/config.py full
2380 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2381 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
2382 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
2383 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2384 make
2385
2386 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2387 make test
2388}
2389
Gilles Peskinea9dda7e2024-06-21 11:25:01 +02002390component_test_full_static_keystore () {
2391 msg "build: full config - MBEDTLS_PSA_KEY_STORE_DYNAMIC"
2392 scripts/config.py full
2393 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
2394 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
2395
2396 msg "test: full config - MBEDTLS_PSA_KEY_STORE_DYNAMIC"
2397 make test
2398}
2399
Minos Galanakis471b34c2024-07-26 15:39:24 +01002400component_test_psa_crypto_drivers () {
Ronald Crona0afbfb2024-10-15 13:20:31 +02002401 # Test dispatch to drivers and fallbacks with
2402 # test_suite_psa_crypto_driver_wrappers test suite. The test drivers that
2403 # are wrappers around the builtin drivers are activated by
2404 # PSA_CRYPTO_DRIVER_TEST.
2405 #
2406 # For the time being, some test cases in test_suite_block_cipher and
2407 # test_suite_md.psa rely on this component to be run at least once by the
2408 # CI. This should disappear as we progress the 4.x work. See
2409 # config_adjust_test_accelerators.h for more information.
Minos Galanakis471b34c2024-07-26 15:39:24 +01002410 msg "build: full + test drivers dispatching to builtins"
2411 scripts/config.py full
Ronald Cron67cc6a72024-10-14 10:55:24 +02002412 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_CONFIG_ADJUST_TEST_ACCELERATORS"
David Horstmann5b93d972024-10-31 15:36:05 +00002413 loc_cflags="${loc_cflags} -I../framework/tests/include"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002414
2415 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
2416
2417 msg "test: full + test drivers dispatching to builtins"
2418 make test
2419}
2420
2421component_build_psa_config_file () {
Minos Galanakis4f619e12024-11-14 14:56:47 +00002422 msg "build: make with TF_PSA_CRYPTO_CONFIG_FILE" # ~40s
Minos Galanakis471b34c2024-07-26 15:39:24 +01002423 cp "$CRYPTO_CONFIG_H" psa_test_config.h
Minos Galanakis4f619e12024-11-14 14:56:47 +00002424 echo '#error "TF_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
2425 make CFLAGS="-I '$PWD' -DTF_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002426 # Make sure this feature is enabled. We'll disable it in the next phase.
Ronald Cron3f120062025-07-03 14:45:51 +02002427 programs/test/query_compile_time_config PSA_WANT_ALG_CMAC
Minos Galanakis471b34c2024-07-26 15:39:24 +01002428 make clean
2429
Minos Galanakis4f619e12024-11-14 14:56:47 +00002430 msg "build: make with TF_PSA_CRYPTO_CONFIG_FILE + TF_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Minos Galanakis471b34c2024-07-26 15:39:24 +01002431 # In the user config, disable one feature and its dependencies, which will
2432 # reflect on the mbedtls configuration so we can query it with
2433 # query_compile_time_config.
2434 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
2435 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Minos Galanakis4f619e12024-11-14 14:56:47 +00002436 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 +02002437 not programs/test/query_compile_time_config PSA_WANT_ALG_CMAC
Minos Galanakis471b34c2024-07-26 15:39:24 +01002438
2439 rm -f psa_test_config.h psa_user_config.h
2440}
2441
2442component_build_psa_alt_headers () {
2443 msg "build: make with PSA alt headers" # ~20s
2444
2445 # Generate alternative versions of the substitutable headers with the
2446 # same content except different include guards.
David Horstmanndc459512024-11-07 17:08:11 +00002447 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 +01002448
2449 # Build the library and some programs.
2450 # Don't build the fuzzers to avoid having to go through hoops to set
2451 # a correct include path for programs/fuzz/Makefile.
David Horstmann5b93d972024-10-31 15:36:05 +00002452 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
2453 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 +01002454
2455 # Check that we're getting the alternative include guards and not the
2456 # original include guards.
2457 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
2458 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
2459 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
2460 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
2461}
2462
2463component_test_min_mpi_window_size () {
2464 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
2465 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
2466 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2467 make
2468
2469 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
2470 make test
2471}
Ronald Cronf256f8a2025-07-10 17:37:18 +02002472
2473component_test_xts () {
2474 # Component dedicated to run XTS unit test cases while XTS is not
2475 # supported through the PSA API.
2476 msg "build: Default + MBEDTLS_CIPHER_MODE_XTS"
2477
2478 echo "#define MBEDTLS_CIPHER_MODE_XTS" > psa_user_config.h
2479 cmake -DTF_PSA_CRYPTO_USER_CONFIG_FILE="psa_user_config.h"
2480 make
2481
Ronald Crone0b06eb2025-07-15 08:58:32 +02002482 rm -f psa_user_config.h
2483
Ronald Cronf256f8a2025-07-10 17:37:18 +02002484 msg "test: Default + MBEDTLS_CIPHER_MODE_XTS"
2485 make test
Ronald Cronf256f8a2025-07-10 17:37:18 +02002486}