blob: 3417b0d740adc3fcb309a0c3dcad0ecda70a81e9 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200136 CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100137 else
138 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100140 fi
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100141 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200142
143 # Files that are clobbered by some jobs will be backed up. Use a different
144 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
145 # independently decide when to remove the backup file.
146 backup_suffix='.all.bak'
147 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100148 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100149 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100150 # Files clobbered by in-tree cmake
151 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
152 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200153
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200154 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100155 MEMORY=0
156 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200157 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100158 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100159
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200160 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200161 #
162 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
163 # both values are kept in sync. If you change the value here because it
164 # breaks some tests, you'll definitely want to change it in
165 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200166 RELEASE_SEED=1
167
Yanray Wang18040ed2023-11-23 21:29:56 +0800168 # Specify character collation for regular expressions and sorting with C locale
169 export LC_COLLATE=C
170
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200171 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200172 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200173 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200174 export MBEDTLS_TEST_PLATFORM
175
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000176 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100178 : ${OPENSSL_NEXT:="$OPENSSL"}
179 : ${GNUTLS_CLI:="gnutls-cli"}
180 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100181 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
182 : ${ARMC5_BIN_DIR:=/usr/bin}
183 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200184 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200185 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100186 : ${CLANG_LATEST:="clang-latest"}
187 : ${CLANG_EARLIEST:="clang-earliest"}
188 : ${GCC_LATEST:="gcc-latest"}
189 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100190 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000191 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200192 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100193 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000194 # if CC is not set, use clang by default (if present) to improve build times
195 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000196 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000197 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000198
Ronald Cronc5e81d22024-04-02 14:39:53 +0200199 if [ -n "${OPENSSL_3+set}" ]; then
200 export OPENSSL_NEXT="$OPENSSL_3"
201 fi
202
Gilles Peskine396853a2021-09-20 18:57:55 +0200203 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000204 export CTEST_OUTPUT_ON_FAILURE=1
205
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100207 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200208 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000209 # Normally, tests should use this compiler for ASAN testing
210 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200211
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400212 # Platform tests have an allocation that returns null
213 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400214 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400215
Gilles Peskine878cf602019-01-06 20:50:38 +0000216 # Gather the list of available components. These are the functions
217 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100218 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000219
Valerio Setti9022f712024-06-27 07:59:39 +0200220 PSASIM_PATH='tests/psa-client-server/psasim/'
221
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000222 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100223 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100224}
Andres AG38495a32016-07-12 16:54:33 +0100225
Dave Rodgman21900632024-02-26 11:41:19 +0000226setup_quiet_wrappers()
227{
228 # Pick up "quiet" wrappers for make and cmake, which don't output very much
229 # unless there is an error. This reduces logging overhead in the CI.
230 #
231 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000232 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
233 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000234 fi
235}
236
Gilles Peskinea28db922019-01-10 00:05:18 +0100237# Test whether the component $1 is included in the command line patterns.
238is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239{
Gilles Peskine03af6782021-08-06 11:35:17 +0200240 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
241 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100242 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000243 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100244 set +f
245 case ${1#component_} in $pattern) return 0;; esac
246 done
247 set +f
248 return 1
249}
Andres AG7770ea82016-10-10 15:46:20 +0100250
Simon Butcher41eeccf2016-09-07 00:07:09 +0100251usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100252{
Gilles Peskine709346a2017-12-10 23:43:39 +0100253 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100254Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100255Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100256By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100257COMPONENT can be the name of a component or a shell wildcard pattern.
258
259Examples:
260 $0 "check_*"
261 Run all sanity checks.
262 $0 --no-armcc --except test_memsan
263 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100264
265Special options:
266 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000267 --list-all-components List all available test components and exit.
268 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269
270General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200271 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100272 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100273 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100274 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200275 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200276 --arm-none-eabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-none-eabi
278 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200279 --arm-linux-gnueabi-gcc-prefix=<string>
280 Prefix for a cross-compiler for arm-linux-gnueabi
281 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100282 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200283 --restore First clean up the build tree, restoring backed up
284 files. Do not run any components unless they are
285 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100286 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200287 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100288 --except Exclude the COMPONENTs listed on the command line,
289 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200290 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100291 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100292 --no-force Refuse to overwrite modified files (default).
293 --no-keep-going Stop at the first error (default).
294 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800295 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100296 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200297 --outcome-file=<path> File where test outcomes are written (not done if
298 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100299 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200300 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100301 -s|--seed Integer seed value to use for this test run.
302
303Tool path options:
304 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
305 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100306 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
307 --clang-latest=<Clang_latest_path> Latest version of clang available
308 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
309 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100310 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
311 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100312 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100313 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100314EOF
SimonB2e23c822016-04-16 21:54:39 +0100315}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100316
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200317# Cleanup before/after running a component.
318# Remove built files as well as the cmake cache/config.
319# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100320cleanup()
321{
David Horstmann76a77382023-08-17 17:32:26 +0100322 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100323 command make clean
324 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200325
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000327 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100328 -iname CMakeFiles -exec rm -rf {} \+ -o \
329 \( -iname cmake_install.cmake -o \
330 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200331 -iname CMakeCache.txt -o \
332 -path './cmake/*.cmake' \) -exec rm -f {} \+
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200333 # Remove Makefiles generated by in-tree CMake builds
334 rm -f 3rdparty/Makefile 3rdparty/*/Makefile pkgconfig/Makefile framework/Makefile
335 rm -f include/Makefile programs/!(fuzz)/Makefile
Ronald Cron30ea2b92024-06-11 14:07:09 +0200336 rm -f tf-psa-crypto/Makefile tf-psa-crypto/include/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200337
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100338 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
339 rm -rf programs/test/cmake_subproject/build
340 rm -f programs/test/cmake_subproject/Makefile
341 rm -f programs/test/cmake_subproject/cmake_subproject
342
Chris Kayd259e342021-03-25 16:03:25 +0000343 # Remove any artifacts from the component_test_cmake_as_package test.
344 rm -rf programs/test/cmake_package/build
345 rm -f programs/test/cmake_package/Makefile
346 rm -f programs/test/cmake_package/cmake_package
347
348 # Remove any artifacts from the component_test_cmake_as_installed_package test.
349 rm -rf programs/test/cmake_package_install/build
350 rm -f programs/test/cmake_package_install/Makefile
351 rm -f programs/test/cmake_package_install/cmake_package_install
352
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 # Restore files that may have been clobbered by the job
354 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200355 if [[ -e "$x$backup_suffix" ]]; then
356 cp -p "$x$backup_suffix" "$x"
357 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358 done
359}
John Durkopbd069d32020-10-31 22:14:03 -0700360
Valerio Setti9022f712024-06-27 07:59:39 +0200361# This is a helper function to be used in psasim builds. It is meant to clean
362# up the library's workspace after the server build and before the client
363# build. Built libraries (mbedcrypto, mbedx509 and mbedtls) are supposed to be
364# already copied to psasim folder at this point.
Valerio Settid8b59372024-07-02 12:02:25 +0200365helper_psasim_cleanup_before_client() {
Valerio Setti9022f712024-06-27 07:59:39 +0200366 # Clean up library files
367 make -C library clean
368 # Clean up intermediate files that were used to build the server
369 make -C $PSASIM_PATH clean_server_intermediate_files
370 # Restore files that were backup before building library files. This
371 # includes $CONFIG_H and $CRYPTO_CONFIG_H.
372 for x in $files_to_back_up; do
373 if [[ -e "$x$backup_suffix" ]]; then
374 cp -p "$x$backup_suffix" "$x"
375 fi
376 done
377}
378
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200379# Final cleanup when this script exits (except when exiting on a failure
380# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200381final_cleanup () {
382 cleanup
383
384 for x in $files_to_back_up; do
385 rm -f "$x$backup_suffix"
386 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100387}
388
Gilles Peskine7c652162017-12-11 00:01:40 +0100389# Executed on exit. May be redefined depending on command line options.
390final_report () {
391 :
392}
393
394fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200395 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100396 final_report $1
397 trap - $1
398 kill -$1 $$
399}
400
401trap 'fatal_signal HUP' HUP
402trap 'fatal_signal INT' INT
403trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200404
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200405# Number of processors on this machine. Used as the default setting
406# for parallel make.
407all_sh_nproc ()
408{
409 {
410 nproc || # Linux
411 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
412 sysctl -n hw.ncpu || # FreeBSD
413 echo 1
414 } 2>/dev/null
415}
416
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100417msg()
418{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100419 if [ -n "${current_component:-}" ]; then
420 current_section="${current_component#component_}: $1"
421 else
422 current_section="$1"
423 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200424
425 if [ $QUIET -eq 1 ]; then
426 return
427 fi
428
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100429 echo ""
430 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100431 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000432 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100433 echo "******************************************************************"
434}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100435
Gilles Peskine8f073122018-11-27 15:58:47 +0100436armc6_build_test()
437{
438 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100439
Gilles Peskine18487f62020-04-30 23:11:54 +0200440 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800441 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100442 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000443 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200444
445 msg "size: ARM Compiler 6 ($FLAGS)"
446 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100447}
Andres AGa5cd9732016-10-17 15:23:10 +0100448
Andres AGd9eba4b2016-08-26 14:42:14 +0100449err_msg()
450{
451 echo "$1" >&2
452}
453
454check_tools()
455{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200456 for tool in "$@"; do
457 if ! `type "$tool" >/dev/null 2>&1`; then
458 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100459 exit 1
460 fi
461 done
462}
463
Gilles Peskine8f073122018-11-27 15:58:47 +0100464pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000465 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100466 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100467 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100468 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200469 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000470 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100471
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000472 # Note that legacy options are ignored instead of being omitted from this
473 # list of options, so invocations that worked with previous version of
474 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100475 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100476 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200477 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200478 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200479 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000480 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100481 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
482 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100483 --clang-earliest) shift; CLANG_EARLIEST="$1";;
484 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100485 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000486 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100488 --gcc-earliest) shift; GCC_EARLIEST="$1";;
489 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200491 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
492 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 --gnutls-serv) shift; GNUTLS_SERV="$1";;
494 --help|-h) usage; exit;;
495 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000496 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100497 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100498 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200499 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000500 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100501 --no-force) FORCE=0;;
502 --no-keep-going) KEEP_GOING=0;;
503 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200504 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100505 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100506 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200507 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100508 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200509 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100510 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200511 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200512 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100513 --seed|-s) shift; SEED="$1";;
514 -*)
515 echo >&2 "Unknown option: $1"
516 echo >&2 "Run $0 --help for usage."
517 exit 120
518 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000519 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100520 esac
521 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100522 done
SimonB2e23c822016-04-16 21:54:39 +0100523
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100524 # Exclude components that are not supported on this platform.
525 SUPPORTED_COMPONENTS=
526 for component in $ALL_COMPONENTS; do
527 case $(type "support_$component" 2>&1) in
528 *' function'*)
529 if ! support_$component; then continue; fi;;
530 esac
531 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
532 done
533
534 if [ $list_components -eq 1 ]; then
535 printf '%s\n' $SUPPORTED_COMPONENTS
536 exit
537 fi
538
Gilles Peskinea28db922019-01-10 00:05:18 +0100539 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200540 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000541 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100542 fi
543
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000544 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
545 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100546 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000547 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100548 fi
SimonB2e23c822016-04-16 21:54:39 +0100549
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200550 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100551 if [ $all_except -eq 0 ]; then
552 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200553 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
554 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200555 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100556 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200557 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200558 # If the requested name includes a wildcard character, don't
559 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100560 case $component in
561 *[*?\[]*) continue;;
562 esac
563 case " $SUPPORTED_COMPONENTS " in
564 *" $component "*) :;;
565 *)
566 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
567 unsupported=$((unsupported + 1));;
568 esac
569 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200570 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100571 if [ $unsupported -ne 0 ]; then
572 exit 2
573 fi
574 fi
575
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000576 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100577 RUN_COMPONENTS=
578 for component in $SUPPORTED_COMPONENTS; do
579 if is_component_included "$component"; [ $? -eq $all_except ]; then
580 RUN_COMPONENTS="$RUN_COMPONENTS $component"
581 fi
582 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000583
584 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000585 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100586}
SimonB2e23c822016-04-16 21:54:39 +0100587
Gilles Peskine8f073122018-11-27 15:58:47 +0100588pre_check_git () {
589 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100590 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100591 git checkout-index -f -q $CONFIG_H
592 cleanup
593 else
SimonB2e23c822016-04-16 21:54:39 +0100594
Gilles Peskine8f073122018-11-27 15:58:47 +0100595 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
596 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
597 echo "You can either delete this directory manually, or force the test by rerunning"
598 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
599 exit 1
600 fi
601
Ronald Cron7a93ac52023-07-20 09:49:12 +0200602 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100603 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100604 echo "You can either delete or preserve your work, or force the test by rerunning the"
605 echo "script as: $0 --force"
606 exit 1
607 fi
SimonB2e23c822016-04-16 21:54:39 +0100608 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500609}
610
Gilles Peskine568f53a2021-07-12 18:16:01 +0200611pre_restore_files () {
612 # If the makefiles have been generated by a framework such as cmake,
613 # restore them from git. If the makefiles look like modifications from
614 # the ones checked into git, take care not to modify them. Whatever
615 # this function leaves behind is what the script will restore before
616 # each component.
617 case "$(head -n1 Makefile)" in
618 *[Gg]enerated*)
619 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
620 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
621 ;;
622 esac
623}
624
Gilles Peskinef83eb822020-03-30 20:11:39 +0200625pre_back_up () {
626 for x in $files_to_back_up; do
627 cp -p "$x" "$x$backup_suffix"
628 done
629}
630
Gilles Peskine8f073122018-11-27 15:58:47 +0100631pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100632 failure_count=0 # Number of failed components
633 last_failure_status=0 # Last failure status in this component
634
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100635 # See err_trap
636 previous_failure_status=0
637 previous_failed_command=
638 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100639 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100640
Gilles Peskine7c652162017-12-11 00:01:40 +0100641 start_red=
642 end_color=
643 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100644 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100645 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
646 start_red=$(printf '\033[31m')
647 end_color=$(printf '\033[0m')
648 ;;
649 esac
650 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100651
652 # Keep a summary of failures in a file. We'll print it out at the end.
653 failure_summary_file=$PWD/all-sh-failures-$$.log
654 : >"$failure_summary_file"
655
656 # Whether it makes sense to keep a component going after the specified
657 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200658 # This function normally receives the failing simple command
659 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
660 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100661 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200662 # False positives result in running things that can't be expected to
663 # work. False negatives result in things not running after something else
664 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100665 can_keep_going_after_failure () {
666 case "$1" in
667 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200668 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100669 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200670 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
671 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
672 *make*check*) true;;
673 "grep "*) true;;
674 "[ "*) true;;
675 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100676 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100677 esac
678 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100679
680 # This function runs if there is any error in a component.
681 # It must either exit with a nonzero status, or set
682 # last_failure_status to a nonzero value.
683 err_trap () {
684 # Save $? (status of the failing command). This must be the very
685 # first thing, before $? is overridden.
686 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100687 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100688
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100689 if [[ $last_failure_status -eq $previous_failure_status &&
690 "$failed_command" == "$previous_failed_command" &&
691 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
692 then
693 # The same command failed twice in a row, but this time one level
694 # less deep in the function call stack. This happens when the last
695 # command of a function returns a nonzero status, and the function
696 # returns that same status. Ignore the second failure.
697 previous_failure_funcall_depth=${#FUNCNAME[@]}
698 return
699 fi
700 previous_failure_status=$last_failure_status
701 previous_failed_command=$failed_command
702 previous_failure_funcall_depth=${#FUNCNAME[@]}
703
Gilles Peskinece266c42020-03-28 18:50:43 +0100704 text="$current_section: $failed_command -> $last_failure_status"
705 echo "${start_red}^^^^$text^^^^${end_color}" >&2
706 echo "$text" >>"$failure_summary_file"
707
708 # If the command is fatal (configure or build command), stop this
709 # component. Otherwise (test command) keep the component running
710 # (run more tests from the same build).
711 if ! can_keep_going_after_failure "$failed_command"; then
712 exit $last_failure_status
713 fi
714 }
715
Gilles Peskine7c652162017-12-11 00:01:40 +0100716 final_report () {
717 if [ $failure_count -gt 0 ]; then
718 echo
719 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100720 echo "${start_red}FAILED: $failure_count components${end_color}"
721 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100722 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
723 elif [ -z "${1-}" ]; then
724 echo "SUCCESS :)"
725 fi
726 if [ -n "${1-}" ]; then
727 echo "Killed by SIG$1."
728 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100729 rm -f "$failure_summary_file"
730 if [ $failure_count -gt 0 ]; then
731 exit 1
732 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100733 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100734}
735
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200736# record_status() and if_build_succeeded() are kept temporarily for backward
737# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100738record_status () {
739 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100740}
Gilles Peskine7c652162017-12-11 00:01:40 +0100741if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100742 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100743}
744
Gilles Peskinea681c592020-03-28 21:27:40 +0100745# '! true' does not trigger the ERR trap. Arrange to trigger it, with
746# a reasonably informative error message (not just "$@").
747not () {
748 if "$@"; then
749 report_failed_command="! $*"
750 false
751 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200752 fi
753}
754
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200755pre_prepare_outcome_file () {
756 case "$MBEDTLS_TEST_OUTCOME_FILE" in
757 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
758 esac
759 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
760 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
761 fi
762}
763
Gilles Peskine8f073122018-11-27 15:58:47 +0100764pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200765 if [ $QUIET -eq 1 ]; then
766 return
767 fi
768
Gilles Peskine8f073122018-11-27 15:58:47 +0100769 msg "info: $0 configuration"
770 echo "MEMORY: $MEMORY"
771 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200772 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100773 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100774 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100775 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100776 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
777 echo "GNUTLS_CLI: $GNUTLS_CLI"
778 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100779 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
780 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
781}
Andres AG7770ea82016-10-10 15:46:20 +0100782
Andres AGd9eba4b2016-08-26 14:42:14 +0100783# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100784pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000785 # Build the list of variables to pass to output_env.sh.
786 set env
SimonB2e23c822016-04-16 21:54:39 +0100787
Gilles Peskine87964262019-01-06 22:40:00 +0000788 case " $RUN_COMPONENTS " in
789 # Require OpenSSL and GnuTLS if running any tests (as opposed to
790 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
791 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100792 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000793 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
794 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100795 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000796 export GNUTLS_CLI="$GNUTLS_CLI"
797 export GNUTLS_SERV="$GNUTLS_SERV"
798 # Avoid passing --seed flag in every call to ssl-opt.sh
799 if [ -n "${SEED-}" ]; then
800 export SEED
801 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200802 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000803 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200804 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
805 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000806 ;;
807 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200808
Gilles Peskine87964262019-01-06 22:40:00 +0000809 case " $RUN_COMPONENTS " in
810 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
811 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100812
Gilles Peskine87964262019-01-06 22:40:00 +0000813 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200814 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000815 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100816
Gilles Peskine87964262019-01-06 22:40:00 +0000817 case " $RUN_COMPONENTS " in
818 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
819 esac
820
821 case " $RUN_COMPONENTS " in
822 *" test_zeroize "*) check_tools "gdb";;
823 esac
824
825 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000826 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000827 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
828 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200829 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000830 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
831 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200832 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
833 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
834 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000835 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000836
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200837 # past this point, no call to check_tool, only printing output
838 if [ $QUIET -eq 1 ]; then
839 return
840 fi
841
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000842 msg "info: output_env.sh"
843 case $RUN_COMPONENTS in
844 *_armcc*)
845 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
846 *) set "$@" RUN_ARMCC=0;;
847 esac
848 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100849}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100850
Gilles Peskine1570b592021-04-22 01:10:12 +0200851pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200852 # since make doesn't have proper dependencies, remove any possibly outdate
853 # file that might be around before generating fresh ones
854 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200855 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200856 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200857 else
858 make generated_files
859 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200860}
861
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000862clang_version() {
863 if command -v clang > /dev/null ; then
864 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
865 else
866 echo 0 # report version 0 for "no clang"
867 fi
868}
869
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200870################################################################
871#### Helpers for components using libtestdriver1
872################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100873
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200874# How to use libtestdriver1
875# -------------------------
876#
877# 1. Define the list algorithms and key types to accelerate,
878# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
879# Examples:
880# - loc_accel_list="ALG_JPAKE"
881# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200882# 2. Make configurations changes for the driver and/or main libraries.
883# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
884# can be either "default" to start with the default config, or a name
885# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200886# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200887# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
888# These changes affect both the driver and the main libraries.
889# (Note: they need to have the same set of PSA_WANT symbols, as that
890# determines the ABI between them.)
891# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
892# main libraries. Typically, you want to disable the module(s) that are
893# being accelerated. You may need to also disable modules that depend
894# on them or options that are not supported with drivers.
895# 2d. On top of psa/crypto_config.h, the driver library uses its own config
896# file: tests/include/test/drivers/config_test_driver.h. You usually
897# don't need to edit it: using loc_extra_list (see below) is preferred.
898# However, when there's no PSA symbol for what you want to enable,
899# calling scripts/config.py on this file remains the only option.
900# 3. Build the driver library, then the main libraries, test, and programs.
901# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
902# need to enable more algorithms here, typically hash algorithms when
903# accelerating some signature algorithms (ECDSA, RSAv2). This is done
904# by passing a 2nd argument listing the extra algorithms.
905# Example:
906# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
907# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800908# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200909# additional arguments will be passed to make: this can be useful if
910# you don't want to build everything when iterating during development.
911# Example:
912# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
913# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200914
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200915# Adjust the configuration - for both libtestdriver1 and main library,
916# as they should have the same PSA_WANT macros.
917helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200918 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200919 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200920 if [ "$base_config" != "default" ]; then
921 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200922 fi
923
924 # Enable PSA-based config (necessary to use drivers)
925 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
926
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200927 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
928 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
929 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000930
931 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
932 # otherwise we will end up running multithreaded tests without mutexes to protect them.
933 if scripts/config.py get MBEDTLS_THREADING_C; then
934 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
935 fi
936
937 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
938 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
939 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200940}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100941
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100942# Build the drivers library libtestdriver1.a (with ASan).
943#
944# Parameters:
945# 1. a space-separated list of things to accelerate;
946# 2. optional: a space-separate list of things to also support.
947# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
948helper_libtestdriver1_make_drivers() {
949 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
950 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
951}
952
953# Build the main libraries, programs and tests,
954# linking to the drivers library (with ASan).
955#
956# Parameters:
957# 1. a space-separated list of things to accelerate;
958# *. remaining arguments if any are passed directly to make
959# (examples: lib, -C tests test_suite_xxx, etc.)
960# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
961helper_libtestdriver1_make_main() {
962 loc_accel_list=$1
963 shift
964
965 # we need flags both with and without the LIBTESTDRIVER1_ prefix
966 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
967 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
968 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
969}
970
Valerio Setti9022f712024-06-27 07:59:39 +0200971# Set some default values $CONFIG_H in order to build server or client sides
972# in PSASIM. There is only 1 mandatory parameter:
973# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200974helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200975 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200976
Valerio Settid1b6ef12024-05-07 16:00:21 +0200977 if [ "$TARGET" == "client" ]; then
978 scripts/config.py full
979 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
980 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
981 # Dynamic secure element support is a deprecated feature and it is not
982 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
983 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
984 # Disable potentially problematic features
985 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
986 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
987 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
988 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
989 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100990 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200991 else
992 scripts/config.py crypto_full
993 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100994 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
995 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
996 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
997 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200998 fi
Valerio Setti9022f712024-06-27 07:59:39 +0200999}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001000
Valerio Setti9022f712024-06-27 07:59:39 +02001001# Helper to build the libraries for client/server in PSASIM. If the server is
1002# being built, then it builds also the final executable.
1003# There is only 1 mandatory parameter:
1004# - $1: target which can be "client" or "server"
1005helper_psasim_build() {
1006 TARGET=$1
1007 shift
1008 TARGET_LIB=${TARGET}_libs
1009
1010 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1011
1012 # Build also the server application after its libraries have been built.
1013 if [ "$TARGET" == "server" ]; then
1014 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1015 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001016}
1017
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001018################################################################
1019#### Configuration helpers
1020################################################################
1021
Valerio Settib2fd6732023-08-15 17:10:47 +02001022# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001023# The function optionally accepts 1 parameter: a space-separated list of the
1024# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001025helper_disable_builtin_curves() {
1026 allowed_list="${1:-}"
1027 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1028
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001029 for curve in $allowed_list; do
1030 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001031 done
1032}
1033
1034# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1035# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1036# in the following helpers.
1037helper_get_psa_curve_list () {
1038 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001039 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1040 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001041 done
1042
1043 echo "$loc_list"
1044}
1045
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001046# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1047# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1048# in the following helpers.
1049helper_get_psa_dh_group_list () {
1050 loc_list=""
1051 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1052 loc_list="$loc_list $item"
1053 done
1054
1055 echo "$loc_list"
1056}
1057
Valerio Settib2fd6732023-08-15 17:10:47 +02001058# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001059# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001060# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001061helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001062 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001063 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001064 for item in $(sed -n "s/^#define PSA_WANT_\(KEY_TYPE_${key_type}_[0-9A-Z_a-z]*\).*/\1/p" <"$CRYPTO_CONFIG_H"); do
Valerio Settib2fd6732023-08-15 17:10:47 +02001065 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1066 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001067 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1068 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001069 fi
1070 done
1071
1072 echo "$loc_list"
1073}
1074
Valerio Setti9022f712024-06-27 07:59:39 +02001075# Helper function for controlling (start & stop) the psasim server.
1076helper_psasim_server() {
1077 OPERATION=$1
1078 if [ "$OPERATION" == "start" ]; then
1079 (
1080 cd tests
1081 msg "start server"
1082 psa-client-server/psasim/test/start_server.sh
1083 )
1084 else
1085 (
1086 cd tests
1087 msg "terminate server and cleanup"
1088 psa-client-server/psasim//test/kill_server.sh
1089 )
1090 fi
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02001091}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001092
1093################################################################
1094#### Basic checks
1095################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001096
1097#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001098# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001099#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001100# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001101# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001102# and/or are more likely to fail than others (eg I use Clang most of the
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001103# time, so start with a GCC build).
1104# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001105#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001106# Indicative running times are given for reference.
1107
Gilles Peskine8f073122018-11-27 15:58:47 +01001108component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001109 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001110 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001111}
Janos Follathb72c6782016-07-19 14:54:17 +01001112
Gilles Peskine67debb62021-05-18 16:09:50 +02001113component_check_generated_files () {
1114 msg "Check: check-generated-files, files generated with make" # 2s
1115 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001116 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001117
1118 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001119 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001120 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001121 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001122
1123 msg "Check: check-generated-files -u, files absent" # 2s
1124 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001125 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001126 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001127 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001128
1129 # This component ends with the generated files present in the source tree.
1130 # This is necessary for subsequent components!
1131}
1132
Gilles Peskine8f073122018-11-27 15:58:47 +01001133component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001134 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001135 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001136}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001137
Gilles Peskine8f073122018-11-27 15:58:47 +01001138component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001139 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001140 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001141}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001142
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001143component_check_changelog () {
1144 msg "Check: changelog entries" # < 1s
1145 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001146 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001147 if [ -e ChangeLog.new ]; then
1148 # Show the diff for information. It isn't an error if the diff is
1149 # non-empty.
1150 diff -u ChangeLog ChangeLog.new || true
1151 rm ChangeLog.new
1152 fi
1153}
1154
Gilles Peskine8f073122018-11-27 15:58:47 +01001155component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001156 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001157 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001158}
Darryl Greena07039c2018-03-13 16:48:16 +00001159
Gilles Peskine895868b2019-09-19 21:30:05 +02001160component_check_test_cases () {
1161 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001162 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001163 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001164 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001165 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001166 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001167 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001168 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001169}
1170
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001171component_check_test_dependencies () {
1172 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001173 # The purpose of this component is to catch unjustified dependencies on
1174 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1175 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1176 # MBEDTLS_PSA_xxx).
1177 #
1178 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1179 # this component is meant to catch. However a few of them are justified,
1180 # mostly by the absence of a PSA equivalent, so this component includes a
1181 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001182
1183 found="check-test-deps-found-$$"
1184 expected="check-test-deps-expected-$$"
1185
1186 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001187 grep 'depends_on' \
1188 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001189 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001190 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001191 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001192
Yanray Wang18040ed2023-11-23 21:29:56 +08001193 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001194 rm -f $expected
1195 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1196 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001197 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1198 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001199 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1200 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001201 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1202 # the test code and that's probably the most convenient way of achieving
1203 # the test's goal.
1204 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1205 # No PSA equivalent - we should probably have one in the future.
1206 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1207 # No PSA equivalent - needed by some init tests
1208 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001209 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001210 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001211
1212 # Compare reality with expectation.
1213 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001214 #
1215 # The output should be empty. When it's not:
1216 # - Each '+' line is a macro that was found but not expected. You want to
1217 # find where that macro occurs, and either replace it with PSA macros, or
1218 # add it to the exceptions list above with a justification.
1219 # - Each '-' line is a macro that was expected but not found; it means the
1220 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001221 diff -U0 $expected $found
1222
1223 rm $found $expected
1224}
1225
Gilles Peskine8f073122018-11-27 15:58:47 +01001226component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001227 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001228 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001229}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001230
Gilles Peskine192c72f2017-12-21 15:59:21 +01001231
Gilles Peskine636c26a2020-03-04 20:46:15 +01001232
Gilles Peskine192c72f2017-12-21 15:59:21 +01001233################################################################
1234#### Build and test many configurations and targets
1235################################################################
1236
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001237component_test_default_out_of_box () {
1238 msg "build: make, default config (out-of-box)" # ~1min
1239 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001240 # Disable fancy stuff
1241 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001242
1243 msg "test: main suites make, default config (out-of-box)" # ~10s
1244 make test
1245
1246 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001247 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001248
1249 msg "program demos: make, default config (out-of-box)" # ~10s
1250 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001251}
1252
Gilles Peskine8f073122018-11-27 15:58:47 +01001253component_test_default_cmake_gcc_asan () {
1254 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001255 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1256 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001257
Gilles Peskine8f073122018-11-27 15:58:47 +01001258 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1259 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001260
Gilles Peskine82b27272019-06-14 18:27:03 +02001261 msg "program demos (ASan build)" # ~10s
1262 tests/scripts/run_demos.py
1263
Gilles Peskine97bea012020-04-23 23:37:45 +02001264 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001265 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001266
Gilles Peskine6848d172023-11-02 19:58:03 +01001267 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001268 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001269
Gilles Peskine8f073122018-11-27 15:58:47 +01001270 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001271 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001272
Gilles Peskine8f073122018-11-27 15:58:47 +01001273 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001274 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001275
1276 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001277 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001278}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001279
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001280component_test_default_cmake_gcc_asan_new_bignum () {
1281 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001282 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001283 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001284 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001285
1286 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1287 make test
1288
1289 msg "test: selftest (ASan build)" # ~ 10s
1290 programs/test/selftest
1291
1292 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1293 tests/ssl-opt.sh
1294
1295 msg "test: compat.sh (ASan build)" # ~ 6 min
1296 tests/compat.sh
1297
1298 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1299 tests/context-info.sh
1300}
1301
Hanno Becker01635512019-02-26 14:27:09 +00001302component_test_full_cmake_gcc_asan () {
1303 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001304 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001305 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1306 make
1307
1308 msg "test: main suites (inc. selftests) (full config, ASan build)"
1309 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001310
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001311 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001312 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001313
Gilles Peskine636c26a2020-03-04 20:46:15 +01001314 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001315 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001316
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001317 # Note: the next two invocations cover all compat.sh test cases.
1318 # We should use the same here and in basic-build-test.sh.
1319 msg "test: compat.sh: default version (full config, ASan build)"
1320 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001321
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001322 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1323 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001324
1325 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001326 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001327}
1328
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001329
1330component_test_full_cmake_gcc_asan_new_bignum () {
1331 msg "build: full config, cmake, gcc, ASan"
1332 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001333 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001334 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001335 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001336
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001337 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001338 make test
1339
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001340 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001341 programs/test/selftest
1342
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001343 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001344 tests/ssl-opt.sh
1345
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001346 # Note: the next two invocations cover all compat.sh test cases.
1347 # We should use the same here and in basic-build-test.sh.
1348 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1349 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001350
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001351 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1352 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001353
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001354 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001355 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001356}
1357
Ronald Cronc3623db2020-10-29 10:51:32 +01001358component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001359 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001360 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001361 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1362 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1363 make
1364
1365 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1366 make test
1367}
1368
David Horstmann4a48bec2024-03-13 15:42:31 +00001369component_test_psa_assume_exclusive_buffers () {
1370 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001371 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001372 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001373 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1374 make
1375
David Horstmann4a48bec2024-03-13 15:42:31 +00001376 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001377 make test
1378}
1379
Gilles Peskinea3548672021-06-17 11:37:52 +02001380# check_renamed_symbols HEADER LIB
1381# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1382# name is LIB.
1383check_renamed_symbols () {
1384 ! nm "$2" | sed 's/.* //' |
1385 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1386}
1387
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001388component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001389 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001390 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001391 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1392 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1393 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1394 # We can only compile, not link, since our test and sample programs
1395 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1396 # is active.
1397 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001398
1399 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1400 # version is not present.
1401 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001402 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001403}
1404
Ryan Everettdaa322a2024-04-18 16:48:55 +01001405component_test_no_rsa_key_pair_generation() {
1406 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001407 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001408 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001409 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001410 make
1411
Ryan Everettdaa322a2024-04-18 16:48:55 +01001412 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001413 make test
1414}
1415
Gilles Peskine782f4112018-11-27 16:11:09 +01001416component_test_ref_configs () {
1417 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001418 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1419 # want to re-generate generated files that depend on it, quite correctly.
1420 # However this doesn't work as the generation script expects a specific
1421 # format for mbedtls_config.h, which the other files don't follow. Also,
1422 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001423 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001424 # whether they're on or off. So, disable cmake's (over-sensitive here)
1425 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001426 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001427 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001428 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001429}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001430
Gilles Peskine8f073122018-11-27 15:58:47 +01001431component_test_no_renegotiation () {
1432 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001433 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001434 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001435 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001436
Gilles Peskine8f073122018-11-27 15:58:47 +01001437 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1438 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001439
Gilles Peskine8f073122018-11-27 15:58:47 +01001440 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001441 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001442}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001443
Gilles Peskine636c26a2020-03-04 20:46:15 +01001444component_test_no_pem_no_fs () {
1445 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1446 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1447 scripts/config.py unset MBEDTLS_FS_IO
1448 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1449 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001450 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001451 make
1452
1453 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1454 make test
1455
1456 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001457 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001458}
1459
Gilles Peskine8f073122018-11-27 15:58:47 +01001460component_test_rsa_no_crt () {
1461 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001462 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001463 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001464 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001465
Gilles Peskine8f073122018-11-27 15:58:47 +01001466 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1467 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001468
Gilles Peskine8f073122018-11-27 15:58:47 +01001469 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001470 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001471
Gilles Peskine8f073122018-11-27 15:58:47 +01001472 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001473 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001474
1475 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001476 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001477}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001478
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001479component_test_no_ctr_drbg_classic () {
1480 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001481 scripts/config.py full
1482 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001483 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001484 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001485
Dave Rodgman17127e92023-12-14 16:42:48 +00001486 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001487 make
1488
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001489 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001490 make test
1491
Gilles Peskineba749042021-01-13 20:02:03 +01001492 # In this configuration, the TLS test programs use HMAC_DRBG.
1493 # The SSL tests are slow, so run a small subset, just enough to get
1494 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001495 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001496 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001497
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001498 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001499 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001500}
1501
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502component_test_no_ctr_drbg_use_psa () {
1503 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001504 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1506 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001507
Dave Rodgman17127e92023-12-14 16:42:48 +00001508 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001509 make
1510
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001511 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1512 make test
1513
1514 # In this configuration, the TLS test programs use HMAC_DRBG.
1515 # The SSL tests are slow, so run a small subset, just enough to get
1516 # confidence that the SSL code copes with HMAC_DRBG.
1517 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001518 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001519
1520 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001521 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001522}
1523
1524component_test_no_hmac_drbg_classic () {
1525 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1526 scripts/config.py full
1527 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1528 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1529 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001530 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531
Dave Rodgman17127e92023-12-14 16:42:48 +00001532 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001533 make
1534
1535 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001536 make test
1537
Gilles Peskinea2224342020-11-19 22:14:34 +01001538 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1539 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1540 # instead.
1541 # Test SSL with non-deterministic ECDSA. Only test features that
1542 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001543 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001544 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001545
1546 # To save time, only test one protocol version, since this part of
1547 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001548 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001549 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001550}
1551
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001552component_test_no_hmac_drbg_use_psa () {
1553 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1554 scripts/config.py full
1555 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1556 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1557 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1558
Dave Rodgman17127e92023-12-14 16:42:48 +00001559 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001560 make
1561
1562 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1563 make test
1564
1565 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1566 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1567 # instead.
1568 # Test SSL with non-deterministic ECDSA. Only test features that
1569 # might be affected by how ECDSA signature is performed.
1570 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001571 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001572
1573 # To save time, only test one protocol version, since this part of
1574 # the protocol is identical in (D)TLS up to 1.2.
1575 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001576 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001577}
1578
1579component_test_psa_external_rng_no_drbg_classic () {
1580 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1581 scripts/config.py full
1582 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001583 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001585 scripts/config.py unset MBEDTLS_ENTROPY_C
1586 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1587 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001588 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1589 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1590 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001591 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1592 # the SSL test programs don't have an RNG and can't work. Explicitly
1593 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001594 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001595
1596 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1597 make test
1598
Gilles Peskine8eb29432021-02-03 20:07:11 +01001599 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001600 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001601}
1602
1603component_test_psa_external_rng_no_drbg_use_psa () {
1604 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001605 scripts/config.py full
1606 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001607 scripts/config.py unset MBEDTLS_ENTROPY_C
1608 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1609 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001610 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1611 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1612 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001613 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001614
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001615 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001616 make test
1617
Gilles Peskine8eb29432021-02-03 20:07:11 +01001618 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001619 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001620}
1621
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001622component_test_psa_external_rng_use_psa_crypto () {
1623 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1624 scripts/config.py full
1625 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1626 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1627 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001628 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001629
1630 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1631 make test
1632
1633 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1634 tests/ssl-opt.sh -f 'Default\|opaque'
1635}
1636
Gilles Peskine801c4332023-04-28 21:04:28 +02001637component_test_psa_inject_entropy () {
1638 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1639 scripts/config.py full
1640 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1641 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1642 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1643 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1644 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1645 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001646 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine801c4332023-04-28 21:04:28 +02001647
1648 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1649 make test
1650}
1651
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001652component_test_sw_inet_pton () {
1653 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1654
1655 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1656 scripts/config.py set MBEDTLS_TEST_HOOKS
1657 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1658
1659 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1660 make test
1661}
1662
Valerio Settia41654d2024-02-08 10:33:11 +01001663component_full_no_pkparse_pkwrite() {
1664 msg "build: full without pkparse and pkwrite"
1665
1666 scripts/config.py crypto_full
1667 scripts/config.py unset MBEDTLS_PK_PARSE_C
1668 scripts/config.py unset MBEDTLS_PK_WRITE_C
1669
Valerio Settia41654d2024-02-08 10:33:11 +01001670 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1671
1672 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1673 not grep mbedtls_pk_parse_key library/pkparse.o
1674 not grep mbedtls_pk_write_key_der library/pkwrite.o
1675
1676 msg "test: full without pkparse and pkwrite"
1677 make test
1678}
1679
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001680component_test_crypto_full_md_light_only () {
1681 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001682 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001683
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001684 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001685 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001686 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001687 scripts/config.py unset MBEDTLS_HKDF_C
1688 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001689 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001690 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001691 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001692 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001693 # Disable things that would auto-enable MD_C
1694 scripts/config.py unset MBEDTLS_PKCS5_C
1695
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001696 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1697 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001698 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001699
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001700 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001701 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001702 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001703
1704 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001705 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001706}
1707
Ronald Cron8dbea482024-05-23 16:04:11 +02001708component_test_full_no_cipher () {
1709 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001710
1711 scripts/config.py full
1712 scripts/config.py unset MBEDTLS_CIPHER_C
1713
Ronald Cron8dbea482024-05-23 16:04:11 +02001714 # The built-in implementation of the following algs/key-types depends
1715 # on CIPHER_C so we disable them.
1716 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1717 # so we keep them enabled.
1718 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1719 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1720 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1721 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1722 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1723 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1724 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1725 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1726 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1727 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1729
Valerio Settic84d9402023-10-23 14:58:25 +02001730 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001731 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001732 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001733
Gilles Peskine21570cf2023-12-22 11:49:50 +01001734 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001735
Valerio Setti7e710e82023-08-25 09:14:15 +02001736 # Ensure that CIPHER_C was not re-enabled
1737 not grep mbedtls_cipher_init library/cipher.o
1738
Ronald Cron8dbea482024-05-23 16:04:11 +02001739 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001740 make test
1741}
1742
Valerio Settibdfecb62023-11-07 15:37:20 +01001743component_test_full_no_ccm() {
1744 msg "build: full no PSA_WANT_ALG_CCM"
1745
1746 # Full config enables:
1747 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1748 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1749 scripts/config.py full
1750
1751 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1752 # enabled, but not used from TLS since USE_PSA is set.
1753 # This is helpful to ensure that TLS tests below have proper dependencies.
1754 #
1755 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1756 # PSA_WANT_ALG_CCM to be re-enabled.
1757 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1758
Gilles Peskine21570cf2023-12-22 11:49:50 +01001759 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001760
1761 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001762 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001763}
1764
1765component_test_full_no_ccm_star_no_tag() {
1766 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1767
1768 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1769 scripts/config.py full
1770
1771 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1772 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1773 # This basically disables all unauthenticated ciphers on the PSA side, while
1774 # keeping AEADs enabled.
1775 #
1776 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1777 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1778 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1779 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1780 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1781 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1782 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1783 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1784 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1785 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1786
Gilles Peskine21570cf2023-12-22 11:49:50 +01001787 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001788
1789 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001790 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001791
1792 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001793 make test
1794}
1795
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001796component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001797 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001798
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001799 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001800 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001801 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001802 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001803 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001804 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1805 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001806 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001807 scripts/config.py unset MBEDTLS_GCM_C
1808 scripts/config.py unset MBEDTLS_CCM_C
1809 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001810 #Disable TLS 1.3 (as no AEAD)
1811 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001812 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1813 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1814 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001815 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney67338c02024-05-09 15:21:14 +01001816 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001817 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001818 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001819 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001820 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1821 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001822 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001823 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001824 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001825
Przemek Stekiel9550c052022-09-28 09:51:55 +02001826 make
1827
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001828 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001829 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001830
1831 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001832}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001833
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001834component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001835 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001836
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001837 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001838 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001839 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001840 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001841 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001842 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1843 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001844 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001845 scripts/config.py unset MBEDTLS_GCM_C
1846 scripts/config.py unset MBEDTLS_CCM_C
1847 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001848 #Disable TLS 1.3 (as no AEAD)
1849 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001850 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney62586212024-04-26 17:01:16 +01001851 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001852 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001853 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001854 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001855 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001856 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001857 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001858 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001859
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001860 make
1861
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001862 msg "test: default with only CBC-legacy cipher use psa"
1863 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001864
1865 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1866 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001867}
1868
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001869component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001870 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001871
1872 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001873 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001874 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001875 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001876 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001877 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1878 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001879 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001880 scripts/config.py unset MBEDTLS_GCM_C
1881 scripts/config.py unset MBEDTLS_CCM_C
1882 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001883 #Disable TLS 1.3 (as no AEAD)
1884 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001885 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001886 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001887 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1888 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1889 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001890 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001891 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001892 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001893 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001894
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001895 make
1896
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001897 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001898 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001899
1900 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1901 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001902}
1903
Valerio Setti9f0ec532022-11-08 13:03:24 +01001904# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1905# that we could use for interop testing. However, we now have sort of two
1906# implementations ourselves: one using PSA, the other not. At least test that
1907# these two interoperate with each other.
1908component_test_tls1_2_ecjpake_compatibility() {
1909 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1910 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001911 # Explicitly make lib first to avoid a race condition:
1912 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1913 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001914 make -C programs ssl/ssl_server2 ssl/ssl_client2
1915 cp programs/ssl/ssl_server2 s2_no_use_psa
1916 cp programs/ssl/ssl_client2 c2_no_use_psa
1917
1918 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1919 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1920 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001921 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001922 make -C programs ssl/ssl_server2 ssl/ssl_client2
1923 make -C programs test/udp_proxy test/query_compile_time_config
1924
Valerio Setti70e02902022-12-02 16:21:56 +01001925 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1926 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1927 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1928 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1929 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1930 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1931 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1932 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password server only, working, TLS"
Valerio Setti9f0ec532022-11-08 13:03:24 +01001933
1934 rm s2_no_use_psa c2_no_use_psa
1935}
1936
Gilles Peskine636c26a2020-03-04 20:46:15 +01001937component_test_everest () {
1938 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001939 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1940 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1941 make
1942
1943 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1944 make test
1945
Gilles Peskine6848d172023-11-02 19:58:03 +01001946 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001947 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001948
Gilles Peskine636c26a2020-03-04 20:46:15 +01001949 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001950 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001951
1952 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1953 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001954 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001955}
1956
Gilles Peskined3beca92020-07-03 00:15:37 +02001957component_test_everest_curve25519_only () {
1958 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001959 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001960 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1961 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001962 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1963 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1964 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1966 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001967 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001968 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1969
Gilles Peskined3beca92020-07-03 00:15:37 +02001970 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001971 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001972 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
1973 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02001974
Dave Rodgman17127e92023-12-14 16:42:48 +00001975 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001976
1977 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1978 make test
1979}
1980
Gilles Peskine8f073122018-11-27 15:58:47 +01001981component_test_small_ssl_out_content_len () {
1982 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001983 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1984 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001985 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001986 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001987
Gilles Peskine8f073122018-11-27 15:58:47 +01001988 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001989 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001990}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001991
Gilles Peskine8f073122018-11-27 15:58:47 +01001992component_test_small_ssl_in_content_len () {
1993 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001994 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
1995 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00001996 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001997 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001998
Gilles Peskine8f073122018-11-27 15:58:47 +01001999 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002000 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002001}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002002
Gilles Peskine8f073122018-11-27 15:58:47 +01002003component_test_small_ssl_dtls_max_buffering () {
2004 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002005 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002006 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002007 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002008
Gilles Peskine8f073122018-11-27 15:58:47 +01002009 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002010 tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
Gilles Peskine8f073122018-11-27 15:58:47 +01002011}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002012
Gilles Peskine8f073122018-11-27 15:58:47 +01002013component_test_small_mbedtls_ssl_dtls_max_buffering () {
2014 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002015 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002016 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002017 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002018
Gilles Peskine8f073122018-11-27 15:58:47 +01002019 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002020 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002021}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002022
Gilles Peskine75cc7712019-09-06 19:47:17 +02002023component_test_psa_collect_statuses () {
2024 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002025 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002026 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002027 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002028 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002029 rm -f tests/statuses.log
2030}
2031
Gilles Peskine8f073122018-11-27 15:58:47 +01002032component_test_full_cmake_clang () {
2033 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002034 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002035 CC=clang CXX=clang cmake -D CMAKE_BUILD_TYPE:String=Release -D ENABLE_TESTING=On -D TEST_CPP=1 .
Gilles Peskine8f073122018-11-27 15:58:47 +01002036 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002037
k-stachowiak0291cb72019-06-26 15:52:12 +02002038 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002039 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002040
Gilles Peskineda6017c2022-10-30 21:02:40 +01002041 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2042 programs/test/cpp_dummy_build
2043
Gilles Peskine6848d172023-11-02 19:58:03 +01002044 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002045 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002046
Gilles Peskine82b27272019-06-14 18:27:03 +02002047 msg "program demos (full config, clang)" # ~10s
2048 tests/scripts/run_demos.py
2049
k-stachowiak0291cb72019-06-26 15:52:12 +02002050 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002051 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002052
Gilles Peskine8f073122018-11-27 15:58:47 +01002053 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002054 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002055}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002056
Gilles Peskine0c671602022-11-29 16:01:41 +01002057skip_suites_without_constant_flow () {
2058 # Skip the test suites that don't have any constant-flow annotations.
2059 # This will need to be adjusted if we ever start declaring things as
2060 # secret from macros or functions inside tests/include or tests/src.
2061 SKIP_TEST_SUITES=$(
2062 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2063 sed 's/test_suite_//; s/\.function$//' |
2064 tr '\n' ,)
2065 export SKIP_TEST_SUITES
2066}
2067
Dave Rodgman246210e2023-07-31 18:07:44 +01002068skip_all_except_given_suite () {
2069 # Skip all but the given test suite
2070 SKIP_TEST_SUITES=$(
2071 ls -1 tests/suites/test_suite_*.function |
2072 grep -v $1.function |
2073 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2074 tr '\n' ,)
2075 export SKIP_TEST_SUITES
2076}
2077
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002078component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002079 # This tests both (1) accesses to undefined memory, and (2) branches or
2080 # memory access depending on secret values. To distinguish between those:
2081 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2082 # - or alternatively, change the build type to MemSanDbg, which enables
2083 # origin tracking and nicer stack traces (which are useful for debugging
2084 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002085 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2086 scripts/config.py full
2087 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2088 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2089 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Elena Uziunaite66ea31c2024-06-28 14:54:09 +01002090 scripts/config.py unset MBEDTLS_HAVE_ASM
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002091 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2092 make
2093
2094 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2095 make test
2096}
2097
2098component_test_memsan_constant_flow_psa () {
2099 # This tests both (1) accesses to undefined memory, and (2) branches or
2100 # memory access depending on secret values. To distinguish between those:
2101 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2102 # - or alternatively, change the build type to MemSanDbg, which enables
2103 # origin tracking and nicer stack traces (which are useful for debugging
2104 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002105 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002106 scripts/config.py full
2107 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2108 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Elena Uziunaite66ea31c2024-06-28 14:54:09 +01002109 scripts/config.py unset MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002110 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2111 make
2112
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002113 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002114 make test
2115}
2116
Bence Szépkúti0354d042023-12-06 16:14:37 +01002117component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002118 # This tests both (1) everything that valgrind's memcheck usually checks
2119 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2120 # etc.) and (2) branches or memory access depending on secret values,
2121 # which will be reported as uninitialized memory. To distinguish between
2122 # secret and actually uninitialized:
2123 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2124 # - or alternatively, build with debug info and manually run the offending
2125 # test suite with valgrind --track-origins=yes, then check if the origin
2126 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002127 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2128 scripts/config.py full
2129 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2130 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002131 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002132 cmake -D CMAKE_BUILD_TYPE:String=Release .
2133 make
2134
2135 # this only shows a summary of the results (how many of each type)
2136 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002137 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002138 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002139
2140 # Test asm path in constant time module - by default, it will test the plain C
2141 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2142 msg "test: valgrind asm constant_time"
2143 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2144 skip_all_except_given_suite test_suite_constant_time
2145 cmake -D CMAKE_BUILD_TYPE:String=Release .
2146 make clean
2147 make
2148 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002149}
2150
Bence Szépkúti0354d042023-12-06 16:14:37 +01002151component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002152 # This tests both (1) everything that valgrind's memcheck usually checks
2153 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2154 # etc.) and (2) branches or memory access depending on secret values,
2155 # which will be reported as uninitialized memory. To distinguish between
2156 # secret and actually uninitialized:
2157 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2158 # - or alternatively, build with debug info and manually run the offending
2159 # test suite with valgrind --track-origins=yes, then check if the origin
2160 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002161 msg "build: cmake release GCC, full config with constant flow testing"
2162 scripts/config.py full
2163 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002164 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002165 cmake -D CMAKE_BUILD_TYPE:String=Release .
2166 make
2167
2168 # this only shows a summary of the results (how many of each type)
2169 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002170 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002171 make memcheck
2172}
2173
Janos Follath9338cac2023-10-04 18:55:39 +01002174component_test_tsan () {
2175 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002176 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002177 scripts/config.py set MBEDTLS_THREADING_C
2178 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002179 # Self-tests do not currently use multiple threads.
2180 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002181
Ryan6caf84f2024-03-05 13:57:00 +00002182 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2183 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2184
Janos Follath9338cac2023-10-04 18:55:39 +01002185 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2186 make
2187
2188 msg "test: main suites (TSan)"
2189 make test
2190}
2191
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002192component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002193 # Test that removing the deprecated features from the default
2194 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002195 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2196 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002197 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002198
2199 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2200 make test
2201}
2202
2203component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002204 msg "build: make, full_no_deprecated config" # ~ 30s
2205 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002206 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002207
Gilles Peskine30de2e82020-04-20 21:39:22 +02002208 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002209 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002210
2211 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2212 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002213}
2214
Gilles Peskine8386ea22020-04-30 09:07:29 +02002215component_test_full_no_deprecated_deprecated_warning () {
2216 # Test that there is nothing deprecated in "full_no_deprecated".
2217 # A deprecated feature would trigger a warning (made fatal) from
2218 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002219 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2220 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002221 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2222 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002223 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002224
Gilles Peskine30de2e82020-04-20 21:39:22 +02002225 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002226 make test
2227}
2228
Gilles Peskine8386ea22020-04-30 09:07:29 +02002229component_test_full_deprecated_warning () {
2230 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2231 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002232 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002233 scripts/config.py full
2234 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002235 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002236 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2237 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002238 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002239
Gilles Peskine8386ea22020-04-30 09:07:29 +02002240 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2241 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2242 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002243 # Expect warnings from '#warning' directives in check_config.h and
2244 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002245 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=deprecated-declarations -Wno-error=cpp -DMBEDTLS_TEST_DEPRECATED' tests
Gilles Peskine841b14b2019-11-26 17:37:37 +01002246
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002247 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2248 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002249
2250 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2251 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002252}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002253
Gilles Peskineec541fe2020-01-31 14:24:14 +01002254# Check that the specified libraries exist and are empty.
2255are_empty_libraries () {
2256 nm "$@" >/dev/null 2>/dev/null
2257 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2258}
2259
2260component_build_crypto_default () {
2261 msg "build: make, crypto only"
2262 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002263 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002264 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002265}
2266
2267component_build_crypto_full () {
2268 msg "build: make, crypto only, full config"
2269 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002270 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002271 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002272}
2273
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002274component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002275 msg "build: make, config for PSA crypto service"
2276 scripts/config.py crypto
2277 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2278 # Disable things that are not needed for just cryptography, to
2279 # reach a configuration that would be typical for a PSA cryptography
2280 # service providing all implemented PSA algorithms.
2281 # System stuff
2282 scripts/config.py unset MBEDTLS_ERROR_C
2283 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002284 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002285 # Crypto stuff with no PSA interface
2286 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002287 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002288 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002289 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002290 scripts/config.py unset MBEDTLS_NIST_KW_C
2291 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2292 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2293 scripts/config.py unset MBEDTLS_PKCS12_C
2294 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002295 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2296 # in PSA code to work with RSA keys. We don't require users to set those:
2297 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002298 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002299 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002300 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002301 make CFLAGS='-O1 -Werror' all test
2302 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2303}
2304
Gilles Peskineec541fe2020-01-31 14:24:14 +01002305component_build_crypto_baremetal () {
2306 msg "build: make, crypto only, baremetal config"
2307 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002308 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002309 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002310}
Daniel Axtens446af202020-09-02 21:30:13 +10002311support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002312 support_build_baremetal "$@"
2313}
2314
2315component_build_baremetal () {
2316 msg "build: make, baremetal config"
2317 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002318 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002319}
2320support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002321 # Older Glibc versions include time.h from other headers such as stdlib.h,
2322 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2323 # problem, Ubuntu 18.04 is ok.
2324 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2325}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002326
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002327# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002328component_test_depends_py_cipher_id () {
2329 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002330 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002331}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002332
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002333component_test_depends_py_cipher_chaining () {
2334 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002335 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002336}
2337
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002338component_test_depends_py_cipher_padding () {
2339 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002340 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002341}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002342
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002343component_test_depends_py_curves () {
2344 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002345 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002346}
2347
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002348component_test_depends_py_hashes () {
2349 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002350 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002351}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002352
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002353component_test_depends_py_kex () {
2354 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002355 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002356}
2357
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002358component_test_depends_py_pkalgs () {
2359 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002360 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002361}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002362
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002363# PSA equivalents of the depends.py tests
2364component_test_depends_py_cipher_id_psa () {
2365 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002366 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002367}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002368
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002369component_test_depends_py_cipher_chaining_psa () {
2370 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002371 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002372}
2373
2374component_test_depends_py_cipher_padding_psa () {
2375 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002376 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002377}
2378
2379component_test_depends_py_curves_psa () {
2380 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002381 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002382}
2383
2384component_test_depends_py_hashes_psa () {
2385 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002386 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002387}
2388
2389component_test_depends_py_kex_psa () {
2390 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002391 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002392}
2393
2394component_test_depends_py_pkalgs_psa () {
2395 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002396 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002397}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002398
Valerio Setti6bed64e2024-01-17 15:21:44 +01002399component_test_psa_crypto_config_ffdh_2048_only () {
2400 msg "build: full config - only DH 2048"
2401
2402 scripts/config.py full
2403
2404 # Disable all DH groups other than 2048.
2405 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2406 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2407 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2408 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2409
2410 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2411
2412 msg "test: full config - only DH 2048"
2413 make test
2414
2415 msg "ssl-opt: full config - only DH 2048"
2416 tests/ssl-opt.sh -f "ffdh"
2417}
2418
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002419component_build_no_pk_rsa_alt_support () {
2420 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2421
2422 scripts/config.py full
2423 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2424 scripts/config.py set MBEDTLS_RSA_C
2425 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2426
2427 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002428 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002429}
2430
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002431component_build_module_alt () {
2432 msg "build: MBEDTLS_XXX_ALT" # ~30s
2433 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002434
2435 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002436 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002437 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002438 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002439 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2440 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002441 # You can only have one threading implementation: alt or pthread, not both.
2442 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002443 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2444 # directly and assumes the implementation works with partial groups.
2445 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002446 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2447 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2448 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002449 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2450 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2451 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002452
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002453 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2454 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2455 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002456 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002457
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002458 # We can only compile, not link, since we don't have any implementations
2459 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002460 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002461}
2462
2463component_build_dhm_alt () {
2464 msg "build: MBEDTLS_DHM_ALT" # ~30s
2465 scripts/config.py full
2466 scripts/config.py set MBEDTLS_DHM_ALT
2467 # debug.c currently references mbedtls_dhm_context fields directly.
2468 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002469 # We can only compile, not link, since we don't have any implementations
2470 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002471 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002472}
2473
Gilles Peskine64996c32024-01-23 20:25:47 +01002474component_test_no_psa_crypto_full_cmake_asan() {
2475 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2476 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002477 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002478 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002479 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002480 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002481 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002482 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002483 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002484 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002485 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002486 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002487 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002488 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002489
Gilles Peskine64996c32024-01-23 20:25:47 +01002490 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002491 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002492
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002493 # Note: ssl-opt.sh has some test cases that depend on
2494 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2495 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002496 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002497 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002498
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002499 # Note: the next two invocations cover all compat.sh test cases.
2500 # We should use the same here and in basic-build-test.sh.
2501 msg "test: compat.sh: default version (full minus PSA crypto)"
2502 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002503
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002504 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002505 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002506}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002507
Ronald Cron403c15c2021-09-13 09:38:05 +02002508component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002509 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002510
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002511 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002512 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002513 $(helper_get_psa_key_type_list "ECC") \
2514 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002515
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002516 # Configure
2517 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002518
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002519 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002520 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002521
2522 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002523 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002524
2525 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002526 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2527 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2528
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002529 # Build
2530 # -----
2531
2532 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002533 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2534 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002535
2536 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2537
Valerio Setti3fe105b2023-10-30 11:08:12 +01002538 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002539
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002540 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002541 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002542
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002543 # Run the tests
2544 # -------------
2545
Ronald Cron403c15c2021-09-13 09:38:05 +02002546 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2547 make test
2548}
2549
Valerio Setti44b178c2023-03-22 14:02:57 +01002550component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002551 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002552
2553 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002554 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002555 $(helper_get_psa_key_type_list "ECC") \
2556 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002557
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002558 # Configure
2559 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002560
Ronald Cron46ac0652024-03-18 12:39:04 +01002561 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002562 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002563
Valerio Setti44b178c2023-03-22 14:02:57 +01002564 # Disable the module that's accelerated
2565 scripts/config.py unset MBEDTLS_ECDH_C
2566
2567 # Disable things that depend on it
2568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2569 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2570 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2571 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2572 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2573
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002574 # Build
2575 # -----
2576
2577 helper_libtestdriver1_make_drivers "$loc_accel_list"
2578
Valerio Setti3fe105b2023-10-30 11:08:12 +01002579 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002580
Valerio Setti44b178c2023-03-22 14:02:57 +01002581 # Make sure this was not re-enabled by accident (additive config)
2582 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002583
2584 # Run the tests
2585 # -------------
2586
Valerio Setti44b178c2023-03-22 14:02:57 +01002587 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002588 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002589}
2590
Przemek Stekieldccb2022023-05-11 10:48:50 +02002591component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002592 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002593
2594 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002595 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002596 $(helper_get_psa_key_type_list "DH") \
2597 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002598
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002599 # Configure
2600 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002601
Przemek Stekiel565353e2023-07-05 11:07:07 +02002602 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002603 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002604
2605 # Disable the module that's accelerated
2606 scripts/config.py unset MBEDTLS_DHM_C
2607
2608 # Disable things that depend on it
2609 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2610 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2611
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002612 # Build
2613 # -----
2614
2615 helper_libtestdriver1_make_drivers "$loc_accel_list"
2616
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002617 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002618
2619 # Make sure this was not re-enabled by accident (additive config)
2620 not grep mbedtls_dhm_ library/dhm.o
2621
2622 # Run the tests
2623 # -------------
2624
Gilles Peskine14302ed2023-07-19 19:30:04 +02002625 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002626 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002627
Gilles Peskine14302ed2023-07-19 19:30:04 +02002628 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002629 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002630}
2631
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002632component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002633 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002634
2635 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002636 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002637
2638 # Disable things that are not supported
2639 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2640 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002641 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002642
Gilles Peskine14302ed2023-07-19 19:30:04 +02002643 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002644 make test
2645
Gilles Peskine14302ed2023-07-19 19:30:04 +02002646 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002647 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002648}
2649
Valerio Setti44b178c2023-03-22 14:02:57 +01002650component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002651 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002652
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002653 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002654 $(helper_get_psa_key_type_list "ECC") \
2655 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002656
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002657 # Configure
2658 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002659
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002660 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002661
2662 # Make built-in fallback not available
2663 scripts/config.py unset MBEDTLS_ECJPAKE_C
2664 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2665
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002666 # Build
2667 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002669 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002670
Valerio Setti3fe105b2023-10-30 11:08:12 +01002671 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002672
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002673 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002674 not grep mbedtls_ecjpake_init library/ecjpake.o
2675
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002676 # Run the tests
2677 # -------------
2678
Gilles Peskine14302ed2023-07-19 19:30:04 +02002679 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002680 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002681}
2682
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002683component_test_psa_crypto_config_accel_ecc_some_key_types () {
2684 msg "build: full with accelerated EC algs and some key types"
2685
2686 # Algorithms and key types to accelerate
2687 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2688 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2689 ALG_ECDH \
2690 ALG_JPAKE \
2691 KEY_TYPE_ECC_PUBLIC_KEY \
2692 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2693 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002694 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2695 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002696
2697 # Configure
2698 # ---------
2699
2700 # start with config full for maximum coverage (also enables USE_PSA)
2701 helper_libtestdriver1_adjust_config "full"
2702
2703 # Disable modules that are accelerated - some will be re-enabled
2704 scripts/config.py unset MBEDTLS_ECDSA_C
2705 scripts/config.py unset MBEDTLS_ECDH_C
2706 scripts/config.py unset MBEDTLS_ECJPAKE_C
2707 scripts/config.py unset MBEDTLS_ECP_C
2708
2709 # Disable all curves - those that aren't accelerated should be re-enabled
2710 helper_disable_builtin_curves
2711
2712 # Restartable feature is not yet supported by PSA. Once it will in
2713 # the future, the following line could be removed (see issues
2714 # 6061, 6332 and following ones)
2715 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2716
2717 # this is not supported by the driver API yet
2718 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2719
2720 # Build
2721 # -----
2722
2723 # These hashes are needed for some ECDSA signature tests.
2724 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2725 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2726 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2727
Valerio Setti3fe105b2023-10-30 11:08:12 +01002728 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002729
2730 # ECP should be re-enabled but not the others
2731 not grep mbedtls_ecdh_ library/ecdh.o
2732 not grep mbedtls_ecdsa library/ecdsa.o
2733 not grep mbedtls_ecjpake library/ecjpake.o
2734 grep mbedtls_ecp library/ecp.o
2735
2736 # Run the tests
2737 # -------------
2738
2739 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002740 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002741}
2742
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002743# Run tests with only (non-)Weierstrass accelerated
2744# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002745# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2746# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002747common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002748 weierstrass=$1
2749 if [ $weierstrass -eq 1 ]; then
2750 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002751 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002752 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002753 fi
2754
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002755 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002756
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002757 # Note: Curves are handled in a special way by the libtestdriver machinery,
2758 # so we only want to include them in the accel list when building the main
2759 # libraries, hence the use of a separate variable.
2760 # Note: the following loop is a modified version of
2761 # helper_get_psa_curve_list that only keeps Weierstrass families.
2762 loc_weierstrass_list=""
2763 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002764 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2765 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002766 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002767 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002768 ;;
2769 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002770 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002771 ;;
2772 esac
2773 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002774 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002775 loc_curve_list=$loc_weierstrass_list
2776 else
2777 loc_curve_list=$loc_non_weierstrass_list
2778 fi
2779
Valerio Setti3fe105b2023-10-30 11:08:12 +01002780 # Algorithms and key types to accelerate
2781 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2782 ALG_ECDH \
2783 ALG_JPAKE \
2784 $(helper_get_psa_key_type_list "ECC") \
2785 $loc_curve_list"
2786
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002787 # Configure
2788 # ---------
2789
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002790 # Start with config crypto_full and remove PK_C:
2791 # that's what's supported now, see docs/driver-only-builds.md.
2792 helper_libtestdriver1_adjust_config "crypto_full"
2793 scripts/config.py unset MBEDTLS_PK_C
2794 scripts/config.py unset MBEDTLS_PK_PARSE_C
2795 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002796
2797 # Disable modules that are accelerated - some will be re-enabled
2798 scripts/config.py unset MBEDTLS_ECDSA_C
2799 scripts/config.py unset MBEDTLS_ECDH_C
2800 scripts/config.py unset MBEDTLS_ECJPAKE_C
2801 scripts/config.py unset MBEDTLS_ECP_C
2802
2803 # Disable all curves - those that aren't accelerated should be re-enabled
2804 helper_disable_builtin_curves
2805
2806 # Restartable feature is not yet supported by PSA. Once it will in
2807 # the future, the following line could be removed (see issues
2808 # 6061, 6332 and following ones)
2809 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2810
2811 # this is not supported by the driver API yet
2812 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2813
2814 # Build
2815 # -----
2816
2817 # These hashes are needed for some ECDSA signature tests.
2818 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2819 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2820 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2821
Valerio Settiac7a8092023-10-31 12:23:44 +01002822 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002823
2824 # We expect ECDH to be re-enabled for the missing curves
2825 grep mbedtls_ecdh_ library/ecdh.o
2826 # We expect ECP to be re-enabled, however the parts specific to the
2827 # families of curves that are accelerated should be ommited.
2828 # - functions with mxz in the name are specific to Montgomery curves
2829 # - ecp_muladd is specific to Weierstrass curves
2830 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002831 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002832 not grep mbedtls_ecp_muladd library/ecp.o
2833 grep mxz library/ecp.o
2834 else
2835 grep mbedtls_ecp_muladd library/ecp.o
2836 not grep mxz library/ecp.o
2837 fi
2838 # We expect ECDSA and ECJPAKE to be re-enabled only when
2839 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002840 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002841 not grep mbedtls_ecdsa library/ecdsa.o
2842 not grep mbedtls_ecjpake library/ecjpake.o
2843 else
2844 grep mbedtls_ecdsa library/ecdsa.o
2845 grep mbedtls_ecjpake library/ecjpake.o
2846 fi
2847
2848 # Run the tests
2849 # -------------
2850
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002851 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2852 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002853}
2854
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002855component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002856 common_test_psa_crypto_config_accel_ecc_some_curves 1
2857}
2858
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002859component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002860 common_test_psa_crypto_config_accel_ecc_some_curves 0
2861}
2862
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002863# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2864# ECDH, ECDSA) with and without drivers.
2865# The input parameter is a boolean value which indicates:
2866# - 0 keep built-in EC algs,
2867# - 1 exclude built-in EC algs (driver only).
2868#
2869# This is used by the two following components to ensure they always use the
2870# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002871# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2872# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002873# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002874config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002875 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002876 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002877 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002878 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002879 # Disable modules that are accelerated
2880 scripts/config.py unset MBEDTLS_ECDSA_C
2881 scripts/config.py unset MBEDTLS_ECDH_C
2882 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002883 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002884 fi
2885
2886 # Restartable feature is not yet supported by PSA. Once it will in
2887 # the future, the following line could be removed (see issues
2888 # 6061, 6332 and following ones)
2889 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002890}
2891
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002892# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2893component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002894 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002895
2896 # Algorithms and key types to accelerate
2897 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2898 ALG_ECDH \
2899 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002900 $(helper_get_psa_key_type_list "ECC") \
2901 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002902
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002903 # Configure
2904 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002905
2906 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002907 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002908
Valerio Setti0a342c92023-09-01 09:12:31 +02002909 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002910 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2911 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002912
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002913 # Build
2914 # -----
2915
2916 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002917 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2918 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002919 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2920
Valerio Setti3fe105b2023-10-30 11:08:12 +01002921 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002922
2923 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2924 not grep mbedtls_ecdsa_ library/ecdsa.o
2925 not grep mbedtls_ecdh_ library/ecdh.o
2926 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002927 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002928
2929 # Run the tests
2930 # -------------
2931
Gilles Peskine14302ed2023-07-19 19:30:04 +02002932 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002933 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002934
Gilles Peskine14302ed2023-07-19 19:30:04 +02002935 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002936 tests/ssl-opt.sh
2937}
2938
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002939# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2940component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002941 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002942
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002943 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002944
Gilles Peskine21570cf2023-12-22 11:49:50 +01002945 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002946
Gilles Peskine14302ed2023-07-19 19:30:04 +02002947 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002948 make test
2949
Gilles Peskine14302ed2023-07-19 19:30:04 +02002950 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002951 tests/ssl-opt.sh
2952}
2953
Valerio Settie618cb02023-04-12 14:59:16 +02002954# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002955# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2956# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002957# to ensure that both tests use the same underlying configuration when testing
2958# driver's coverage with analyze_outcomes.py.
2959#
2960# This functions accepts 1 boolean parameter as follows:
2961# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2962# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2963# - 0: include built-in implementation of EC algorithms.
2964#
2965# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2966# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002967config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002968 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002969 # start with full config for maximum coverage (also enables USE_PSA)
2970 helper_libtestdriver1_adjust_config "full"
2971
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002972 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002973 # Disable modules that are accelerated
2974 scripts/config.py unset MBEDTLS_ECDSA_C
2975 scripts/config.py unset MBEDTLS_ECDH_C
2976 scripts/config.py unset MBEDTLS_ECJPAKE_C
2977 # Disable ECP module (entirely)
2978 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002979 fi
2980
Valerio Settiaecd32c2023-06-14 10:42:31 +02002981 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2982 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002983 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002984 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002985
Valerio Settie618cb02023-04-12 14:59:16 +02002986 # Restartable feature is not yet supported by PSA. Once it will in
2987 # the future, the following line could be removed (see issues
2988 # 6061, 6332 and following ones)
2989 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002990}
2991
2992# Build and test a configuration where driver accelerates all EC algs while
2993# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2994# side.
2995#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002996# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2997component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002998 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002999
3000 # Algorithms and key types to accelerate
3001 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3002 ALG_ECDH \
3003 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003004 $(helper_get_psa_key_type_list "ECC") \
3005 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003006
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003007 # Configure
3008 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003009
Valerio Settie618cb02023-04-12 14:59:16 +02003010 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003011 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003012 # Disable all the builtin curves. All the required algs are accelerated.
3013 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003014
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003015 # Build
3016 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003017
3018 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003019 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3020 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3021 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003022
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003023 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003024
Valerio Setti3fe105b2023-10-30 11:08:12 +01003025 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003026
3027 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3028 not grep mbedtls_ecdsa_ library/ecdsa.o
3029 not grep mbedtls_ecdh_ library/ecdh.o
3030 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003031 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003032 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003033
3034 # Run the tests
3035 # -------------
3036
Gilles Peskine14302ed2023-07-19 19:30:04 +02003037 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003038 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003039
Gilles Peskine14302ed2023-07-19 19:30:04 +02003040 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003041 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003042}
3043
3044# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003045# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003046# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003047component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003048 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003049
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003050 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003051
Gilles Peskine21570cf2023-12-22 11:49:50 +01003052 make
Valerio Settie618cb02023-04-12 14:59:16 +02003053
Gilles Peskine14302ed2023-07-19 19:30:04 +02003054 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003055 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003056
Gilles Peskine14302ed2023-07-19 19:30:04 +02003057 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003058 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003059}
3060
Valerio Setti4e2f2442023-08-15 10:10:26 +02003061# This is a common configuration helper used directly from:
3062# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3063# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3064# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003065# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003066# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003067# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003068# - this is the reference component of the above
3069# - it still disables RSA and FFDH, but it uses builtin EC algs
3070# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3071# - accelerate all EC and FFDH algs, disable only RSA
3072# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3073# - this is the reference component of the above
3074# - it still disables RSA, but it uses builtin EC and FFDH algs
3075#
3076# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003077# $1: a boolean value which states if we are testing an accelerated scenario
3078# or not.
3079# $2: a string value which states which components are tested. Allowed values
3080# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003081config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003082 driver_only="$1"
3083 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003084 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003085 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003086
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003087 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003088 # Disable modules that are accelerated
3089 scripts/config.py unset MBEDTLS_ECDSA_C
3090 scripts/config.py unset MBEDTLS_ECDH_C
3091 scripts/config.py unset MBEDTLS_ECJPAKE_C
3092 # Disable ECP module (entirely)
3093 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003094 # Also disable bignum
3095 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003096 fi
3097
3098 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3099 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3100 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3102
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003103 # RSA support is intentionally disabled on this test because RSA_C depends
3104 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003105 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3106 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_ALG_RSA_[0-9A-Z_a-z]*"
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003107 scripts/config.py unset MBEDTLS_RSA_C
3108 scripts/config.py unset MBEDTLS_PKCS1_V15
3109 scripts/config.py unset MBEDTLS_PKCS1_V21
3110 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3111 # Also disable key exchanges that depend on RSA
3112 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3113 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3114 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3115 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3116 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3117
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003118 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003119 # When testing ECC only, we disable FFDH support, both from builtin and
3120 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003121 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003122 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003123 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003124 scripts/config.py unset MBEDTLS_DHM_C
3125 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3126 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3127 else
3128 # When testing ECC and DH instead, we disable DHM and depending key
3129 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003130 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003131 scripts/config.py unset MBEDTLS_DHM_C
3132 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3133 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3134 fi
3135 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003136
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003137 # Restartable feature is not yet supported by PSA. Once it will in
3138 # the future, the following line could be removed (see issues
3139 # 6061, 6332 and following ones)
3140 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3141}
3142
Valerio Setti4e2f2442023-08-15 10:10:26 +02003143# Common helper used by:
3144# - component_test_psa_crypto_config_accel_ecc_no_bignum
3145# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003146#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003147# The goal is to build and test accelerating either:
3148# - ECC only or
3149# - both ECC and FFDH
3150#
3151# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003152# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3153# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003154common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003155 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003156
Valerio Setti5dfaca42023-09-05 08:48:51 +02003157 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003158 if [ "$test_target" = "ECC_DH" ]; then
3159 accel_text="ECC/FFDH"
3160 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003161 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003162 accel_text="ECC"
3163 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003164 fi
3165
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003166 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003167
3168 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003169 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3170 ALG_ECDH \
3171 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003172 $(helper_get_psa_key_type_list "ECC") \
3173 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003174 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003175 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003176 loc_accel_list="$loc_accel_list \
3177 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003178 $(helper_get_psa_key_type_list "DH") \
3179 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003180 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003181
3182 # Configure
3183 # ---------
3184
3185 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003186 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003187 # Disable all the builtin curves. All the required algs are accelerated.
3188 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003189
3190 # Build
3191 # -----
3192
3193 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003194 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3195 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3196 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003197
3198 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3199
Valerio Setti3fe105b2023-10-30 11:08:12 +01003200 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003201
3202 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3203 not grep mbedtls_ecdsa_ library/ecdsa.o
3204 not grep mbedtls_ecdh_ library/ecdh.o
3205 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003206 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003207 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003208 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003209 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003210 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003211
3212 # Run the tests
3213 # -------------
3214
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003215 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003216
Gilles Peskine21570cf2023-12-22 11:49:50 +01003217 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003218
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003219 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003220 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003221}
3222
Valerio Setti4e2f2442023-08-15 10:10:26 +02003223# Common helper used by:
3224# - component_test_psa_crypto_config_reference_ecc_no_bignum
3225# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3226#
3227# The goal is to build and test a reference scenario (i.e. with builtin
3228# components) compared to the ones used in
3229# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3230#
3231# It is meant to be used in conjunction with
3232# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3233# coverage analysis in "analyze_outcomes.py" script.
3234common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003235 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003236
Valerio Setti5dfaca42023-09-05 08:48:51 +02003237 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003238 if [ "$test_target" = "ECC_DH" ]; then
3239 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003240 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003241 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003242 fi
3243
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003244 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003245
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003246 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003247
Gilles Peskine21570cf2023-12-22 11:49:50 +01003248 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003249
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003250 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003251 make test
3252
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003253 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003254 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003255}
3256
Valerio Setti4e2f2442023-08-15 10:10:26 +02003257component_test_psa_crypto_config_accel_ecc_no_bignum () {
3258 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3259}
3260
3261component_test_psa_crypto_config_reference_ecc_no_bignum () {
3262 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3263}
3264
3265component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3266 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3267}
3268
3269component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3270 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3271}
3272
Valerio Settiac6d35f2023-08-04 12:49:11 +02003273# Helper for setting common configurations between:
3274# - component_test_tfm_config_p256m_driver_accel_ec()
3275# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003276common_tfm_config () {
3277 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003278 cp configs/config-tfm.h "$CONFIG_H"
3279 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3280 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003281
Yanray Wang73bb2312023-09-25 11:21:15 +08003282 # Other config adjustment to make the tests pass.
3283 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003284 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003285 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3286 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003287
Yanray Wang73bb2312023-09-25 11:21:15 +08003288 # Config adjustment for better test coverage in our environment.
3289 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003290 #
3291 # Enable filesystem I/O for the benefit of PK parse/write tests.
3292 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3293}
3294
Valerio Settiac6d35f2023-08-04 12:49:11 +02003295# Keep this in sync with component_test_tfm_config() as they are both meant
3296# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003297component_test_tfm_config_p256m_driver_accel_ec () {
3298 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3299
3300 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003301
Dave Rodgman897bb772023-11-15 16:34:20 +00003302 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003303 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003304
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003305 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3306 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003307 not grep mbedtls_ecdh_ library/ecdh.o
3308 not grep mbedtls_ecjpake_ library/ecjpake.o
3309 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3310 not grep mbedtls_ecp_ library/ecp.o
3311 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003312 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003313 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003314 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003315 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003316
Valerio Setti5e18b902023-12-04 12:07:30 +01003317 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3318 # files, so we want to ensure that it has not be re-enabled accidentally.
3319 not grep mbedtls_cipher library/cipher.o
3320
Valerio Settib7e95442023-03-21 11:52:33 +01003321 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003322 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003323 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003324}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003325
Valerio Settiac6d35f2023-08-04 12:49:11 +02003326# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3327# they are both meant to be used in analyze_outcomes.py for driver's coverage
3328# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003329component_test_tfm_config() {
3330 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003331
Dave Rodgman897bb772023-11-15 16:34:20 +00003332 # Disable P256M driver, which is on by default, so that analyze_outcomes
3333 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3334 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3335
Valerio Setti52ba0e32023-08-04 12:43:03 +02003336 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003337 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003338
Dave Rodgman897bb772023-11-15 16:34:20 +00003339 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003340 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003341
Valerio Setti5e18b902023-12-04 12:07:30 +01003342 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3343 # files, so we want to ensure that it has not be re-enabled accidentally.
3344 not grep mbedtls_cipher library/cipher.o
3345
Valerio Setti52ba0e32023-08-04 12:43:03 +02003346 msg "test: TF-M config"
3347 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003348}
3349
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003350# Common helper for component_full_without_ecdhe_ecdsa() and
3351# component_full_without_ecdhe_ecdsa_and_tls13() which:
3352# - starts from the "full" configuration minus the list of symbols passed in
3353# as 1st parameter
3354# - build
3355# - test only TLS (i.e. test_suite_tls and ssl-opt)
3356build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003357 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003358
3359 msg "build: full minus something, test TLS"
3360
3361 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003362 for sym in $symbols_to_disable; do
3363 echo "Disabling $sym"
3364 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003365 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003366
Gilles Peskine21570cf2023-12-22 11:49:50 +01003367 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003368
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003369 msg "test: full minus something, test TLS"
3370 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003371
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003372 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003373 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003374}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003375
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003376component_full_without_ecdhe_ecdsa () {
3377 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003378}
3379
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003380component_full_without_ecdhe_ecdsa_and_tls13 () {
3381 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3382 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003383}
3384
Valerio Setti249b18a2023-06-20 12:08:30 +02003385# This is an helper used by:
3386# - component_test_psa_ecc_key_pair_no_derive
3387# - component_test_psa_ecc_key_pair_no_generate
3388# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3389# enabled, but one. Input arguments are as follows:
3390# - $1 is the key type under test, i.e. ECC/RSA/DH
3391# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003392build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003393 key_type=$1
3394 unset_option=$2
3395 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003396
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003397 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003398 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003399 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3400 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3401
3402 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3403 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003404 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003405
Gilles Peskine21570cf2023-12-22 11:49:50 +01003406 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003407
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003408 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003409 make test
3410}
3411
3412component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003413 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003414}
3415
3416component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003417 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003418}
3419
Pengyu Lve705f572023-12-06 16:38:15 +08003420config_psa_crypto_accel_rsa () {
3421 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003422
Pengyu Lve705f572023-12-06 16:38:15 +08003423 # Start from crypto_full config (no X.509, no TLS)
3424 helper_libtestdriver1_adjust_config "crypto_full"
3425
3426 if [ "$driver_only" -eq 1 ]; then
3427 # Remove RSA support and its dependencies
3428 scripts/config.py unset MBEDTLS_RSA_C
3429 scripts/config.py unset MBEDTLS_PKCS1_V15
3430 scripts/config.py unset MBEDTLS_PKCS1_V21
3431
3432 # We need PEM parsing in the test library as well to support the import
3433 # of PEM encoded RSA keys.
3434 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3435 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3436 fi
3437}
3438
3439component_test_psa_crypto_config_accel_rsa_crypto () {
3440 msg "build: crypto_full with accelerated RSA"
3441
3442 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3443 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3444 KEY_TYPE_RSA_PUBLIC_KEY \
3445 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3446 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3447 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3448 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003449
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003450 # Configure
3451 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003452
Pengyu Lve705f572023-12-06 16:38:15 +08003453 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003454
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003455 # Build
3456 # -----
3457
Pengyu Lve705f572023-12-06 16:38:15 +08003458 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003459 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
Pengyu Lve705f572023-12-06 16:38:15 +08003460 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003461 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003462
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003463 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003464
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003465 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003466 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003467
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003468 # Run the tests
3469 # -------------
3470
Pengyu Lve705f572023-12-06 16:38:15 +08003471 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003472 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003473}
3474
3475component_test_psa_crypto_config_reference_rsa_crypto () {
3476 msg "build: crypto_full with non-accelerated RSA"
3477
3478 # Configure
3479 # ---------
3480 config_psa_crypto_accel_rsa 0
3481
3482 # Build
3483 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003484 make
Pengyu Lve705f572023-12-06 16:38:15 +08003485
3486 # Run the tests
3487 # -------------
3488 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003489 make test
3490}
3491
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003492# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003493# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003494component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003495 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003496
Valerio Setti4590bc22023-06-13 15:39:23 +02003497 # Create a temporary output file unless there is already one set
3498 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3499 REMOVE_OUTCOME_ON_EXIT="no"
3500 else
3501 REMOVE_OUTCOME_ON_EXIT="yes"
3502 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3503 export MBEDTLS_TEST_OUTCOME_FILE
3504 fi
3505
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003506 # Start from crypto configuration
3507 scripts/config.py crypto
3508
3509 # Remove RSA support and its dependencies
3510 scripts/config.py unset MBEDTLS_PKCS1_V15
3511 scripts/config.py unset MBEDTLS_PKCS1_V21
3512 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3513 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3514 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3515 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3516 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3517 scripts/config.py unset MBEDTLS_RSA_C
3518 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3519
3520 # Enable PSA support
3521 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3522
Valerio Setti01cc88a2023-06-15 11:53:08 +02003523 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003524 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003525 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3526 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3527 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003528
3529 make
3530
Valerio Setti01cc88a2023-06-15 11:53:08 +02003531 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003532 make test
3533
3534 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3535 # performing RSA signature.
3536 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3537 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3538
3539 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3540 rm $MBEDTLS_TEST_OUTCOME_FILE
3541 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003542}
3543
Ronald Cronb2312452021-05-08 14:32:59 +02003544component_test_psa_crypto_config_accel_hash () {
3545 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3546
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003547 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3548 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3549 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003550
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003551 # Configure
3552 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003553
Ronald Cron46ac0652024-03-18 12:39:04 +01003554 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003555 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003556
3557 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003558 scripts/config.py unset MBEDTLS_MD5_C
3559 scripts/config.py unset MBEDTLS_RIPEMD160_C
3560 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003561 scripts/config.py unset MBEDTLS_SHA224_C
3562 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003563 scripts/config.py unset MBEDTLS_SHA384_C
3564 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003565 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003566
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003567 # Build
3568 # -----
3569
3570 helper_libtestdriver1_make_drivers "$loc_accel_list"
3571
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003572 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003573
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003574 # There's a risk of something getting re-enabled via config_psa.h;
3575 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3576 not grep mbedtls_md5 library/md5.o
3577 not grep mbedtls_sha1 library/sha1.o
3578 not grep mbedtls_sha256 library/sha256.o
3579 not grep mbedtls_sha512 library/sha512.o
3580 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003581
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003582 # Run the tests
3583 # -------------
3584
Ronald Cronb2312452021-05-08 14:32:59 +02003585 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3586 make test
3587}
3588
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003589# Auxiliary function to build config for hashes with and without drivers
3590config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003591 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003592 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003593 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003594 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003595 # disable the built-in implementation of hashes
3596 scripts/config.py unset MBEDTLS_MD5_C
3597 scripts/config.py unset MBEDTLS_RIPEMD160_C
3598 scripts/config.py unset MBEDTLS_SHA1_C
3599 scripts/config.py unset MBEDTLS_SHA224_C
3600 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003601 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003602 scripts/config.py unset MBEDTLS_SHA384_C
3603 scripts/config.py unset MBEDTLS_SHA512_C
3604 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003605 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003606 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003607}
3608
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003609# Note that component_test_psa_crypto_config_reference_hash_use_psa
3610# is related to this component and both components need to be kept in sync.
3611# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003612component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003613 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003614
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003615 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3616 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3617 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003618
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003619 # Configure
3620 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003621
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003622 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003623
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003624 # Build
3625 # -----
3626
3627 helper_libtestdriver1_make_drivers "$loc_accel_list"
3628
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003629 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003630
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003631 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003632 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003633 not grep mbedtls_md5 library/md5.o
3634 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003635 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003636 not grep mbedtls_sha512 library/sha512.o
3637 not grep mbedtls_ripemd160 library/ripemd160.o
3638
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003639 # Run the tests
3640 # -------------
3641
Gilles Peskine14302ed2023-07-19 19:30:04 +02003642 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003643 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003644
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003645 # This is mostly useful so that we can later compare outcome files with
3646 # the reference config in analyze_outcomes.py, to check that the
3647 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003648 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003649 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003650
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003651 # This is to make sure all ciphersuites are exercised, but we don't need
3652 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003653 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003654 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003655}
3656
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003657# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3658# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3659# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3660# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003661component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003662 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003663
3664 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003665
Gilles Peskine21570cf2023-12-22 11:49:50 +01003666 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003667
Gilles Peskine14302ed2023-07-19 19:30:04 +02003668 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003669 make test
3670
Gilles Peskine14302ed2023-07-19 19:30:04 +02003671 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003672 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003673}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003674
Valerio Setti8eb310c2024-01-22 16:22:57 +01003675# Auxiliary function to build config for hashes with and without drivers
3676config_psa_crypto_hmac_use_psa () {
3677 driver_only="$1"
3678 # start with config full for maximum coverage (also enables USE_PSA)
3679 helper_libtestdriver1_adjust_config "full"
3680
Valerio Setticd89b0b2024-01-24 14:24:55 +01003681 if [ "$driver_only" -eq 1 ]; then
3682 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3683 # is still enabled though (for ENTROPY_C among others).
3684 scripts/config.py unset MBEDTLS_MD_C
3685 # Disable also the builtin hashes since they are supported by the driver
3686 # and MD module is able to perform PSA dispathing.
3687 scripts/config.py unset-all MBEDTLS_SHA
3688 scripts/config.py unset MBEDTLS_MD5_C
3689 scripts/config.py unset MBEDTLS_RIPEMD160_C
3690 fi
3691
Valerio Setti8eb310c2024-01-22 16:22:57 +01003692 # Direct dependencies of MD_C. We disable them also in the reference
3693 # component to work with the same set of features.
3694 scripts/config.py unset MBEDTLS_PKCS7_C
3695 scripts/config.py unset MBEDTLS_PKCS5_C
3696 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3697 scripts/config.py unset MBEDTLS_HKDF_C
3698 # Dependencies of HMAC_DRBG
3699 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3700 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3701}
3702
3703component_test_psa_crypto_config_accel_hmac() {
3704 msg "test: full with accelerated hmac"
3705
3706 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3707 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3708 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3709 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3710
3711 # Configure
3712 # ---------
3713
3714 config_psa_crypto_hmac_use_psa 1
3715
Valerio Setti8eb310c2024-01-22 16:22:57 +01003716 # Build
3717 # -----
3718
3719 helper_libtestdriver1_make_drivers "$loc_accel_list"
3720
3721 helper_libtestdriver1_make_main "$loc_accel_list"
3722
3723 # Ensure that built-in support for HMAC is disabled.
3724 not grep mbedtls_md_hmac library/md.o
3725
3726 # Run the tests
3727 # -------------
3728
3729 msg "test: full with accelerated hmac"
3730 make test
3731}
3732
3733component_test_psa_crypto_config_reference_hmac() {
3734 msg "test: full without accelerated hmac"
3735
3736 config_psa_crypto_hmac_use_psa 0
3737
3738 make
3739
3740 msg "test: full without accelerated hmac"
3741 make test
3742}
3743
Valerio Setti9da01a72023-12-18 17:38:18 +01003744component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003745 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003746
Valerio Setti9da01a72023-12-18 17:38:18 +01003747 # Albeit this components aims at accelerating DES which should only support
3748 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3749 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003750 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3751 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3752 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003753
Valerio Setti9da01a72023-12-18 17:38:18 +01003754 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3755 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3756 # of this component. This limitation will be addressed by #8598.
3757
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003758 # Configure
3759 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003760
Valerio Setti9a427302023-10-17 11:40:42 +02003761 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003762 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003763
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003764 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003765 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3766 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3767 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3768 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3769 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3770 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3771 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003772 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003773
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003774 # Build
3775 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003776
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003777 helper_libtestdriver1_make_drivers "$loc_accel_list"
3778
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003779 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003780
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003781 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003782 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003783
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003784 # Run the tests
3785 # -------------
3786
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003787 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003788 make test
3789}
3790
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003791component_test_psa_crypto_config_accel_aead () {
3792 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3793
Valerio Setti3f02bb72023-10-02 15:57:33 +02003794 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3795 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003796
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003797 # Configure
3798 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003799
Valerio Setti3f02bb72023-10-02 15:57:33 +02003800 # Start from full config
3801 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003802
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003803 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003804 scripts/config.py unset MBEDTLS_GCM_C
3805 scripts/config.py unset MBEDTLS_CCM_C
3806 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003807
Valerio Settia50b89e2023-11-08 15:58:47 +01003808 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3809 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003810
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003811 # Build
3812 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003813
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003814 helper_libtestdriver1_make_drivers "$loc_accel_list"
3815
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003816 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003817
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003818 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003819 not grep mbedtls_ccm library/ccm.o
3820 not grep mbedtls_gcm library/gcm.o
3821 not grep mbedtls_chachapoly library/chachapoly.o
3822
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003823 # Run the tests
3824 # -------------
3825
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003826 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3827 make test
3828}
3829
Valerio Settib680fc42023-10-13 09:29:37 +02003830# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003831# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3832# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3833common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003834 # Start from the full config
3835 helper_libtestdriver1_adjust_config "full"
3836
Valerio Settib680fc42023-10-13 09:29:37 +02003837 scripts/config.py unset MBEDTLS_NIST_KW_C
3838}
3839
Valerio Settib6b301f2023-10-04 12:05:05 +02003840# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003841# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3842# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003843# are meant to be used together in analyze_outcomes.py script in order to test
3844# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003845component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3846 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003847
Valerio Settiad8b7f02023-10-25 12:39:50 +02003848 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 ALG_CTR ALG_CFB \
Valerio Setti51d5b192023-11-08 10:56:54 +01003849 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003850 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003851 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3852
3853 # Configure
3854 # ---------
3855
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003856 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003857
3858 # Disable the things that are being accelerated
3859 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3860 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3861 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3862 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3863 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3864 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3865 scripts/config.py unset MBEDTLS_GCM_C
3866 scripts/config.py unset MBEDTLS_CCM_C
3867 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003868 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003869 scripts/config.py unset MBEDTLS_DES_C
3870 scripts/config.py unset MBEDTLS_AES_C
3871 scripts/config.py unset MBEDTLS_ARIA_C
3872 scripts/config.py unset MBEDTLS_CHACHA20_C
3873 scripts/config.py unset MBEDTLS_CAMELLIA_C
3874
Valerio Settiec9b2582023-11-08 16:50:54 +01003875 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3876 # does not depend on it.
3877 scripts/config.py unset MBEDTLS_CIPHER_C
3878
Valerio Settib6b301f2023-10-04 12:05:05 +02003879 # Build
3880 # -----
3881
3882 helper_libtestdriver1_make_drivers "$loc_accel_list"
3883
3884 helper_libtestdriver1_make_main "$loc_accel_list"
3885
3886 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003887 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003888 not grep mbedtls_des library/des.o
3889 not grep mbedtls_aes library/aes.o
3890 not grep mbedtls_aria library/aria.o
3891 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003892 not grep mbedtls_ccm library/ccm.o
3893 not grep mbedtls_gcm library/gcm.o
3894 not grep mbedtls_chachapoly library/chachapoly.o
3895 not grep mbedtls_cmac library/cmac.o
3896
3897 # Run the tests
3898 # -------------
3899
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003900 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003901 make test
Valerio Settif9414552023-11-09 10:43:20 +01003902
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003903 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003904 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003905
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003906 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003907 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003908}
3909
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003910component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3911 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3912 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003913
Gilles Peskine21570cf2023-12-22 11:49:50 +01003914 make
Valerio Settif9414552023-11-09 10:43:20 +01003915
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003916 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003917 make test
Valerio Settif9414552023-11-09 10:43:20 +01003918
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003919 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003920 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003921
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003922 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003923 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003924}
3925
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003926common_block_cipher_dispatch() {
3927 TEST_WITH_DRIVER="$1"
3928
3929 # Start from the full config
3930 helper_libtestdriver1_adjust_config "full"
3931
3932 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3933 # Disable key types that are accelerated (there is no legacy equivalent
3934 # symbol for ECB)
3935 scripts/config.py unset MBEDTLS_AES_C
3936 scripts/config.py unset MBEDTLS_ARIA_C
3937 scripts/config.py unset MBEDTLS_CAMELLIA_C
3938 fi
3939
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003940 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003941 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003942 # Keep this also in the reference component in order to skip the same tests
3943 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3945 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3946 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3947 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3948 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3949 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3950 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003951 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003952
3953 # Disable direct dependency on AES_C
3954 scripts/config.py unset MBEDTLS_NIST_KW_C
3955
3956 # Prevent the cipher module from using deprecated PSA path. The reason is
3957 # that otherwise there will be tests relying on "aes_info" (defined in
3958 # "cipher_wrap.c") whose functions are not available when AES_C is
3959 # not defined. ARIA and Camellia are not a problem in this case because
3960 # the PSA path is not tested for these key types.
3961 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3962}
3963
Valerio Settif8e6cba2023-12-12 11:53:39 +01003964component_test_full_block_cipher_psa_dispatch () {
3965 msg "build: full + PSA dispatch in block_cipher"
3966
3967 loc_accel_list="ALG_ECB_NO_PADDING \
3968 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3969
3970 # Configure
3971 # ---------
3972
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003973 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003974
Valerio Settif8e6cba2023-12-12 11:53:39 +01003975 # Build
3976 # -----
3977
3978 helper_libtestdriver1_make_drivers "$loc_accel_list"
3979
3980 helper_libtestdriver1_make_main "$loc_accel_list"
3981
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003982 # Make sure disabled components were not re-enabled by accident (additive
3983 # config)
3984 not grep mbedtls_aes_ library/aes.o
3985 not grep mbedtls_aria_ library/aria.o
3986 not grep mbedtls_camellia_ library/camellia.o
3987
Valerio Settif8e6cba2023-12-12 11:53:39 +01003988 # Run the tests
3989 # -------------
3990
3991 msg "test: full + PSA dispatch in block_cipher"
3992 make test
3993}
3994
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003995# This is the reference component of component_test_full_block_cipher_psa_dispatch
3996component_test_full_block_cipher_legacy_dispatch () {
3997 msg "build: full + legacy dispatch in block_cipher"
3998
3999 common_block_cipher_dispatch 0
4000
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004001 make
4002
4003 msg "test: full + legacy dispatch in block_cipher"
4004 make test
4005}
4006
Gilles Peskine36dea152023-07-20 22:19:45 +02004007component_test_aead_chachapoly_disabled() {
4008 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004009 scripts/config.py full
4010 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004011 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004012 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004013
Gilles Peskine36dea152023-07-20 22:19:45 +02004014 msg "test: full minus CHACHAPOLY"
4015 make test
4016}
4017
4018component_test_aead_only_ccm() {
4019 msg "build: full minus CHACHAPOLY and GCM"
4020 scripts/config.py full
4021 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4022 scripts/config.py unset MBEDTLS_GCM_C
4023 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4024 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004025 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004026
4027 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004028 make test
4029}
4030
Ronald Crone501d0e2023-07-10 08:31:19 +02004031component_test_ccm_aes_sha256() {
4032 msg "build: CCM + AES + SHA256 configuration"
4033
Ronald Cron7612d8c2023-07-20 10:03:54 +02004034 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004035 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004036
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004037 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004038
4039 msg "test: CCM + AES + SHA256 configuration"
4040 make test
4041}
4042
Dave Rodgman904c5892023-06-28 17:36:02 +01004043support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004044 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004045}
4046
Dave Rodgman904c5892023-06-28 17:36:02 +01004047component_build_tfm_armcc() {
4048 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004049 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004050
Dave Rodgman88651c42023-06-29 12:35:51 +01004051 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004052 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-m -mthumb -Os -std=c99 -Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wasm-operand-widths -Wunused -I../tests/include/spe"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004053}
4054
4055component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004056 # Check that the TF-M configuration can build cleanly with various
4057 # warning flags enabled. We don't build or run tests, since the
4058 # TF-M configuration needs a TF-M platform. A tweaked version of
4059 # the configuration that works on mainstream platforms is in
4060 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004061 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004062
Dave Rodgman88651c42023-06-29 12:35:51 +01004063 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004064 make lib CC="clang" CFLAGS="--target=arm-linux-gnueabihf -march=armv7-m -mthumb -Os -std=c99 -Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wasm-operand-widths -Wunused -I../tests/include/spe"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004065
Dave Rodgman904c5892023-06-28 17:36:02 +01004066 msg "build: TF-M config, gcc native build"
4067 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004068 make lib CC="gcc" CFLAGS="-Os -std=c99 -Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wformat-signedness -Wlogical-op -I../tests/include/spe"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004069}
4070
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004071# Test that the given .o file builds with all (valid) combinations of the given options.
4072#
4073# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4074#
4075# The validator function is the name of a function to validate the combination of options.
4076# It may be "" if all combinations are valid.
4077# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004078# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004079build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004080 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004081 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004082 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004083 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004084 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004085
Dave Rodgman42436102023-10-03 15:47:05 +01004086 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004087 for opt in "${options[@]}"; do
4088 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004089 done
4090
4091 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004092 cd $(dirname ${file})
4093 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004094
Dave Rodgman920343a2023-10-01 18:41:09 +01004095 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004096 warning_flags="-Werror -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral -Wshadow -Wasm-operand-widths -Wunused"
Dave Rodgman97285622023-09-29 17:32:06 +01004097
Dave Rodgman42436102023-10-03 15:47:05 +01004098 # Extract the command generated by the Makefile to build the target file.
4099 # This ensures that we have any include paths, macro definitions, etc
4100 # that may be applied by make.
4101 # Add -fsyntax-only as we only want a syntax check and don't need to generate a file.
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004102 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004103
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004104 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004105 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004106
Dave Rodgman28e38d82023-10-04 11:50:30 +01004107 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004108 source_file=${file%.o}.c
4109
4110 targets=0
4111 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004112
Dave Rodgman28e38d82023-10-04 11:50:30 +01004113 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004114 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004115 # each bit of $i is used to determine if options[i] will be set or not
4116 target="t"
4117 clang_args=""
4118 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004119 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004120 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004121 clang_args="${clang_args} ${opt}"
4122 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004123 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004124 done
4125
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004126 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004127 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004128 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004129 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004130
Dave Rodgman28e38d82023-10-04 11:50:30 +01004131 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004132 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004133 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004134 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004135
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004136 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004137
Dave Rodgman920343a2023-10-01 18:41:09 +01004138 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004139 make -s -f ${makefile} build_test_config_combos
4140 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004141
4142 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004143 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004144}
4145
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004146validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004147 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004148 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4149 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004150 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004151 fi
4152 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004153 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004154}
4155
4156component_build_aes_variations() {
4157 # 18s - around 90ms per clang invocation on M1 Pro
4158 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004159 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004160 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004161
Yanray Wangbc29aef2023-11-06 11:08:17 +08004162 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004163 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004164
Dave Rodgman42436102023-10-03 15:47:05 +01004165 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004166 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4167 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004168 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004169 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004170
4171 cd "$MBEDTLS_ROOT_DIR"
4172 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4173
Yanray Wang42be1ba2023-11-23 14:28:47 +08004174 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004175 # manually set or unset those configurations to check
4176 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004177 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4178 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4179 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4180 scripts/config.py unset MBEDTLS_DES_C
4181 scripts/config.py unset MBEDTLS_NIST_KW_C
4182 build_test_config_combos library/aes.o validate_aes_config_variations \
4183 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4184 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004185 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004186 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004187}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004188
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004189component_test_no_platform () {
4190 # Full configuration build, without platform support, file IO and net sockets.
4191 # This should catch missing mbedtls_printf definitions, and by disabling file
4192 # IO, it should catch missing '#include <stdio.h>'
4193 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004194 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004195 scripts/config.py unset MBEDTLS_PLATFORM_C
4196 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004197 scripts/config.py unset MBEDTLS_FS_IO
4198 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004199 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004200 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004201 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004202 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004203 # to re-enable platform integration features otherwise disabled in C99 builds
4204 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004205 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004206}
Gilles Peskine7c652162017-12-11 00:01:40 +01004207
4208component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004209 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004210 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4211 scripts/config.py full
4212 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004213 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4214 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4215 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4216 make
4217}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004218
Gilles Peskine8f073122018-11-27 15:58:47 +01004219component_build_no_ssl_srv () {
4220 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004221 scripts/config.py full
4222 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004223 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004224}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004225
Gilles Peskine8f073122018-11-27 15:58:47 +01004226component_build_no_ssl_cli () {
4227 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004228 scripts/config.py full
4229 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004230 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004231}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004232
Gilles Peskine8f073122018-11-27 15:58:47 +01004233component_build_no_sockets () {
4234 # Note, C99 compliance can also be tested with the sockets support disabled,
4235 # as that requires a POSIX platform (which isn't the same as C99).
4236 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004237 scripts/config.py full
4238 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4239 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4240 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4241}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004242
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004243component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004244 msg "build: default config with memory buffer allocator and backtrace enabled"
4245 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4246 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4247 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004248 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004249 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004250 make
4251
4252 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4253 make test
4254}
4255
4256component_test_memory_buffer_allocator () {
4257 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004258 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4259 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004260 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004261 make
4262
4263 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4264 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004265
4266 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4267 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004268 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004269}
4270
Gilles Peskine8f073122018-11-27 15:58:47 +01004271component_test_no_max_fragment_length () {
4272 # Run max fragment length tests with MFL disabled
4273 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004274 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004275 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004276 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004277
Gilles Peskine8f073122018-11-27 15:58:47 +01004278 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004279 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004280}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004281
Hanno Becker545ced42019-02-19 11:10:48 +00004282component_test_asan_remove_peer_certificate () {
4283 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004284 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004285 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004286 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004287 make
4288
4289 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4290 make test
4291
4292 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004293 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004294
4295 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004296 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004297
4298 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004299 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004300}
4301
Gilles Peskine8f073122018-11-27 15:58:47 +01004302component_test_no_max_fragment_length_small_ssl_out_content_len () {
4303 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004304 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4305 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4306 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004307 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004308 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004309
Gilles Peskine8f073122018-11-27 15:58:47 +01004310 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004311 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004312
4313 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004314 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004315}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004316
Darryl Greenaad82f92019-12-02 10:53:11 +00004317component_test_variable_ssl_in_out_buffer_len () {
4318 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4319 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004320 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004321 make
4322
4323 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4324 make test
4325
4326 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004327 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004328
4329 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004330 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004331}
4332
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004333component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004334 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004335 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004336
Dave Rodgman17127e92023-12-14 16:42:48 +00004337 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004338 make
4339
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004340 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004341 make test
4342
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004343 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004344 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004345
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004346 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004347 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004348}
4349
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004350component_test_ssl_alloc_buffer_and_mfl () {
4351 msg "build: default config with memory buffer allocator and MFL extension"
4352 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4353 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4354 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4355 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4356 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004357 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004358 make
4359
4360 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4361 make test
4362
4363 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004364 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004365}
4366
Gilles Peskine636c26a2020-03-04 20:46:15 +01004367component_test_when_no_ciphersuites_have_mac () {
4368 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004369 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4370 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4371 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4372 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4373 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4374
Gilles Peskine636c26a2020-03-04 20:46:15 +01004375 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004376 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004377 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004378
Gilles Peskine636c26a2020-03-04 20:46:15 +01004379 make
4380
Ronald Croncd33cd62024-05-27 08:14:27 +02004381 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004382 make test
4383
Ronald Croncd33cd62024-05-27 08:14:27 +02004384 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004385 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004386}
4387
Raoul Strackxa4e86142020-06-15 17:03:13 +02004388component_test_no_date_time () {
4389 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4390 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004391 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004392 make
4393
4394 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4395 make test
4396}
4397
Gilles Peskine8f073122018-11-27 15:58:47 +01004398component_test_platform_calloc_macro () {
4399 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004400 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4401 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4402 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004403 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004404 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004405
Gilles Peskine8f073122018-11-27 15:58:47 +01004406 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4407 make test
4408}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004409
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004410component_test_malloc_0_null () {
4411 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004412 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004413 make CC=$ASAN_CC CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"$PWD/tests/configs/user-config-malloc-0-null.h\"' $ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004414
4415 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4416 make test
4417
4418 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4419 # Just the calloc selftest. "make test" ran the others as part of the
4420 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004421 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004422
4423 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4424 # Run a subset of the tests. The choice is a balance between coverage
4425 # and time (including time indirectly wasted due to flaky tests).
4426 # The current choice is to skip tests whose description includes
4427 # "proxy", which is an approximation of skipping tests that use the
4428 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004429 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004430}
4431
Dave Rodgman6a08b682023-06-19 11:51:33 +01004432support_test_aesni() {
4433 # Check that gcc targets x86_64 (we can build AESNI), and check for
4434 # AESNI support on the host (we can run AESNI).
4435 #
4436 # The name of this function is possibly slightly misleading, but needs to align
4437 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004438 #
4439 # In principle 32-bit x86 can support AESNI, but our implementation does not
4440 # support 32-bit x86, so we check for x86-64.
4441 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004442 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4443 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004444 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004445}
4446
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004447component_test_aesni () { # ~ 60s
4448 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4449 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4450 #
4451 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4452 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4453 # exercise the plain C impl).
4454
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004455 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004456 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004457 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004458 scripts/config.py set MBEDTLS_HAVE_ASM
4459
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004460 # test the intrinsics implementation
4461 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004462 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004463 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004464 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004465 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004466
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004467 # test the asm implementation
4468 msg "AES tests, test assembly"
4469 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004470 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004471 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004472 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004473
4474 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004475 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004476 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004477 msg "AES tests, plain C"
4478 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004479 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004480 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004481 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004482 not grep -q "AES note: using AESNI" ./programs/test/selftest
4483 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004484
4485 # test the intrinsics implementation
4486 scripts/config.py set MBEDTLS_AESNI_C
4487 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4488 msg "AES tests, test AESNI only"
4489 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004490 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004491 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4492 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004493 grep -q "AES note: using AESNI" ./programs/test/selftest
4494 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004495}
4496
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004497component_test_sha3_variations() {
4498 msg "sha3 loop unroll variations"
4499
4500 # define minimal config sufficient to test SHA3
4501 cat > include/mbedtls/mbedtls_config.h << END
4502 #define MBEDTLS_SELF_TEST
4503 #define MBEDTLS_SHA3_C
4504END
4505
4506 msg "all loops unrolled"
4507 make clean
4508 make -C 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"
4509 ./tests/test_suite_shax
4510
4511 msg "all loops rolled up"
4512 make clean
4513 make -C 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"
4514 ./tests/test_suite_shax
4515}
4516
Jerry Yub6d39c22023-08-16 15:11:48 +08004517support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004518 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004519}
4520
4521component_test_aesni_m32 () { # ~ 60s
4522 # This tests are duplicated from component_test_aesni for i386 target
4523 #
4524 # AESNI intrinsic code supports i386 and assembly code does not support it.
4525
4526 msg "build: default config with different AES implementations"
4527 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004528 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4529 scripts/config.py set MBEDTLS_HAVE_ASM
4530
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004531 # test the intrinsics implementation with gcc
4532 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004533 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004534 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004535 # check that we built intrinsics - this should be used by default when supported by the compiler
4536 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4537 grep -q "AES note: using AESNI" ./programs/test/selftest
4538 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004539 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4540
4541 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004542 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4543 msg "AES tests, test AESNI only"
4544 make clean
4545 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4546 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4547 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4548 grep -q "AES note: using AESNI" ./programs/test/selftest
4549 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004550 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4551}
4552
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004553support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004554 # clang >= 4 is required to build with target attributes
4555 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004556}
4557
4558component_test_aesni_m32_clang() {
4559
4560 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004561 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4562 scripts/config.py set MBEDTLS_HAVE_ASM
4563
4564 # test the intrinsics implementation with clang
4565 msg "AES tests, test intrinsics (clang)"
4566 make clean
4567 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4568 # check that we built intrinsics - this should be used by default when supported by the compiler
4569 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4570 grep -q "AES note: using AESNI" ./programs/test/selftest
4571 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004572 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4573}
4574
Jerry Yu193cbc02023-08-03 17:06:29 +08004575# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4576component_build_aes_aesce_armcc () {
4577 msg "Build: AESCE test on arm64 platform without plain C."
4578 scripts/config.py baremetal
4579
4580 # armc[56] don't support SHA-512 intrinsics
4581 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4582
4583 # Stop armclang warning about feature detection for A64_CRYPTO.
4584 # With this enabled, the library does build correctly under armclang,
4585 # but in baremetal builds (as tested here), feature detection is
4586 # unavailable, and the user is notified via a #warning. So enabling
4587 # this feature would prevent us from building with -Werror on
4588 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004589 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004590 scripts/config.py set MBEDTLS_HAVE_ASM
4591
4592 msg "AESCE, build with default configuration."
4593 scripts/config.py set MBEDTLS_AESCE_C
4594 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4595 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4596
4597 msg "AESCE, build AESCE only"
4598 scripts/config.py set MBEDTLS_AESCE_C
4599 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4600 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4601}
4602
Dave Rodgman0c584032023-10-08 12:26:54 +01004603support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004604 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004605 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004606}
4607
4608component_build_aes_armce () {
4609 # Test variations of AES with Armv8 crypto extensions
4610 scripts/config.py set MBEDTLS_AESCE_C
4611 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4612
4613 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004614 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004615
4616 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4617 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4618
4619 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4620 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4621
Dave Rodgman5e419372023-10-23 15:30:20 +01004622 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004623
Dave Rodgman5e419372023-10-23 15:30:20 +01004624 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4625 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004626
Dave Rodgman5e419372023-10-23 15:30:20 +01004627 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4628 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004629
Dave Rodgman5e419372023-10-23 15:30:20 +01004630 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4631 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004632
4633 # test for presence of AES instructions
4634 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4635 msg "clang, test A32 crypto instructions built"
4636 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4637 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4638 msg "clang, test T32 crypto instructions built"
4639 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4640 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4641 msg "clang, test aarch64 crypto instructions built"
4642 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4643 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4644
4645 # test for absence of AES instructions
4646 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4647 scripts/config.py unset MBEDTLS_AESCE_C
4648 msg "clang, test A32 crypto instructions not built"
4649 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4650 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4651 msg "clang, test T32 crypto instructions not built"
4652 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4653 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4654 msg "clang, test aarch64 crypto instructions not built"
4655 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4656 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004657}
4658
Dave Rodgman9ed18532023-10-05 00:06:47 +01004659support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004660 # clang >= 4 is required to build with SHA extensions
4661 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004662}
4663
Dave Rodgmand9e80832023-10-04 17:17:46 +01004664component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004665 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004666
4667
4668 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004669 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004670 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4671 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4672 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4673 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4674 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004675
Dave Rodgmand9e80832023-10-04 17:17:46 +01004676
Dave Rodgman94a634d2023-10-10 12:59:29 +01004677 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004678 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004679 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4680 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4681 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004682
Dave Rodgman5b89c552023-10-10 14:59:02 +01004683 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004684 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4685 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4686 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004687
Dave Rodgmancd654002023-10-05 09:40:07 +01004688
Dave Rodgman94a634d2023-10-10 12:59:29 +01004689 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004690 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004691 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4692 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4693 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4694 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4695 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004696
Dave Rodgmancd654002023-10-05 09:40:07 +01004697
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004698 # examine the disassembly for presence of SHA instructions
4699 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4700 scripts/config.py set ${opt}
4701 msg "${opt} clang, test A32 crypto instructions built"
4702 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4703 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4704
4705 msg "${opt} clang, test T32 crypto instructions built"
4706 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4707 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4708
4709 msg "${opt} clang, test aarch64 crypto instructions built"
4710 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4711 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4712 scripts/config.py unset ${opt}
4713 done
4714
4715
4716 # examine the disassembly for absence of SHA instructions
4717 msg "clang, test A32 crypto instructions not built"
4718 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4719 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4720
4721 msg "clang, test T32 crypto instructions not built"
4722 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4723 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4724
4725 msg "clang, test aarch64 crypto instructions not built"
4726 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4727 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004728}
4729
Jerry Yu193cbc02023-08-03 17:06:29 +08004730support_build_aes_aesce_armcc () {
4731 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004732}
4733
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004734component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004735 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004736 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004737
Dave Rodgmand8d64512023-12-19 12:20:21 +00004738 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004739
4740 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4741 make test
4742}
4743
4744component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4745 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4746 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004747 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004748
Hanno Becker83ebf782017-07-07 12:29:15 +01004749 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004750
4751 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004752 make test
4753}
Gilles Peskine8f073122018-11-27 15:58:47 +01004754
Hanno Becker83ebf782017-07-07 12:29:15 +01004755component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004756 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4757 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004758 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004759 scripts/config.py unset MBEDTLS_AESCE_C
4760
Dave Rodgmand8d64512023-12-19 12:20:21 +00004761 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004762
4763 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004764 make test
4765
4766 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4767 programs/test/selftest
4768}
4769
Matthias Schulz0767fda2024-02-07 10:46:28 +01004770component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004771 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4772 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004773 scripts/config.py unset MBEDTLS_AESNI_C
4774 scripts/config.py unset MBEDTLS_AESCE_C
4775
4776 make CFLAGS='-O2 -Werror -Wall -Wextra'
4777
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004778 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004779 make test
4780}
4781
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004782component_test_aes_fewer_tables () {
4783 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004784 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004785 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004786
Gilles Peskine7c652162017-12-11 00:01:40 +01004787 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004788 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004789}
4790
4791component_test_aes_rom_tables () {
4792 msg "build: default config with AES_ROM_TABLES enabled"
4793 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004794 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004795
4796 msg "test: AES_ROM_TABLES"
4797 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004798}
4799
Gilles Peskine14c3c062018-01-29 21:25:12 +01004800component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004801 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4802 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4803 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004804 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004805
Gilles Peskine8f073122018-11-27 15:58:47 +01004806 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4807 make test
4808}
4809
Yanray Wang49cd4b52023-11-10 11:58:37 +08004810# helper for common_block_cipher_no_decrypt() which:
4811# - enable/disable the list of config options passed from -s/-u respectively.
4812# - build
4813# - test for tests_suite_xxx
4814# - selftest
4815#
4816# Usage: helper_block_cipher_no_decrypt_build_test
4817# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4818# Options: -s set_opts the list of config options to enable
4819# -u unset_opts the list of config options to disable
4820# -c cflags the list of options passed to CFLAGS
4821# -l ldflags the list of options passed to LDFLAGS
4822helper_block_cipher_no_decrypt_build_test () {
4823 while [ $# -gt 0 ]; do
4824 case "$1" in
4825 -s)
4826 shift; local set_opts="$1";;
4827 -u)
4828 shift; local unset_opts="$1";;
4829 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004830 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004831 -l)
4832 shift; local ldflags="$1";;
4833 esac
4834 shift
4835 done
4836 set_opts="${set_opts:-}"
4837 unset_opts="${unset_opts:-}"
4838 cflags="${cflags:-}"
4839 ldflags="${ldflags:-}"
4840
Yanray Wangb2d6e522023-11-13 16:57:47 +08004841 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4842 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004843
4844 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4845 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004846 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004847
4848 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4849 not grep mbedtls_aes_setkey_dec library/aes.o
4850 not grep mbedtls_aria_setkey_dec library/aria.o
4851 not grep mbedtls_camellia_setkey_dec library/camellia.o
4852 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4853 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004854 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4855 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004856
4857 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4858 make test
4859
4860 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4861 programs/test/selftest
4862}
4863
4864# This is a common configuration function used in:
4865# - component_test_block_cipher_no_decrypt_aesni_legacy()
4866# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4867# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4868# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4869# on x86.
4870common_block_cipher_no_decrypt () {
4871 # test AESNI intrinsics
4872 helper_block_cipher_no_decrypt_build_test \
4873 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004874 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004875
4876 # test AESNI assembly
4877 helper_block_cipher_no_decrypt_build_test \
4878 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004879 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004880
4881 # test AES C implementation
4882 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004883 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004884
4885 # test AESNI intrinsics for i386 target
4886 helper_block_cipher_no_decrypt_build_test \
4887 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004888 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004889 -l "-m32"
4890}
4891
Yanray Wang3ae11992023-11-13 17:32:09 +08004892# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4893# usage: 0: no PSA crypto configuration
4894# 1: use PSA crypto configuration
4895config_block_cipher_no_decrypt () {
4896 use_psa=$1
4897
Yanray Wang66111392023-10-31 18:54:54 +08004898 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004899 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4900 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004901 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004902 scripts/config.py unset MBEDTLS_NIST_KW_C
4903
Yanray Wang3ae11992023-11-13 17:32:09 +08004904 if [ "$use_psa" -eq 1 ]; then
4905 # Enable support for cryptographic mechanisms through the PSA API.
4906 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4907 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4908 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4909 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4910 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4911 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4912 fi
4913}
4914
4915component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004916 # This consistently causes an llvm crash on clang 3.8, so use gcc
4917 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004918 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004919 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004920}
4921
Yanray Wangf1496402023-11-01 18:55:13 +08004922component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004923 # This consistently causes an llvm crash on clang 3.8, so use gcc
4924 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004925 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004926 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004927}
4928
Yanray Wang66111392023-10-31 18:54:54 +08004929support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004930 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004931}
4932
Yanray Wang66111392023-10-31 18:54:54 +08004933component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004934 scripts/config.py baremetal
4935
4936 # armc[56] don't support SHA-512 intrinsics
4937 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4938
4939 # Stop armclang warning about feature detection for A64_CRYPTO.
4940 # With this enabled, the library does build correctly under armclang,
4941 # but in baremetal builds (as tested here), feature detection is
4942 # unavailable, and the user is notified via a #warning. So enabling
4943 # this feature would prevent us from building with -Werror on
4944 # armclang. Tracked in #7198.
4945 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4946 scripts/config.py set MBEDTLS_HAVE_ASM
4947
Yanray Wang3ae11992023-11-13 17:32:09 +08004948 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004949
4950 # test AESCE baremetal build
4951 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004952 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004953 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004954
Yanray Wangef1b04d2023-09-08 11:09:26 +08004955 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4956 not grep mbedtls_aes_setkey_dec library/aes.o
4957 not grep mbedtls_aria_setkey_dec library/aria.o
4958 not grep mbedtls_camellia_setkey_dec library/camellia.o
4959 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4960 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004961 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08004962 not grep mbedtls_aesce_inverse_key library/aesce.o
4963 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004964}
4965
Gilles Peskine592f5912019-10-07 18:49:32 +02004966component_test_ctr_drbg_aes_256_sha_256 () {
4967 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4968 scripts/config.py full
4969 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4970 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004971 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004972 make
4973
4974 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4975 make test
4976}
4977
4978component_test_ctr_drbg_aes_128_sha_512 () {
4979 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004980 scripts/config.py full
4981 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4982 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00004983 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004984 make
4985
4986 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
4987 make test
4988}
4989
4990component_test_ctr_drbg_aes_128_sha_256 () {
4991 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004992 scripts/config.py full
4993 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4994 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
4995 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004996 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004997 make
4998
4999 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5000 make test
5001}
5002
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005003component_test_se_default () {
5004 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005005 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005006 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005007
5008 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5009 make test
5010}
5011
Steven Cooremand57203d2020-07-16 20:28:59 +02005012component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005013 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005014 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005015 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005016 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5017 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005018 loc_cflags="${loc_cflags} -I../tests/include -O2"
5019
Gilles Peskine21570cf2023-12-22 11:49:50 +01005020 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005021
Gilles Peskine1997f302023-07-26 18:45:20 +02005022 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005023 make test
5024}
5025
Gilles Peskine8f073122018-11-27 15:58:47 +01005026component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005027 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005028 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005029 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005030 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005031}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005032
Gilles Peskinecf740502019-07-03 20:43:05 +02005033component_test_cmake_shared () {
5034 msg "build/test: cmake shared" # ~ 2min
5035 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5036 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005037 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005038 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005039 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005040}
5041
Gilles Peskineec10bf12019-09-20 19:56:06 +02005042test_build_opt () {
5043 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005044 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005045 for opt in "$@"; do
5046 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005047 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005048 # We're confident enough in compilers to not run _all_ the tests,
5049 # but at least run the unit tests. In particular, runs with
5050 # optimizations use inline assembly whereas runs with -O0
5051 # skip inline assembly.
5052 make test # ~30s
5053 make clean
5054 done
5055}
5056
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005057# For FreeBSD we invoke the function by name so this condition is added
5058# to disable the existing test_clang_opt function for linux.
5059if [[ $(uname) != "Linux" ]]; then
5060 component_test_clang_opt () {
5061 scripts/config.py full
5062 test_build_opt 'full config' clang -O0 -Os -O2
5063 }
5064fi
5065
5066component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005067 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005068 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005069}
5070support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005071 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005072}
5073
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005074component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005075 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005076 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005077}
5078support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005079 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005080}
5081
5082component_test_gcc_latest_opt () {
5083 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005084 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005085}
5086support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005087 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005088}
5089
5090component_test_gcc_earliest_opt () {
5091 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005092 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005093}
5094support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005095 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005096}
5097
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005098component_build_mbedtls_config_file () {
5099 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005100 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005101 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005102 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005103 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005104 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5105 make clean
5106
5107 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5108 # In the user config, disable one feature (for simplicity, pick a feature
5109 # that nothing else depends on).
5110 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005111 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005112 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5113
5114 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005115}
5116
Gilles Peskine7d904e72022-04-07 21:59:14 +02005117component_build_psa_config_file () {
5118 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5119 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5120 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5121 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5122 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005123 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005124 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5125 make clean
5126
5127 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005128 # In the user config, disable one feature and its dependencies, which will
5129 # reflect on the mbedtls configuration so we can query it with
5130 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005131 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005132 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005133 scripts/config.py unset MBEDTLS_CMAC_C
5134 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5135 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5136
5137 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005138}
5139
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005140component_build_psa_alt_headers () {
5141 msg "build: make with PSA alt headers" # ~20s
5142
5143 # Generate alternative versions of the substitutable headers with the
5144 # same content except different include guards.
5145 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5146
5147 # Build the library and some programs.
5148 # Don't build the fuzzers to avoid having to go through hoops to set
5149 # a correct include path for programs/fuzz/Makefile.
5150 make CFLAGS="-I ../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
5151 make -C programs -o fuzz CFLAGS="-I ../tests/include/alt-extra -DMBEDTLS_PSA_CRYPTO_PLATFORM_FILE='\"psa/crypto_platform_alt.h\"' -DMBEDTLS_PSA_CRYPTO_STRUCT_FILE='\"psa/crypto_struct_alt.h\"'"
5152
5153 # Check that we're getting the alternative include guards and not the
5154 # original include guards.
5155 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5156 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5157 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5158 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5159}
5160
Dave Rodgman852de3c2023-12-14 14:46:45 +00005161component_test_m32_no_asm () {
5162 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005163 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005164 #
5165 # Note that we require gcc, because clang Asan builds fail to link for
5166 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005167 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005168 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005169 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005170 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005171 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005172
Dave Rodgman852de3c2023-12-14 14:46:45 +00005173 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005174 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005175}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005176support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005177 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005178 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005179 *) false;;
5180 esac
5181}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005182
Gilles Peskineff0aee02021-10-05 09:36:03 +02005183component_test_m32_o2 () {
5184 # Build with optimization, to use the i386 specific inline assembly
5185 # and go faster for tests.
5186 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005187 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005188 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005189 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005190
Gilles Peskineff0aee02021-10-05 09:36:03 +02005191 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005192 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005193
Gilles Peskineff0aee02021-10-05 09:36:03 +02005194 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005195 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005196}
Gilles Peskinecf522222021-10-07 19:25:29 +02005197support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005198 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005199}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005200
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005201component_test_m32_everest () {
5202 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005203 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005204 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005205 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005206
5207 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5208 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005209
5210 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005211 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005212
5213 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5214 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005215 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005216}
5217support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005218 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005219}
5220
Gilles Peskine8f073122018-11-27 15:58:47 +01005221component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005222 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005223 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005224 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005225
5226 msg "test: 64-bit ILP32, make, gcc"
5227 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005228}
Gilles Peskine878cf602019-01-06 20:50:38 +00005229support_test_mx32 () {
5230 case $(uname -m) in
5231 amd64|x86_64) true;;
5232 *) false;;
5233 esac
5234}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005235
Peter Kolbus60c6da22018-12-27 06:59:04 -06005236component_test_min_mpi_window_size () {
5237 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005238 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005239 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005240 make
5241
5242 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5243 make test
5244}
5245
Gilles Peskine8f073122018-11-27 15:58:47 +01005246component_test_have_int32 () {
5247 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005248 scripts/config.py unset MBEDTLS_HAVE_ASM
5249 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005250 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005251 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005252
Gilles Peskine8f073122018-11-27 15:58:47 +01005253 msg "test: gcc, force 32-bit bignum limbs"
5254 make test
5255}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005256
Gilles Peskine8f073122018-11-27 15:58:47 +01005257component_test_have_int64 () {
5258 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005259 scripts/config.py unset MBEDTLS_HAVE_ASM
5260 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005261 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005262 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005263
Gilles Peskine8f073122018-11-27 15:58:47 +01005264 msg "test: gcc, force 64-bit bignum limbs"
5265 make test
5266}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005267
Gabor Mezeie256cc12023-07-26 17:28:48 +02005268component_test_have_int32_cmake_new_bignum () {
5269 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5270 scripts/config.py unset MBEDTLS_HAVE_ASM
5271 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005272 scripts/config.py unset MBEDTLS_AESCE_C
5273 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005274 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005275 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005276
5277 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5278 make test
5279}
5280
Gilles Peskine8f073122018-11-27 15:58:47 +01005281component_test_no_udbl_division () {
5282 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005283 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005284 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005285 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005286
Gilles Peskine8f073122018-11-27 15:58:47 +01005287 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5288 make test
5289}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005290
Gilles Peskine8f073122018-11-27 15:58:47 +01005291component_test_no_64bit_multiplication () {
5292 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005293 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005294 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005295 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005296
Gilles Peskine8f073122018-11-27 15:58:47 +01005297 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5298 make test
5299}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005300
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005301component_test_no_strings () {
5302 msg "build: no strings" # ~10s
5303 scripts/config.py full
5304 # Disable options that activate a large amount of string constants.
5305 scripts/config.py unset MBEDTLS_DEBUG_C
5306 scripts/config.py unset MBEDTLS_ERROR_C
5307 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5308 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005309 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005310
5311 msg "test: no strings" # ~ 10s
5312 make test
5313}
5314
Hanno Beckerc5722d12020-10-09 11:10:42 +01005315component_test_no_x509_info () {
5316 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5317 scripts/config.pl full
5318 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5319 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005320 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005321
5322 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5323 make test
5324
5325 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005326 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005327}
5328
Gilles Peskine8f073122018-11-27 15:58:47 +01005329component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005330 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005331 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005332 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -Wall -Wextra -O1' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005333
Gilles Peskinee36fe812021-09-01 20:00:33 +02005334 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005335 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005336}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005337
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005338component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005339 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005340 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005341 # Build for a target platform that's close to what Debian uses
5342 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005343 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005344 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005345 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005346 make CC="${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc" AR="${ARM_LINUX_GNUEABI_GCC_PREFIX}ar" CFLAGS='-Werror -Wall -Wextra -march=armv5te -O1' LDFLAGS='-march=armv5te'
5347
Gilles Peskinee36fe812021-09-01 20:00:33 +02005348 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005349 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005350}
5351support_build_arm_linux_gnueabi_gcc_arm5vte () {
5352 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5353}
5354
5355component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005356 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005357 scripts/config.py baremetal
5358 # This is an imperfect substitute for
5359 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005360 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005361 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" CFLAGS='-std=c99 -Werror -Wall -Wextra -march=armv5te -O1' LDFLAGS='-march=armv5te' SHELL='sh -x' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005362
Gilles Peskinee36fe812021-09-01 20:00:33 +02005363 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005364 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005365}
5366
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005367component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005368 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5369 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005370 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -Wall -Wextra -mthumb -mcpu=cortex-m0plus -Os' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005371
Gilles Peskinee36fe812021-09-01 20:00:33 +02005372 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005373 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005374 for lib in library/*.a; do
5375 echo "$lib:"
5376 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5377 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005378}
5379
Gilles Peskine8f073122018-11-27 15:58:47 +01005380component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005381 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005382 scripts/config.py baremetal
5383 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005384 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005385 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005386 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005387}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005388
Gilles Peskine8f073122018-11-27 15:58:47 +01005389component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005390 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005391 scripts/config.py baremetal
5392 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005393 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -O1 -march=armv6-m -mthumb' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005394 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005395 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005396}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005397
Dave Rodgman8c315f22023-06-02 10:26:24 -04005398component_build_arm_clang_thumb () {
5399 # ~ 30s
5400
5401 scripts/config.py baremetal
5402
5403 msg "build: clang thumb 2, make"
5404 make clean
5405 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5406
5407 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5408 msg "build: clang thumb 1 -O0, make"
5409 make clean
5410 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5411
5412 msg "build: clang thumb 1 -Os, make"
5413 make clean
5414 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5415}
5416
Gilles Peskine8f073122018-11-27 15:58:47 +01005417component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005418 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005419 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005420 # armc[56] don't support SHA-512 intrinsics
5421 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005422
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005423 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5424 scripts/config.py unset MBEDTLS_AESCE_C
5425
Dave Rodgman0fddf822023-03-02 15:32:12 +00005426 # Stop armclang warning about feature detection for A64_CRYPTO.
5427 # With this enabled, the library does build correctly under armclang,
5428 # but in baremetal builds (as tested here), feature detection is
5429 # unavailable, and the user is notified via a #warning. So enabling
5430 # this feature would prevent us from building with -Werror on
5431 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005432 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005433
Hanno Beckerf0762e92022-07-15 12:08:19 +01005434 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005435
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005436 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005437
5438 msg "size: ARM Compiler 5"
5439 "$ARMC5_FROMELF" -z library/*.o
5440
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005441 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005442
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005443 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005444 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005445
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005446 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005447 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5448
5449 # ARM Compiler 6 - Target ARMv7-M+DSP
5450 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005451
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005452 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005453 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005454
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005455 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005456 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005457
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005458 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5459 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5460
Dave Rodgman99318e62023-05-24 12:27:42 +01005461 # ARM Compiler 6 - Target Cortex-M0
5462 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005463
5464 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5465 #
5466 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5467 # that we have in our CI
5468 scripts/config.py set MBEDTLS_AESCE_C
5469 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005470}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005471
Pengyu Lvdf070032023-02-24 16:03:31 +08005472support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005473 armc5_cc="$ARMC5_BIN_DIR/armcc"
5474 armc6_cc="$ARMC6_BIN_DIR/armclang"
5475 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005476}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005477
Ronald Crond2cb7f42024-03-18 12:49:18 +01005478component_test_tls12_only () {
5479 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5480 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5481 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5482 make
5483
5484 msg "test: main suites (inc. selftests) (ASan build)"
5485 make test
5486
5487 msg "test: ssl-opt.sh (ASan build)"
5488 tests/ssl-opt.sh
5489
5490 msg "test: compat.sh (ASan build)"
5491 tests/compat.sh
5492}
5493
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005494component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005495 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005496 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005497 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005498 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5499
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005500 msg "test: TLS 1.3 only, all key exchange modes enabled"
5501 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005502
Ronald Cronc3f43b62022-10-17 17:35:32 +02005503 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5504 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005505}
5506
Ronald Cronc3f43b62022-10-17 17:35:32 +02005507component_test_tls13_only_psk () {
5508 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5509 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5510 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5511 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005512 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005513 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5514 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5515 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5516 scripts/config.py unset MBEDTLS_ECDSA_C
5517 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005518 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005519 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005520 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5521
Ronald Cronc3f43b62022-10-17 17:35:32 +02005522 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5523 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005524
Ronald Cronc3f43b62022-10-17 17:35:32 +02005525 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5526 tests/ssl-opt.sh
5527}
5528
5529component_test_tls13_only_ephemeral () {
5530 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5531 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5532 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005533 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005534 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5535
5536 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5537 cd tests; ./test_suite_ssl; cd ..
5538
5539 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5540 tests/ssl-opt.sh
5541}
5542
Przemek Stekiela01c2422023-06-13 10:46:48 +02005543component_test_tls13_only_ephemeral_ffdh () {
5544 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5545 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5546 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5547 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005548 scripts/config.py unset MBEDTLS_ECDH_C
5549
Przemek Stekiela01c2422023-06-13 10:46:48 +02005550 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5551
5552 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5553 cd tests; ./test_suite_ssl; cd ..
5554
5555 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5556 tests/ssl-opt.sh
5557}
5558
Ronald Cronc3f43b62022-10-17 17:35:32 +02005559component_test_tls13_only_psk_ephemeral () {
5560 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5561 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5562 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5563 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5564 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5565 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5566 scripts/config.py unset MBEDTLS_ECDSA_C
5567 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005568 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005569 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005570 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5571
5572 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5573 cd tests; ./test_suite_ssl; cd ..
5574
5575 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5576 tests/ssl-opt.sh
5577}
5578
Przemek Stekiela01c2422023-06-13 10:46:48 +02005579component_test_tls13_only_psk_ephemeral_ffdh () {
5580 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5581 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5582 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5583 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5584 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5585 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5586 scripts/config.py unset MBEDTLS_ECDSA_C
5587 scripts/config.py unset MBEDTLS_PKCS1_V21
5588 scripts/config.py unset MBEDTLS_PKCS7_C
5589 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005590 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005591 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5592
5593 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5594 cd tests; ./test_suite_ssl; cd ..
5595
5596 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5597 tests/ssl-opt.sh
5598}
5599
Ronald Cronc3f43b62022-10-17 17:35:32 +02005600component_test_tls13_only_psk_all () {
5601 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5602 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5603 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5604 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5605 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5606 scripts/config.py unset MBEDTLS_ECDSA_C
5607 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005608 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005609 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005610 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5611
5612 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5613 cd tests; ./test_suite_ssl; cd ..
5614
5615 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5616 tests/ssl-opt.sh
5617}
5618
5619component_test_tls13_only_ephemeral_all () {
5620 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5621 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005622 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005623 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5624
5625 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5626 cd tests; ./test_suite_ssl; cd ..
5627
5628 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5629 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005630}
5631
Ronald Cron46ac0652024-03-18 12:39:04 +01005632component_test_tls13_no_padding () {
5633 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005634 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005635 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005636 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005637 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005638 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005639 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005640 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005641 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005642}
5643
Ronald Cron6f135e12021-12-08 16:57:54 +01005644component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005645 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005646 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005647 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005648 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005649 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005650 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005651 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005652 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005653 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005654}
5655
Ronald Crondd96c0a2024-04-02 12:34:24 +02005656component_test_full_minus_session_tickets() {
5657 msg "build: full config without session tickets"
5658 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005659 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005660 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005661 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5662 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005663 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005664 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005665 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005666 tests/ssl-opt.sh
5667}
5668
Gilles Peskine8f073122018-11-27 15:58:47 +01005669component_build_mingw () {
5670 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005671 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 lib programs
Hanno Beckere963efa2018-01-03 10:03:43 +00005672
Gilles Peskine8f073122018-11-27 15:58:47 +01005673 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005674 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -maes -msse2 -mpclmul' WINDOWS_BUILD=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005675 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005676
Gilles Peskine8f073122018-11-27 15:58:47 +01005677 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005678 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 SHARED=1 lib programs
5679 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 SHARED=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005680 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005681
Pengyu Lv158eead2023-10-19 11:27:05 +08005682 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005683 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005684 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005685 make WINDOWS_BUILD=1 clean
5686}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005687support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005688 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5689 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005690 *) true;;
5691 esac
5692}
Simon Butcher91aef332016-11-17 09:20:50 +00005693
Gilles Peskine8f073122018-11-27 15:58:47 +01005694component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005695 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005696 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005697 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5698 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005699
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005700 msg "test: main suites (MSan)" # ~ 10s
5701 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005702
Gilles Peskine6848d172023-11-02 19:58:03 +01005703 msg "test: metatests (MSan)"
5704 tests/scripts/run-metatests.sh any msan
5705
Gilles Peskine82b27272019-06-14 18:27:03 +02005706 msg "program demos (MSan)" # ~20s
5707 tests/scripts/run_demos.py
5708
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005709 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005710 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005711
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005712 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005713
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005714 if [ "$MEMORY" -gt 0 ]; then
5715 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005716 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005717 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005718}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005719
Bence Szépkúti0354d042023-12-06 16:14:37 +01005720component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005721 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005722 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005723 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5724 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005725
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005726 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005727 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005728
Gilles Peskine636c26a2020-03-04 20:46:15 +01005729 # Optional parts (slow; currently broken on OS X because programs don't
5730 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005731 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005732 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005733 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005734 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005735 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005736
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005737 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005738 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005739 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005740 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005741
5742 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005743 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005744 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005745 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005746}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005747
Bence Szépkúti0354d042023-12-06 16:14:37 +01005748component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005749 msg "build: Release, full (clang)"
5750 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5751 scripts/config.py full
5752 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5753 make
5754
5755 msg "test: main suites, Valgrind (full config)"
5756 make memcheck
5757}
5758
Paul Elliott62dc3922021-11-25 17:29:40 +00005759support_test_cmake_out_of_source () {
5760 distrib_id=""
5761 distrib_ver=""
5762 distrib_ver_minor=""
5763 distrib_ver_major=""
5764
5765 # Attempt to parse lsb-release to find out distribution and version. If not
5766 # found this should fail safe (test is supported).
5767 if [[ -f /etc/lsb-release ]]; then
5768
5769 while read -r lsb_line; do
5770 case "$lsb_line" in
5771 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5772 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5773 esac
5774 done < /etc/lsb-release
5775
5776 distrib_ver_major="${distrib_ver%%.*}"
5777 distrib_ver="${distrib_ver#*.}"
5778 distrib_ver_minor="${distrib_ver%%.*}"
5779 fi
5780
5781 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5782 # processor (as the CI does) can create a race condition whereby the build
5783 # fails to see a generated file, despite that file actually having been
5784 # generated. This problem appears to go away with 18.04 or newer, so make
5785 # the out of source tests unsupported on Ubuntu 16.04.
5786 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5787}
5788
Gilles Peskine8f073122018-11-27 15:58:47 +01005789component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005790 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005791 # generates
5792 make neat
5793
Gilles Peskine8f073122018-11-27 15:58:47 +01005794 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005795 MBEDTLS_ROOT_DIR="$PWD"
5796 mkdir "$OUT_OF_SOURCE_DIR"
5797 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005798 # Note: Explicitly generate files as these are turned off in releases
5799 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005800 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005801
Gilles Peskine8f073122018-11-27 15:58:47 +01005802 msg "test: cmake 'out-of-source' build"
5803 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005804 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005805 # Also ensure that there are no error messages such as
5806 # "No such file or directory", which would indicate that some required
5807 # file is missing (ssl-opt.sh tolerates the absence of some files so
5808 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005809 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005810 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005811 cat ssl-opt.err >&2
5812 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005813 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005814 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005815 cd "$MBEDTLS_ROOT_DIR"
5816 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005817}
Andres AGdc192212016-08-31 17:33:13 +01005818
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005819component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005820 # Remove existing generated files so that we use the ones CMake
5821 # generates
5822 make neat
5823
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005824 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005825 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005826 # Note: Explicitly generate files as these are turned off in releases
5827 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005828 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005829 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005830}
Gilles Peskinea3000992022-02-04 00:21:12 +01005831support_test_cmake_as_subdirectory () {
5832 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005833}
5834
Chris Kayd259e342021-03-25 16:03:25 +00005835component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005836 # Remove existing generated files so that we use the ones CMake
5837 # generates
5838 make neat
5839
Chris Kayd259e342021-03-25 16:03:25 +00005840 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005841 cd programs/test/cmake_package
5842 cmake .
5843 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005844 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005845}
Gilles Peskinea3000992022-02-04 00:21:12 +01005846support_test_cmake_as_package () {
5847 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005848}
5849
5850component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005851 # Remove existing generated files so that we use the ones CMake
5852 # generates
5853 make neat
5854
Chris Kayd259e342021-03-25 16:03:25 +00005855 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005856 cd programs/test/cmake_package_install
5857 cmake .
5858 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005859 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005860}
Gilles Peskinea3000992022-02-04 00:21:12 +01005861support_test_cmake_as_package_install () {
5862 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005863}
5864
David Horstmann20550e32023-01-12 14:17:01 +00005865component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005866 # Make a copy of config file to use for the in-tree test
5867 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005868
5869 MBEDTLS_ROOT_DIR="$PWD"
5870 mkdir "$OUT_OF_SOURCE_DIR"
5871 cd "$OUT_OF_SOURCE_DIR"
5872
David Horstmann969c1452023-01-31 10:34:44 +00005873 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005874 cmake "$MBEDTLS_ROOT_DIR"
5875 make
5876
5877 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5878 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005879 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005880 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5881 make
5882
5883 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5884 # In the user config, disable one feature (for simplicity, pick a feature
5885 # that nothing else depends on).
5886 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5887
5888 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5889 make
5890 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5891
5892 rm -f user_config.h full_config.h
5893
5894 cd "$MBEDTLS_ROOT_DIR"
5895 rm -rf "$OUT_OF_SOURCE_DIR"
5896
5897 # Now repeat the test for an in-tree build:
5898
David Horstmann969c1452023-01-31 10:34:44 +00005899 # Restore config for the in-tree test
5900 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005901
David Horstmann969c1452023-01-31 10:34:44 +00005902 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005903 cmake .
5904 make
5905
5906 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5907 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005908 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005909 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5910 make
5911
5912 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5913 # In the user config, disable one feature (for simplicity, pick a feature
5914 # that nothing else depends on).
5915 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5916
5917 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5918 make
5919 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5920
5921 rm -f user_config.h full_config.h
5922}
5923support_build_cmake_custom_config_file () {
5924 support_test_cmake_out_of_source
5925}
5926
David Horstmann041ed422024-05-10 14:37:48 +01005927component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005928 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005929 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5930 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5931 make
5932}
5933support_build_cmake_programs_no_testing () {
5934 support_test_cmake_out_of_source
5935}
David Horstmann20550e32023-01-12 14:17:01 +00005936
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005937component_build_zeroize_checks () {
5938 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5939
5940 scripts/config.py full
5941
5942 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005943 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-zeroize-memset.h\"' -DMBEDTLS_TEST_DEFINES_ZEROIZE -Werror -Wsizeof-pointer-memaccess"
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005944}
5945
5946
Gilles Peskine8f073122018-11-27 15:58:47 +01005947component_test_zeroize () {
5948 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5949 # different combinations of compilers and optimization flags by using an
5950 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5951 # system in all cases that the script fails, so we must manually search the
5952 # output to check whether the pass string is present and no failure strings
5953 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005954
Gilles Peskine4976e822019-01-06 19:52:22 +00005955 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5956 # about a spurious message if Gdb tries and fails, so suppress that.
5957 gdb_disable_aslr=
5958 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5959 gdb_disable_aslr='set disable-randomization off'
5960 fi
5961
Gilles Peskine8f073122018-11-27 15:58:47 +01005962 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005963 for compiler in clang gcc; do
5964 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5965 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005966 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5967 grep "The buffer was correctly zeroized" test_zeroize.log
5968 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005969 rm -f test_zeroize.log
5970 make clean
5971 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005972 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005973}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005974
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005975component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00005976 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005977 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00005978 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005979
5980 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00005981 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005982}
5983
5984support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01005985 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02005986 ver="$(cmake --version)"
5987 ver="${ver#cmake version }"
5988 ver_major="${ver%%.*}"
5989
5990 ver="${ver#*.}"
5991 ver_minor="${ver%%.*}"
5992
5993 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005994}
5995
Gilles Peskinec848d222022-12-09 12:23:35 +01005996component_check_code_style () {
5997 msg "Check C code style"
5998 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00005999}
6000
Gilles Peskinec848d222022-12-09 12:23:35 +01006001support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006002 case $(uncrustify --version) in
6003 *0.75.1*) true;;
6004 *) false;;
6005 esac
6006}
6007
Gilles Peskine8f073122018-11-27 15:58:47 +01006008component_check_python_files () {
6009 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006010 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006011}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006012
Joe Subbianid614c0b2021-07-29 11:18:29 +01006013component_check_test_helpers () {
6014 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006015 # unittest writes out mundane stuff like number or tests run on stderr.
6016 # Our convention is to reserve stderr for actual errors, and write
6017 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006018 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006019
Joe Subbiania25ffab2021-08-06 09:41:27 +01006020 msg "unit test: translate_ciphers.py"
6021 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006022}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006023
Valerio Settid9e42512024-05-06 15:59:51 +02006024component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006025 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006026 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006027 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006028 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006029
Valerio Settid8b59372024-07-02 12:02:25 +02006030 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006031
6032 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006033 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006034 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006035
Valerio Setti5beb2362024-06-24 13:13:17 +02006036 msg "build basic psasim client"
6037 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6038 msg "test basic psasim client"
6039 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006040
Valerio Setti5beb2362024-06-24 13:13:17 +02006041 msg "build full psasim client"
6042 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6043 msg "test full psasim client"
6044 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006045
Valerio Settid9e42512024-05-06 15:59:51 +02006046 make -C tests/psa-client-server/psasim clean
6047}
Jerry Yud767cc42023-03-31 15:03:55 +08006048
Valerio Setti9022f712024-06-27 07:59:39 +02006049component_test_suite_with_psasim()
6050{
6051 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006052 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006053 # Modify server's library configuration here (if needed)
6054 helper_psasim_build server
6055
Valerio Settid8b59372024-07-02 12:02:25 +02006056 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006057
6058 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006059 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006060 # PAKE functions are still unsupported from PSASIM
6061 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6062 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6063 helper_psasim_build client
6064
6065 msg "build test suites"
6066 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6067
6068 helper_psasim_server start
6069
Valerio Setti1a493832024-07-01 07:29:02 +02006070 # psasim takes an extremely long execution time on some test suites so we
6071 # exclude them from the list.
6072 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6073 export SKIP_TEST_SUITES
6074
Valerio Setti9022f712024-06-27 07:59:39 +02006075 msg "run test suites"
6076 make PSASIM=1 test
6077
6078 helper_psasim_server kill
6079}
Gilles Peskine5d996822020-03-28 21:09:21 +01006080
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006081################################################################
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006082#### Termination
6083################################################################
6084
Gilles Peskine8f073122018-11-27 15:58:47 +01006085post_report () {
6086 msg "Done, cleaning up"
Gilles Peskine878cf602019-01-06 20:50:38 +00006087 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006088
6089 final_report
6090}
6091
6092
6093
6094################################################################
6095#### Run all the things
6096################################################################
6097
6098# Function invoked by --error-test to test error reporting.
6099pseudo_component_error_test () {
6100 msg "Testing error reporting $error_test_i"
6101 if [ $KEEP_GOING -ne 0 ]; then
6102 echo "Expect three failing commands."
6103 fi
6104 # If the component doesn't run in a subshell, changing error_test_i to an
6105 # invalid integer will cause an error in the loop that runs this function.
6106 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
6107 # Expected error: 'grep non_existent /dev/null -> 1'
6108 grep non_existent /dev/null
6109 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
6110 not grep -q . "$0"
6111 # Expected error: 'make unknown_target -> 2'
6112 make unknown_target
6113 false "this should not be executed"
6114}
6115
6116# Run one component and clean up afterwards.
6117run_component () {
6118 current_component="$1"
6119 export MBEDTLS_TEST_CONFIGURATION="$current_component"
6120
6121 # Unconditionally create a seedfile that's sufficiently long.
6122 # Do this before each component, because a previous component may
6123 # have messed it up or shortened it.
6124 local dd_cmd
6125 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6126 case $OSTYPE in
6127 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
6128 esac
6129 "${dd_cmd[@]}"
6130
6131 # Run the component in a subshell, with error trapping and output
6132 # redirection set up based on the relevant options.
6133 if [ $KEEP_GOING -eq 1 ]; then
6134 # We want to keep running if the subshell fails, so 'set -e' must
6135 # be off when the subshell runs.
6136 set +e
6137 fi
6138 (
6139 if [ $QUIET -eq 1 ]; then
6140 # msg() will be silenced, so just print the component name here.
6141 echo "${current_component#component_}"
6142 exec >/dev/null
6143 fi
6144 if [ $KEEP_GOING -eq 1 ]; then
6145 # Keep "set -e" off, and run an ERR trap instead to record failures.
6146 set -E
6147 trap err_trap ERR
6148 fi
6149 # The next line is what runs the component
6150 "$@"
6151 if [ $KEEP_GOING -eq 1 ]; then
6152 trap - ERR
6153 exit $last_failure_status
6154 fi
6155 )
6156 component_status=$?
6157 if [ $KEEP_GOING -eq 1 ]; then
6158 set -e
6159 if [ $component_status -ne 0 ]; then
6160 failure_count=$((failure_count + 1))
6161 fi
6162 fi
6163
6164 # Restore the build tree to a clean state.
6165 cleanup
6166 unset current_component
6167}
6168
6169# Preliminary setup
6170pre_check_environment
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006171pre_initialize_variables
6172pre_parse_command_line "$@"
6173
Dave Rodgman21900632024-02-26 11:41:19 +00006174setup_quiet_wrappers
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006175pre_check_git
6176pre_restore_files
6177pre_back_up
6178
6179build_status=0
6180if [ $KEEP_GOING -eq 1 ]; then
6181 pre_setup_keep_going
6182fi
6183pre_prepare_outcome_file
6184pre_print_configuration
6185pre_check_tools
6186cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006187if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006188 pre_generate_files
6189fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006190
6191# Run the requested tests.
6192for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
6193 run_component pseudo_component_error_test
6194done
6195unset error_test_i
6196for component in $RUN_COMPONENTS; do
6197 run_component "component_$component"
6198done
6199
6200# We're done.
6201post_report