blob: c78e53244da96a65e8276cd92c7d12b3b36a7cda [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
Ben Taylor39a68bf2025-07-15 13:34:55 +010019 msg "test: full config - PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Minos Galanakis471b34c2024-07-26 15:39:24 +010020 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
Ben Taylor39a68bf2025-07-15 13:34:55 +0100191 msg "test: Full minus CTR_DRBG- main suites"
Minos Galanakisc06fd302024-08-01 12:16:59 +0100192 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.
Ben Taylor39a68bf2025-07-15 13:34:55 +0100197 msg "test: Full minus CTR_DRBG - ssl-opt.sh (subset)"
Minos Galanakisc06fd302024-08-01 12:16:59 +0100198 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
199
Ben Taylor39a68bf2025-07-15 13:34:55 +0100200 msg "test: Full minus CTR_DRBG - compat.sh (subset)"
Minos Galanakisc06fd302024-08-01 12:16:59 +0100201 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
Ben Taylor39a68bf2025-07-15 13:34:55 +0100213 msg "test: Full minus HMAC_DRBG - main suites"
Minos Galanakisc06fd302024-08-01 12:16:59 +0100214 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.
Ben Taylor39a68bf2025-07-15 13:34:55 +0100221 msg "test: Full minus HMAC_DRBG - ssl-opt.sh (subset)"
Minos Galanakisc06fd302024-08-01 12:16:59 +0100222 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.
Ben Taylor39a68bf2025-07-15 13:34:55 +0100226 msg "test: Full minus HMAC_DRBG - compat.sh (ECDSA)"
Minos Galanakisc06fd302024-08-01 12:16:59 +0100227 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 () {
Ben Taylor39a68bf2025-07-15 13:34:55 +0100250 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG minus CTR_DRBG"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100251 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
Ben Taylor39a68bf2025-07-15 13:34:55 +0100256 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG minus CTR_DRBG"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100257 make test
258
Ben Taylor39a68bf2025-07-15 13:34:55 +0100259 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG minus CTR_DRBG"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100260 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:
Minos Galanakis471b34c2024-07-26 15:39:24 +0100345 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
346 scripts/config.py full
347
348 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
349 # enabled, but not used from TLS since USE_PSA is set.
350 # This is helpful to ensure that TLS tests below have proper dependencies.
351 #
352 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
353 # PSA_WANT_ALG_CCM to be re-enabled.
354 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
355
356 make
357
358 msg "test: full no PSA_WANT_ALG_CCM"
359 make test
360}
361
Minos Galanakisf78447f2024-07-26 20:49:51 +0100362component_test_full_no_ccm_star_no_tag () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100363 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
364
365 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
366 scripts/config.py full
367
368 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
369 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
370 # This basically disables all unauthenticated ciphers on the PSA side, while
371 # keeping AEADs enabled.
372 #
373 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
374 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
375 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
376 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
377 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
378 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
379 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
380 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
Ben Taylor1948c942025-03-04 09:11:11 +0000381 # NOTE unsettting PSA_WANT_ALG_ECB_NO_PADDING without unsetting NIST_KW_C will
382 # mean PSA_WANT_ALG_ECB_NO_PADDING is re-enabled, so disabling it also.
383 scripts/config.py -f "$CRYPTO_CONFIG_H" unset MBEDTLS_NIST_KW_C
Minos Galanakis471b34c2024-07-26 15:39:24 +0100384 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
385 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
386
387 make
388
389 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
390 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
391
392 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
393 make test
394}
395
Gilles Peskineea5de2b2024-09-19 18:41:55 +0200396component_test_config_symmetric_only () {
397 msg "build: configs/config-symmetric-only.h"
Minos Galanakis5da58e52024-11-07 15:35:33 +0000398 MBEDTLS_CONFIG="configs/config-symmetric-only.h"
Harry Ramsey94c386a2025-01-16 16:08:34 +0000399 CRYPTO_CONFIG="tf-psa-crypto/configs/crypto-config-symmetric-only.h"
Ronald Cronfaadfc22024-12-07 17:24:28 +0100400 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 +0200401 make
402
Gilles Peskineea5de2b2024-09-19 18:41:55 +0200403 msg "test: configs/config-symmetric-only.h - unit tests"
Gilles Peskineaf5a8992024-09-14 11:27:44 +0200404 make test
405}
406
Minos Galanakisc06fd302024-08-01 12:16:59 +0100407component_test_everest () {
408 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
409 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
410 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
411 make
412
413 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
414 make test
415
416 msg "test: metatests (clang, ASan)"
417 tests/scripts/run-metatests.sh any asan poison
418
419 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
420 tests/ssl-opt.sh -f ECDH
421
422 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
423 # Exclude some symmetric ciphers that are redundant here to gain time.
424 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
425}
426
427component_test_everest_curve25519_only () {
428 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Minos Galanakisc06fd302024-08-01 12:16:59 +0100429 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
430 scripts/config.py unset MBEDTLS_ECDSA_C
Minos Galanakis00b641c2024-11-28 23:05:10 +0000431 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
432 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
433 scripts/config.py -c $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Minos Galanakisc06fd302024-08-01 12:16:59 +0100434 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
435 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
436 scripts/config.py unset MBEDTLS_ECJPAKE_C
Minos Galanakis00b641c2024-11-28 23:05:10 +0000437 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
Minos Galanakisc06fd302024-08-01 12:16:59 +0100438
439 # Disable all curves
440 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Minos Galanakis00b641c2024-11-28 23:05:10 +0000441 scripts/config.py -c $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
442 scripts/config.py -c $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Minos Galanakisc06fd302024-08-01 12:16:59 +0100443
444 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
445
446 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
447 make test
448}
449
Minos Galanakis471b34c2024-07-26 15:39:24 +0100450component_test_psa_collect_statuses () {
451 msg "build+test: psa_collect_statuses" # ~30s
452 scripts/config.py full
453 tests/scripts/psa_collect_statuses.py
454 # Check that psa_crypto_init() succeeded at least once
455 grep -q '^0:psa_crypto_init:' tests/statuses.log
456 rm -f tests/statuses.log
457}
458
459# Check that the specified libraries exist and are empty.
460are_empty_libraries () {
461 nm "$@" >/dev/null 2>/dev/null
462 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
463}
464
Minos Galanakis471b34c2024-07-26 15:39:24 +0100465component_test_crypto_for_psa_service () {
466 msg "build: make, config for PSA crypto service"
467 scripts/config.py crypto
468 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
469 # Disable things that are not needed for just cryptography, to
470 # reach a configuration that would be typical for a PSA cryptography
471 # service providing all implemented PSA algorithms.
472 # System stuff
473 scripts/config.py unset MBEDTLS_ERROR_C
474 scripts/config.py unset MBEDTLS_TIMING_C
475 scripts/config.py unset MBEDTLS_VERSION_FEATURES
476 # Crypto stuff with no PSA interface
477 scripts/config.py unset MBEDTLS_BASE64_C
Minos Galanakis471b34c2024-07-26 15:39:24 +0100478 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
479 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
480 scripts/config.py unset MBEDTLS_NIST_KW_C
481 scripts/config.py unset MBEDTLS_PEM_PARSE_C
482 scripts/config.py unset MBEDTLS_PEM_WRITE_C
483 scripts/config.py unset MBEDTLS_PKCS12_C
484 scripts/config.py unset MBEDTLS_PKCS5_C
485 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
486 # in PSA code to work with RSA keys. We don't require users to set those:
487 # they will be reenabled in build_info.h.
488 scripts/config.py unset MBEDTLS_PK_C
489 scripts/config.py unset MBEDTLS_PK_PARSE_C
490 scripts/config.py unset MBEDTLS_PK_WRITE_C
491 make CFLAGS='-O1 -Werror' all test
492 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
493}
494
495component_build_crypto_baremetal () {
496 msg "build: make, crypto only, baremetal config"
497 scripts/config.py crypto_baremetal
David Horstmann5b93d972024-10-31 15:36:05 +0000498 make CFLAGS="-O1 -Werror -I$PWD/framework/tests/include/baremetal-override/"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100499 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
500}
501
502support_build_crypto_baremetal () {
503 support_build_baremetal "$@"
504}
505
506# depends.py family of tests
507component_test_depends_py_cipher_id () {
508 msg "test/build: depends.py cipher_id (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200509 tests/scripts/depends.py cipher_id
Minos Galanakis471b34c2024-07-26 15:39:24 +0100510}
511
512component_test_depends_py_cipher_chaining () {
513 msg "test/build: depends.py cipher_chaining (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200514 tests/scripts/depends.py cipher_chaining
Minos Galanakis471b34c2024-07-26 15:39:24 +0100515}
516
Minos Galanakis471b34c2024-07-26 15:39:24 +0100517component_test_depends_py_curves () {
518 msg "test/build: depends.py curves (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200519 tests/scripts/depends.py curves
Minos Galanakis471b34c2024-07-26 15:39:24 +0100520}
521
522component_test_depends_py_hashes () {
523 msg "test/build: depends.py hashes (gcc)"
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200524 tests/scripts/depends.py hashes
Minos Galanakis471b34c2024-07-26 15:39:24 +0100525}
526
Minos Galanakis471b34c2024-07-26 15:39:24 +0100527component_test_depends_py_pkalgs () {
528 msg "test/build: depends.py pkalgs (gcc)"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100529 tests/scripts/depends.py pkalgs
530}
531
532component_test_psa_crypto_config_ffdh_2048_only () {
533 msg "build: full config - only DH 2048"
534
535 scripts/config.py full
536
537 # Disable all DH groups other than 2048.
538 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
539 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
540 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
541 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
542
543 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
544
545 msg "test: full config - only DH 2048"
546 make test
547
548 msg "ssl-opt: full config - only DH 2048"
549 tests/ssl-opt.sh -f "ffdh"
550}
551
Minos Galanakis471b34c2024-07-26 15:39:24 +0100552component_test_psa_crypto_config_accel_ecdsa () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200553 msg "build: accelerated ECDSA"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100554
555 # Algorithms and key types to accelerate
556 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
557 $(helper_get_psa_key_type_list "ECC") \
558 $(helper_get_psa_curve_list)"
559
560 # Configure
561 # ---------
562
Elena Uziunaite91d83862024-09-04 14:51:31 +0100563 # Start from default config + TLS 1.3
Minos Galanakis471b34c2024-07-26 15:39:24 +0100564 helper_libtestdriver1_adjust_config "default"
565
566 # Disable the module that's accelerated
567 scripts/config.py unset MBEDTLS_ECDSA_C
568
569 # Disable things that depend on it
570 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
571 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
572
573 # Build
574 # -----
575
576 # These hashes are needed for some ECDSA signature tests.
Elena Uziunaiteffce45c2024-09-12 14:58:52 +0100577 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 +0100578 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
579
580 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
581
582 helper_libtestdriver1_make_main "$loc_accel_list"
583
584 # Make sure this was not re-enabled by accident (additive config)
585 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
586
587 # Run the tests
588 # -------------
589
Ronald Cron93ba6252024-09-05 10:37:14 +0200590 msg "test: accelerated ECDSA"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100591 make test
592}
593
594component_test_psa_crypto_config_accel_ecdh () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200595 msg "build: accelerated ECDH"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100596
597 # Algorithms and key types to accelerate
598 loc_accel_list="ALG_ECDH \
599 $(helper_get_psa_key_type_list "ECC") \
600 $(helper_get_psa_curve_list)"
601
602 # Configure
603 # ---------
604
605 # Start from default config (no USE_PSA)
606 helper_libtestdriver1_adjust_config "default"
607
608 # Disable the module that's accelerated
609 scripts/config.py unset MBEDTLS_ECDH_C
610
611 # Disable things that depend on it
612 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
613 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
614 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
615 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
616 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
617
618 # Build
619 # -----
620
621 helper_libtestdriver1_make_drivers "$loc_accel_list"
622
623 helper_libtestdriver1_make_main "$loc_accel_list"
624
625 # Make sure this was not re-enabled by accident (additive config)
626 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
627
628 # Run the tests
629 # -------------
630
Ronald Cron93ba6252024-09-05 10:37:14 +0200631 msg "test: accelerated ECDH"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100632 make test
633}
634
635component_test_psa_crypto_config_accel_ffdh () {
636 msg "build: full with accelerated FFDH"
637
638 # Algorithms and key types to accelerate
639 loc_accel_list="ALG_FFDH \
640 $(helper_get_psa_key_type_list "DH") \
641 $(helper_get_psa_dh_group_list)"
642
643 # Configure
644 # ---------
645
646 # start with full (USE_PSA and TLS 1.3)
647 helper_libtestdriver1_adjust_config "full"
648
Minos Galanakis471b34c2024-07-26 15:39:24 +0100649 # Build
650 # -----
651
652 helper_libtestdriver1_make_drivers "$loc_accel_list"
653
654 helper_libtestdriver1_make_main "$loc_accel_list"
655
656 # Make sure this was not re-enabled by accident (additive config)
Valerio Settieb63eb22025-02-12 13:32:49 +0100657 not grep mbedtls_psa_ffdh_key_agreement ${BUILTIN_SRC_PATH}/psa_crypto_ffdh.o
Minos Galanakis471b34c2024-07-26 15:39:24 +0100658
659 # Run the tests
660 # -------------
661
662 msg "test: full with accelerated FFDH"
663 make test
664
665 msg "ssl-opt: full with accelerated FFDH alg"
666 tests/ssl-opt.sh -f "ffdh"
667}
668
669component_test_psa_crypto_config_reference_ffdh () {
670 msg "build: full with non-accelerated FFDH"
671
672 # Start with full (USE_PSA and TLS 1.3)
673 helper_libtestdriver1_adjust_config "full"
674
Minos Galanakis471b34c2024-07-26 15:39:24 +0100675 make
676
677 msg "test suites: full with non-accelerated FFDH alg"
678 make test
679
680 msg "ssl-opt: full with non-accelerated FFDH alg"
681 tests/ssl-opt.sh -f "ffdh"
682}
683
Minos Galanakisf78447f2024-07-26 20:49:51 +0100684component_test_psa_crypto_config_accel_pake () {
Minos Galanakis471b34c2024-07-26 15:39:24 +0100685 msg "build: full with accelerated PAKE"
686
687 loc_accel_list="ALG_JPAKE \
688 $(helper_get_psa_key_type_list "ECC") \
689 $(helper_get_psa_curve_list)"
690
691 # Configure
692 # ---------
693
694 helper_libtestdriver1_adjust_config "full"
695
696 # Make built-in fallback not available
697 scripts/config.py unset MBEDTLS_ECJPAKE_C
698 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
699
700 # Build
701 # -----
702
703 helper_libtestdriver1_make_drivers "$loc_accel_list"
704
705 helper_libtestdriver1_make_main "$loc_accel_list"
706
707 # Make sure this was not re-enabled by accident (additive config)
708 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
709
710 # Run the tests
711 # -------------
712
713 msg "test: full with accelerated PAKE"
714 make test
715}
716
717component_test_psa_crypto_config_accel_ecc_some_key_types () {
718 msg "build: full with accelerated EC algs and some key types"
719
720 # Algorithms and key types to accelerate
721 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
722 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
723 ALG_ECDH \
724 ALG_JPAKE \
725 KEY_TYPE_ECC_PUBLIC_KEY \
726 KEY_TYPE_ECC_KEY_PAIR_BASIC \
727 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
728 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
729 $(helper_get_psa_curve_list)"
730
731 # Configure
732 # ---------
733
734 # start with config full for maximum coverage (also enables USE_PSA)
735 helper_libtestdriver1_adjust_config "full"
736
737 # Disable modules that are accelerated - some will be re-enabled
738 scripts/config.py unset MBEDTLS_ECDSA_C
739 scripts/config.py unset MBEDTLS_ECDH_C
740 scripts/config.py unset MBEDTLS_ECJPAKE_C
741 scripts/config.py unset MBEDTLS_ECP_C
742
743 # Disable all curves - those that aren't accelerated should be re-enabled
744 helper_disable_builtin_curves
745
746 # Restartable feature is not yet supported by PSA. Once it will in
747 # the future, the following line could be removed (see issues
748 # 6061, 6332 and following ones)
749 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
750
751 # this is not supported by the driver API yet
752 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
753
754 # Build
755 # -----
756
757 # These hashes are needed for some ECDSA signature tests.
758 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
759 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
760 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
761
762 helper_libtestdriver1_make_main "$loc_accel_list"
763
764 # ECP should be re-enabled but not the others
765 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
766 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
767 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
768 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
769
770 # Run the tests
771 # -------------
772
773 msg "test suites: full with accelerated EC algs and some key types"
774 make test
775}
776
777# Run tests with only (non-)Weierstrass accelerated
778# Common code used in:
779# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
780# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Minos Galanakis471b34c2024-07-26 15:39:24 +0100781common_test_psa_crypto_config_accel_ecc_some_curves () {
782 weierstrass=$1
783 if [ $weierstrass -eq 1 ]; then
784 desc="Weierstrass"
785 else
786 desc="non-Weierstrass"
787 fi
788
789 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
790
791 # Note: Curves are handled in a special way by the libtestdriver machinery,
792 # so we only want to include them in the accel list when building the main
793 # libraries, hence the use of a separate variable.
794 # Note: the following loop is a modified version of
795 # helper_get_psa_curve_list that only keeps Weierstrass families.
796 loc_weierstrass_list=""
797 loc_non_weierstrass_list=""
798 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
799 case $item in
800 ECC_BRAINPOOL*|ECC_SECP*)
801 loc_weierstrass_list="$loc_weierstrass_list $item"
802 ;;
803 *)
804 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
805 ;;
806 esac
807 done
808 if [ $weierstrass -eq 1 ]; then
809 loc_curve_list=$loc_weierstrass_list
810 else
811 loc_curve_list=$loc_non_weierstrass_list
812 fi
813
814 # Algorithms and key types to accelerate
815 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
816 ALG_ECDH \
817 ALG_JPAKE \
818 $(helper_get_psa_key_type_list "ECC") \
819 $loc_curve_list"
820
821 # Configure
822 # ---------
823
824 # Start with config crypto_full and remove PK_C:
825 # that's what's supported now, see docs/driver-only-builds.md.
826 helper_libtestdriver1_adjust_config "crypto_full"
827 scripts/config.py unset MBEDTLS_PK_C
828 scripts/config.py unset MBEDTLS_PK_PARSE_C
829 scripts/config.py unset MBEDTLS_PK_WRITE_C
830
831 # Disable modules that are accelerated - some will be re-enabled
832 scripts/config.py unset MBEDTLS_ECDSA_C
833 scripts/config.py unset MBEDTLS_ECDH_C
834 scripts/config.py unset MBEDTLS_ECJPAKE_C
835 scripts/config.py unset MBEDTLS_ECP_C
836
837 # Disable all curves - those that aren't accelerated should be re-enabled
838 helper_disable_builtin_curves
839
840 # Restartable feature is not yet supported by PSA. Once it will in
841 # the future, the following line could be removed (see issues
842 # 6061, 6332 and following ones)
843 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
844
845 # this is not supported by the driver API yet
846 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
847
848 # Build
849 # -----
850
851 # These hashes are needed for some ECDSA signature tests.
852 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
853 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
854 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
855
856 helper_libtestdriver1_make_main "$loc_accel_list"
857
858 # We expect ECDH to be re-enabled for the missing curves
859 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
860 # We expect ECP to be re-enabled, however the parts specific to the
861 # families of curves that are accelerated should be ommited.
862 # - functions with mxz in the name are specific to Montgomery curves
863 # - ecp_muladd is specific to Weierstrass curves
864 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
865 if [ $weierstrass -eq 1 ]; then
866 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
867 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
868 else
869 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
870 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
871 fi
872 # We expect ECDSA and ECJPAKE to be re-enabled only when
873 # Weierstrass curves are not accelerated
874 if [ $weierstrass -eq 1 ]; then
875 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
876 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
877 else
878 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
879 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
880 fi
881
882 # Run the tests
883 # -------------
884
885 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
886 make test
887}
888
889component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
890 common_test_psa_crypto_config_accel_ecc_some_curves 1
891}
892
893component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
894 common_test_psa_crypto_config_accel_ecc_some_curves 0
895}
896
897# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
898# ECDH, ECDSA) with and without drivers.
899# The input parameter is a boolean value which indicates:
900# - 0 keep built-in EC algs,
901# - 1 exclude built-in EC algs (driver only).
902#
903# This is used by the two following components to ensure they always use the
904# same config, except for the use of driver or built-in EC algorithms:
905# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
906# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
907# This supports comparing their test coverage with analyze_outcomes.py.
Minos Galanakis471b34c2024-07-26 15:39:24 +0100908config_psa_crypto_config_ecp_light_only () {
909 driver_only="$1"
910 # start with config full for maximum coverage (also enables USE_PSA)
911 helper_libtestdriver1_adjust_config "full"
912 if [ "$driver_only" -eq 1 ]; then
913 # Disable modules that are accelerated
914 scripts/config.py unset MBEDTLS_ECDSA_C
915 scripts/config.py unset MBEDTLS_ECDH_C
916 scripts/config.py unset MBEDTLS_ECJPAKE_C
917 scripts/config.py unset MBEDTLS_ECP_C
918 fi
919
920 # Restartable feature is not yet supported by PSA. Once it will in
921 # the future, the following line could be removed (see issues
922 # 6061, 6332 and following ones)
923 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
924}
925
926# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
Minos Galanakis471b34c2024-07-26 15:39:24 +0100927component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
928 msg "build: full with accelerated EC algs"
929
930 # Algorithms and key types to accelerate
931 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
932 ALG_ECDH \
933 ALG_JPAKE \
934 $(helper_get_psa_key_type_list "ECC") \
935 $(helper_get_psa_curve_list)"
936
937 # Configure
938 # ---------
939
940 # Use the same config as reference, only without built-in EC algs
941 config_psa_crypto_config_ecp_light_only 1
942
943 # Do not disable builtin curves because that support is required for:
944 # - MBEDTLS_PK_PARSE_EC_EXTENDED
945 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
946
947 # Build
948 # -----
949
950 # These hashes are needed for some ECDSA signature tests.
951 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
952 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
953 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
954
955 helper_libtestdriver1_make_main "$loc_accel_list"
956
957 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
958 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
959 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
960 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
961 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
962
963 # Run the tests
964 # -------------
965
966 msg "test suites: full with accelerated EC algs"
967 make test
968
969 msg "ssl-opt: full with accelerated EC algs"
970 tests/ssl-opt.sh
971}
972
973# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
Minos Galanakis471b34c2024-07-26 15:39:24 +0100974component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Ronald Cron93ba6252024-09-05 10:37:14 +0200975 msg "build: non-accelerated EC algs"
Minos Galanakis471b34c2024-07-26 15:39:24 +0100976
977 config_psa_crypto_config_ecp_light_only 0
978
979 make
980
981 msg "test suites: full with non-accelerated EC algs"
982 make test
983
984 msg "ssl-opt: full with non-accelerated EC algs"
985 tests/ssl-opt.sh
986}
987
988# This helper function is used by:
989# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
990# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
991# to ensure that both tests use the same underlying configuration when testing
992# driver's coverage with analyze_outcomes.py.
993#
994# This functions accepts 1 boolean parameter as follows:
995# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
996# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
997# - 0: include built-in implementation of EC algorithms.
998#
999# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
1000# on the ECP module.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001001config_psa_crypto_no_ecp_at_all () {
1002 driver_only="$1"
1003 # start with full config for maximum coverage (also enables USE_PSA)
1004 helper_libtestdriver1_adjust_config "full"
1005
1006 if [ "$driver_only" -eq 1 ]; then
1007 # Disable modules that are accelerated
1008 scripts/config.py unset MBEDTLS_ECDSA_C
1009 scripts/config.py unset MBEDTLS_ECDH_C
1010 scripts/config.py unset MBEDTLS_ECJPAKE_C
1011 # Disable ECP module (entirely)
1012 scripts/config.py unset MBEDTLS_ECP_C
1013 fi
1014
1015 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
1016 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1017 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
1018 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
1019
1020 # Restartable feature is not yet supported by PSA. Once it will in
1021 # the future, the following line could be removed (see issues
1022 # 6061, 6332 and following ones)
1023 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
1024}
1025
1026# Build and test a configuration where driver accelerates all EC algs while
1027# all support and dependencies from ECP and ECP_LIGHT are removed on the library
1028# side.
1029#
1030# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Minos Galanakis471b34c2024-07-26 15:39:24 +01001031component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
1032 msg "build: full + accelerated EC algs - ECP"
1033
1034 # Algorithms and key types to accelerate
1035 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
1036 ALG_ECDH \
1037 ALG_JPAKE \
1038 $(helper_get_psa_key_type_list "ECC") \
1039 $(helper_get_psa_curve_list)"
1040
1041 # Configure
1042 # ---------
1043
1044 # Set common configurations between library's and driver's builds
1045 config_psa_crypto_no_ecp_at_all 1
1046 # Disable all the builtin curves. All the required algs are accelerated.
1047 helper_disable_builtin_curves
1048
1049 # Build
1050 # -----
1051
1052 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
1053 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
1054 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1055 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1056
1057 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1058
1059 helper_libtestdriver1_make_main "$loc_accel_list"
1060
1061 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1062 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1063 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1064 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
1065 # Also ensure that ECP module was not re-enabled
1066 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1067
1068 # Run the tests
1069 # -------------
1070
1071 msg "test: full + accelerated EC algs - ECP"
1072 make test
1073
1074 msg "ssl-opt: full + accelerated EC algs - ECP"
1075 tests/ssl-opt.sh
1076}
1077
1078# Reference function used for driver's coverage analysis in analyze_outcomes.py
1079# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
1080# Keep in sync with its accelerated counterpart.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001081component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
1082 msg "build: full + non accelerated EC algs"
1083
1084 config_psa_crypto_no_ecp_at_all 0
1085
1086 make
1087
1088 msg "test: full + non accelerated EC algs"
1089 make test
1090
1091 msg "ssl-opt: full + non accelerated EC algs"
1092 tests/ssl-opt.sh
1093}
1094
1095# This is a common configuration helper used directly from:
1096# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1097# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1098# and indirectly from:
1099# - component_test_psa_crypto_config_accel_ecc_no_bignum
1100# - accelerate all EC algs, disable RSA and FFDH
1101# - component_test_psa_crypto_config_reference_ecc_no_bignum
1102# - this is the reference component of the above
1103# - it still disables RSA and FFDH, but it uses builtin EC algs
1104# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1105# - accelerate all EC and FFDH algs, disable only RSA
1106# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1107# - this is the reference component of the above
1108# - it still disables RSA, but it uses builtin EC and FFDH algs
1109#
1110# This function accepts 2 parameters:
1111# $1: a boolean value which states if we are testing an accelerated scenario
1112# or not.
1113# $2: a string value which states which components are tested. Allowed values
1114# are "ECC" or "ECC_DH".
Minos Galanakisf78447f2024-07-26 20:49:51 +01001115config_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001116 driver_only="$1"
1117 test_target="$2"
1118 # start with full config for maximum coverage (also enables USE_PSA)
1119 helper_libtestdriver1_adjust_config "full"
1120
1121 if [ "$driver_only" -eq 1 ]; then
1122 # Disable modules that are accelerated
1123 scripts/config.py unset MBEDTLS_ECDSA_C
1124 scripts/config.py unset MBEDTLS_ECDH_C
1125 scripts/config.py unset MBEDTLS_ECJPAKE_C
1126 # Disable ECP module (entirely)
1127 scripts/config.py unset MBEDTLS_ECP_C
1128 # Also disable bignum
1129 scripts/config.py unset MBEDTLS_BIGNUM_C
1130 fi
1131
1132 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
1133 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1134 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
1135 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
1136
1137 # RSA support is intentionally disabled on this test because RSA_C depends
1138 # on BIGNUM_C.
1139 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
1140 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 +01001141 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1142 # Also disable key exchanges that depend on RSA
Minos Galanakis471b34c2024-07-26 15:39:24 +01001143 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1144 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1145
1146 if [ "$test_target" = "ECC" ]; then
1147 # When testing ECC only, we disable FFDH support, both from builtin and
Valerio Setti8438c632025-01-22 11:56:40 +01001148 # PSA sides.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001149 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
1150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
1151 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001152 fi
1153
1154 # Restartable feature is not yet supported by PSA. Once it will in
1155 # the future, the following line could be removed (see issues
1156 # 6061, 6332 and following ones)
1157 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
1158}
1159
1160# Common helper used by:
1161# - component_test_psa_crypto_config_accel_ecc_no_bignum
1162# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
1163#
1164# The goal is to build and test accelerating either:
1165# - ECC only or
1166# - both ECC and FFDH
1167#
1168# It is meant to be used in conjunction with
1169# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
1170# coverage analysis in the "analyze_outcomes.py" script.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001171common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
1172 test_target="$1"
1173
1174 # This is an internal helper to simplify text message handling
1175 if [ "$test_target" = "ECC_DH" ]; then
1176 accel_text="ECC/FFDH"
1177 removed_text="ECP - DH"
1178 else
1179 accel_text="ECC"
1180 removed_text="ECP"
1181 fi
1182
1183 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
1184
1185 # By default we accelerate all EC keys/algs
1186 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
1187 ALG_ECDH \
1188 ALG_JPAKE \
1189 $(helper_get_psa_key_type_list "ECC") \
1190 $(helper_get_psa_curve_list)"
1191 # Optionally we can also add DH to the list of accelerated items
1192 if [ "$test_target" = "ECC_DH" ]; then
1193 loc_accel_list="$loc_accel_list \
1194 ALG_FFDH \
1195 $(helper_get_psa_key_type_list "DH") \
1196 $(helper_get_psa_dh_group_list)"
1197 fi
1198
1199 # Configure
1200 # ---------
1201
1202 # Set common configurations between library's and driver's builds
1203 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
1204 # Disable all the builtin curves. All the required algs are accelerated.
1205 helper_disable_builtin_curves
1206
1207 # Build
1208 # -----
1209
1210 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
1211 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
1212 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1213 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1214
1215 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1216
1217 helper_libtestdriver1_make_main "$loc_accel_list"
1218
1219 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1220 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1221 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1222 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settieb63eb22025-02-12 13:32:49 +01001223 # Also ensure that ECP, RSA or BIGNUM modules were not re-enabled
Minos Galanakis471b34c2024-07-26 15:39:24 +01001224 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1225 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
1226 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001227
1228 # Run the tests
1229 # -------------
1230
Valerio Settieb63eb22025-02-12 13:32:49 +01001231 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001232
1233 make test
1234
1235 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
1236 tests/ssl-opt.sh
1237}
1238
1239# Common helper used by:
1240# - component_test_psa_crypto_config_reference_ecc_no_bignum
1241# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
1242#
1243# The goal is to build and test a reference scenario (i.e. with builtin
1244# components) compared to the ones used in
1245# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
1246#
1247# It is meant to be used in conjunction with
1248# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
1249# coverage analysis in "analyze_outcomes.py" script.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001250common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
1251 test_target="$1"
1252
1253 # This is an internal helper to simplify text message handling
1254 if [ "$test_target" = "ECC_DH" ]; then
1255 accel_text="ECC/FFDH"
1256 else
1257 accel_text="ECC"
1258 fi
1259
1260 msg "build: full + non accelerated $accel_text algs + USE_PSA"
1261
1262 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
1263
1264 make
1265
1266 msg "test suites: full + non accelerated EC algs + USE_PSA"
1267 make test
1268
1269 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
1270 tests/ssl-opt.sh
1271}
1272
1273component_test_psa_crypto_config_accel_ecc_no_bignum () {
1274 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
1275}
1276
1277component_test_psa_crypto_config_reference_ecc_no_bignum () {
1278 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
1279}
1280
1281component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
1282 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
1283}
1284
1285component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
1286 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
1287}
1288
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001289component_test_tfm_config_as_is () {
1290 msg "build: configs/config-tfm.h"
Minos Galanakis5da58e52024-11-07 15:35:33 +00001291 MBEDTLS_CONFIG="configs/config-tfm.h"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001292 CRYPTO_CONFIG="tf-psa-crypto/configs/ext/crypto_config_profile_medium.h"
Minos Galanakis4f619e12024-11-14 14:56:47 +00001293 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 +02001294 make
1295
1296 msg "test: configs/config-tfm.h - unit tests"
1297 make test
1298}
1299
Minos Galanakis471b34c2024-07-26 15:39:24 +01001300# Helper for setting common configurations between:
1301# - component_test_tfm_config_p256m_driver_accel_ec()
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001302# - component_test_tfm_config_no_p256m()
Minos Galanakis471b34c2024-07-26 15:39:24 +01001303common_tfm_config () {
1304 # Enable TF-M config
1305 cp configs/config-tfm.h "$CONFIG_H"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001306 cp tf-psa-crypto/configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001307
Minos Galanakis471b34c2024-07-26 15:39:24 +01001308 # Config adjustment for better test coverage in our environment.
1309 # This is not needed just to build and pass tests.
1310 #
1311 # Enable filesystem I/O for the benefit of PK parse/write tests.
Minos Galanakis5da58e52024-11-07 15:35:33 +00001312 sed -i '/PROFILE_M_PSA_CRYPTO_CONFIG_H/i #define MBEDTLS_FS_IO' "$CRYPTO_CONFIG_H"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001313}
1314
1315# Keep this in sync with component_test_tfm_config() as they are both meant
1316# to be used in analyze_outcomes.py for driver's coverage analysis.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001317component_test_tfm_config_p256m_driver_accel_ec () {
1318 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
1319
1320 common_tfm_config
1321
1322 # Build crypto library
David Horstmann5b93d972024-10-31 15:36:05 +00001323 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../framework/tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001324
1325 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
1326 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
1327 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
1328 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settieb63eb22025-02-12 13:32:49 +01001329 # Also ensure that ECP, RSA or BIGNUM modules were not re-enabled
Minos Galanakis471b34c2024-07-26 15:39:24 +01001330 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
1331 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001332 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
1333 # Check that p256m was built
1334 grep -q p256_ecdsa_ library/libmbedcrypto.a
1335
1336 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
1337 # files, so we want to ensure that it has not be re-enabled accidentally.
1338 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
1339
1340 # Run the tests
1341 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
1342 make test
1343}
1344
1345# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
1346# they are both meant to be used in analyze_outcomes.py for driver's coverage
1347# analysis.
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001348component_test_tfm_config_no_p256m () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001349 common_tfm_config
1350
1351 # Disable P256M driver, which is on by default, so that analyze_outcomes
1352 # can compare this test with test_tfm_config_p256m_driver_accel_ec
Minos Galanakis5da58e52024-11-07 15:35:33 +00001353 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 +01001354
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001355 msg "build: TF-M config without p256m"
David Horstmann5b93d972024-10-31 15:36:05 +00001356 make CFLAGS='-Werror -Wall -Wextra -I../framework/tests/include/spe' tests
Minos Galanakis471b34c2024-07-26 15:39:24 +01001357
1358 # Check that p256m was not built
1359 not grep p256_ecdsa_ library/libmbedcrypto.a
1360
1361 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
1362 # files, so we want to ensure that it has not be re-enabled accidentally.
1363 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
1364
Gilles Peskineeffa6a02024-09-14 11:35:36 +02001365 msg "test: TF-M config without p256m"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001366 make test
1367}
1368
Minos Galanakis471b34c2024-07-26 15:39:24 +01001369# This is an helper used by:
1370# - component_test_psa_ecc_key_pair_no_derive
1371# - component_test_psa_ecc_key_pair_no_generate
1372# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
1373# enabled, but one. Input arguments are as follows:
Gilles Peskinefef912c2024-09-20 16:07:09 +02001374# - $1 is the configuration to start from
1375# - $2 is the key type under test, i.e. ECC/RSA/DH
1376# - $3 is the key option to be unset (i.e. generate, derive, etc)
Minos Galanakisf78447f2024-07-26 20:49:51 +01001377build_and_test_psa_want_key_pair_partial () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001378 base_config=$1
1379 key_type=$2
1380 unset_option=$3
Minos Galanakis471b34c2024-07-26 15:39:24 +01001381 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
1382
Gilles Peskinefef912c2024-09-20 16:07:09 +02001383 msg "build: $base_config - ${disabled_psa_want}"
1384 scripts/config.py "$base_config"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001385
1386 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
1387 # crypto_config.h so we just disable the one we don't want.
1388 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
1389
1390 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1391
Gilles Peskinefef912c2024-09-20 16:07:09 +02001392 msg "test: $base_config - ${disabled_psa_want}"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001393 make test
1394}
1395
Minos Galanakisf78447f2024-07-26 20:49:51 +01001396component_test_psa_ecc_key_pair_no_derive () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001397 build_and_test_psa_want_key_pair_partial full "ECC" "DERIVE"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001398}
1399
Minos Galanakisf78447f2024-07-26 20:49:51 +01001400component_test_psa_ecc_key_pair_no_generate () {
Gilles Peskinefef912c2024-09-20 16:07:09 +02001401 # TLS needs ECC key generation whenever ephemeral ECDH is enabled.
1402 # We don't have proper guards for configurations with ECC key generation
1403 # disabled (https://github.com/Mbed-TLS/mbedtls/issues/9481). Until
1404 # then (if ever), just test the crypto part of the library.
1405 build_and_test_psa_want_key_pair_partial crypto_full "ECC" "GENERATE"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001406}
1407
1408config_psa_crypto_accel_rsa () {
1409 driver_only=$1
1410
1411 # Start from crypto_full config (no X.509, no TLS)
1412 helper_libtestdriver1_adjust_config "crypto_full"
1413
1414 if [ "$driver_only" -eq 1 ]; then
Minos Galanakis471b34c2024-07-26 15:39:24 +01001415 # We need PEM parsing in the test library as well to support the import
1416 # of PEM encoded RSA keys.
Minos Galanakis23452f52024-11-28 17:48:14 +00001417 scripts/config.py -c "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
1418 scripts/config.py -c "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
Minos Galanakis471b34c2024-07-26 15:39:24 +01001419 fi
1420}
1421
1422component_test_psa_crypto_config_accel_rsa_crypto () {
1423 msg "build: crypto_full with accelerated RSA"
1424
1425 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
1426 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
1427 KEY_TYPE_RSA_PUBLIC_KEY \
1428 KEY_TYPE_RSA_KEY_PAIR_BASIC \
1429 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
1430 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
1431 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
1432
1433 # Configure
1434 # ---------
1435
1436 config_psa_crypto_accel_rsa 1
1437
1438 # Build
1439 # -----
1440
1441 # These hashes are needed for unit tests.
1442 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1443 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
1444 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
1445
1446 helper_libtestdriver1_make_main "$loc_accel_list"
1447
1448 # Make sure this was not re-enabled by accident (additive config)
1449 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
1450
1451 # Run the tests
1452 # -------------
1453
1454 msg "test: crypto_full with accelerated RSA"
1455 make test
1456}
1457
1458component_test_psa_crypto_config_reference_rsa_crypto () {
1459 msg "build: crypto_full with non-accelerated RSA"
1460
1461 # Configure
1462 # ---------
1463 config_psa_crypto_accel_rsa 0
1464
1465 # Build
1466 # -----
1467 make
1468
1469 # Run the tests
1470 # -------------
1471 msg "test: crypto_full with non-accelerated RSA"
1472 make test
1473}
1474
1475# This is a temporary test to verify that full RSA support is present even when
1476# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001477component_test_new_psa_want_key_pair_symbol () {
Ronald Cron892bb612025-07-21 14:26:27 +02001478 msg "Build: crypto config - PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001479
1480 # Create a temporary output file unless there is already one set
1481 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
1482 REMOVE_OUTCOME_ON_EXIT="no"
1483 else
1484 REMOVE_OUTCOME_ON_EXIT="yes"
1485 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
1486 export MBEDTLS_TEST_OUTCOME_FILE
1487 fi
1488
1489 # Start from crypto configuration
1490 scripts/config.py crypto
1491
1492 # Remove RSA support and its dependencies
Minos Galanakis471b34c2024-07-26 15:39:24 +01001493 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1494 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Minos Galanakis471b34c2024-07-26 15:39:24 +01001495 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1496
Minos Galanakis471b34c2024-07-26 15:39:24 +01001497 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
1498 # that proper translations is done in crypto_legacy.h.
1499 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
1500 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
1501 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
1502
1503 make
1504
Ronald Cron892bb612025-07-21 14:26:27 +02001505 msg "Test: crypto config - PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001506 make test
1507
1508 # Parse only 1 relevant line from the outcome file, i.e. a test which is
1509 # performing RSA signature.
1510 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
1511 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
1512
1513 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
1514 rm $MBEDTLS_TEST_OUTCOME_FILE
1515 fi
1516}
1517
1518component_test_psa_crypto_config_accel_hash () {
Ronald Cron93ba6252024-09-05 10:37:14 +02001519 msg "test: accelerated hash"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001520
1521 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1522 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1523 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1524
1525 # Configure
1526 # ---------
1527
1528 # Start from default config (no USE_PSA)
1529 helper_libtestdriver1_adjust_config "default"
1530
Minos Galanakis471b34c2024-07-26 15:39:24 +01001531 # Build
1532 # -----
1533
1534 helper_libtestdriver1_make_drivers "$loc_accel_list"
1535
1536 helper_libtestdriver1_make_main "$loc_accel_list"
1537
1538 # There's a risk of something getting re-enabled via config_psa.h;
1539 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
1540 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
1541 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
1542 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
1543 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
1544 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
1545
1546 # Run the tests
1547 # -------------
1548
Ronald Cron93ba6252024-09-05 10:37:14 +02001549 msg "test: accelerated hash"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001550 make test
1551}
1552
1553# Auxiliary function to build config for hashes with and without drivers
Minos Galanakis471b34c2024-07-26 15:39:24 +01001554config_psa_crypto_hash_use_psa () {
1555 driver_only="$1"
1556 # start with config full for maximum coverage (also enables USE_PSA)
1557 helper_libtestdriver1_adjust_config "full"
1558 if [ "$driver_only" -eq 1 ]; then
1559 # disable the built-in implementation of hashes
Minos Galanakis471b34c2024-07-26 15:39:24 +01001560 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Minos Galanakis471b34c2024-07-26 15:39:24 +01001561 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Minos Galanakis471b34c2024-07-26 15:39:24 +01001562 fi
1563}
1564
1565# Note that component_test_psa_crypto_config_reference_hash_use_psa
1566# is related to this component and both components need to be kept in sync.
1567# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001568component_test_psa_crypto_config_accel_hash_use_psa () {
1569 msg "test: full with accelerated hashes"
1570
1571 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1572 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1573 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1574
1575 # Configure
1576 # ---------
1577
1578 config_psa_crypto_hash_use_psa 1
1579
1580 # Build
1581 # -----
1582
1583 helper_libtestdriver1_make_drivers "$loc_accel_list"
1584
1585 helper_libtestdriver1_make_main "$loc_accel_list"
1586
1587 # There's a risk of something getting re-enabled via config_psa.h;
1588 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
1589 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
1590 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
1591 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
1592 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
1593 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
1594
1595 # Run the tests
1596 # -------------
1597
1598 msg "test: full with accelerated hashes"
1599 make test
1600
1601 # This is mostly useful so that we can later compare outcome files with
1602 # the reference config in analyze_outcomes.py, to check that the
1603 # dependency declarations in ssl-opt.sh and in TLS code are correct.
1604 msg "test: ssl-opt.sh, full with accelerated hashes"
1605 tests/ssl-opt.sh
1606
1607 # This is to make sure all ciphersuites are exercised, but we don't need
1608 # interop testing (besides, we already got some from ssl-opt.sh).
1609 msg "test: compat.sh, full with accelerated hashes"
1610 tests/compat.sh -p mbedTLS -V YES
1611}
1612
1613# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
1614# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
1615# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
1616# Both components need to be kept in sync.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001617component_test_psa_crypto_config_reference_hash_use_psa () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001618 msg "test: full without accelerated hashes"
1619
1620 config_psa_crypto_hash_use_psa 0
1621
1622 make
1623
1624 msg "test: full without accelerated hashes"
1625 make test
1626
1627 msg "test: ssl-opt.sh, full without accelerated hashes"
1628 tests/ssl-opt.sh
1629}
1630
1631# Auxiliary function to build config for hashes with and without drivers
Minos Galanakis471b34c2024-07-26 15:39:24 +01001632config_psa_crypto_hmac_use_psa () {
1633 driver_only="$1"
1634 # start with config full for maximum coverage (also enables USE_PSA)
1635 helper_libtestdriver1_adjust_config "full"
1636
1637 if [ "$driver_only" -eq 1 ]; then
1638 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
1639 # is still enabled though (for ENTROPY_C among others).
1640 scripts/config.py unset MBEDTLS_MD_C
Ronald Cron772a8ad2025-07-21 12:36:29 +02001641 # Also disable the configuration options that tune the builtin hashes,
1642 # since those hashes are disabled.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001643 scripts/config.py unset-all MBEDTLS_SHA
Minos Galanakis471b34c2024-07-26 15:39:24 +01001644 fi
1645
1646 # Direct dependencies of MD_C. We disable them also in the reference
1647 # component to work with the same set of features.
1648 scripts/config.py unset MBEDTLS_PKCS7_C
1649 scripts/config.py unset MBEDTLS_PKCS5_C
1650 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1651 scripts/config.py unset MBEDTLS_HKDF_C
1652 # Dependencies of HMAC_DRBG
1653 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
1654 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1655}
1656
Minos Galanakisf78447f2024-07-26 20:49:51 +01001657component_test_psa_crypto_config_accel_hmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001658 msg "test: full with accelerated hmac"
1659
1660 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
1661 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
1662 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
1663 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
1664
1665 # Configure
1666 # ---------
1667
1668 config_psa_crypto_hmac_use_psa 1
1669
1670 # Build
1671 # -----
1672
1673 helper_libtestdriver1_make_drivers "$loc_accel_list"
1674
1675 helper_libtestdriver1_make_main "$loc_accel_list"
1676
1677 # Ensure that built-in support for HMAC is disabled.
1678 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1679
1680 # Run the tests
1681 # -------------
1682
1683 msg "test: full with accelerated hmac"
1684 make test
1685}
1686
Minos Galanakisf78447f2024-07-26 20:49:51 +01001687component_test_psa_crypto_config_reference_hmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001688 msg "test: full without accelerated hmac"
1689
1690 config_psa_crypto_hmac_use_psa 0
1691
1692 make
1693
1694 msg "test: full without accelerated hmac"
1695 make test
1696}
1697
Minos Galanakis471b34c2024-07-26 15:39:24 +01001698component_test_psa_crypto_config_accel_aead () {
Ronald Cron93ba6252024-09-05 10:37:14 +02001699 msg "test: accelerated AEAD"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001700
1701 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
1702 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1703
1704 # Configure
1705 # ---------
1706
1707 # Start from full config
1708 helper_libtestdriver1_adjust_config "full"
1709
Minos Galanakis471b34c2024-07-26 15:39:24 +01001710 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
1711 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1712
1713 # Build
1714 # -----
1715
1716 helper_libtestdriver1_make_drivers "$loc_accel_list"
1717
1718 helper_libtestdriver1_make_main "$loc_accel_list"
1719
1720 # Make sure this was not re-enabled by accident (additive config)
1721 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
1722 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
1723 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
1724
1725 # Run the tests
1726 # -------------
1727
Ronald Cron93ba6252024-09-05 10:37:14 +02001728 msg "test: accelerated AEAD"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001729 make test
1730}
1731
1732# This is a common configuration function used in:
1733# - component_test_psa_crypto_config_accel_cipher_aead_cmac
1734# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Minos Galanakisf78447f2024-07-26 20:49:51 +01001735common_psa_crypto_config_accel_cipher_aead_cmac () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001736 # Start from the full config
1737 helper_libtestdriver1_adjust_config "full"
1738
1739 scripts/config.py unset MBEDTLS_NIST_KW_C
1740}
1741
1742# The 2 following test components, i.e.
1743# - component_test_psa_crypto_config_accel_cipher_aead_cmac
1744# - component_test_psa_crypto_config_reference_cipher_aead_cmac
1745# are meant to be used together in analyze_outcomes.py script in order to test
1746# driver's coverage for ciphers and AEADs.
Minos Galanakis471b34c2024-07-26 15:39:24 +01001747component_test_psa_crypto_config_accel_cipher_aead_cmac () {
1748 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
1749
1750 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 ALG_CTR ALG_CFB \
1751 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
1752 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Ari Weiler-Ofek86422e52025-07-04 14:43:30 +01001753 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001754
1755 # Configure
1756 # ---------
1757
1758 common_psa_crypto_config_accel_cipher_aead_cmac
1759
Ari Weiler-Ofek5d8d2992025-07-07 23:20:29 +01001760 # Disable DES, if it still exists.
1761 # This can be removed once we remove DES from the library.
1762 scripts/config.py unset PSA_WANT_KEY_TYPE_DES
1763
Minos Galanakis471b34c2024-07-26 15:39:24 +01001764 # Build
1765 # -----
1766
1767 helper_libtestdriver1_make_drivers "$loc_accel_list"
1768
1769 helper_libtestdriver1_make_main "$loc_accel_list"
1770
1771 # Make sure this was not re-enabled by accident (additive config)
1772 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001773 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
1774 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
1775 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
1776 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
1777 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
1778 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
1779 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Ronald Cronb5c6fcc2025-07-10 13:40:00 +02001780 not grep mbedtls_poly1305 ${BUILTIN_SRC_PATH}/poly1305.o
Minos Galanakis471b34c2024-07-26 15:39:24 +01001781
1782 # Run the tests
1783 # -------------
1784
1785 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
1786 make test
1787
1788 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Ronald Cronbd28acf2025-07-10 09:53:50 +02001789 # Exclude password-protected key tests — they require built-in CBC and AES.
1790 tests/ssl-opt.sh -e "TLS: password protected"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001791
1792 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
1793 tests/compat.sh -V NO -p mbedTLS
1794}
1795
1796component_test_psa_crypto_config_reference_cipher_aead_cmac () {
1797 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
1798 common_psa_crypto_config_accel_cipher_aead_cmac
1799
Ari Weiler-Ofek5d8d2992025-07-07 23:20:29 +01001800 # Disable DES, if it still exists.
1801 # This can be removed once we remove DES from the library.
1802 scripts/config.py unset PSA_WANT_KEY_TYPE_DES
1803
Minos Galanakis471b34c2024-07-26 15:39:24 +01001804 make
1805
1806 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
1807 make test
1808
1809 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Ronald Cronbd28acf2025-07-10 09:53:50 +02001810 # Exclude password-protected key tests as in test_psa_crypto_config_accel_cipher_aead_cmac.
1811 tests/ssl-opt.sh -e "TLS: password protected"
Minos Galanakis471b34c2024-07-26 15:39:24 +01001812
1813 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
1814 tests/compat.sh -V NO -p mbedTLS
1815}
1816
Minos Galanakisf78447f2024-07-26 20:49:51 +01001817common_block_cipher_dispatch () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001818 TEST_WITH_DRIVER="$1"
1819
1820 # Start from the full config
1821 helper_libtestdriver1_adjust_config "full"
1822
Minos Galanakis471b34c2024-07-26 15:39:24 +01001823 # Disable cipher's modes that, when not accelerated, cause
1824 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
1825 # Keep this also in the reference component in order to skip the same tests
1826 # that were skipped in the accelerated one.
1827 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1828 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1829 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1830 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1831 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1832 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1835
1836 # Disable direct dependency on AES_C
1837 scripts/config.py unset MBEDTLS_NIST_KW_C
1838
1839 # Prevent the cipher module from using deprecated PSA path. The reason is
1840 # that otherwise there will be tests relying on "aes_info" (defined in
1841 # "cipher_wrap.c") whose functions are not available when AES_C is
1842 # not defined. ARIA and Camellia are not a problem in this case because
1843 # the PSA path is not tested for these key types.
1844 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
1845}
1846
Gilles Peskinea9dda7e2024-06-21 11:25:01 +02001847component_test_full_block_cipher_psa_dispatch_static_keystore () {
1848 msg "build: full + PSA dispatch in block_cipher with static keystore"
1849 # Check that the static key store works well when CTR_DRBG uses a
1850 # PSA key for AES.
1851 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
1852
1853 loc_accel_list="ALG_ECB_NO_PADDING \
1854 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1855
1856 # Configure
1857 # ---------
1858
1859 common_block_cipher_dispatch 1
1860
1861 # Build
1862 # -----
1863
1864 helper_libtestdriver1_make_drivers "$loc_accel_list"
1865
1866 helper_libtestdriver1_make_main "$loc_accel_list"
1867
1868 # Make sure disabled components were not re-enabled by accident (additive
1869 # config)
1870 not grep mbedtls_aes_ library/aes.o
1871 not grep mbedtls_aria_ library/aria.o
1872 not grep mbedtls_camellia_ library/camellia.o
1873
1874 # Run the tests
1875 # -------------
1876
1877 msg "test: full + PSA dispatch in block_cipher with static keystore"
1878 make test
1879}
1880
Minos Galanakis471b34c2024-07-26 15:39:24 +01001881component_test_full_block_cipher_psa_dispatch () {
1882 msg "build: full + PSA dispatch in block_cipher"
1883
1884 loc_accel_list="ALG_ECB_NO_PADDING \
1885 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
1886
1887 # Configure
1888 # ---------
1889
1890 common_block_cipher_dispatch 1
1891
1892 # Build
1893 # -----
1894
1895 helper_libtestdriver1_make_drivers "$loc_accel_list"
1896
1897 helper_libtestdriver1_make_main "$loc_accel_list"
1898
1899 # Make sure disabled components were not re-enabled by accident (additive
1900 # config)
1901 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
1902 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
1903 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
1904
1905 # Run the tests
1906 # -------------
1907
1908 msg "test: full + PSA dispatch in block_cipher"
1909 make test
1910}
1911
1912# This is the reference component of component_test_full_block_cipher_psa_dispatch
Minos Galanakis471b34c2024-07-26 15:39:24 +01001913component_test_full_block_cipher_legacy_dispatch () {
1914 msg "build: full + legacy dispatch in block_cipher"
1915
1916 common_block_cipher_dispatch 0
1917
1918 make
1919
1920 msg "test: full + legacy dispatch in block_cipher"
1921 make test
1922}
1923
Minos Galanakisf78447f2024-07-26 20:49:51 +01001924component_test_aead_chachapoly_disabled () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001925 msg "build: full minus CHACHAPOLY"
1926 scripts/config.py full
Minos Galanakis471b34c2024-07-26 15:39:24 +01001927 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
1928 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1929
1930 msg "test: full minus CHACHAPOLY"
1931 make test
1932}
1933
Minos Galanakisf78447f2024-07-26 20:49:51 +01001934component_test_aead_only_ccm () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001935 msg "build: full minus CHACHAPOLY and GCM"
1936 scripts/config.py full
Minos Galanakis471b34c2024-07-26 15:39:24 +01001937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
1938 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
1939 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1940
1941 msg "test: full minus CHACHAPOLY and GCM"
1942 make test
1943}
1944
Minos Galanakisf78447f2024-07-26 20:49:51 +01001945component_test_ccm_aes_sha256 () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001946 msg "build: CCM + AES + SHA256 configuration"
1947
Minos Galanakisa17ffc72024-12-02 23:57:30 +00001948 # Setting a blank config disables everyhing in the library side.
1949 echo '#define MBEDTLS_CONFIG_H ' >"$CONFIG_H"
Harry Ramsey94c386a2025-01-16 16:08:34 +00001950 cp tf-psa-crypto/configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Cron9d262d72024-12-06 17:41:26 +01001951
Minos Galanakis471b34c2024-07-26 15:39:24 +01001952 make
Minos Galanakis471b34c2024-07-26 15:39:24 +01001953 msg "test: CCM + AES + SHA256 configuration"
1954 make test
1955}
1956
1957# Test that the given .o file builds with all (valid) combinations of the given options.
1958#
1959# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
1960#
1961# The validator function is the name of a function to validate the combination of options.
1962# It may be "" if all combinations are valid.
1963# It receives a string containing a combination of options, as passed to the compiler,
1964# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Minos Galanakisf78447f2024-07-26 20:49:51 +01001965build_test_config_combos () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01001966 file=$1
1967 shift
1968 validate_options=$1
1969 shift
1970 options=("$@")
1971
1972 # clear all of the options so that they can be overridden on the clang commandline
1973 for opt in "${options[@]}"; do
1974 ./scripts/config.py unset ${opt}
1975 done
1976
1977 # enter the library directory
1978 cd library
1979
1980 # The most common issue is unused variables/functions, so ensure -Wunused is set.
1981 warning_flags="-Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wasm-operand-widths -Wunused"
1982
1983 # Extract the command generated by the Makefile to build the target file.
1984 # This ensures that we have any include paths, macro definitions, etc
1985 # that may be applied by make.
1986 # Add -fsyntax-only as we only want a syntax check and don't need to generate a file.
1987 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
1988
1989 makefile=$(TMPDIR=. mktemp)
1990 deps=""
1991
1992 len=${#options[@]}
1993 source_file=../${file%.o}.c
1994
1995 targets=0
1996 echo 'include Makefile' >${makefile}
1997
1998 for ((i = 0; i < $((2**${len})); i++)); do
1999 # generate each of 2^n combinations of options
2000 # each bit of $i is used to determine if options[i] will be set or not
2001 target="t"
2002 clang_args=""
2003 for ((j = 0; j < ${len}; j++)); do
2004 if (((i >> j) & 1)); then
2005 opt=-D${options[$j]}
2006 clang_args="${clang_args} ${opt}"
2007 target="${target}${opt}"
2008 fi
2009 done
2010
2011 # if combination is not known to be invalid, add it to the makefile
2012 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
2013 cmd="${compile_cmd} ${clang_args}"
2014 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
2015
2016 deps="${deps} ${target}"
2017 ((++targets))
2018 fi
2019 done
2020
2021 echo "build_test_config_combos: ${deps}" >> ${makefile}
2022
2023 # execute all of the commands via Make (probably in parallel)
2024 make -s -f ${makefile} build_test_config_combos
2025 echo "$targets targets checked"
2026
2027 # clean up the temporary makefile
2028 rm ${makefile}
2029}
2030
Minos Galanakisf78447f2024-07-26 20:49:51 +01002031validate_aes_config_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002032 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
2033 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
2034 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
2035 return 1
2036 fi
2037 fi
2038 return 0
2039}
2040
Minos Galanakisf78447f2024-07-26 20:49:51 +01002041component_build_aes_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002042 # 18s - around 90ms per clang invocation on M1 Pro
2043 #
2044 # aes.o has many #if defined(...) guards that intersect in complex ways.
2045 # Test that all the combinations build cleanly.
2046
2047 MBEDTLS_ROOT_DIR="$PWD"
2048 msg "build: aes.o for all combinations of relevant config options"
2049
2050 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Thomas Daubney6cf05f92024-07-18 11:30:22 +01002051 "MBEDTLS_AES_ROM_TABLES" \
Minos Galanakis471b34c2024-07-26 15:39:24 +01002052 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
2053 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
2054
2055 cd "$MBEDTLS_ROOT_DIR"
2056 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
2057
Ari Weiler-Ofek86422e52025-07-04 14:43:30 +01002058 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW,
Minos Galanakis471b34c2024-07-26 15:39:24 +01002059 # manually set or unset those configurations to check
2060 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
2061 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Minos Galanakis471b34c2024-07-26 15:39:24 +01002062 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron54d1eec2024-09-06 09:55:38 +02002063
Minos Galanakis00b641c2024-11-28 23:05:10 +00002064 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
2065 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
2066 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
2067 scripts/config.py -c $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Ronald Cron54d1eec2024-09-06 09:55:38 +02002068
Minos Galanakis471b34c2024-07-26 15:39:24 +01002069 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Thomas Daubney6cf05f92024-07-18 11:30:22 +01002070 "MBEDTLS_AES_ROM_TABLES" \
Minos Galanakis471b34c2024-07-26 15:39:24 +01002071 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
2072 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
2073}
2074
Minos Galanakisf78447f2024-07-26 20:49:51 +01002075component_test_sha3_variations () {
Minos Galanakis471b34c2024-07-26 15:39:24 +01002076 msg "sha3 loop unroll variations"
2077
2078 # define minimal config sufficient to test SHA3
Ronald Crone7f289e2024-09-06 11:02:47 +02002079 cat > include/mbedtls/mbedtls_config.h << END
Ronald Crone7f289e2024-09-06 11:02:47 +02002080END
2081
2082 cat > tf-psa-crypto/include/psa/crypto_config.h << END
2083 #define PSA_WANT_ALG_SHA_256 1
2084 #define PSA_WANT_ALG_SHA3_224 1
2085 #define PSA_WANT_ALG_SHA3_256 1
2086 #define PSA_WANT_ALG_SHA3_384 1
2087 #define PSA_WANT_ALG_SHA3_512 1
Ronald Cron06680362025-07-21 15:21:22 +02002088 #define PSA_WANT_KEY_TYPE_AES 1
Ronald Cron3dd1d3d2024-12-05 15:12:06 +01002089 #define MBEDTLS_CTR_DRBG_C
2090 #define MBEDTLS_ENTROPY_C
2091 #define MBEDTLS_PSA_CRYPTO_C
2092 #define MBEDTLS_SELF_TEST
Minos Galanakis471b34c2024-07-26 15:39:24 +01002093END
2094
2095 msg "all loops unrolled"
2096 make clean
2097 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"
2098 ./tf-psa-crypto/tests/test_suite_shax
2099
2100 msg "all loops rolled up"
2101 make clean
2102 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"
2103 ./tf-psa-crypto/tests/test_suite_shax
2104}
2105
Minos Galanakisf699d512024-08-01 11:32:30 +01002106support_build_aes_aesce_armcc () {
2107 support_build_armcc
2108}
2109
Minos Galanakis471b34c2024-07-26 15:39:24 +01002110# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
2111component_build_aes_aesce_armcc () {
2112 msg "Build: AESCE test on arm64 platform without plain C."
2113 scripts/config.py baremetal
2114
2115 # armc[56] don't support SHA-512 intrinsics
2116 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2117
2118 # Stop armclang warning about feature detection for A64_CRYPTO.
2119 # With this enabled, the library does build correctly under armclang,
2120 # but in baremetal builds (as tested here), feature detection is
2121 # unavailable, and the user is notified via a #warning. So enabling
2122 # this feature would prevent us from building with -Werror on
2123 # armclang. Tracked in #7198.
2124 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2125 scripts/config.py set MBEDTLS_HAVE_ASM
2126
2127 msg "AESCE, build with default configuration."
2128 scripts/config.py set MBEDTLS_AESCE_C
2129 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002130 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002131
2132 msg "AESCE, build AESCE only"
2133 scripts/config.py set MBEDTLS_AESCE_C
2134 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002135 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002136}
2137
Minos Galanakis471b34c2024-07-26 15:39:24 +01002138component_test_aes_only_128_bit_keys () {
2139 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
2140 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
2141
2142 make CFLAGS='-O2 -Werror -Wall -Wextra'
2143
2144 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
2145 make test
2146}
2147
2148component_test_no_ctr_drbg_aes_only_128_bit_keys () {
2149 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
2150 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
2151 scripts/config.py unset MBEDTLS_CTR_DRBG_C
2152
2153 make CC=clang CFLAGS='-Werror -Wall -Wextra'
2154
2155 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
2156 make test
2157}
2158
2159component_test_aes_only_128_bit_keys_have_builtins () {
2160 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2161 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
2162 scripts/config.py unset MBEDTLS_AESNI_C
2163 scripts/config.py unset MBEDTLS_AESCE_C
2164
2165 make CFLAGS='-O2 -Werror -Wall -Wextra'
2166
2167 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2168 make test
2169
2170 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
2171 programs/test/selftest
2172}
2173
2174component_test_gcm_largetable () {
2175 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
2176 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
2177 scripts/config.py unset MBEDTLS_AESNI_C
2178 scripts/config.py unset MBEDTLS_AESCE_C
2179
2180 make CFLAGS='-O2 -Werror -Wall -Wextra'
2181
2182 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
2183 make test
2184}
2185
2186component_test_aes_fewer_tables () {
2187 msg "build: default config with AES_FEWER_TABLES enabled"
2188 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
2189 make CFLAGS='-O2 -Werror -Wall -Wextra'
2190
2191 msg "test: AES_FEWER_TABLES"
2192 make test
2193}
2194
2195component_test_aes_rom_tables () {
2196 msg "build: default config with AES_ROM_TABLES enabled"
2197 scripts/config.py set MBEDTLS_AES_ROM_TABLES
2198 make CFLAGS='-O2 -Werror -Wall -Wextra'
2199
2200 msg "test: AES_ROM_TABLES"
2201 make test
2202}
2203
2204component_test_aes_fewer_tables_and_rom_tables () {
2205 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
2206 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
2207 scripts/config.py set MBEDTLS_AES_ROM_TABLES
2208 make CFLAGS='-O2 -Werror -Wall -Wextra'
2209
2210 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
2211 make test
2212}
2213
Ronald Cron66040472024-09-06 10:14:38 +02002214# helper for component_test_block_cipher_no_decrypt_aesni() which:
Minos Galanakis471b34c2024-07-26 15:39:24 +01002215# - enable/disable the list of config options passed from -s/-u respectively.
2216# - build
2217# - test for tests_suite_xxx
2218# - selftest
2219#
2220# Usage: helper_block_cipher_no_decrypt_build_test
2221# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
2222# Options: -s set_opts the list of config options to enable
2223# -u unset_opts the list of config options to disable
2224# -c cflags the list of options passed to CFLAGS
2225# -l ldflags the list of options passed to LDFLAGS
Minos Galanakis471b34c2024-07-26 15:39:24 +01002226helper_block_cipher_no_decrypt_build_test () {
2227 while [ $# -gt 0 ]; do
2228 case "$1" in
2229 -s)
2230 shift; local set_opts="$1";;
2231 -u)
2232 shift; local unset_opts="$1";;
2233 -c)
2234 shift; local cflags="-Werror -Wall -Wextra $1";;
2235 -l)
2236 shift; local ldflags="$1";;
2237 esac
2238 shift
2239 done
2240 set_opts="${set_opts:-}"
2241 unset_opts="${unset_opts:-}"
2242 cflags="${cflags:-}"
2243 ldflags="${ldflags:-}"
2244
2245 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
2246 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
2247
2248 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2249 make clean
2250 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
2251
2252 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
2253 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
2254 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
2255 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
2256 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
2257 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
2258 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
2259 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
2260
2261 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2262 make test
2263
2264 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
2265 programs/test/selftest
2266}
2267
Ronald Cron66040472024-09-06 10:14:38 +02002268# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
2269config_block_cipher_no_decrypt () {
2270 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Ronald Cron66040472024-09-06 10:14:38 +02002271 scripts/config.py unset MBEDTLS_NIST_KW_C
2272
2273 # Enable support for cryptographic mechanisms through the PSA API.
2274 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
Ronald Cron66040472024-09-06 10:14:38 +02002275 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
2276 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
2277 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
2278 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
Ronald Cron66040472024-09-06 10:14:38 +02002279}
2280
2281component_test_block_cipher_no_decrypt_aesni () {
2282 # Test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics, AESNI assembly and
2283 # AES C implementation on x86_64 and with AESNI intrinsics on x86.
2284
2285 # This consistently causes an llvm crash on clang 3.8, so use gcc
2286 export CC=gcc
2287 config_block_cipher_no_decrypt
2288
Minos Galanakis471b34c2024-07-26 15:39:24 +01002289 # test AESNI intrinsics
2290 helper_block_cipher_no_decrypt_build_test \
2291 -s "MBEDTLS_AESNI_C" \
2292 -c "-mpclmul -msse2 -maes"
2293
2294 # test AESNI assembly
2295 helper_block_cipher_no_decrypt_build_test \
2296 -s "MBEDTLS_AESNI_C" \
2297 -c "-mno-pclmul -mno-sse2 -mno-aes"
2298
2299 # test AES C implementation
2300 helper_block_cipher_no_decrypt_build_test \
2301 -u "MBEDTLS_AESNI_C"
2302
2303 # test AESNI intrinsics for i386 target
2304 helper_block_cipher_no_decrypt_build_test \
2305 -s "MBEDTLS_AESNI_C" \
2306 -c "-m32 -mpclmul -msse2 -maes" \
2307 -l "-m32"
2308}
2309
Minos Galanakisf699d512024-08-01 11:32:30 +01002310support_test_block_cipher_no_decrypt_aesce_armcc () {
2311 support_build_armcc
2312}
2313
Minos Galanakis471b34c2024-07-26 15:39:24 +01002314component_test_block_cipher_no_decrypt_aesce_armcc () {
2315 scripts/config.py baremetal
2316
2317 # armc[56] don't support SHA-512 intrinsics
2318 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2319
2320 # Stop armclang warning about feature detection for A64_CRYPTO.
2321 # With this enabled, the library does build correctly under armclang,
2322 # but in baremetal builds (as tested here), feature detection is
2323 # unavailable, and the user is notified via a #warning. So enabling
2324 # this feature would prevent us from building with -Werror on
2325 # armclang. Tracked in #7198.
2326 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2327 scripts/config.py set MBEDTLS_HAVE_ASM
2328
Ronald Cron66040472024-09-06 10:14:38 +02002329 config_block_cipher_no_decrypt
Minos Galanakis471b34c2024-07-26 15:39:24 +01002330
2331 # test AESCE baremetal build
2332 scripts/config.py set MBEDTLS_AESCE_C
2333 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Manuel Pégourié-Gonnard8f08bcd2024-10-01 13:01:54 +02002334 helper_armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002335
2336 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
2337 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
2338 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
2339 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
2340 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
2341 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
2342 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
2343 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
2344 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
2345}
2346
2347component_test_ctr_drbg_aes_256_sha_256 () {
2348 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2349 scripts/config.py full
2350 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2351 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
2352 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2353 make
2354
2355 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2356 make test
2357}
2358
2359component_test_ctr_drbg_aes_128_sha_512 () {
2360 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
2361 scripts/config.py full
2362 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2363 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
2364 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2365 make
2366
2367 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
2368 make test
2369}
2370
2371component_test_ctr_drbg_aes_128_sha_256 () {
2372 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2373 scripts/config.py full
2374 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
2375 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
2376 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
2377 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2378 make
2379
2380 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
2381 make test
2382}
2383
Gilles Peskinea9dda7e2024-06-21 11:25:01 +02002384component_test_full_static_keystore () {
2385 msg "build: full config - MBEDTLS_PSA_KEY_STORE_DYNAMIC"
2386 scripts/config.py full
2387 scripts/config.py unset MBEDTLS_PSA_KEY_STORE_DYNAMIC
2388 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
2389
2390 msg "test: full config - MBEDTLS_PSA_KEY_STORE_DYNAMIC"
2391 make test
2392}
2393
Minos Galanakis471b34c2024-07-26 15:39:24 +01002394component_test_psa_crypto_drivers () {
Ronald Crona0afbfb2024-10-15 13:20:31 +02002395 # Test dispatch to drivers and fallbacks with
2396 # test_suite_psa_crypto_driver_wrappers test suite. The test drivers that
2397 # are wrappers around the builtin drivers are activated by
2398 # PSA_CRYPTO_DRIVER_TEST.
2399 #
2400 # For the time being, some test cases in test_suite_block_cipher and
2401 # test_suite_md.psa rely on this component to be run at least once by the
2402 # CI. This should disappear as we progress the 4.x work. See
2403 # config_adjust_test_accelerators.h for more information.
Minos Galanakis471b34c2024-07-26 15:39:24 +01002404 msg "build: full + test drivers dispatching to builtins"
2405 scripts/config.py full
Ronald Cron67cc6a72024-10-14 10:55:24 +02002406 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_CONFIG_ADJUST_TEST_ACCELERATORS"
David Horstmann5b93d972024-10-31 15:36:05 +00002407 loc_cflags="${loc_cflags} -I../framework/tests/include"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002408
2409 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
2410
2411 msg "test: full + test drivers dispatching to builtins"
2412 make test
2413}
2414
2415component_build_psa_config_file () {
Minos Galanakis4f619e12024-11-14 14:56:47 +00002416 msg "build: make with TF_PSA_CRYPTO_CONFIG_FILE" # ~40s
Minos Galanakis471b34c2024-07-26 15:39:24 +01002417 cp "$CRYPTO_CONFIG_H" psa_test_config.h
Minos Galanakis4f619e12024-11-14 14:56:47 +00002418 echo '#error "TF_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
2419 make CFLAGS="-I '$PWD' -DTF_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Minos Galanakis471b34c2024-07-26 15:39:24 +01002420 # Make sure this feature is enabled. We'll disable it in the next phase.
Ronald Cron3f120062025-07-03 14:45:51 +02002421 programs/test/query_compile_time_config PSA_WANT_ALG_CMAC
Minos Galanakis471b34c2024-07-26 15:39:24 +01002422 make clean
2423
Minos Galanakis4f619e12024-11-14 14:56:47 +00002424 msg "build: make with TF_PSA_CRYPTO_CONFIG_FILE + TF_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Minos Galanakis471b34c2024-07-26 15:39:24 +01002425 # In the user config, disable one feature and its dependencies, which will
2426 # reflect on the mbedtls configuration so we can query it with
2427 # query_compile_time_config.
2428 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
2429 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Minos Galanakis4f619e12024-11-14 14:56:47 +00002430 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 +02002431 not programs/test/query_compile_time_config PSA_WANT_ALG_CMAC
Minos Galanakis471b34c2024-07-26 15:39:24 +01002432
2433 rm -f psa_test_config.h psa_user_config.h
2434}
2435
2436component_build_psa_alt_headers () {
2437 msg "build: make with PSA alt headers" # ~20s
2438
2439 # Generate alternative versions of the substitutable headers with the
2440 # same content except different include guards.
David Horstmanndc459512024-11-07 17:08:11 +00002441 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 +01002442
2443 # Build the library and some programs.
2444 # Don't build the fuzzers to avoid having to go through hoops to set
2445 # a correct include path for programs/fuzz/Makefile.
David Horstmann5b93d972024-10-31 15:36:05 +00002446 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
2447 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 +01002448
2449 # Check that we're getting the alternative include guards and not the
2450 # original include guards.
2451 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
2452 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
2453 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
2454 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
2455}
2456
2457component_test_min_mpi_window_size () {
2458 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
2459 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
2460 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
2461 make
2462
2463 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
2464 make test
2465}
Ronald Cronf256f8a2025-07-10 17:37:18 +02002466
2467component_test_xts () {
2468 # Component dedicated to run XTS unit test cases while XTS is not
2469 # supported through the PSA API.
2470 msg "build: Default + MBEDTLS_CIPHER_MODE_XTS"
2471
2472 echo "#define MBEDTLS_CIPHER_MODE_XTS" > psa_user_config.h
2473 cmake -DTF_PSA_CRYPTO_USER_CONFIG_FILE="psa_user_config.h"
2474 make
2475
Ronald Crone0b06eb2025-07-15 08:58:32 +02002476 rm -f psa_user_config.h
2477
Ronald Cronf256f8a2025-07-10 17:37:18 +02002478 msg "test: Default + MBEDTLS_CIPHER_MODE_XTS"
2479 make test
Ronald Cronf256f8a2025-07-10 17:37:18 +02002480}