blob: 9273b8ab6f24a8b377038ddfd5193df8b46bf711 [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
Ronald Cron709bbf02024-07-03 07:59:30 +0200447 "$ARMC6_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100448}
Andres AGa5cd9732016-10-17 15:23:10 +0100449
Andres AGd9eba4b2016-08-26 14:42:14 +0100450err_msg()
451{
452 echo "$1" >&2
453}
454
455check_tools()
456{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200457 for tool in "$@"; do
458 if ! `type "$tool" >/dev/null 2>&1`; then
459 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100460 exit 1
461 fi
462 done
463}
464
Gilles Peskine8f073122018-11-27 15:58:47 +0100465pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000466 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100467 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100468 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100469 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200470 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000471 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100472
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000473 # Note that legacy options are ignored instead of being omitted from this
474 # list of options, so invocations that worked with previous version of
475 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100476 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100477 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200478 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200479 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200480 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000481 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100482 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
483 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100484 --clang-earliest) shift; CLANG_EARLIEST="$1";;
485 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100486 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000487 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100488 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100489 --gcc-earliest) shift; GCC_EARLIEST="$1";;
490 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100491 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200492 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
493 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100494 --gnutls-serv) shift; GNUTLS_SERV="$1";;
495 --help|-h) usage; exit;;
496 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000497 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100498 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100499 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200500 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000501 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100502 --no-force) FORCE=0;;
503 --no-keep-going) KEEP_GOING=0;;
504 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200505 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100506 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100507 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200508 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100509 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200510 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100511 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200512 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200513 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100514 --seed|-s) shift; SEED="$1";;
515 -*)
516 echo >&2 "Unknown option: $1"
517 echo >&2 "Run $0 --help for usage."
518 exit 120
519 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000520 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100521 esac
522 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100523 done
SimonB2e23c822016-04-16 21:54:39 +0100524
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100525 # Exclude components that are not supported on this platform.
526 SUPPORTED_COMPONENTS=
527 for component in $ALL_COMPONENTS; do
528 case $(type "support_$component" 2>&1) in
529 *' function'*)
530 if ! support_$component; then continue; fi;;
531 esac
532 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
533 done
534
535 if [ $list_components -eq 1 ]; then
536 printf '%s\n' $SUPPORTED_COMPONENTS
537 exit
538 fi
539
Gilles Peskinea28db922019-01-10 00:05:18 +0100540 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200541 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000542 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100543 fi
544
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000545 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
546 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100547 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000548 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100549 fi
SimonB2e23c822016-04-16 21:54:39 +0100550
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200551 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100552 if [ $all_except -eq 0 ]; then
553 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200554 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
555 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200556 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100557 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200558 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200559 # If the requested name includes a wildcard character, don't
560 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100561 case $component in
562 *[*?\[]*) continue;;
563 esac
564 case " $SUPPORTED_COMPONENTS " in
565 *" $component "*) :;;
566 *)
567 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
568 unsupported=$((unsupported + 1));;
569 esac
570 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200571 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100572 if [ $unsupported -ne 0 ]; then
573 exit 2
574 fi
575 fi
576
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000577 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100578 RUN_COMPONENTS=
579 for component in $SUPPORTED_COMPONENTS; do
580 if is_component_included "$component"; [ $? -eq $all_except ]; then
581 RUN_COMPONENTS="$RUN_COMPONENTS $component"
582 fi
583 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000584
585 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000586 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100587}
SimonB2e23c822016-04-16 21:54:39 +0100588
Gilles Peskine8f073122018-11-27 15:58:47 +0100589pre_check_git () {
590 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100591 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100592 git checkout-index -f -q $CONFIG_H
593 cleanup
594 else
SimonB2e23c822016-04-16 21:54:39 +0100595
Gilles Peskine8f073122018-11-27 15:58:47 +0100596 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
597 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
598 echo "You can either delete this directory manually, or force the test by rerunning"
599 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
600 exit 1
601 fi
602
Ronald Cron7a93ac52023-07-20 09:49:12 +0200603 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100604 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100605 echo "You can either delete or preserve your work, or force the test by rerunning the"
606 echo "script as: $0 --force"
607 exit 1
608 fi
SimonB2e23c822016-04-16 21:54:39 +0100609 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500610}
611
Gilles Peskine568f53a2021-07-12 18:16:01 +0200612pre_restore_files () {
613 # If the makefiles have been generated by a framework such as cmake,
614 # restore them from git. If the makefiles look like modifications from
615 # the ones checked into git, take care not to modify them. Whatever
616 # this function leaves behind is what the script will restore before
617 # each component.
618 case "$(head -n1 Makefile)" in
619 *[Gg]enerated*)
620 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
621 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
622 ;;
623 esac
624}
625
Gilles Peskinef83eb822020-03-30 20:11:39 +0200626pre_back_up () {
627 for x in $files_to_back_up; do
628 cp -p "$x" "$x$backup_suffix"
629 done
630}
631
Gilles Peskine8f073122018-11-27 15:58:47 +0100632pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100633 failure_count=0 # Number of failed components
634 last_failure_status=0 # Last failure status in this component
635
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100636 # See err_trap
637 previous_failure_status=0
638 previous_failed_command=
639 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100640 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100641
Gilles Peskine7c652162017-12-11 00:01:40 +0100642 start_red=
643 end_color=
644 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100645 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100646 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
647 start_red=$(printf '\033[31m')
648 end_color=$(printf '\033[0m')
649 ;;
650 esac
651 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100652
653 # Keep a summary of failures in a file. We'll print it out at the end.
654 failure_summary_file=$PWD/all-sh-failures-$$.log
655 : >"$failure_summary_file"
656
657 # Whether it makes sense to keep a component going after the specified
658 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200659 # This function normally receives the failing simple command
660 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
661 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100662 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200663 # False positives result in running things that can't be expected to
664 # work. False negatives result in things not running after something else
665 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100666 can_keep_going_after_failure () {
667 case "$1" in
668 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200669 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100670 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200671 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
672 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
673 *make*check*) true;;
674 "grep "*) true;;
675 "[ "*) true;;
676 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100677 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100678 esac
679 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100680
681 # This function runs if there is any error in a component.
682 # It must either exit with a nonzero status, or set
683 # last_failure_status to a nonzero value.
684 err_trap () {
685 # Save $? (status of the failing command). This must be the very
686 # first thing, before $? is overridden.
687 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100688 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100689
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100690 if [[ $last_failure_status -eq $previous_failure_status &&
691 "$failed_command" == "$previous_failed_command" &&
692 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
693 then
694 # The same command failed twice in a row, but this time one level
695 # less deep in the function call stack. This happens when the last
696 # command of a function returns a nonzero status, and the function
697 # returns that same status. Ignore the second failure.
698 previous_failure_funcall_depth=${#FUNCNAME[@]}
699 return
700 fi
701 previous_failure_status=$last_failure_status
702 previous_failed_command=$failed_command
703 previous_failure_funcall_depth=${#FUNCNAME[@]}
704
Gilles Peskinece266c42020-03-28 18:50:43 +0100705 text="$current_section: $failed_command -> $last_failure_status"
706 echo "${start_red}^^^^$text^^^^${end_color}" >&2
707 echo "$text" >>"$failure_summary_file"
708
709 # If the command is fatal (configure or build command), stop this
710 # component. Otherwise (test command) keep the component running
711 # (run more tests from the same build).
712 if ! can_keep_going_after_failure "$failed_command"; then
713 exit $last_failure_status
714 fi
715 }
716
Gilles Peskine7c652162017-12-11 00:01:40 +0100717 final_report () {
718 if [ $failure_count -gt 0 ]; then
719 echo
720 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100721 echo "${start_red}FAILED: $failure_count components${end_color}"
722 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100723 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
724 elif [ -z "${1-}" ]; then
725 echo "SUCCESS :)"
726 fi
727 if [ -n "${1-}" ]; then
728 echo "Killed by SIG$1."
729 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100730 rm -f "$failure_summary_file"
731 if [ $failure_count -gt 0 ]; then
732 exit 1
733 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100734 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100735}
736
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200737# record_status() and if_build_succeeded() are kept temporarily for backward
738# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100739record_status () {
740 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100741}
Gilles Peskine7c652162017-12-11 00:01:40 +0100742if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100743 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100744}
745
Gilles Peskinea681c592020-03-28 21:27:40 +0100746# '! true' does not trigger the ERR trap. Arrange to trigger it, with
747# a reasonably informative error message (not just "$@").
748not () {
749 if "$@"; then
750 report_failed_command="! $*"
751 false
752 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200753 fi
754}
755
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200756pre_prepare_outcome_file () {
757 case "$MBEDTLS_TEST_OUTCOME_FILE" in
758 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
759 esac
760 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
761 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
762 fi
763}
764
Gilles Peskine8f073122018-11-27 15:58:47 +0100765pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200766 if [ $QUIET -eq 1 ]; then
767 return
768 fi
769
Gilles Peskine8f073122018-11-27 15:58:47 +0100770 msg "info: $0 configuration"
771 echo "MEMORY: $MEMORY"
772 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200773 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100774 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100775 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100776 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100777 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
778 echo "GNUTLS_CLI: $GNUTLS_CLI"
779 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100780 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
781 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
782}
Andres AG7770ea82016-10-10 15:46:20 +0100783
Andres AGd9eba4b2016-08-26 14:42:14 +0100784# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100785pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000786 # Build the list of variables to pass to output_env.sh.
787 set env
SimonB2e23c822016-04-16 21:54:39 +0100788
Gilles Peskine87964262019-01-06 22:40:00 +0000789 case " $RUN_COMPONENTS " in
790 # Require OpenSSL and GnuTLS if running any tests (as opposed to
791 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
792 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100793 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000794 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
795 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100796 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000797 export GNUTLS_CLI="$GNUTLS_CLI"
798 export GNUTLS_SERV="$GNUTLS_SERV"
799 # Avoid passing --seed flag in every call to ssl-opt.sh
800 if [ -n "${SEED-}" ]; then
801 export SEED
802 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200803 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000804 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200805 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
806 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ;;
808 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200809
Gilles Peskine87964262019-01-06 22:40:00 +0000810 case " $RUN_COMPONENTS " in
811 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
812 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100813
Gilles Peskine87964262019-01-06 22:40:00 +0000814 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200815 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000816 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100817
Gilles Peskine87964262019-01-06 22:40:00 +0000818 case " $RUN_COMPONENTS " in
819 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
820 esac
821
822 case " $RUN_COMPONENTS " in
823 *" test_zeroize "*) check_tools "gdb";;
824 esac
825
826 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000827 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000828 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
829 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200830 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000831 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
832 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200833 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
834 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
835 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000836 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000837
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200838 # past this point, no call to check_tool, only printing output
839 if [ $QUIET -eq 1 ]; then
840 return
841 fi
842
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000843 msg "info: output_env.sh"
844 case $RUN_COMPONENTS in
845 *_armcc*)
846 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
847 *) set "$@" RUN_ARMCC=0;;
848 esac
849 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100850}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100851
Gilles Peskine1570b592021-04-22 01:10:12 +0200852pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200853 # since make doesn't have proper dependencies, remove any possibly outdate
854 # file that might be around before generating fresh ones
855 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200856 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200857 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200858 else
859 make generated_files
860 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200861}
862
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000863clang_version() {
864 if command -v clang > /dev/null ; then
865 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
866 else
867 echo 0 # report version 0 for "no clang"
868 fi
869}
870
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200871################################################################
872#### Helpers for components using libtestdriver1
873################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100874
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200875# How to use libtestdriver1
876# -------------------------
877#
878# 1. Define the list algorithms and key types to accelerate,
879# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
880# Examples:
881# - loc_accel_list="ALG_JPAKE"
882# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200883# 2. Make configurations changes for the driver and/or main libraries.
884# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
885# can be either "default" to start with the default config, or a name
886# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200887# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200888# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
889# These changes affect both the driver and the main libraries.
890# (Note: they need to have the same set of PSA_WANT symbols, as that
891# determines the ABI between them.)
892# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
893# main libraries. Typically, you want to disable the module(s) that are
894# being accelerated. You may need to also disable modules that depend
895# on them or options that are not supported with drivers.
896# 2d. On top of psa/crypto_config.h, the driver library uses its own config
897# file: tests/include/test/drivers/config_test_driver.h. You usually
898# don't need to edit it: using loc_extra_list (see below) is preferred.
899# However, when there's no PSA symbol for what you want to enable,
900# calling scripts/config.py on this file remains the only option.
901# 3. Build the driver library, then the main libraries, test, and programs.
902# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
903# need to enable more algorithms here, typically hash algorithms when
904# accelerating some signature algorithms (ECDSA, RSAv2). This is done
905# by passing a 2nd argument listing the extra algorithms.
906# Example:
907# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
908# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800909# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200910# additional arguments will be passed to make: this can be useful if
911# you don't want to build everything when iterating during development.
912# Example:
913# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
914# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200915
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200916# Adjust the configuration - for both libtestdriver1 and main library,
917# as they should have the same PSA_WANT macros.
918helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200919 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200920 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200921 if [ "$base_config" != "default" ]; then
922 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200923 fi
924
925 # Enable PSA-based config (necessary to use drivers)
926 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
927
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200928 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
929 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
930 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000931
932 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
933 # otherwise we will end up running multithreaded tests without mutexes to protect them.
934 if scripts/config.py get MBEDTLS_THREADING_C; then
935 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
936 fi
937
938 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
939 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
940 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200941}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100942
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100943# Build the drivers library libtestdriver1.a (with ASan).
944#
945# Parameters:
946# 1. a space-separated list of things to accelerate;
947# 2. optional: a space-separate list of things to also support.
948# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
949helper_libtestdriver1_make_drivers() {
950 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
951 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
952}
953
954# Build the main libraries, programs and tests,
955# linking to the drivers library (with ASan).
956#
957# Parameters:
958# 1. a space-separated list of things to accelerate;
959# *. remaining arguments if any are passed directly to make
960# (examples: lib, -C tests test_suite_xxx, etc.)
961# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
962helper_libtestdriver1_make_main() {
963 loc_accel_list=$1
964 shift
965
966 # we need flags both with and without the LIBTESTDRIVER1_ prefix
967 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
968 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
969 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" "$@"
970}
971
Valerio Setti9022f712024-06-27 07:59:39 +0200972# Set some default values $CONFIG_H in order to build server or client sides
973# in PSASIM. There is only 1 mandatory parameter:
974# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200975helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200976 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200977
Valerio Settid1b6ef12024-05-07 16:00:21 +0200978 if [ "$TARGET" == "client" ]; then
979 scripts/config.py full
980 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
981 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
982 # Dynamic secure element support is a deprecated feature and it is not
983 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
984 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
985 # Disable potentially problematic features
986 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
987 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
988 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
989 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
990 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100991 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200992 else
993 scripts/config.py crypto_full
994 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100995 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
996 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
997 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
998 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200999 fi
Valerio Setti9022f712024-06-27 07:59:39 +02001000}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001001
Valerio Setti9022f712024-06-27 07:59:39 +02001002# Helper to build the libraries for client/server in PSASIM. If the server is
1003# being built, then it builds also the final executable.
1004# There is only 1 mandatory parameter:
1005# - $1: target which can be "client" or "server"
1006helper_psasim_build() {
1007 TARGET=$1
1008 shift
1009 TARGET_LIB=${TARGET}_libs
1010
1011 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1012
1013 # Build also the server application after its libraries have been built.
1014 if [ "$TARGET" == "server" ]; then
1015 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1016 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001017}
1018
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001019################################################################
1020#### Configuration helpers
1021################################################################
1022
Valerio Settib2fd6732023-08-15 17:10:47 +02001023# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001024# The function optionally accepts 1 parameter: a space-separated list of the
1025# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001026helper_disable_builtin_curves() {
1027 allowed_list="${1:-}"
1028 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1029
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001030 for curve in $allowed_list; do
1031 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001032 done
1033}
1034
1035# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1036# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1037# in the following helpers.
1038helper_get_psa_curve_list () {
1039 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001040 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1041 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001042 done
1043
1044 echo "$loc_list"
1045}
1046
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001047# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1048# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1049# in the following helpers.
1050helper_get_psa_dh_group_list () {
1051 loc_list=""
1052 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1053 loc_list="$loc_list $item"
1054 done
1055
1056 echo "$loc_list"
1057}
1058
Valerio Settib2fd6732023-08-15 17:10:47 +02001059# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001060# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001061# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001062helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001063 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001064 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001065 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 +02001066 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1067 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001068 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1069 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001070 fi
1071 done
1072
1073 echo "$loc_list"
1074}
1075
Valerio Setti9022f712024-06-27 07:59:39 +02001076# Helper function for controlling (start & stop) the psasim server.
1077helper_psasim_server() {
1078 OPERATION=$1
1079 if [ "$OPERATION" == "start" ]; then
1080 (
1081 cd tests
1082 msg "start server"
1083 psa-client-server/psasim/test/start_server.sh
1084 )
1085 else
1086 (
1087 cd tests
1088 msg "terminate server and cleanup"
1089 psa-client-server/psasim//test/kill_server.sh
1090 )
1091 fi
1092}
1093
Gilles Peskine192c72f2017-12-21 15:59:21 +01001094################################################################
1095#### Basic checks
1096################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001097
Ronald Cron709bbf02024-07-03 07:59:30 +02001098export BUILTIN_SRC_PATH="tf-psa-crypto/drivers/builtin/src"
1099
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001100#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001101# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001102#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001103# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001104# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001105# 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 +02001106# time, so start with a GCC build).
1107# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001108#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001109# Indicative running times are given for reference.
1110
Gilles Peskine8f073122018-11-27 15:58:47 +01001111component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001112 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001113 tests/scripts/recursion.pl library/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001114 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001115}
Janos Follathb72c6782016-07-19 14:54:17 +01001116
Gilles Peskine67debb62021-05-18 16:09:50 +02001117component_check_generated_files () {
1118 msg "Check: check-generated-files, files generated with make" # 2s
1119 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001120 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001121
1122 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001123 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001124 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001125 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001126
1127 msg "Check: check-generated-files -u, files absent" # 2s
1128 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001129 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001130 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001131 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001132
1133 # This component ends with the generated files present in the source tree.
1134 # This is necessary for subsequent components!
1135}
1136
Gilles Peskine8f073122018-11-27 15:58:47 +01001137component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001138 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001139 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001140}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001141
Gilles Peskine8f073122018-11-27 15:58:47 +01001142component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001143 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001144 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001145}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001146
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001147component_check_changelog () {
1148 msg "Check: changelog entries" # < 1s
1149 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001150 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001151 if [ -e ChangeLog.new ]; then
1152 # Show the diff for information. It isn't an error if the diff is
1153 # non-empty.
1154 diff -u ChangeLog ChangeLog.new || true
1155 rm ChangeLog.new
1156 fi
1157}
1158
Gilles Peskine8f073122018-11-27 15:58:47 +01001159component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001160 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001161 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001162}
Darryl Greena07039c2018-03-13 16:48:16 +00001163
Gilles Peskine895868b2019-09-19 21:30:05 +02001164component_check_test_cases () {
1165 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001166 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001167 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001168 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001169 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001170 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001171 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001172 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001173}
1174
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001175component_check_test_dependencies () {
1176 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001177 # The purpose of this component is to catch unjustified dependencies on
1178 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1179 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1180 # MBEDTLS_PSA_xxx).
1181 #
1182 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1183 # this component is meant to catch. However a few of them are justified,
1184 # mostly by the absence of a PSA equivalent, so this component includes a
1185 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001186
1187 found="check-test-deps-found-$$"
1188 expected="check-test-deps-expected-$$"
1189
1190 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001191 grep 'depends_on' \
1192 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001193 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001194 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001195 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001196
Yanray Wang18040ed2023-11-23 21:29:56 +08001197 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001198 rm -f $expected
1199 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1200 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001201 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1202 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001203 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1204 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001205 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1206 # the test code and that's probably the most convenient way of achieving
1207 # the test's goal.
1208 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1209 # No PSA equivalent - we should probably have one in the future.
1210 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1211 # No PSA equivalent - needed by some init tests
1212 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001213 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001214 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001215
1216 # Compare reality with expectation.
1217 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001218 #
1219 # The output should be empty. When it's not:
1220 # - Each '+' line is a macro that was found but not expected. You want to
1221 # find where that macro occurs, and either replace it with PSA macros, or
1222 # add it to the exceptions list above with a justification.
1223 # - Each '-' line is a macro that was expected but not found; it means the
1224 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001225 diff -U0 $expected $found
1226
1227 rm $found $expected
1228}
1229
Gilles Peskine8f073122018-11-27 15:58:47 +01001230component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001231 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001232 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001233}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001234
Gilles Peskine192c72f2017-12-21 15:59:21 +01001235
Gilles Peskine636c26a2020-03-04 20:46:15 +01001236
Gilles Peskine192c72f2017-12-21 15:59:21 +01001237################################################################
1238#### Build and test many configurations and targets
1239################################################################
1240
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001241component_test_default_out_of_box () {
1242 msg "build: make, default config (out-of-box)" # ~1min
1243 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001244 # Disable fancy stuff
1245 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001246
1247 msg "test: main suites make, default config (out-of-box)" # ~10s
1248 make test
1249
1250 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001251 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001252
1253 msg "program demos: make, default config (out-of-box)" # ~10s
1254 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001255}
1256
Gilles Peskine8f073122018-11-27 15:58:47 +01001257component_test_default_cmake_gcc_asan () {
1258 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001259 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1260 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001261
Gilles Peskine8f073122018-11-27 15:58:47 +01001262 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1263 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001264
Gilles Peskine82b27272019-06-14 18:27:03 +02001265 msg "program demos (ASan build)" # ~10s
1266 tests/scripts/run_demos.py
1267
Gilles Peskine97bea012020-04-23 23:37:45 +02001268 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001269 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001270
Gilles Peskine6848d172023-11-02 19:58:03 +01001271 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001272 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001273
Gilles Peskine8f073122018-11-27 15:58:47 +01001274 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001275 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001276
Gilles Peskine8f073122018-11-27 15:58:47 +01001277 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001278 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001279
1280 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001281 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001282}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001283
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001284component_test_default_cmake_gcc_asan_new_bignum () {
1285 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001286 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001287 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001288 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001289
1290 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1291 make test
1292
1293 msg "test: selftest (ASan build)" # ~ 10s
1294 programs/test/selftest
1295
1296 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1297 tests/ssl-opt.sh
1298
1299 msg "test: compat.sh (ASan build)" # ~ 6 min
1300 tests/compat.sh
1301
1302 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1303 tests/context-info.sh
1304}
1305
Hanno Becker01635512019-02-26 14:27:09 +00001306component_test_full_cmake_gcc_asan () {
1307 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001308 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001309 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1310 make
1311
1312 msg "test: main suites (inc. selftests) (full config, ASan build)"
1313 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001314
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001315 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001316 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001317
Gilles Peskine636c26a2020-03-04 20:46:15 +01001318 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001319 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001320
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001321 # Note: the next two invocations cover all compat.sh test cases.
1322 # We should use the same here and in basic-build-test.sh.
1323 msg "test: compat.sh: default version (full config, ASan build)"
1324 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001325
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001326 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1327 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001328
1329 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001330 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001331}
1332
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001333
1334component_test_full_cmake_gcc_asan_new_bignum () {
1335 msg "build: full config, cmake, gcc, ASan"
1336 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001337 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001338 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001339 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001340
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001341 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001342 make test
1343
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001344 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001345 programs/test/selftest
1346
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001347 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001348 tests/ssl-opt.sh
1349
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001350 # Note: the next two invocations cover all compat.sh test cases.
1351 # We should use the same here and in basic-build-test.sh.
1352 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1353 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001354
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001355 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1356 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001357
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001358 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001359 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001360}
1361
Ronald Cronc3623db2020-10-29 10:51:32 +01001362component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001363 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001364 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001365 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1366 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1367 make
1368
1369 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1370 make test
1371}
1372
David Horstmann4a48bec2024-03-13 15:42:31 +00001373component_test_psa_assume_exclusive_buffers () {
1374 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001375 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001376 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001377 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1378 make
1379
David Horstmann4a48bec2024-03-13 15:42:31 +00001380 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001381 make test
1382}
1383
Gilles Peskinea3548672021-06-17 11:37:52 +02001384# check_renamed_symbols HEADER LIB
1385# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1386# name is LIB.
1387check_renamed_symbols () {
1388 ! nm "$2" | sed 's/.* //' |
1389 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1390}
1391
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001392component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001393 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001394 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001395 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1396 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1397 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1398 # We can only compile, not link, since our test and sample programs
1399 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1400 # is active.
1401 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001402
1403 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1404 # version is not present.
1405 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001406 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001407}
1408
Ryan Everettdaa322a2024-04-18 16:48:55 +01001409component_test_no_rsa_key_pair_generation() {
1410 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001411 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001412 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001413 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001414 make
1415
Ryan Everettdaa322a2024-04-18 16:48:55 +01001416 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 make test
1418}
1419
Gilles Peskine782f4112018-11-27 16:11:09 +01001420component_test_ref_configs () {
1421 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001422 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1423 # want to re-generate generated files that depend on it, quite correctly.
1424 # However this doesn't work as the generation script expects a specific
1425 # format for mbedtls_config.h, which the other files don't follow. Also,
1426 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001427 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001428 # whether they're on or off. So, disable cmake's (over-sensitive here)
1429 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001430 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001431 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001432 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001433}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001434
Gilles Peskine8f073122018-11-27 15:58:47 +01001435component_test_no_renegotiation () {
1436 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001437 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001438 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001439 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001440
Gilles Peskine8f073122018-11-27 15:58:47 +01001441 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1442 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001443
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001445 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001446}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001447
Gilles Peskine636c26a2020-03-04 20:46:15 +01001448component_test_no_pem_no_fs () {
1449 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1450 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1451 scripts/config.py unset MBEDTLS_FS_IO
1452 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1453 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001454 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001455 make
1456
1457 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1458 make test
1459
1460 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001461 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001462}
1463
Gilles Peskine8f073122018-11-27 15:58:47 +01001464component_test_rsa_no_crt () {
1465 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001466 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001467 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001468 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001469
Gilles Peskine8f073122018-11-27 15:58:47 +01001470 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1471 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001474 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001477 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001478
1479 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001481}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001482
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001483component_test_no_ctr_drbg_classic () {
1484 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001485 scripts/config.py full
1486 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001487 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001488 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001489
Dave Rodgman17127e92023-12-14 16:42:48 +00001490 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001491 make
1492
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494 make test
1495
Gilles Peskineba749042021-01-13 20:02:03 +01001496 # In this configuration, the TLS test programs use HMAC_DRBG.
1497 # The SSL tests are slow, so run a small subset, just enough to get
1498 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001499 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001500 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001501
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001503 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001504}
1505
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001506component_test_no_ctr_drbg_use_psa () {
1507 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001508 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1510 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001511
Dave Rodgman17127e92023-12-14 16:42:48 +00001512 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001513 make
1514
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001515 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1516 make test
1517
1518 # In this configuration, the TLS test programs use HMAC_DRBG.
1519 # The SSL tests are slow, so run a small subset, just enough to get
1520 # confidence that the SSL code copes with HMAC_DRBG.
1521 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001522 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001523
1524 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001525 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526}
1527
1528component_test_no_hmac_drbg_classic () {
1529 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1530 scripts/config.py full
1531 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1532 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1533 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001534 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001535
Dave Rodgman17127e92023-12-14 16:42:48 +00001536 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001537 make
1538
1539 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001540 make test
1541
Gilles Peskinea2224342020-11-19 22:14:34 +01001542 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1543 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1544 # instead.
1545 # Test SSL with non-deterministic ECDSA. Only test features that
1546 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001547 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001548 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001549
1550 # To save time, only test one protocol version, since this part of
1551 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001552 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001553 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001554}
1555
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001556component_test_no_hmac_drbg_use_psa () {
1557 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1558 scripts/config.py full
1559 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1560 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1561 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1562
Dave Rodgman17127e92023-12-14 16:42:48 +00001563 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001564 make
1565
1566 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1567 make test
1568
1569 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1570 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1571 # instead.
1572 # Test SSL with non-deterministic ECDSA. Only test features that
1573 # might be affected by how ECDSA signature is performed.
1574 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001575 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001576
1577 # To save time, only test one protocol version, since this part of
1578 # the protocol is identical in (D)TLS up to 1.2.
1579 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001580 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001581}
1582
1583component_test_psa_external_rng_no_drbg_classic () {
1584 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1585 scripts/config.py full
1586 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001587 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001588 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001589 scripts/config.py unset MBEDTLS_ENTROPY_C
1590 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1591 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001592 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1593 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1594 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001595 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1596 # the SSL test programs don't have an RNG and can't work. Explicitly
1597 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001598 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001599
1600 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1601 make test
1602
Gilles Peskine8eb29432021-02-03 20:07:11 +01001603 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001604 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001605}
1606
1607component_test_psa_external_rng_no_drbg_use_psa () {
1608 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001609 scripts/config.py full
1610 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001611 scripts/config.py unset MBEDTLS_ENTROPY_C
1612 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1613 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001614 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1615 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1616 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001617 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001618
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001619 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001620 make test
1621
Gilles Peskine8eb29432021-02-03 20:07:11 +01001622 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001623 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001624}
1625
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001626component_test_psa_external_rng_use_psa_crypto () {
1627 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1628 scripts/config.py full
1629 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1630 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1631 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001632 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001633
1634 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1635 make test
1636
1637 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1638 tests/ssl-opt.sh -f 'Default\|opaque'
1639}
1640
Gilles Peskine801c4332023-04-28 21:04:28 +02001641component_test_psa_inject_entropy () {
1642 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1643 scripts/config.py full
1644 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1645 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1646 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1647 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1648 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1649 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001650 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 +02001651
1652 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1653 make test
1654}
1655
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001656component_test_sw_inet_pton () {
1657 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1658
1659 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1660 scripts/config.py set MBEDTLS_TEST_HOOKS
1661 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1662
1663 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1664 make test
1665}
1666
Valerio Settia41654d2024-02-08 10:33:11 +01001667component_full_no_pkparse_pkwrite() {
1668 msg "build: full without pkparse and pkwrite"
1669
1670 scripts/config.py crypto_full
1671 scripts/config.py unset MBEDTLS_PK_PARSE_C
1672 scripts/config.py unset MBEDTLS_PK_WRITE_C
1673
Valerio Settia41654d2024-02-08 10:33:11 +01001674 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1675
1676 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001677 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1678 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001679
1680 msg "test: full without pkparse and pkwrite"
1681 make test
1682}
1683
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001684component_test_crypto_full_md_light_only () {
1685 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001686 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001687
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001688 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001689 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001690 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001691 scripts/config.py unset MBEDTLS_HKDF_C
1692 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001693 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001694 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001695 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001696 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001697 # Disable things that would auto-enable MD_C
1698 scripts/config.py unset MBEDTLS_PKCS5_C
1699
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001700 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1701 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001702 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001703
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001704 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001705 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1706 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001707
1708 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001709 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001710}
1711
Ronald Cron8dbea482024-05-23 16:04:11 +02001712component_test_full_no_cipher () {
1713 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001714
1715 scripts/config.py full
1716 scripts/config.py unset MBEDTLS_CIPHER_C
1717
Ronald Cron8dbea482024-05-23 16:04:11 +02001718 # The built-in implementation of the following algs/key-types depends
1719 # on CIPHER_C so we disable them.
1720 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1721 # so we keep them enabled.
1722 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1723 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1724 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1725 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1726 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1727 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1732 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1733
Valerio Settic84d9402023-10-23 14:58:25 +02001734 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001735 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001736 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001737
Gilles Peskine21570cf2023-12-22 11:49:50 +01001738 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001739
Valerio Setti7e710e82023-08-25 09:14:15 +02001740 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001741 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001742
Ronald Cron8dbea482024-05-23 16:04:11 +02001743 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001744 make test
1745}
1746
Valerio Settibdfecb62023-11-07 15:37:20 +01001747component_test_full_no_ccm() {
1748 msg "build: full no PSA_WANT_ALG_CCM"
1749
1750 # Full config enables:
1751 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1752 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1753 scripts/config.py full
1754
1755 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1756 # enabled, but not used from TLS since USE_PSA is set.
1757 # This is helpful to ensure that TLS tests below have proper dependencies.
1758 #
1759 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1760 # PSA_WANT_ALG_CCM to be re-enabled.
1761 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1762
Gilles Peskine21570cf2023-12-22 11:49:50 +01001763 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001764
1765 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001766 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001767}
1768
1769component_test_full_no_ccm_star_no_tag() {
1770 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1771
1772 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1773 scripts/config.py full
1774
1775 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1776 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1777 # This basically disables all unauthenticated ciphers on the PSA side, while
1778 # keeping AEADs enabled.
1779 #
1780 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1781 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1782 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1783 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1784 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1785 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1786 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1787 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1788 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1789 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1790
Gilles Peskine21570cf2023-12-22 11:49:50 +01001791 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001792
1793 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001794 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001795
1796 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001797 make test
1798}
1799
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001800component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001801 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001802
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001803 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001804 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001805 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001806 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001807 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001808 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1809 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001810 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001811 scripts/config.py unset MBEDTLS_GCM_C
1812 scripts/config.py unset MBEDTLS_CCM_C
1813 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001814 #Disable TLS 1.3 (as no AEAD)
1815 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001816 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1817 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1818 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001819 # 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 +01001820 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001821 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001822 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001823 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001824 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1825 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001826 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001827 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001828 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001829
Przemek Stekiel9550c052022-09-28 09:51:55 +02001830 make
1831
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001832 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001833 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001834
1835 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001836}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001837
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001838component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001839 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001840
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001841 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001842 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001843 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001844 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001845 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001846 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1847 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001848 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001849 scripts/config.py unset MBEDTLS_GCM_C
1850 scripts/config.py unset MBEDTLS_CCM_C
1851 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001852 #Disable TLS 1.3 (as no AEAD)
1853 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001854 # 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 +01001855 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001856 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001857 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001858 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001859 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001860 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001861 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001862 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001863
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001864 make
1865
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001866 msg "test: default with only CBC-legacy cipher use psa"
1867 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001868
1869 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1870 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001871}
1872
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001873component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001874 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001875
1876 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001877 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001878 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001879 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001880 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001881 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1882 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001883 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001884 scripts/config.py unset MBEDTLS_GCM_C
1885 scripts/config.py unset MBEDTLS_CCM_C
1886 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001887 #Disable TLS 1.3 (as no AEAD)
1888 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001889 # 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 +01001890 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001891 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1892 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1893 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001894 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001895 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001896 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001897 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001898
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001899 make
1900
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001901 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001902 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001903
1904 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1905 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001906}
1907
Valerio Setti9f0ec532022-11-08 13:03:24 +01001908# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1909# that we could use for interop testing. However, we now have sort of two
1910# implementations ourselves: one using PSA, the other not. At least test that
1911# these two interoperate with each other.
1912component_test_tls1_2_ecjpake_compatibility() {
1913 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1914 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001915 # Explicitly make lib first to avoid a race condition:
1916 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1917 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001918 make -C programs ssl/ssl_server2 ssl/ssl_client2
1919 cp programs/ssl/ssl_server2 s2_no_use_psa
1920 cp programs/ssl/ssl_client2 c2_no_use_psa
1921
1922 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1923 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1924 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001925 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001926 make -C programs ssl/ssl_server2 ssl/ssl_client2
1927 make -C programs test/udp_proxy test/query_compile_time_config
1928
Valerio Setti70e02902022-12-02 16:21:56 +01001929 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1930 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1931 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1932 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1933 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1934 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1935 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1936 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 +01001937
1938 rm s2_no_use_psa c2_no_use_psa
1939}
1940
Gilles Peskine636c26a2020-03-04 20:46:15 +01001941component_test_everest () {
1942 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001943 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1944 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1945 make
1946
1947 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1948 make test
1949
Gilles Peskine6848d172023-11-02 19:58:03 +01001950 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001951 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001952
Gilles Peskine636c26a2020-03-04 20:46:15 +01001953 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001954 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001955
1956 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1957 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001958 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001959}
1960
Gilles Peskined3beca92020-07-03 00:15:37 +02001961component_test_everest_curve25519_only () {
1962 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001963 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001964 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1965 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001966 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1967 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1968 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001969 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1970 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001971 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001972 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1973
Gilles Peskined3beca92020-07-03 00:15:37 +02001974 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001975 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001976 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
1977 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02001978
Dave Rodgman17127e92023-12-14 16:42:48 +00001979 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001980
1981 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1982 make test
1983}
1984
Gilles Peskine8f073122018-11-27 15:58:47 +01001985component_test_small_ssl_out_content_len () {
1986 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001987 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1988 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001989 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001990 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001991
Gilles Peskine8f073122018-11-27 15:58:47 +01001992 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001993 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001994}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001995
Gilles Peskine8f073122018-11-27 15:58:47 +01001996component_test_small_ssl_in_content_len () {
1997 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001998 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
1999 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002000 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002001 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002002
Gilles Peskine8f073122018-11-27 15:58:47 +01002003 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002004 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002005}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002006
Gilles Peskine8f073122018-11-27 15:58:47 +01002007component_test_small_ssl_dtls_max_buffering () {
2008 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002009 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002010 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002011 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002012
Gilles Peskine8f073122018-11-27 15:58:47 +01002013 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002014 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 +01002015}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002016
Gilles Peskine8f073122018-11-27 15:58:47 +01002017component_test_small_mbedtls_ssl_dtls_max_buffering () {
2018 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002019 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002020 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002021 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002022
Gilles Peskine8f073122018-11-27 15:58:47 +01002023 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002024 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002025}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002026
Gilles Peskine75cc7712019-09-06 19:47:17 +02002027component_test_psa_collect_statuses () {
2028 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002029 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002030 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002031 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002032 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002033 rm -f tests/statuses.log
2034}
2035
Gilles Peskine8f073122018-11-27 15:58:47 +01002036component_test_full_cmake_clang () {
2037 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002038 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002039 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 +01002040 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002041
k-stachowiak0291cb72019-06-26 15:52:12 +02002042 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002043 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002044
Gilles Peskineda6017c2022-10-30 21:02:40 +01002045 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2046 programs/test/cpp_dummy_build
2047
Gilles Peskine6848d172023-11-02 19:58:03 +01002048 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002049 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002050
Gilles Peskine82b27272019-06-14 18:27:03 +02002051 msg "program demos (full config, clang)" # ~10s
2052 tests/scripts/run_demos.py
2053
k-stachowiak0291cb72019-06-26 15:52:12 +02002054 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002055 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002056
Gilles Peskine8f073122018-11-27 15:58:47 +01002057 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002058 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002059}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002060
Gilles Peskine0c671602022-11-29 16:01:41 +01002061skip_suites_without_constant_flow () {
2062 # Skip the test suites that don't have any constant-flow annotations.
2063 # This will need to be adjusted if we ever start declaring things as
2064 # secret from macros or functions inside tests/include or tests/src.
2065 SKIP_TEST_SUITES=$(
2066 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2067 sed 's/test_suite_//; s/\.function$//' |
2068 tr '\n' ,)
2069 export SKIP_TEST_SUITES
2070}
2071
Dave Rodgman246210e2023-07-31 18:07:44 +01002072skip_all_except_given_suite () {
2073 # Skip all but the given test suite
2074 SKIP_TEST_SUITES=$(
2075 ls -1 tests/suites/test_suite_*.function |
2076 grep -v $1.function |
2077 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2078 tr '\n' ,)
2079 export SKIP_TEST_SUITES
2080}
2081
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002082component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002083 # This tests both (1) accesses to undefined memory, and (2) branches or
2084 # memory access depending on secret values. To distinguish between those:
2085 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2086 # - or alternatively, change the build type to MemSanDbg, which enables
2087 # origin tracking and nicer stack traces (which are useful for debugging
2088 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002089 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2090 scripts/config.py full
2091 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2092 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2093 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2094 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2095 make
2096
2097 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2098 make test
2099}
2100
2101component_test_memsan_constant_flow_psa () {
2102 # This tests both (1) accesses to undefined memory, and (2) branches or
2103 # memory access depending on secret values. To distinguish between those:
2104 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2105 # - or alternatively, change the build type to MemSanDbg, which enables
2106 # origin tracking and nicer stack traces (which are useful for debugging
2107 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002108 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002109 scripts/config.py full
2110 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2111 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2112 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2113 make
2114
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002115 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002116 make test
2117}
2118
Bence Szépkúti0354d042023-12-06 16:14:37 +01002119component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002120 # This tests both (1) everything that valgrind's memcheck usually checks
2121 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2122 # etc.) and (2) branches or memory access depending on secret values,
2123 # which will be reported as uninitialized memory. To distinguish between
2124 # secret and actually uninitialized:
2125 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2126 # - or alternatively, build with debug info and manually run the offending
2127 # test suite with valgrind --track-origins=yes, then check if the origin
2128 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002129 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2130 scripts/config.py full
2131 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2132 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002133 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002134 cmake -D CMAKE_BUILD_TYPE:String=Release .
2135 make
2136
2137 # this only shows a summary of the results (how many of each type)
2138 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002139 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002140 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002141
2142 # Test asm path in constant time module - by default, it will test the plain C
2143 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2144 msg "test: valgrind asm constant_time"
2145 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2146 skip_all_except_given_suite test_suite_constant_time
2147 cmake -D CMAKE_BUILD_TYPE:String=Release .
2148 make clean
2149 make
2150 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002151}
2152
Bence Szépkúti0354d042023-12-06 16:14:37 +01002153component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002154 # This tests both (1) everything that valgrind's memcheck usually checks
2155 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2156 # etc.) and (2) branches or memory access depending on secret values,
2157 # which will be reported as uninitialized memory. To distinguish between
2158 # secret and actually uninitialized:
2159 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2160 # - or alternatively, build with debug info and manually run the offending
2161 # test suite with valgrind --track-origins=yes, then check if the origin
2162 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002163 msg "build: cmake release GCC, full config with constant flow testing"
2164 scripts/config.py full
2165 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002166 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002167 cmake -D CMAKE_BUILD_TYPE:String=Release .
2168 make
2169
2170 # this only shows a summary of the results (how many of each type)
2171 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002172 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002173 make memcheck
2174}
2175
Janos Follath9338cac2023-10-04 18:55:39 +01002176component_test_tsan () {
2177 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002178 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002179 scripts/config.py set MBEDTLS_THREADING_C
2180 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002181 # Self-tests do not currently use multiple threads.
2182 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002183
Ryan6caf84f2024-03-05 13:57:00 +00002184 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2185 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2186
Janos Follath9338cac2023-10-04 18:55:39 +01002187 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2188 make
2189
2190 msg "test: main suites (TSan)"
2191 make test
2192}
2193
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002194component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002195 # Test that removing the deprecated features from the default
2196 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002197 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2198 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002199 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002200
2201 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2202 make test
2203}
2204
2205component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002206 msg "build: make, full_no_deprecated config" # ~ 30s
2207 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002208 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002209
Gilles Peskine30de2e82020-04-20 21:39:22 +02002210 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002211 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002212
2213 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2214 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002215}
2216
Gilles Peskine8386ea22020-04-30 09:07:29 +02002217component_test_full_no_deprecated_deprecated_warning () {
2218 # Test that there is nothing deprecated in "full_no_deprecated".
2219 # A deprecated feature would trigger a warning (made fatal) from
2220 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002221 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2222 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002223 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2224 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002225 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002226
Gilles Peskine30de2e82020-04-20 21:39:22 +02002227 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002228 make test
2229}
2230
Gilles Peskine8386ea22020-04-30 09:07:29 +02002231component_test_full_deprecated_warning () {
2232 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2233 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002234 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002235 scripts/config.py full
2236 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002237 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002238 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2239 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002240 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002241
Gilles Peskine8386ea22020-04-30 09:07:29 +02002242 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2243 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2244 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002245 # Expect warnings from '#warning' directives in check_config.h and
2246 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002247 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 +01002248
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002249 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2250 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002251
2252 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2253 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002254}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002255
Gilles Peskineec541fe2020-01-31 14:24:14 +01002256# Check that the specified libraries exist and are empty.
2257are_empty_libraries () {
2258 nm "$@" >/dev/null 2>/dev/null
2259 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2260}
2261
2262component_build_crypto_default () {
2263 msg "build: make, crypto only"
2264 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002265 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002266 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002267}
2268
2269component_build_crypto_full () {
2270 msg "build: make, crypto only, full config"
2271 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002272 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002273 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002274}
2275
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002276component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002277 msg "build: make, config for PSA crypto service"
2278 scripts/config.py crypto
2279 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2280 # Disable things that are not needed for just cryptography, to
2281 # reach a configuration that would be typical for a PSA cryptography
2282 # service providing all implemented PSA algorithms.
2283 # System stuff
2284 scripts/config.py unset MBEDTLS_ERROR_C
2285 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002286 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002287 # Crypto stuff with no PSA interface
2288 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002289 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002290 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002291 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002292 scripts/config.py unset MBEDTLS_NIST_KW_C
2293 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2294 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2295 scripts/config.py unset MBEDTLS_PKCS12_C
2296 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002297 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2298 # in PSA code to work with RSA keys. We don't require users to set those:
2299 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002300 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002301 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002302 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002303 make CFLAGS='-O1 -Werror' all test
2304 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2305}
2306
Gilles Peskineec541fe2020-01-31 14:24:14 +01002307component_build_crypto_baremetal () {
2308 msg "build: make, crypto only, baremetal config"
2309 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002310 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002311 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002312}
Daniel Axtens446af202020-09-02 21:30:13 +10002313support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002314 support_build_baremetal "$@"
2315}
2316
2317component_build_baremetal () {
2318 msg "build: make, baremetal config"
2319 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002320 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002321}
2322support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002323 # Older Glibc versions include time.h from other headers such as stdlib.h,
2324 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2325 # problem, Ubuntu 18.04 is ok.
2326 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2327}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002328
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002329# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002330component_test_depends_py_cipher_id () {
2331 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002332 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002333}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002334
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002335component_test_depends_py_cipher_chaining () {
2336 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002337 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002338}
2339
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002340component_test_depends_py_cipher_padding () {
2341 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002342 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002343}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002344
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002345component_test_depends_py_curves () {
2346 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002347 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002348}
2349
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002350component_test_depends_py_hashes () {
2351 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002352 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002353}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002354
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002355component_test_depends_py_kex () {
2356 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002357 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002358}
2359
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002360component_test_depends_py_pkalgs () {
2361 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002362 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002363}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002364
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002365# PSA equivalents of the depends.py tests
2366component_test_depends_py_cipher_id_psa () {
2367 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002368 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002369}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002370
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002371component_test_depends_py_cipher_chaining_psa () {
2372 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002373 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002374}
2375
2376component_test_depends_py_cipher_padding_psa () {
2377 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002378 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002379}
2380
2381component_test_depends_py_curves_psa () {
2382 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002383 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002384}
2385
2386component_test_depends_py_hashes_psa () {
2387 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002388 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002389}
2390
2391component_test_depends_py_kex_psa () {
2392 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002393 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002394}
2395
2396component_test_depends_py_pkalgs_psa () {
2397 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002398 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002399}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002400
Valerio Setti6bed64e2024-01-17 15:21:44 +01002401component_test_psa_crypto_config_ffdh_2048_only () {
2402 msg "build: full config - only DH 2048"
2403
2404 scripts/config.py full
2405
2406 # Disable all DH groups other than 2048.
2407 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2408 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2409 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2410 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2411
2412 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2413
2414 msg "test: full config - only DH 2048"
2415 make test
2416
2417 msg "ssl-opt: full config - only DH 2048"
2418 tests/ssl-opt.sh -f "ffdh"
2419}
2420
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002421component_build_no_pk_rsa_alt_support () {
2422 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2423
2424 scripts/config.py full
2425 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2426 scripts/config.py set MBEDTLS_RSA_C
2427 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2428
2429 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002430 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002431}
2432
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002433component_build_module_alt () {
2434 msg "build: MBEDTLS_XXX_ALT" # ~30s
2435 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002436
2437 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002438 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002439 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002440 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002441 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2442 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002443 # You can only have one threading implementation: alt or pthread, not both.
2444 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002445 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2446 # directly and assumes the implementation works with partial groups.
2447 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002448 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2449 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2450 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002451 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2452 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2453 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002454
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002455 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2456 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2457 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002458
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002459 # We can only compile, not link, since we don't have any implementations
2460 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002461 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002462}
2463
Gilles Peskine64996c32024-01-23 20:25:47 +01002464component_test_no_psa_crypto_full_cmake_asan() {
2465 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2466 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002467 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002468 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002469 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002470 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002471 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002472 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002473 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002474 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002475 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002476 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002477 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002478 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002479
Gilles Peskine64996c32024-01-23 20:25:47 +01002480 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002481 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002482
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002483 # Note: ssl-opt.sh has some test cases that depend on
2484 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2485 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002486 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002487 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002488
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002489 # Note: the next two invocations cover all compat.sh test cases.
2490 # We should use the same here and in basic-build-test.sh.
2491 msg "test: compat.sh: default version (full minus PSA crypto)"
2492 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002493
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002494 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002495 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002496}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002497
Ronald Cron403c15c2021-09-13 09:38:05 +02002498component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002499 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002500
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002501 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002502 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002503 $(helper_get_psa_key_type_list "ECC") \
2504 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002505
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002506 # Configure
2507 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002508
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002509 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002510 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002511
2512 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002513 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002514
2515 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002516 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2517 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2518
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002519 # Build
2520 # -----
2521
2522 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002523 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2524 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002525
2526 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2527
Valerio Setti3fe105b2023-10-30 11:08:12 +01002528 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002529
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002530 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002531 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002532
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002533 # Run the tests
2534 # -------------
2535
Ronald Cron403c15c2021-09-13 09:38:05 +02002536 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2537 make test
2538}
2539
Valerio Setti44b178c2023-03-22 14:02:57 +01002540component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002541 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002542
2543 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002544 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002545 $(helper_get_psa_key_type_list "ECC") \
2546 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002547
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002548 # Configure
2549 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002550
Ronald Cron46ac0652024-03-18 12:39:04 +01002551 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002552 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002553
Valerio Setti44b178c2023-03-22 14:02:57 +01002554 # Disable the module that's accelerated
2555 scripts/config.py unset MBEDTLS_ECDH_C
2556
2557 # Disable things that depend on it
2558 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2559 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2560 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2561 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2562 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2563
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002564 # Build
2565 # -----
2566
2567 helper_libtestdriver1_make_drivers "$loc_accel_list"
2568
Valerio Setti3fe105b2023-10-30 11:08:12 +01002569 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002570
Valerio Setti44b178c2023-03-22 14:02:57 +01002571 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002572 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002573
2574 # Run the tests
2575 # -------------
2576
Valerio Setti44b178c2023-03-22 14:02:57 +01002577 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002578 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002579}
2580
Przemek Stekieldccb2022023-05-11 10:48:50 +02002581component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002582 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002583
2584 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002585 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002586 $(helper_get_psa_key_type_list "DH") \
2587 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002588
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002589 # Configure
2590 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002591
Przemek Stekiel565353e2023-07-05 11:07:07 +02002592 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002593 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002594
2595 # Disable the module that's accelerated
2596 scripts/config.py unset MBEDTLS_DHM_C
2597
2598 # Disable things that depend on it
2599 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2600 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2601
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002602 # Build
2603 # -----
2604
2605 helper_libtestdriver1_make_drivers "$loc_accel_list"
2606
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002607 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002608
2609 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002610 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002611
2612 # Run the tests
2613 # -------------
2614
Gilles Peskine14302ed2023-07-19 19:30:04 +02002615 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002616 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002617
Gilles Peskine14302ed2023-07-19 19:30:04 +02002618 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002619 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002620}
2621
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002622component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002623 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002624
2625 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002626 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002627
2628 # Disable things that are not supported
2629 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2630 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002631 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002632
Gilles Peskine14302ed2023-07-19 19:30:04 +02002633 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002634 make test
2635
Gilles Peskine14302ed2023-07-19 19:30:04 +02002636 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002637 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002638}
2639
Valerio Setti44b178c2023-03-22 14:02:57 +01002640component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002641 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002642
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002643 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002644 $(helper_get_psa_key_type_list "ECC") \
2645 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002646
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002647 # Configure
2648 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002649
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002650 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002651
2652 # Make built-in fallback not available
2653 scripts/config.py unset MBEDTLS_ECJPAKE_C
2654 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2655
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002656 # Build
2657 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002658
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002659 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002660
Valerio Setti3fe105b2023-10-30 11:08:12 +01002661 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002662
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002663 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002664 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002665
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002666 # Run the tests
2667 # -------------
2668
Gilles Peskine14302ed2023-07-19 19:30:04 +02002669 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002670 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002671}
2672
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002673component_test_psa_crypto_config_accel_ecc_some_key_types () {
2674 msg "build: full with accelerated EC algs and some key types"
2675
2676 # Algorithms and key types to accelerate
2677 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2678 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2679 ALG_ECDH \
2680 ALG_JPAKE \
2681 KEY_TYPE_ECC_PUBLIC_KEY \
2682 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2683 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002684 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2685 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002686
2687 # Configure
2688 # ---------
2689
2690 # start with config full for maximum coverage (also enables USE_PSA)
2691 helper_libtestdriver1_adjust_config "full"
2692
2693 # Disable modules that are accelerated - some will be re-enabled
2694 scripts/config.py unset MBEDTLS_ECDSA_C
2695 scripts/config.py unset MBEDTLS_ECDH_C
2696 scripts/config.py unset MBEDTLS_ECJPAKE_C
2697 scripts/config.py unset MBEDTLS_ECP_C
2698
2699 # Disable all curves - those that aren't accelerated should be re-enabled
2700 helper_disable_builtin_curves
2701
2702 # Restartable feature is not yet supported by PSA. Once it will in
2703 # the future, the following line could be removed (see issues
2704 # 6061, 6332 and following ones)
2705 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2706
2707 # this is not supported by the driver API yet
2708 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2709
2710 # Build
2711 # -----
2712
2713 # These hashes are needed for some ECDSA signature tests.
2714 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2715 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2716 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2717
Valerio Setti3fe105b2023-10-30 11:08:12 +01002718 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002719
2720 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002721 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2722 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2723 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2724 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002725
2726 # Run the tests
2727 # -------------
2728
2729 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002730 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002731}
2732
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002733# Run tests with only (non-)Weierstrass accelerated
2734# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002735# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2736# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002737common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002738 weierstrass=$1
2739 if [ $weierstrass -eq 1 ]; then
2740 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002741 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002742 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002743 fi
2744
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002745 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002746
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002747 # Note: Curves are handled in a special way by the libtestdriver machinery,
2748 # so we only want to include them in the accel list when building the main
2749 # libraries, hence the use of a separate variable.
2750 # Note: the following loop is a modified version of
2751 # helper_get_psa_curve_list that only keeps Weierstrass families.
2752 loc_weierstrass_list=""
2753 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002754 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2755 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002756 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002757 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002758 ;;
2759 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002760 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002761 ;;
2762 esac
2763 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002764 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002765 loc_curve_list=$loc_weierstrass_list
2766 else
2767 loc_curve_list=$loc_non_weierstrass_list
2768 fi
2769
Valerio Setti3fe105b2023-10-30 11:08:12 +01002770 # Algorithms and key types to accelerate
2771 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2772 ALG_ECDH \
2773 ALG_JPAKE \
2774 $(helper_get_psa_key_type_list "ECC") \
2775 $loc_curve_list"
2776
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002777 # Configure
2778 # ---------
2779
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002780 # Start with config crypto_full and remove PK_C:
2781 # that's what's supported now, see docs/driver-only-builds.md.
2782 helper_libtestdriver1_adjust_config "crypto_full"
2783 scripts/config.py unset MBEDTLS_PK_C
2784 scripts/config.py unset MBEDTLS_PK_PARSE_C
2785 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002786
2787 # Disable modules that are accelerated - some will be re-enabled
2788 scripts/config.py unset MBEDTLS_ECDSA_C
2789 scripts/config.py unset MBEDTLS_ECDH_C
2790 scripts/config.py unset MBEDTLS_ECJPAKE_C
2791 scripts/config.py unset MBEDTLS_ECP_C
2792
2793 # Disable all curves - those that aren't accelerated should be re-enabled
2794 helper_disable_builtin_curves
2795
2796 # Restartable feature is not yet supported by PSA. Once it will in
2797 # the future, the following line could be removed (see issues
2798 # 6061, 6332 and following ones)
2799 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2800
2801 # this is not supported by the driver API yet
2802 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2803
2804 # Build
2805 # -----
2806
2807 # These hashes are needed for some ECDSA signature tests.
2808 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2809 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2810 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2811
Valerio Settiac7a8092023-10-31 12:23:44 +01002812 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002813
2814 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002815 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002816 # We expect ECP to be re-enabled, however the parts specific to the
2817 # families of curves that are accelerated should be ommited.
2818 # - functions with mxz in the name are specific to Montgomery curves
2819 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002820 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002821 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002822 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2823 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002824 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002825 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2826 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002827 fi
2828 # We expect ECDSA and ECJPAKE to be re-enabled only when
2829 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002830 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002831 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2832 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002833 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002834 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2835 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002836 fi
2837
2838 # Run the tests
2839 # -------------
2840
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002841 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2842 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002843}
2844
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002845component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002846 common_test_psa_crypto_config_accel_ecc_some_curves 1
2847}
2848
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002849component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002850 common_test_psa_crypto_config_accel_ecc_some_curves 0
2851}
2852
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002853# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2854# ECDH, ECDSA) with and without drivers.
2855# The input parameter is a boolean value which indicates:
2856# - 0 keep built-in EC algs,
2857# - 1 exclude built-in EC algs (driver only).
2858#
2859# This is used by the two following components to ensure they always use the
2860# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002861# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2862# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002863# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002864config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002865 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002866 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002867 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002868 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002869 # Disable modules that are accelerated
2870 scripts/config.py unset MBEDTLS_ECDSA_C
2871 scripts/config.py unset MBEDTLS_ECDH_C
2872 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002873 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002874 fi
2875
2876 # Restartable feature is not yet supported by PSA. Once it will in
2877 # the future, the following line could be removed (see issues
2878 # 6061, 6332 and following ones)
2879 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002880}
2881
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002882# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2883component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002884 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002885
2886 # Algorithms and key types to accelerate
2887 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2888 ALG_ECDH \
2889 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002890 $(helper_get_psa_key_type_list "ECC") \
2891 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002892
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002893 # Configure
2894 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002895
2896 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002897 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002898
Valerio Setti0a342c92023-09-01 09:12:31 +02002899 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002900 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2901 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002902
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002903 # Build
2904 # -----
2905
2906 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002907 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2908 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002909 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2910
Valerio Setti3fe105b2023-10-30 11:08:12 +01002911 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002912
2913 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002914 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2915 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2916 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2917 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002918
2919 # Run the tests
2920 # -------------
2921
Gilles Peskine14302ed2023-07-19 19:30:04 +02002922 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002923 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002924
Gilles Peskine14302ed2023-07-19 19:30:04 +02002925 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002926 tests/ssl-opt.sh
2927}
2928
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002929# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2930component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002931 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002932
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002933 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002934
Gilles Peskine21570cf2023-12-22 11:49:50 +01002935 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002936
Gilles Peskine14302ed2023-07-19 19:30:04 +02002937 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002938 make test
2939
Gilles Peskine14302ed2023-07-19 19:30:04 +02002940 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002941 tests/ssl-opt.sh
2942}
2943
Valerio Settie618cb02023-04-12 14:59:16 +02002944# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002945# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2946# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002947# to ensure that both tests use the same underlying configuration when testing
2948# driver's coverage with analyze_outcomes.py.
2949#
2950# This functions accepts 1 boolean parameter as follows:
2951# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2952# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2953# - 0: include built-in implementation of EC algorithms.
2954#
2955# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2956# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002957config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002958 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002959 # start with full config for maximum coverage (also enables USE_PSA)
2960 helper_libtestdriver1_adjust_config "full"
2961
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002962 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002963 # Disable modules that are accelerated
2964 scripts/config.py unset MBEDTLS_ECDSA_C
2965 scripts/config.py unset MBEDTLS_ECDH_C
2966 scripts/config.py unset MBEDTLS_ECJPAKE_C
2967 # Disable ECP module (entirely)
2968 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002969 fi
2970
Valerio Settiaecd32c2023-06-14 10:42:31 +02002971 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2972 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002973 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002974 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002975
Valerio Settie618cb02023-04-12 14:59:16 +02002976 # Restartable feature is not yet supported by PSA. Once it will in
2977 # the future, the following line could be removed (see issues
2978 # 6061, 6332 and following ones)
2979 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002980}
2981
2982# Build and test a configuration where driver accelerates all EC algs while
2983# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2984# side.
2985#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002986# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2987component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002988 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002989
2990 # Algorithms and key types to accelerate
2991 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2992 ALG_ECDH \
2993 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002994 $(helper_get_psa_key_type_list "ECC") \
2995 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02002996
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002997 # Configure
2998 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002999
Valerio Settie618cb02023-04-12 14:59:16 +02003000 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003001 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003002 # Disable all the builtin curves. All the required algs are accelerated.
3003 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003004
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003005 # Build
3006 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003007
3008 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003009 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3010 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3011 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003012
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003013 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003014
Valerio Setti3fe105b2023-10-30 11:08:12 +01003015 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003016
3017 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003018 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3019 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3020 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003021 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003022 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003023
3024 # Run the tests
3025 # -------------
3026
Gilles Peskine14302ed2023-07-19 19:30:04 +02003027 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003028 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003029
Gilles Peskine14302ed2023-07-19 19:30:04 +02003030 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003031 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003032}
3033
3034# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003035# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003036# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003037component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003038 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003039
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003040 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003041
Gilles Peskine21570cf2023-12-22 11:49:50 +01003042 make
Valerio Settie618cb02023-04-12 14:59:16 +02003043
Gilles Peskine14302ed2023-07-19 19:30:04 +02003044 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003045 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003046
Gilles Peskine14302ed2023-07-19 19:30:04 +02003047 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003048 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003049}
3050
Valerio Setti4e2f2442023-08-15 10:10:26 +02003051# This is a common configuration helper used directly from:
3052# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3053# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3054# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003055# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003056# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003057# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003058# - this is the reference component of the above
3059# - it still disables RSA and FFDH, but it uses builtin EC algs
3060# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3061# - accelerate all EC and FFDH algs, disable only RSA
3062# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3063# - this is the reference component of the above
3064# - it still disables RSA, but it uses builtin EC and FFDH algs
3065#
3066# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003067# $1: a boolean value which states if we are testing an accelerated scenario
3068# or not.
3069# $2: a string value which states which components are tested. Allowed values
3070# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003071config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003072 driver_only="$1"
3073 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003074 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003075 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003076
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003077 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003078 # Disable modules that are accelerated
3079 scripts/config.py unset MBEDTLS_ECDSA_C
3080 scripts/config.py unset MBEDTLS_ECDH_C
3081 scripts/config.py unset MBEDTLS_ECJPAKE_C
3082 # Disable ECP module (entirely)
3083 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003084 # Also disable bignum
3085 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003086 fi
3087
3088 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3089 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3090 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3091 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3092
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003093 # RSA support is intentionally disabled on this test because RSA_C depends
3094 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003095 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3096 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 +02003097 scripts/config.py unset MBEDTLS_RSA_C
3098 scripts/config.py unset MBEDTLS_PKCS1_V15
3099 scripts/config.py unset MBEDTLS_PKCS1_V21
3100 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3101 # Also disable key exchanges that depend on RSA
3102 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3103 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3104 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3105 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3106 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3107
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003108 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003109 # When testing ECC only, we disable FFDH support, both from builtin and
3110 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003111 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003112 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 +01003113 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003114 scripts/config.py unset MBEDTLS_DHM_C
3115 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3116 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3117 else
3118 # When testing ECC and DH instead, we disable DHM and depending key
3119 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003120 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003121 scripts/config.py unset MBEDTLS_DHM_C
3122 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3123 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3124 fi
3125 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003126
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003127 # Restartable feature is not yet supported by PSA. Once it will in
3128 # the future, the following line could be removed (see issues
3129 # 6061, 6332 and following ones)
3130 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3131}
3132
Valerio Setti4e2f2442023-08-15 10:10:26 +02003133# Common helper used by:
3134# - component_test_psa_crypto_config_accel_ecc_no_bignum
3135# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003136#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003137# The goal is to build and test accelerating either:
3138# - ECC only or
3139# - both ECC and FFDH
3140#
3141# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003142# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3143# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003144common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003145 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003146
Valerio Setti5dfaca42023-09-05 08:48:51 +02003147 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003148 if [ "$test_target" = "ECC_DH" ]; then
3149 accel_text="ECC/FFDH"
3150 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003151 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003152 accel_text="ECC"
3153 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003154 fi
3155
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003156 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003157
3158 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003159 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3160 ALG_ECDH \
3161 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003162 $(helper_get_psa_key_type_list "ECC") \
3163 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003164 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003165 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003166 loc_accel_list="$loc_accel_list \
3167 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003168 $(helper_get_psa_key_type_list "DH") \
3169 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003170 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003171
3172 # Configure
3173 # ---------
3174
3175 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003176 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003177 # Disable all the builtin curves. All the required algs are accelerated.
3178 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003179
3180 # Build
3181 # -----
3182
3183 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003184 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3185 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3186 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003187
3188 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3189
Valerio Setti3fe105b2023-10-30 11:08:12 +01003190 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003191
3192 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003193 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3194 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3195 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003196 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003197 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3198 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3199 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3200 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003201
3202 # Run the tests
3203 # -------------
3204
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003205 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003206
Gilles Peskine21570cf2023-12-22 11:49:50 +01003207 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003208
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003209 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003210 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003211}
3212
Valerio Setti4e2f2442023-08-15 10:10:26 +02003213# Common helper used by:
3214# - component_test_psa_crypto_config_reference_ecc_no_bignum
3215# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3216#
3217# The goal is to build and test a reference scenario (i.e. with builtin
3218# components) compared to the ones used in
3219# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3220#
3221# It is meant to be used in conjunction with
3222# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3223# coverage analysis in "analyze_outcomes.py" script.
3224common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003225 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003226
Valerio Setti5dfaca42023-09-05 08:48:51 +02003227 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003228 if [ "$test_target" = "ECC_DH" ]; then
3229 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003230 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003231 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003232 fi
3233
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003234 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003235
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003236 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003237
Gilles Peskine21570cf2023-12-22 11:49:50 +01003238 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003239
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003240 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003241 make test
3242
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003243 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003244 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003245}
3246
Valerio Setti4e2f2442023-08-15 10:10:26 +02003247component_test_psa_crypto_config_accel_ecc_no_bignum () {
3248 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3249}
3250
3251component_test_psa_crypto_config_reference_ecc_no_bignum () {
3252 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3253}
3254
3255component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3256 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3257}
3258
3259component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3260 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3261}
3262
Valerio Settiac6d35f2023-08-04 12:49:11 +02003263# Helper for setting common configurations between:
3264# - component_test_tfm_config_p256m_driver_accel_ec()
3265# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003266common_tfm_config () {
3267 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003268 cp configs/config-tfm.h "$CONFIG_H"
3269 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3270 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003271
Yanray Wang73bb2312023-09-25 11:21:15 +08003272 # Other config adjustment to make the tests pass.
3273 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003274 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003275 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3276 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003277
Yanray Wang73bb2312023-09-25 11:21:15 +08003278 # Config adjustment for better test coverage in our environment.
3279 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003280 #
3281 # Enable filesystem I/O for the benefit of PK parse/write tests.
3282 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3283}
3284
Valerio Settiac6d35f2023-08-04 12:49:11 +02003285# Keep this in sync with component_test_tfm_config() as they are both meant
3286# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003287component_test_tfm_config_p256m_driver_accel_ec () {
3288 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3289
3290 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003291
Dave Rodgman897bb772023-11-15 16:34:20 +00003292 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003293 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003294
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003295 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003296 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3297 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3298 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003299 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003300 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3301 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3302 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3303 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003304 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003305 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003306
Valerio Setti5e18b902023-12-04 12:07:30 +01003307 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3308 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003309 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003310
Valerio Settib7e95442023-03-21 11:52:33 +01003311 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003312 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003313 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003314}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003315
Valerio Settiac6d35f2023-08-04 12:49:11 +02003316# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3317# they are both meant to be used in analyze_outcomes.py for driver's coverage
3318# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003319component_test_tfm_config() {
3320 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003321
Dave Rodgman897bb772023-11-15 16:34:20 +00003322 # Disable P256M driver, which is on by default, so that analyze_outcomes
3323 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3324 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3325
Valerio Setti52ba0e32023-08-04 12:43:03 +02003326 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003327 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003328
Dave Rodgman897bb772023-11-15 16:34:20 +00003329 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003330 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003331
Valerio Setti5e18b902023-12-04 12:07:30 +01003332 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3333 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003334 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003335
Valerio Setti52ba0e32023-08-04 12:43:03 +02003336 msg "test: TF-M config"
3337 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003338}
3339
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003340# Common helper for component_full_without_ecdhe_ecdsa() and
3341# component_full_without_ecdhe_ecdsa_and_tls13() which:
3342# - starts from the "full" configuration minus the list of symbols passed in
3343# as 1st parameter
3344# - build
3345# - test only TLS (i.e. test_suite_tls and ssl-opt)
3346build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003347 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003348
3349 msg "build: full minus something, test TLS"
3350
3351 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003352 for sym in $symbols_to_disable; do
3353 echo "Disabling $sym"
3354 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003355 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003356
Gilles Peskine21570cf2023-12-22 11:49:50 +01003357 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003358
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003359 msg "test: full minus something, test TLS"
3360 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003361
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003362 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003363 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003364}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003365
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003366component_full_without_ecdhe_ecdsa () {
3367 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003368}
3369
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003370component_full_without_ecdhe_ecdsa_and_tls13 () {
3371 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3372 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003373}
3374
Valerio Setti249b18a2023-06-20 12:08:30 +02003375# This is an helper used by:
3376# - component_test_psa_ecc_key_pair_no_derive
3377# - component_test_psa_ecc_key_pair_no_generate
3378# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3379# enabled, but one. Input arguments are as follows:
3380# - $1 is the key type under test, i.e. ECC/RSA/DH
3381# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003382build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003383 key_type=$1
3384 unset_option=$2
3385 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003386
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003387 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003388 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003389 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3390 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3391
3392 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3393 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003394 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003395
Gilles Peskine21570cf2023-12-22 11:49:50 +01003396 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003397
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003398 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003399 make test
3400}
3401
3402component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003403 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003404}
3405
3406component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003407 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003408}
3409
Pengyu Lve705f572023-12-06 16:38:15 +08003410config_psa_crypto_accel_rsa () {
3411 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003412
Pengyu Lve705f572023-12-06 16:38:15 +08003413 # Start from crypto_full config (no X.509, no TLS)
3414 helper_libtestdriver1_adjust_config "crypto_full"
3415
3416 if [ "$driver_only" -eq 1 ]; then
3417 # Remove RSA support and its dependencies
3418 scripts/config.py unset MBEDTLS_RSA_C
3419 scripts/config.py unset MBEDTLS_PKCS1_V15
3420 scripts/config.py unset MBEDTLS_PKCS1_V21
3421
3422 # We need PEM parsing in the test library as well to support the import
3423 # of PEM encoded RSA keys.
3424 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3425 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3426 fi
3427}
3428
3429component_test_psa_crypto_config_accel_rsa_crypto () {
3430 msg "build: crypto_full with accelerated RSA"
3431
3432 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3433 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3434 KEY_TYPE_RSA_PUBLIC_KEY \
3435 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3436 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3437 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3438 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003439
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003440 # Configure
3441 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003442
Pengyu Lve705f572023-12-06 16:38:15 +08003443 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003444
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003445 # Build
3446 # -----
3447
Pengyu Lve705f572023-12-06 16:38:15 +08003448 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003449 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 +08003450 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003451 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003452
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003453 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003454
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003455 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003456 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003457
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003458 # Run the tests
3459 # -------------
3460
Pengyu Lve705f572023-12-06 16:38:15 +08003461 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003462 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003463}
3464
3465component_test_psa_crypto_config_reference_rsa_crypto () {
3466 msg "build: crypto_full with non-accelerated RSA"
3467
3468 # Configure
3469 # ---------
3470 config_psa_crypto_accel_rsa 0
3471
3472 # Build
3473 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003474 make
Pengyu Lve705f572023-12-06 16:38:15 +08003475
3476 # Run the tests
3477 # -------------
3478 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003479 make test
3480}
3481
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003482# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003483# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003484component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003485 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003486
Valerio Setti4590bc22023-06-13 15:39:23 +02003487 # Create a temporary output file unless there is already one set
3488 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3489 REMOVE_OUTCOME_ON_EXIT="no"
3490 else
3491 REMOVE_OUTCOME_ON_EXIT="yes"
3492 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3493 export MBEDTLS_TEST_OUTCOME_FILE
3494 fi
3495
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003496 # Start from crypto configuration
3497 scripts/config.py crypto
3498
3499 # Remove RSA support and its dependencies
3500 scripts/config.py unset MBEDTLS_PKCS1_V15
3501 scripts/config.py unset MBEDTLS_PKCS1_V21
3502 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3503 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3504 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3505 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3506 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3507 scripts/config.py unset MBEDTLS_RSA_C
3508 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3509
3510 # Enable PSA support
3511 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3512
Valerio Setti01cc88a2023-06-15 11:53:08 +02003513 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003514 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003515 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3516 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3517 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003518
3519 make
3520
Valerio Setti01cc88a2023-06-15 11:53:08 +02003521 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003522 make test
3523
3524 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3525 # performing RSA signature.
3526 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3527 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3528
3529 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3530 rm $MBEDTLS_TEST_OUTCOME_FILE
3531 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003532}
3533
Ronald Cronb2312452021-05-08 14:32:59 +02003534component_test_psa_crypto_config_accel_hash () {
3535 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3536
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003537 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3538 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3539 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003540
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003541 # Configure
3542 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003543
Ronald Cron46ac0652024-03-18 12:39:04 +01003544 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003545 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003546
3547 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003548 scripts/config.py unset MBEDTLS_MD5_C
3549 scripts/config.py unset MBEDTLS_RIPEMD160_C
3550 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003551 scripts/config.py unset MBEDTLS_SHA224_C
3552 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003553 scripts/config.py unset MBEDTLS_SHA384_C
3554 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003555 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003556
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003557 # Build
3558 # -----
3559
3560 helper_libtestdriver1_make_drivers "$loc_accel_list"
3561
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003562 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003563
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003564 # There's a risk of something getting re-enabled via config_psa.h;
3565 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003566 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3567 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3568 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3569 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3570 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003571
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003572 # Run the tests
3573 # -------------
3574
Ronald Cronb2312452021-05-08 14:32:59 +02003575 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3576 make test
3577}
3578
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003579# Auxiliary function to build config for hashes with and without drivers
3580config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003581 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003582 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003583 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003584 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003585 # disable the built-in implementation of hashes
3586 scripts/config.py unset MBEDTLS_MD5_C
3587 scripts/config.py unset MBEDTLS_RIPEMD160_C
3588 scripts/config.py unset MBEDTLS_SHA1_C
3589 scripts/config.py unset MBEDTLS_SHA224_C
3590 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003591 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003592 scripts/config.py unset MBEDTLS_SHA384_C
3593 scripts/config.py unset MBEDTLS_SHA512_C
3594 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003595 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003596 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003597}
3598
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003599# Note that component_test_psa_crypto_config_reference_hash_use_psa
3600# is related to this component and both components need to be kept in sync.
3601# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003602component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003603 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003604
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003605 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3606 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3607 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003608
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003609 # Configure
3610 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003611
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003612 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003613
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003614 # Build
3615 # -----
3616
3617 helper_libtestdriver1_make_drivers "$loc_accel_list"
3618
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003619 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003620
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003621 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003622 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003623 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3624 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3625 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3626 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3627 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003628
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003629 # Run the tests
3630 # -------------
3631
Gilles Peskine14302ed2023-07-19 19:30:04 +02003632 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003633 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003634
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003635 # This is mostly useful so that we can later compare outcome files with
3636 # the reference config in analyze_outcomes.py, to check that the
3637 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003638 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003639 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003640
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003641 # This is to make sure all ciphersuites are exercised, but we don't need
3642 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003643 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003644 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003645}
3646
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003647# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3648# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3649# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3650# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003651component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003652 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003653
3654 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003655
Gilles Peskine21570cf2023-12-22 11:49:50 +01003656 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003657
Gilles Peskine14302ed2023-07-19 19:30:04 +02003658 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003659 make test
3660
Gilles Peskine14302ed2023-07-19 19:30:04 +02003661 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003662 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003663}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003664
Valerio Setti8eb310c2024-01-22 16:22:57 +01003665# Auxiliary function to build config for hashes with and without drivers
3666config_psa_crypto_hmac_use_psa () {
3667 driver_only="$1"
3668 # start with config full for maximum coverage (also enables USE_PSA)
3669 helper_libtestdriver1_adjust_config "full"
3670
Valerio Setticd89b0b2024-01-24 14:24:55 +01003671 if [ "$driver_only" -eq 1 ]; then
3672 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3673 # is still enabled though (for ENTROPY_C among others).
3674 scripts/config.py unset MBEDTLS_MD_C
3675 # Disable also the builtin hashes since they are supported by the driver
3676 # and MD module is able to perform PSA dispathing.
3677 scripts/config.py unset-all MBEDTLS_SHA
3678 scripts/config.py unset MBEDTLS_MD5_C
3679 scripts/config.py unset MBEDTLS_RIPEMD160_C
3680 fi
3681
Valerio Setti8eb310c2024-01-22 16:22:57 +01003682 # Direct dependencies of MD_C. We disable them also in the reference
3683 # component to work with the same set of features.
3684 scripts/config.py unset MBEDTLS_PKCS7_C
3685 scripts/config.py unset MBEDTLS_PKCS5_C
3686 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3687 scripts/config.py unset MBEDTLS_HKDF_C
3688 # Dependencies of HMAC_DRBG
3689 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3690 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3691}
3692
3693component_test_psa_crypto_config_accel_hmac() {
3694 msg "test: full with accelerated hmac"
3695
3696 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3697 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3698 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3699 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3700
3701 # Configure
3702 # ---------
3703
3704 config_psa_crypto_hmac_use_psa 1
3705
Valerio Setti8eb310c2024-01-22 16:22:57 +01003706 # Build
3707 # -----
3708
3709 helper_libtestdriver1_make_drivers "$loc_accel_list"
3710
3711 helper_libtestdriver1_make_main "$loc_accel_list"
3712
3713 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003714 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003715
3716 # Run the tests
3717 # -------------
3718
3719 msg "test: full with accelerated hmac"
3720 make test
3721}
3722
3723component_test_psa_crypto_config_reference_hmac() {
3724 msg "test: full without accelerated hmac"
3725
3726 config_psa_crypto_hmac_use_psa 0
3727
3728 make
3729
3730 msg "test: full without accelerated hmac"
3731 make test
3732}
3733
Valerio Setti9da01a72023-12-18 17:38:18 +01003734component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003735 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003736
Valerio Setti9da01a72023-12-18 17:38:18 +01003737 # Albeit this components aims at accelerating DES which should only support
3738 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3739 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003740 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3741 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3742 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003743
Valerio Setti9da01a72023-12-18 17:38:18 +01003744 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3745 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3746 # of this component. This limitation will be addressed by #8598.
3747
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003748 # Configure
3749 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003750
Valerio Setti9a427302023-10-17 11:40:42 +02003751 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003752 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003753
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003754 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003755 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3756 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3757 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3758 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3759 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3760 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3761 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003762 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003763
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003764 # Build
3765 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003767 helper_libtestdriver1_make_drivers "$loc_accel_list"
3768
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003769 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003770
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003771 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003772 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003773
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003774 # Run the tests
3775 # -------------
3776
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003777 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003778 make test
3779}
3780
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003781component_test_psa_crypto_config_accel_aead () {
3782 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3783
Valerio Setti3f02bb72023-10-02 15:57:33 +02003784 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3785 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003786
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003787 # Configure
3788 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003789
Valerio Setti3f02bb72023-10-02 15:57:33 +02003790 # Start from full config
3791 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003792
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003793 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003794 scripts/config.py unset MBEDTLS_GCM_C
3795 scripts/config.py unset MBEDTLS_CCM_C
3796 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003797
Valerio Settia50b89e2023-11-08 15:58:47 +01003798 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3799 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003800
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003801 # Build
3802 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003803
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003804 helper_libtestdriver1_make_drivers "$loc_accel_list"
3805
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003806 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003807
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003808 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003809 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3810 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3811 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003812
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003813 # Run the tests
3814 # -------------
3815
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003816 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3817 make test
3818}
3819
Valerio Settib680fc42023-10-13 09:29:37 +02003820# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003821# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3822# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3823common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003824 # Start from the full config
3825 helper_libtestdriver1_adjust_config "full"
3826
Valerio Settib680fc42023-10-13 09:29:37 +02003827 scripts/config.py unset MBEDTLS_NIST_KW_C
3828}
3829
Valerio Settib6b301f2023-10-04 12:05:05 +02003830# The 2 following test components, i.e.
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
Valerio Settib6b301f2023-10-04 12:05:05 +02003833# are meant to be used together in analyze_outcomes.py script in order to test
3834# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003835component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3836 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003837
Valerio Settiad8b7f02023-10-25 12:39:50 +02003838 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 +01003839 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003840 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003841 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3842
3843 # Configure
3844 # ---------
3845
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003846 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003847
3848 # Disable the things that are being accelerated
3849 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3850 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3851 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3852 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3853 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3854 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3855 scripts/config.py unset MBEDTLS_GCM_C
3856 scripts/config.py unset MBEDTLS_CCM_C
3857 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003858 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003859 scripts/config.py unset MBEDTLS_DES_C
3860 scripts/config.py unset MBEDTLS_AES_C
3861 scripts/config.py unset MBEDTLS_ARIA_C
3862 scripts/config.py unset MBEDTLS_CHACHA20_C
3863 scripts/config.py unset MBEDTLS_CAMELLIA_C
3864
Valerio Settiec9b2582023-11-08 16:50:54 +01003865 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3866 # does not depend on it.
3867 scripts/config.py unset MBEDTLS_CIPHER_C
3868
Valerio Settib6b301f2023-10-04 12:05:05 +02003869 # Build
3870 # -----
3871
3872 helper_libtestdriver1_make_drivers "$loc_accel_list"
3873
3874 helper_libtestdriver1_make_main "$loc_accel_list"
3875
3876 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003877 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3878 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3879 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3880 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3881 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3882 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3883 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3884 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3885 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003886
3887 # Run the tests
3888 # -------------
3889
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003890 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003891 make test
Valerio Settif9414552023-11-09 10:43:20 +01003892
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003893 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003894 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003895
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003896 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003897 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003898}
3899
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003900component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3901 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3902 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003903
Gilles Peskine21570cf2023-12-22 11:49:50 +01003904 make
Valerio Settif9414552023-11-09 10:43:20 +01003905
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003906 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003907 make test
Valerio Settif9414552023-11-09 10:43:20 +01003908
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003909 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003910 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003911
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003912 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003913 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003914}
3915
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003916common_block_cipher_dispatch() {
3917 TEST_WITH_DRIVER="$1"
3918
3919 # Start from the full config
3920 helper_libtestdriver1_adjust_config "full"
3921
3922 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3923 # Disable key types that are accelerated (there is no legacy equivalent
3924 # symbol for ECB)
3925 scripts/config.py unset MBEDTLS_AES_C
3926 scripts/config.py unset MBEDTLS_ARIA_C
3927 scripts/config.py unset MBEDTLS_CAMELLIA_C
3928 fi
3929
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003930 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003931 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003932 # Keep this also in the reference component in order to skip the same tests
3933 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003934 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3935 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3936 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3938 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3939 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3940 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003941 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003942
3943 # Disable direct dependency on AES_C
3944 scripts/config.py unset MBEDTLS_NIST_KW_C
3945
3946 # Prevent the cipher module from using deprecated PSA path. The reason is
3947 # that otherwise there will be tests relying on "aes_info" (defined in
3948 # "cipher_wrap.c") whose functions are not available when AES_C is
3949 # not defined. ARIA and Camellia are not a problem in this case because
3950 # the PSA path is not tested for these key types.
3951 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3952}
3953
Valerio Settif8e6cba2023-12-12 11:53:39 +01003954component_test_full_block_cipher_psa_dispatch () {
3955 msg "build: full + PSA dispatch in block_cipher"
3956
3957 loc_accel_list="ALG_ECB_NO_PADDING \
3958 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3959
3960 # Configure
3961 # ---------
3962
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003963 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003964
Valerio Settif8e6cba2023-12-12 11:53:39 +01003965 # Build
3966 # -----
3967
3968 helper_libtestdriver1_make_drivers "$loc_accel_list"
3969
3970 helper_libtestdriver1_make_main "$loc_accel_list"
3971
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003972 # Make sure disabled components were not re-enabled by accident (additive
3973 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003974 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
3975 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
3976 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003977
Valerio Settif8e6cba2023-12-12 11:53:39 +01003978 # Run the tests
3979 # -------------
3980
3981 msg "test: full + PSA dispatch in block_cipher"
3982 make test
3983}
3984
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003985# This is the reference component of component_test_full_block_cipher_psa_dispatch
3986component_test_full_block_cipher_legacy_dispatch () {
3987 msg "build: full + legacy dispatch in block_cipher"
3988
3989 common_block_cipher_dispatch 0
3990
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003991 make
3992
3993 msg "test: full + legacy dispatch in block_cipher"
3994 make test
3995}
3996
Gilles Peskine36dea152023-07-20 22:19:45 +02003997component_test_aead_chachapoly_disabled() {
3998 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02003999 scripts/config.py full
4000 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004001 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004002 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004003
Gilles Peskine36dea152023-07-20 22:19:45 +02004004 msg "test: full minus CHACHAPOLY"
4005 make test
4006}
4007
4008component_test_aead_only_ccm() {
4009 msg "build: full minus CHACHAPOLY and GCM"
4010 scripts/config.py full
4011 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4012 scripts/config.py unset MBEDTLS_GCM_C
4013 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4014 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004015 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004016
4017 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004018 make test
4019}
4020
Ronald Crone501d0e2023-07-10 08:31:19 +02004021component_test_ccm_aes_sha256() {
4022 msg "build: CCM + AES + SHA256 configuration"
4023
Ronald Cron7612d8c2023-07-20 10:03:54 +02004024 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004025 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004026
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004027 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004028
4029 msg "test: CCM + AES + SHA256 configuration"
4030 make test
4031}
4032
Dave Rodgman904c5892023-06-28 17:36:02 +01004033support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004034 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004035}
4036
Dave Rodgman904c5892023-06-28 17:36:02 +01004037component_build_tfm_armcc() {
4038 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004039 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004040
Dave Rodgman88651c42023-06-29 12:35:51 +01004041 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004042 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 +01004043}
4044
4045component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004046 # Check that the TF-M configuration can build cleanly with various
4047 # warning flags enabled. We don't build or run tests, since the
4048 # TF-M configuration needs a TF-M platform. A tweaked version of
4049 # the configuration that works on mainstream platforms is in
4050 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004051 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004052
Dave Rodgman88651c42023-06-29 12:35:51 +01004053 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004054 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 +01004055
Dave Rodgman904c5892023-06-28 17:36:02 +01004056 msg "build: TF-M config, gcc native build"
4057 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004058 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 +01004059}
4060
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004061# Test that the given .o file builds with all (valid) combinations of the given options.
4062#
4063# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4064#
4065# The validator function is the name of a function to validate the combination of options.
4066# It may be "" if all combinations are valid.
4067# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004068# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004069build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004070 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004071 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004072 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004073 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004074 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004075
Dave Rodgman42436102023-10-03 15:47:05 +01004076 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004077 for opt in "${options[@]}"; do
4078 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004079 done
4080
Ronald Cron709bbf02024-07-03 07:59:30 +02004081 # enter the library directory
4082 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004083
Dave Rodgman920343a2023-10-01 18:41:09 +01004084 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004085 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 +01004086
Dave Rodgman42436102023-10-03 15:47:05 +01004087 # Extract the command generated by the Makefile to build the target file.
4088 # This ensures that we have any include paths, macro definitions, etc
4089 # that may be applied by make.
4090 # 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 +01004091 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004092
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004093 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004094 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004095
Dave Rodgman28e38d82023-10-04 11:50:30 +01004096 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004097 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004098
4099 targets=0
4100 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004101
Dave Rodgman28e38d82023-10-04 11:50:30 +01004102 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004103 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004104 # each bit of $i is used to determine if options[i] will be set or not
4105 target="t"
4106 clang_args=""
4107 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004108 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004109 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004110 clang_args="${clang_args} ${opt}"
4111 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004112 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004113 done
4114
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004115 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004116 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004117 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004118 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004119
Dave Rodgman28e38d82023-10-04 11:50:30 +01004120 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004121 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004122 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004123 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004124
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004125 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004126
Dave Rodgman920343a2023-10-01 18:41:09 +01004127 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004128 make -s -f ${makefile} build_test_config_combos
4129 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004130
4131 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004132 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004133}
4134
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004135validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004136 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004137 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4138 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004139 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004140 fi
4141 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004142 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004143}
4144
4145component_build_aes_variations() {
4146 # 18s - around 90ms per clang invocation on M1 Pro
4147 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004148 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004149 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004150
Yanray Wangbc29aef2023-11-06 11:08:17 +08004151 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004152 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004153
Ronald Cron709bbf02024-07-03 07:59:30 +02004154 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004155 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4156 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004157 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004158 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004159
4160 cd "$MBEDTLS_ROOT_DIR"
4161 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4162
Yanray Wang42be1ba2023-11-23 14:28:47 +08004163 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004164 # manually set or unset those configurations to check
4165 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004166 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4167 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4168 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4169 scripts/config.py unset MBEDTLS_DES_C
4170 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004171 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004172 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4173 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004174 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004175 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004176}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004177
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004178component_test_no_platform () {
4179 # Full configuration build, without platform support, file IO and net sockets.
4180 # This should catch missing mbedtls_printf definitions, and by disabling file
4181 # IO, it should catch missing '#include <stdio.h>'
4182 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004183 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004184 scripts/config.py unset MBEDTLS_PLATFORM_C
4185 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004186 scripts/config.py unset MBEDTLS_FS_IO
4187 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004188 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004189 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004190 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004191 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004192 # to re-enable platform integration features otherwise disabled in C99 builds
4193 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004194 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004195}
Gilles Peskine7c652162017-12-11 00:01:40 +01004196
4197component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004198 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004199 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4200 scripts/config.py full
4201 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004202 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4203 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4204 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4205 make
4206}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004207
Gilles Peskine8f073122018-11-27 15:58:47 +01004208component_build_no_ssl_srv () {
4209 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004210 scripts/config.py full
4211 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004212 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004213}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004214
Gilles Peskine8f073122018-11-27 15:58:47 +01004215component_build_no_ssl_cli () {
4216 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004217 scripts/config.py full
4218 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004219 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004220}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004221
Gilles Peskine8f073122018-11-27 15:58:47 +01004222component_build_no_sockets () {
4223 # Note, C99 compliance can also be tested with the sockets support disabled,
4224 # as that requires a POSIX platform (which isn't the same as C99).
4225 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004226 scripts/config.py full
4227 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4228 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4229 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4230}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004231
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004232component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004233 msg "build: default config with memory buffer allocator and backtrace enabled"
4234 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4235 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4236 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004237 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004238 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004239 make
4240
4241 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4242 make test
4243}
4244
4245component_test_memory_buffer_allocator () {
4246 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004247 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4248 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004249 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004250 make
4251
4252 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4253 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004254
4255 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4256 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004257 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004258}
4259
Gilles Peskine8f073122018-11-27 15:58:47 +01004260component_test_no_max_fragment_length () {
4261 # Run max fragment length tests with MFL disabled
4262 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004263 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004264 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004265 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004266
Gilles Peskine8f073122018-11-27 15:58:47 +01004267 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004268 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004269}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004270
Hanno Becker545ced42019-02-19 11:10:48 +00004271component_test_asan_remove_peer_certificate () {
4272 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004273 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004274 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004275 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004276 make
4277
4278 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4279 make test
4280
4281 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004282 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004283
4284 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004285 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004286
4287 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004288 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004289}
4290
Gilles Peskine8f073122018-11-27 15:58:47 +01004291component_test_no_max_fragment_length_small_ssl_out_content_len () {
4292 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004293 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4294 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4295 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004296 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004297 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004298
Gilles Peskine8f073122018-11-27 15:58:47 +01004299 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004300 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004301
4302 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004303 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004304}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004305
Darryl Greenaad82f92019-12-02 10:53:11 +00004306component_test_variable_ssl_in_out_buffer_len () {
4307 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4308 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004309 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004310 make
4311
4312 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4313 make test
4314
4315 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004316 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004317
4318 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004319 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004320}
4321
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004322component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004323 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004324 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004325
Dave Rodgman17127e92023-12-14 16:42:48 +00004326 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004327 make
4328
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004329 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004330 make test
4331
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004332 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004333 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004334
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004335 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004336 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004337}
4338
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004339component_test_ssl_alloc_buffer_and_mfl () {
4340 msg "build: default config with memory buffer allocator and MFL extension"
4341 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4342 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4343 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4344 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4345 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004346 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004347 make
4348
4349 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4350 make test
4351
4352 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 +02004353 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004354}
4355
Gilles Peskine636c26a2020-03-04 20:46:15 +01004356component_test_when_no_ciphersuites_have_mac () {
4357 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004358 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4359 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4360 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4361 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4362 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4363
Gilles Peskine636c26a2020-03-04 20:46:15 +01004364 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004365 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004366 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004367
Gilles Peskine636c26a2020-03-04 20:46:15 +01004368 make
4369
Ronald Croncd33cd62024-05-27 08:14:27 +02004370 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004371 make test
4372
Ronald Croncd33cd62024-05-27 08:14:27 +02004373 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004374 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004375}
4376
Raoul Strackxa4e86142020-06-15 17:03:13 +02004377component_test_no_date_time () {
4378 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4379 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004380 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004381 make
4382
4383 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4384 make test
4385}
4386
Gilles Peskine8f073122018-11-27 15:58:47 +01004387component_test_platform_calloc_macro () {
4388 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004389 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4390 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4391 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004392 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004393 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004394
Gilles Peskine8f073122018-11-27 15:58:47 +01004395 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4396 make test
4397}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004398
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004399component_test_malloc_0_null () {
4400 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004401 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004402 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 +02004403
4404 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4405 make test
4406
4407 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4408 # Just the calloc selftest. "make test" ran the others as part of the
4409 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004410 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004411
4412 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4413 # Run a subset of the tests. The choice is a balance between coverage
4414 # and time (including time indirectly wasted due to flaky tests).
4415 # The current choice is to skip tests whose description includes
4416 # "proxy", which is an approximation of skipping tests that use the
4417 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004418 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004419}
4420
Dave Rodgman6a08b682023-06-19 11:51:33 +01004421support_test_aesni() {
4422 # Check that gcc targets x86_64 (we can build AESNI), and check for
4423 # AESNI support on the host (we can run AESNI).
4424 #
4425 # The name of this function is possibly slightly misleading, but needs to align
4426 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004427 #
4428 # In principle 32-bit x86 can support AESNI, but our implementation does not
4429 # support 32-bit x86, so we check for x86-64.
4430 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004431 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4432 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004433 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004434}
4435
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004436component_test_aesni () { # ~ 60s
4437 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4438 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4439 #
4440 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4441 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4442 # exercise the plain C impl).
4443
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004444 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004445 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004446 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004447 scripts/config.py set MBEDTLS_HAVE_ASM
4448
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004449 # test the intrinsics implementation
4450 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004451 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004452 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004453 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004454 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004455
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004456 # test the asm implementation
4457 msg "AES tests, test assembly"
4458 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004459 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004460 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004461 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004462
4463 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004464 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004465 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004466 msg "AES tests, plain C"
4467 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004468 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004469 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004470 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004471 not grep -q "AES note: using AESNI" ./programs/test/selftest
4472 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004473
4474 # test the intrinsics implementation
4475 scripts/config.py set MBEDTLS_AESNI_C
4476 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4477 msg "AES tests, test AESNI only"
4478 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004479 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004480 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4481 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004482 grep -q "AES note: using AESNI" ./programs/test/selftest
4483 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004484}
4485
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004486component_test_sha3_variations() {
4487 msg "sha3 loop unroll variations"
4488
4489 # define minimal config sufficient to test SHA3
4490 cat > include/mbedtls/mbedtls_config.h << END
4491 #define MBEDTLS_SELF_TEST
4492 #define MBEDTLS_SHA3_C
4493END
4494
4495 msg "all loops unrolled"
4496 make clean
4497 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"
4498 ./tests/test_suite_shax
4499
4500 msg "all loops rolled up"
4501 make clean
4502 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"
4503 ./tests/test_suite_shax
4504}
4505
Jerry Yub6d39c22023-08-16 15:11:48 +08004506support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004507 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004508}
4509
4510component_test_aesni_m32 () { # ~ 60s
4511 # This tests are duplicated from component_test_aesni for i386 target
4512 #
4513 # AESNI intrinsic code supports i386 and assembly code does not support it.
4514
4515 msg "build: default config with different AES implementations"
4516 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004517 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4518 scripts/config.py set MBEDTLS_HAVE_ASM
4519
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004520 # test the intrinsics implementation with gcc
4521 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004522 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004523 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004524 # check that we built intrinsics - this should be used by default when supported by the compiler
4525 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4526 grep -q "AES note: using AESNI" ./programs/test/selftest
4527 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004528 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4529
4530 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004531 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4532 msg "AES tests, test AESNI only"
4533 make clean
4534 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4535 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4536 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4537 grep -q "AES note: using AESNI" ./programs/test/selftest
4538 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004539 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4540}
4541
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004542support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004543 # clang >= 4 is required to build with target attributes
4544 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004545}
4546
4547component_test_aesni_m32_clang() {
4548
4549 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004550 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4551 scripts/config.py set MBEDTLS_HAVE_ASM
4552
4553 # test the intrinsics implementation with clang
4554 msg "AES tests, test intrinsics (clang)"
4555 make clean
4556 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4557 # check that we built intrinsics - this should be used by default when supported by the compiler
4558 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4559 grep -q "AES note: using AESNI" ./programs/test/selftest
4560 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004561 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4562}
4563
Jerry Yu193cbc02023-08-03 17:06:29 +08004564# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4565component_build_aes_aesce_armcc () {
4566 msg "Build: AESCE test on arm64 platform without plain C."
4567 scripts/config.py baremetal
4568
4569 # armc[56] don't support SHA-512 intrinsics
4570 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4571
4572 # Stop armclang warning about feature detection for A64_CRYPTO.
4573 # With this enabled, the library does build correctly under armclang,
4574 # but in baremetal builds (as tested here), feature detection is
4575 # unavailable, and the user is notified via a #warning. So enabling
4576 # this feature would prevent us from building with -Werror on
4577 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004578 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004579 scripts/config.py set MBEDTLS_HAVE_ASM
4580
4581 msg "AESCE, build with default configuration."
4582 scripts/config.py set MBEDTLS_AESCE_C
4583 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4584 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4585
4586 msg "AESCE, build AESCE only"
4587 scripts/config.py set MBEDTLS_AESCE_C
4588 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4589 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4590}
4591
Dave Rodgman0c584032023-10-08 12:26:54 +01004592support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004593 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004594 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004595}
4596
4597component_build_aes_armce () {
4598 # Test variations of AES with Armv8 crypto extensions
4599 scripts/config.py set MBEDTLS_AESCE_C
4600 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4601
4602 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004603 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004604
4605 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004606 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004607
4608 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004609 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgman0c584032023-10-08 12:26:54 +01004610
Dave Rodgman5e419372023-10-23 15:30:20 +01004611 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004612
Dave Rodgman5e419372023-10-23 15:30:20 +01004613 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004614 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004615
Dave Rodgman5e419372023-10-23 15:30:20 +01004616 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004617 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004618
Dave Rodgman5e419372023-10-23 15:30:20 +01004619 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004620 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004621
4622 # test for presence of AES instructions
4623 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4624 msg "clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004625 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4626 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004627 msg "clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004628 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4629 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004630 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004631 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4632 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004633
4634 # test for absence of AES instructions
4635 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4636 scripts/config.py unset MBEDTLS_AESCE_C
4637 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004638 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4639 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004640 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004641 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4642 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004643 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004644 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4645 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004646}
4647
Dave Rodgman9ed18532023-10-05 00:06:47 +01004648support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004649 # clang >= 4 is required to build with SHA extensions
4650 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004651}
4652
Dave Rodgmand9e80832023-10-04 17:17:46 +01004653component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004654 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004655
4656
4657 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004658 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004659 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004660 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004661 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004662 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004663 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004664
Dave Rodgmand9e80832023-10-04 17:17:46 +01004665
Dave Rodgman94a634d2023-10-10 12:59:29 +01004666 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004667 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004668 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004669 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004670 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004671
Dave Rodgman5b89c552023-10-10 14:59:02 +01004672 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004673 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004674 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004675 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004676
Dave Rodgmancd654002023-10-05 09:40:07 +01004677
Dave Rodgman94a634d2023-10-10 12:59:29 +01004678 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004679 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004680 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004681 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004682 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004683 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004684 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004685
Dave Rodgmancd654002023-10-05 09:40:07 +01004686
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004687 # examine the disassembly for presence of SHA instructions
4688 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4689 scripts/config.py set ${opt}
4690 msg "${opt} clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004691 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4692 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004693
4694 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004695 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4696 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004697
4698 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004699 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4700 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004701 scripts/config.py unset ${opt}
4702 done
4703
4704
4705 # examine the disassembly for absence of SHA instructions
4706 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004707 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4708 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004709
4710 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004711 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4712 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004713
4714 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004715 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4716 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004717}
4718
Jerry Yu193cbc02023-08-03 17:06:29 +08004719support_build_aes_aesce_armcc () {
4720 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004721}
4722
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004723component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004724 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004725 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004726
Dave Rodgmand8d64512023-12-19 12:20:21 +00004727 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004728
4729 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4730 make test
4731}
4732
4733component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4734 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4735 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004736 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004737
Hanno Becker83ebf782017-07-07 12:29:15 +01004738 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004739
4740 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004741 make test
4742}
Gilles Peskine8f073122018-11-27 15:58:47 +01004743
Hanno Becker83ebf782017-07-07 12:29:15 +01004744component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004745 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_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_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004748 scripts/config.py unset MBEDTLS_AESCE_C
4749
Dave Rodgmand8d64512023-12-19 12:20:21 +00004750 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004751
4752 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004753 make test
4754
4755 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4756 programs/test/selftest
4757}
4758
Matthias Schulz0767fda2024-02-07 10:46:28 +01004759component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004760 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4761 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004762 scripts/config.py unset MBEDTLS_AESNI_C
4763 scripts/config.py unset MBEDTLS_AESCE_C
4764
4765 make CFLAGS='-O2 -Werror -Wall -Wextra'
4766
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004767 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004768 make test
4769}
4770
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004771component_test_aes_fewer_tables () {
4772 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004773 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004774 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004775
Gilles Peskine7c652162017-12-11 00:01:40 +01004776 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004777 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004778}
4779
4780component_test_aes_rom_tables () {
4781 msg "build: default config with AES_ROM_TABLES enabled"
4782 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004783 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004784
4785 msg "test: AES_ROM_TABLES"
4786 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004787}
4788
Gilles Peskine14c3c062018-01-29 21:25:12 +01004789component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004790 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4791 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4792 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004793 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004794
Gilles Peskine8f073122018-11-27 15:58:47 +01004795 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4796 make test
4797}
4798
Yanray Wang49cd4b52023-11-10 11:58:37 +08004799# helper for common_block_cipher_no_decrypt() which:
4800# - enable/disable the list of config options passed from -s/-u respectively.
4801# - build
4802# - test for tests_suite_xxx
4803# - selftest
4804#
4805# Usage: helper_block_cipher_no_decrypt_build_test
4806# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4807# Options: -s set_opts the list of config options to enable
4808# -u unset_opts the list of config options to disable
4809# -c cflags the list of options passed to CFLAGS
4810# -l ldflags the list of options passed to LDFLAGS
4811helper_block_cipher_no_decrypt_build_test () {
4812 while [ $# -gt 0 ]; do
4813 case "$1" in
4814 -s)
4815 shift; local set_opts="$1";;
4816 -u)
4817 shift; local unset_opts="$1";;
4818 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004819 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004820 -l)
4821 shift; local ldflags="$1";;
4822 esac
4823 shift
4824 done
4825 set_opts="${set_opts:-}"
4826 unset_opts="${unset_opts:-}"
4827 cflags="${cflags:-}"
4828 ldflags="${ldflags:-}"
4829
Yanray Wangb2d6e522023-11-13 16:57:47 +08004830 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4831 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004832
4833 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4834 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004835 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004836
4837 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004838 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4839 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4840 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004841 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004842 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004843 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004844 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004845
4846 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4847 make test
4848
4849 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4850 programs/test/selftest
4851}
4852
4853# This is a common configuration function used in:
4854# - component_test_block_cipher_no_decrypt_aesni_legacy()
4855# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4856# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4857# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4858# on x86.
4859common_block_cipher_no_decrypt () {
4860 # test AESNI intrinsics
4861 helper_block_cipher_no_decrypt_build_test \
4862 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004863 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004864
4865 # test AESNI assembly
4866 helper_block_cipher_no_decrypt_build_test \
4867 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004868 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004869
4870 # test AES C implementation
4871 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004872 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004873
4874 # test AESNI intrinsics for i386 target
4875 helper_block_cipher_no_decrypt_build_test \
4876 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004877 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004878 -l "-m32"
4879}
4880
Yanray Wang3ae11992023-11-13 17:32:09 +08004881# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4882# usage: 0: no PSA crypto configuration
4883# 1: use PSA crypto configuration
4884config_block_cipher_no_decrypt () {
4885 use_psa=$1
4886
Yanray Wang66111392023-10-31 18:54:54 +08004887 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004888 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4889 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004890 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004891 scripts/config.py unset MBEDTLS_NIST_KW_C
4892
Yanray Wang3ae11992023-11-13 17:32:09 +08004893 if [ "$use_psa" -eq 1 ]; then
4894 # Enable support for cryptographic mechanisms through the PSA API.
4895 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4896 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4897 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4898 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4899 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4900 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4901 fi
4902}
4903
4904component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004905 # This consistently causes an llvm crash on clang 3.8, so use gcc
4906 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004907 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004908 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004909}
4910
Yanray Wangf1496402023-11-01 18:55:13 +08004911component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004912 # This consistently causes an llvm crash on clang 3.8, so use gcc
4913 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004914 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004915 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004916}
4917
Yanray Wang66111392023-10-31 18:54:54 +08004918support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004919 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004920}
4921
Yanray Wang66111392023-10-31 18:54:54 +08004922component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004923 scripts/config.py baremetal
4924
4925 # armc[56] don't support SHA-512 intrinsics
4926 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4927
4928 # Stop armclang warning about feature detection for A64_CRYPTO.
4929 # With this enabled, the library does build correctly under armclang,
4930 # but in baremetal builds (as tested here), feature detection is
4931 # unavailable, and the user is notified via a #warning. So enabling
4932 # this feature would prevent us from building with -Werror on
4933 # armclang. Tracked in #7198.
4934 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4935 scripts/config.py set MBEDTLS_HAVE_ASM
4936
Yanray Wang3ae11992023-11-13 17:32:09 +08004937 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004938
4939 # test AESCE baremetal build
4940 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004941 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004942 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004943
Yanray Wangef1b04d2023-09-08 11:09:26 +08004944 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004945 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4946 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4947 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004948 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004949 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004950 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004951 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4952 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004953}
4954
Gilles Peskine592f5912019-10-07 18:49:32 +02004955component_test_ctr_drbg_aes_256_sha_256 () {
4956 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4957 scripts/config.py full
4958 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4959 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004960 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004961 make
4962
4963 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4964 make test
4965}
4966
4967component_test_ctr_drbg_aes_128_sha_512 () {
4968 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004969 scripts/config.py full
4970 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4971 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00004972 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004973 make
4974
4975 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
4976 make test
4977}
4978
4979component_test_ctr_drbg_aes_128_sha_256 () {
4980 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004981 scripts/config.py full
4982 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4983 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
4984 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004985 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004986 make
4987
4988 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4989 make test
4990}
4991
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004992component_test_se_default () {
4993 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004994 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02004995 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004996
4997 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
4998 make test
4999}
5000
Steven Cooremand57203d2020-07-16 20:28:59 +02005001component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005002 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005003 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005004 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005005 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5006 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005007 loc_cflags="${loc_cflags} -I../tests/include -O2"
5008
Gilles Peskine21570cf2023-12-22 11:49:50 +01005009 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005010
Gilles Peskine1997f302023-07-26 18:45:20 +02005011 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005012 make test
5013}
5014
Gilles Peskine8f073122018-11-27 15:58:47 +01005015component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005016 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005017 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005018 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005019 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005020}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005021
Gilles Peskinecf740502019-07-03 20:43:05 +02005022component_test_cmake_shared () {
5023 msg "build/test: cmake shared" # ~ 2min
5024 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5025 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005026 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005027 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005028 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005029}
5030
Gilles Peskineec10bf12019-09-20 19:56:06 +02005031test_build_opt () {
5032 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005033 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005034 for opt in "$@"; do
5035 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005036 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005037 # We're confident enough in compilers to not run _all_ the tests,
5038 # but at least run the unit tests. In particular, runs with
5039 # optimizations use inline assembly whereas runs with -O0
5040 # skip inline assembly.
5041 make test # ~30s
5042 make clean
5043 done
5044}
5045
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005046# For FreeBSD we invoke the function by name so this condition is added
5047# to disable the existing test_clang_opt function for linux.
5048if [[ $(uname) != "Linux" ]]; then
5049 component_test_clang_opt () {
5050 scripts/config.py full
5051 test_build_opt 'full config' clang -O0 -Os -O2
5052 }
5053fi
5054
5055component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005056 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005057 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005058}
5059support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005060 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005061}
5062
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005063component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005064 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005065 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005066}
5067support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005068 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005069}
5070
5071component_test_gcc_latest_opt () {
5072 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005073 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005074}
5075support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005076 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005077}
5078
5079component_test_gcc_earliest_opt () {
5080 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005081 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005082}
5083support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005084 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005085}
5086
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005087component_build_mbedtls_config_file () {
5088 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005089 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005090 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005091 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005092 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005093 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5094 make clean
5095
5096 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5097 # In the user config, disable one feature (for simplicity, pick a feature
5098 # that nothing else depends on).
5099 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005100 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005101 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5102
5103 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005104}
5105
Gilles Peskine7d904e72022-04-07 21:59:14 +02005106component_build_psa_config_file () {
5107 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5108 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5109 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5110 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5111 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005112 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005113 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5114 make clean
5115
5116 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005117 # In the user config, disable one feature and its dependencies, which will
5118 # reflect on the mbedtls configuration so we can query it with
5119 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005120 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005121 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005122 scripts/config.py unset MBEDTLS_CMAC_C
5123 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5124 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5125
5126 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005127}
5128
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005129component_build_psa_alt_headers () {
5130 msg "build: make with PSA alt headers" # ~20s
5131
5132 # Generate alternative versions of the substitutable headers with the
5133 # same content except different include guards.
5134 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5135
5136 # Build the library and some programs.
5137 # Don't build the fuzzers to avoid having to go through hoops to set
5138 # a correct include path for programs/fuzz/Makefile.
5139 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
5140 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\"'"
5141
5142 # Check that we're getting the alternative include guards and not the
5143 # original include guards.
5144 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5145 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5146 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5147 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5148}
5149
Dave Rodgman852de3c2023-12-14 14:46:45 +00005150component_test_m32_no_asm () {
5151 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005152 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005153 #
5154 # Note that we require gcc, because clang Asan builds fail to link for
5155 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005156 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005157 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005158 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005159 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005160 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005161
Dave Rodgman852de3c2023-12-14 14:46:45 +00005162 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005163 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005164}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005165support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005166 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005167 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005168 *) false;;
5169 esac
5170}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005171
Gilles Peskineff0aee02021-10-05 09:36:03 +02005172component_test_m32_o2 () {
5173 # Build with optimization, to use the i386 specific inline assembly
5174 # and go faster for tests.
5175 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005176 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005177 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005178 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005179
Gilles Peskineff0aee02021-10-05 09:36:03 +02005180 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005181 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005182
Gilles Peskineff0aee02021-10-05 09:36:03 +02005183 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005184 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005185}
Gilles Peskinecf522222021-10-07 19:25:29 +02005186support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005187 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005188}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005189
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005190component_test_m32_everest () {
5191 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005192 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005193 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005194 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005195
5196 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5197 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005198
5199 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005200 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005201
5202 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5203 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005204 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005205}
5206support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005207 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005208}
5209
Gilles Peskine8f073122018-11-27 15:58:47 +01005210component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005211 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005212 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005213 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005214
5215 msg "test: 64-bit ILP32, make, gcc"
5216 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005217}
Gilles Peskine878cf602019-01-06 20:50:38 +00005218support_test_mx32 () {
5219 case $(uname -m) in
5220 amd64|x86_64) true;;
5221 *) false;;
5222 esac
5223}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005224
Peter Kolbus60c6da22018-12-27 06:59:04 -06005225component_test_min_mpi_window_size () {
5226 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005227 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005228 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005229 make
5230
5231 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5232 make test
5233}
5234
Gilles Peskine8f073122018-11-27 15:58:47 +01005235component_test_have_int32 () {
5236 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005237 scripts/config.py unset MBEDTLS_HAVE_ASM
5238 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005239 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005240 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005241
Gilles Peskine8f073122018-11-27 15:58:47 +01005242 msg "test: gcc, force 32-bit bignum limbs"
5243 make test
5244}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005245
Gilles Peskine8f073122018-11-27 15:58:47 +01005246component_test_have_int64 () {
5247 msg "build: gcc, force 64-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_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005252
Gilles Peskine8f073122018-11-27 15:58:47 +01005253 msg "test: gcc, force 64-bit bignum limbs"
5254 make test
5255}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005256
Gabor Mezeie256cc12023-07-26 17:28:48 +02005257component_test_have_int32_cmake_new_bignum () {
5258 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5259 scripts/config.py unset MBEDTLS_HAVE_ASM
5260 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005261 scripts/config.py unset MBEDTLS_AESCE_C
5262 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005263 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005264 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005265
5266 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5267 make test
5268}
5269
Gilles Peskine8f073122018-11-27 15:58:47 +01005270component_test_no_udbl_division () {
5271 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005272 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005273 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005274 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005275
Gilles Peskine8f073122018-11-27 15:58:47 +01005276 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5277 make test
5278}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005279
Gilles Peskine8f073122018-11-27 15:58:47 +01005280component_test_no_64bit_multiplication () {
5281 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005282 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005283 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005284 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005285
Gilles Peskine8f073122018-11-27 15:58:47 +01005286 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5287 make test
5288}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005289
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005290component_test_no_strings () {
5291 msg "build: no strings" # ~10s
5292 scripts/config.py full
5293 # Disable options that activate a large amount of string constants.
5294 scripts/config.py unset MBEDTLS_DEBUG_C
5295 scripts/config.py unset MBEDTLS_ERROR_C
5296 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5297 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005298 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005299
5300 msg "test: no strings" # ~ 10s
5301 make test
5302}
5303
Hanno Beckerc5722d12020-10-09 11:10:42 +01005304component_test_no_x509_info () {
5305 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5306 scripts/config.pl full
5307 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5308 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005309 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005310
5311 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5312 make test
5313
5314 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005315 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005316}
5317
Gilles Peskine8f073122018-11-27 15:58:47 +01005318component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005319 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005320 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005321 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 +02005322
Gilles Peskinee36fe812021-09-01 20:00:33 +02005323 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005324 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005325 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005326}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005327
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005328component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005329 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005330 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005331 # Build for a target platform that's close to what Debian uses
5332 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005333 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005334 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005335 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005336 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'
5337
Gilles Peskinee36fe812021-09-01 20:00:33 +02005338 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005339 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005340 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005341}
5342support_build_arm_linux_gnueabi_gcc_arm5vte () {
5343 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5344}
5345
5346component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005347 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005348 scripts/config.py baremetal
5349 # This is an imperfect substitute for
5350 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005351 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005352 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 +02005353
Gilles Peskinee36fe812021-09-01 20:00:33 +02005354 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005355 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005356 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005357}
5358
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005359component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005360 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5361 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005362 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 +02005363
Gilles Peskinee36fe812021-09-01 20:00:33 +02005364 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005365 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005366 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005367 for lib in library/*.a; do
5368 echo "$lib:"
5369 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5370 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005371}
5372
Gilles Peskine8f073122018-11-27 15:58:47 +01005373component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005374 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005375 scripts/config.py baremetal
5376 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005377 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 +01005378 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005379 not grep __aeabi_uldiv library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005380 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005381}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005382
Gilles Peskine8f073122018-11-27 15:58:47 +01005383component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005384 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005385 scripts/config.py baremetal
5386 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005387 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 +01005388 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005389 not grep __aeabi_lmul library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005390 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005391}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005392
Dave Rodgman8c315f22023-06-02 10:26:24 -04005393component_build_arm_clang_thumb () {
5394 # ~ 30s
5395
5396 scripts/config.py baremetal
5397
5398 msg "build: clang thumb 2, make"
5399 make clean
5400 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5401
5402 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5403 msg "build: clang thumb 1 -O0, make"
5404 make clean
5405 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5406
5407 msg "build: clang thumb 1 -Os, make"
5408 make clean
5409 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5410}
5411
Gilles Peskine8f073122018-11-27 15:58:47 +01005412component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005413 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005414 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005415 # armc[56] don't support SHA-512 intrinsics
5416 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005417
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005418 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5419 scripts/config.py unset MBEDTLS_AESCE_C
5420
Dave Rodgman0fddf822023-03-02 15:32:12 +00005421 # Stop armclang warning about feature detection for A64_CRYPTO.
5422 # With this enabled, the library does build correctly under armclang,
5423 # but in baremetal builds (as tested here), feature detection is
5424 # unavailable, and the user is notified via a #warning. So enabling
5425 # this feature would prevent us from building with -Werror on
5426 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005427 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005428
Hanno Beckerf0762e92022-07-15 12:08:19 +01005429 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005430
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005431 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005432
5433 msg "size: ARM Compiler 5"
5434 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005435 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005436
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005437 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005438
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005439 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005440 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005441
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005442 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005443 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5444
5445 # ARM Compiler 6 - Target ARMv7-M+DSP
5446 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005447
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005448 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005449 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005450
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005451 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005452 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005453
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005454 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5455 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5456
Dave Rodgman99318e62023-05-24 12:27:42 +01005457 # ARM Compiler 6 - Target Cortex-M0
5458 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005459
5460 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5461 #
5462 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5463 # that we have in our CI
5464 scripts/config.py set MBEDTLS_AESCE_C
5465 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005466}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005467
Pengyu Lvdf070032023-02-24 16:03:31 +08005468support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005469 armc5_cc="$ARMC5_BIN_DIR/armcc"
5470 armc6_cc="$ARMC6_BIN_DIR/armclang"
5471 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005472}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005473
Ronald Crond2cb7f42024-03-18 12:49:18 +01005474component_test_tls12_only () {
5475 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5476 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5477 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5478 make
5479
5480 msg "test: main suites (inc. selftests) (ASan build)"
5481 make test
5482
5483 msg "test: ssl-opt.sh (ASan build)"
5484 tests/ssl-opt.sh
5485
5486 msg "test: compat.sh (ASan build)"
5487 tests/compat.sh
5488}
5489
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005490component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005491 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005492 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005493 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005494 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5495
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005496 msg "test: TLS 1.3 only, all key exchange modes enabled"
5497 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005498
Ronald Cronc3f43b62022-10-17 17:35:32 +02005499 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5500 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005501}
5502
Ronald Cronc3f43b62022-10-17 17:35:32 +02005503component_test_tls13_only_psk () {
5504 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5505 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5506 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5507 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005508 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005509 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5510 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5511 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5512 scripts/config.py unset MBEDTLS_ECDSA_C
5513 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005514 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005515 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005516 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5517
Ronald Cronc3f43b62022-10-17 17:35:32 +02005518 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5519 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005520
Ronald Cronc3f43b62022-10-17 17:35:32 +02005521 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5522 tests/ssl-opt.sh
5523}
5524
5525component_test_tls13_only_ephemeral () {
5526 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5527 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5528 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005529 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005530 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5531
5532 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5533 cd tests; ./test_suite_ssl; cd ..
5534
5535 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5536 tests/ssl-opt.sh
5537}
5538
Przemek Stekiela01c2422023-06-13 10:46:48 +02005539component_test_tls13_only_ephemeral_ffdh () {
5540 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5541 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5542 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5543 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005544 scripts/config.py unset MBEDTLS_ECDH_C
5545
Przemek Stekiela01c2422023-06-13 10:46:48 +02005546 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5547
5548 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5549 cd tests; ./test_suite_ssl; cd ..
5550
5551 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5552 tests/ssl-opt.sh
5553}
5554
Ronald Cronc3f43b62022-10-17 17:35:32 +02005555component_test_tls13_only_psk_ephemeral () {
5556 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5557 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5558 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5559 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5560 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5561 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5562 scripts/config.py unset MBEDTLS_ECDSA_C
5563 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005564 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005565 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005566 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5567
5568 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5569 cd tests; ./test_suite_ssl; cd ..
5570
5571 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5572 tests/ssl-opt.sh
5573}
5574
Przemek Stekiela01c2422023-06-13 10:46:48 +02005575component_test_tls13_only_psk_ephemeral_ffdh () {
5576 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5577 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5578 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5579 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5580 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5581 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5582 scripts/config.py unset MBEDTLS_ECDSA_C
5583 scripts/config.py unset MBEDTLS_PKCS1_V21
5584 scripts/config.py unset MBEDTLS_PKCS7_C
5585 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005586 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005587 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5588
5589 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5590 cd tests; ./test_suite_ssl; cd ..
5591
5592 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5593 tests/ssl-opt.sh
5594}
5595
Ronald Cronc3f43b62022-10-17 17:35:32 +02005596component_test_tls13_only_psk_all () {
5597 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5598 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5599 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5600 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5601 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5602 scripts/config.py unset MBEDTLS_ECDSA_C
5603 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005604 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005605 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005606 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5607
5608 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5609 cd tests; ./test_suite_ssl; cd ..
5610
5611 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5612 tests/ssl-opt.sh
5613}
5614
5615component_test_tls13_only_ephemeral_all () {
5616 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5617 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005618 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005619 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5620
5621 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5622 cd tests; ./test_suite_ssl; cd ..
5623
5624 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5625 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005626}
5627
Ronald Cron46ac0652024-03-18 12:39:04 +01005628component_test_tls13_no_padding () {
5629 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005630 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005631 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005632 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005633 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005634 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005635 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005636 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005637 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005638}
5639
Ronald Cron6f135e12021-12-08 16:57:54 +01005640component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005641 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005642 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005643 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005644 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005645 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005646 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005647 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005648 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005649 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005650}
5651
Ronald Crondd96c0a2024-04-02 12:34:24 +02005652component_test_full_minus_session_tickets() {
5653 msg "build: full config without session tickets"
5654 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005655 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005656 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005657 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5658 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005659 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005660 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005661 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005662 tests/ssl-opt.sh
5663}
5664
Gilles Peskine8f073122018-11-27 15:58:47 +01005665component_build_mingw () {
5666 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005667 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 +00005668
Gilles Peskine8f073122018-11-27 15:58:47 +01005669 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005670 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 +01005671 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005672
Gilles Peskine8f073122018-11-27 15:58:47 +01005673 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
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 -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 SHARED=1 lib programs
5675 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 +01005676 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005677
Pengyu Lv158eead2023-10-19 11:27:05 +08005678 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005679 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005680 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 +01005681 make WINDOWS_BUILD=1 clean
5682}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005683support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005684 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5685 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005686 *) true;;
5687 esac
5688}
Simon Butcher91aef332016-11-17 09:20:50 +00005689
Gilles Peskine8f073122018-11-27 15:58:47 +01005690component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005691 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005692 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005693 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5694 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005695
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005696 msg "test: main suites (MSan)" # ~ 10s
5697 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005698
Gilles Peskine6848d172023-11-02 19:58:03 +01005699 msg "test: metatests (MSan)"
5700 tests/scripts/run-metatests.sh any msan
5701
Gilles Peskine82b27272019-06-14 18:27:03 +02005702 msg "program demos (MSan)" # ~20s
5703 tests/scripts/run_demos.py
5704
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005705 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005706 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005707
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005708 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005709
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005710 if [ "$MEMORY" -gt 0 ]; then
5711 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005712 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005713 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005714}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005715
Bence Szépkúti0354d042023-12-06 16:14:37 +01005716component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005717 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005718 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005719 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5720 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005721
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005722 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005723 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005724
Gilles Peskine636c26a2020-03-04 20:46:15 +01005725 # Optional parts (slow; currently broken on OS X because programs don't
5726 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005727 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005728 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005729 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005730 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005731 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005732
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005733 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005734 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005735 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005736 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005737
5738 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005739 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005740 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005741 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005742}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005743
Bence Szépkúti0354d042023-12-06 16:14:37 +01005744component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005745 msg "build: Release, full (clang)"
5746 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5747 scripts/config.py full
5748 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5749 make
5750
5751 msg "test: main suites, Valgrind (full config)"
5752 make memcheck
5753}
5754
Paul Elliott62dc3922021-11-25 17:29:40 +00005755support_test_cmake_out_of_source () {
5756 distrib_id=""
5757 distrib_ver=""
5758 distrib_ver_minor=""
5759 distrib_ver_major=""
5760
5761 # Attempt to parse lsb-release to find out distribution and version. If not
5762 # found this should fail safe (test is supported).
5763 if [[ -f /etc/lsb-release ]]; then
5764
5765 while read -r lsb_line; do
5766 case "$lsb_line" in
5767 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5768 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5769 esac
5770 done < /etc/lsb-release
5771
5772 distrib_ver_major="${distrib_ver%%.*}"
5773 distrib_ver="${distrib_ver#*.}"
5774 distrib_ver_minor="${distrib_ver%%.*}"
5775 fi
5776
5777 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5778 # processor (as the CI does) can create a race condition whereby the build
5779 # fails to see a generated file, despite that file actually having been
5780 # generated. This problem appears to go away with 18.04 or newer, so make
5781 # the out of source tests unsupported on Ubuntu 16.04.
5782 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5783}
5784
Gilles Peskine8f073122018-11-27 15:58:47 +01005785component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005786 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005787 # generates
5788 make neat
5789
Gilles Peskine8f073122018-11-27 15:58:47 +01005790 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005791 MBEDTLS_ROOT_DIR="$PWD"
5792 mkdir "$OUT_OF_SOURCE_DIR"
5793 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005794 # Note: Explicitly generate files as these are turned off in releases
5795 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005796 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005797
Gilles Peskine8f073122018-11-27 15:58:47 +01005798 msg "test: cmake 'out-of-source' build"
5799 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005800 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005801 # Also ensure that there are no error messages such as
5802 # "No such file or directory", which would indicate that some required
5803 # file is missing (ssl-opt.sh tolerates the absence of some files so
5804 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005805 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005806 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005807 cat ssl-opt.err >&2
5808 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005809 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005810 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005811 cd "$MBEDTLS_ROOT_DIR"
5812 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005813}
Andres AGdc192212016-08-31 17:33:13 +01005814
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005815component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005816 # Remove existing generated files so that we use the ones CMake
5817 # generates
5818 make neat
5819
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005820 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005821 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005822 # Note: Explicitly generate files as these are turned off in releases
5823 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005824 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005825 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005826}
Gilles Peskinea3000992022-02-04 00:21:12 +01005827support_test_cmake_as_subdirectory () {
5828 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005829}
5830
Chris Kayd259e342021-03-25 16:03:25 +00005831component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005832 # Remove existing generated files so that we use the ones CMake
5833 # generates
5834 make neat
5835
Chris Kayd259e342021-03-25 16:03:25 +00005836 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005837 cd programs/test/cmake_package
5838 cmake .
5839 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005840 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005841}
Gilles Peskinea3000992022-02-04 00:21:12 +01005842support_test_cmake_as_package () {
5843 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005844}
5845
5846component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005847 # Remove existing generated files so that we use the ones CMake
5848 # generates
5849 make neat
5850
Chris Kayd259e342021-03-25 16:03:25 +00005851 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005852 cd programs/test/cmake_package_install
5853 cmake .
5854 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005855 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005856}
Gilles Peskinea3000992022-02-04 00:21:12 +01005857support_test_cmake_as_package_install () {
5858 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005859}
5860
David Horstmann20550e32023-01-12 14:17:01 +00005861component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005862 # Make a copy of config file to use for the in-tree test
5863 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005864
5865 MBEDTLS_ROOT_DIR="$PWD"
5866 mkdir "$OUT_OF_SOURCE_DIR"
5867 cd "$OUT_OF_SOURCE_DIR"
5868
David Horstmann969c1452023-01-31 10:34:44 +00005869 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005870 cmake "$MBEDTLS_ROOT_DIR"
5871 make
5872
5873 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5874 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005875 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005876 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5877 make
5878
5879 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5880 # In the user config, disable one feature (for simplicity, pick a feature
5881 # that nothing else depends on).
5882 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5883
5884 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5885 make
5886 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5887
5888 rm -f user_config.h full_config.h
5889
5890 cd "$MBEDTLS_ROOT_DIR"
5891 rm -rf "$OUT_OF_SOURCE_DIR"
5892
5893 # Now repeat the test for an in-tree build:
5894
David Horstmann969c1452023-01-31 10:34:44 +00005895 # Restore config for the in-tree test
5896 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005897
David Horstmann969c1452023-01-31 10:34:44 +00005898 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005899 cmake .
5900 make
5901
5902 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5903 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005904 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005905 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5906 make
5907
5908 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5909 # In the user config, disable one feature (for simplicity, pick a feature
5910 # that nothing else depends on).
5911 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5912
5913 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5914 make
5915 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5916
5917 rm -f user_config.h full_config.h
5918}
5919support_build_cmake_custom_config_file () {
5920 support_test_cmake_out_of_source
5921}
5922
David Horstmann041ed422024-05-10 14:37:48 +01005923component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005924 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005925 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5926 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5927 make
5928}
5929support_build_cmake_programs_no_testing () {
5930 support_test_cmake_out_of_source
5931}
David Horstmann20550e32023-01-12 14:17:01 +00005932
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005933component_build_zeroize_checks () {
5934 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5935
5936 scripts/config.py full
5937
5938 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005939 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 +01005940}
5941
5942
Gilles Peskine8f073122018-11-27 15:58:47 +01005943component_test_zeroize () {
5944 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5945 # different combinations of compilers and optimization flags by using an
5946 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5947 # system in all cases that the script fails, so we must manually search the
5948 # output to check whether the pass string is present and no failure strings
5949 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005950
Gilles Peskine4976e822019-01-06 19:52:22 +00005951 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5952 # about a spurious message if Gdb tries and fails, so suppress that.
5953 gdb_disable_aslr=
5954 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5955 gdb_disable_aslr='set disable-randomization off'
5956 fi
5957
Gilles Peskine8f073122018-11-27 15:58:47 +01005958 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005959 for compiler in clang gcc; do
5960 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5961 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005962 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5963 grep "The buffer was correctly zeroized" test_zeroize.log
5964 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005965 rm -f test_zeroize.log
5966 make clean
5967 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005968 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005969}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005970
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005971component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00005972 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005973 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00005974 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005975
5976 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00005977 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005978}
5979
5980support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01005981 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02005982 ver="$(cmake --version)"
5983 ver="${ver#cmake version }"
5984 ver_major="${ver%%.*}"
5985
5986 ver="${ver#*.}"
5987 ver_minor="${ver%%.*}"
5988
5989 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005990}
5991
Gilles Peskinec848d222022-12-09 12:23:35 +01005992component_check_code_style () {
5993 msg "Check C code style"
5994 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00005995}
5996
Gilles Peskinec848d222022-12-09 12:23:35 +01005997support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00005998 case $(uncrustify --version) in
5999 *0.75.1*) true;;
6000 *) false;;
6001 esac
6002}
6003
Gilles Peskine8f073122018-11-27 15:58:47 +01006004component_check_python_files () {
6005 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006006 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006007}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006008
Joe Subbianid614c0b2021-07-29 11:18:29 +01006009component_check_test_helpers () {
6010 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006011 # unittest writes out mundane stuff like number or tests run on stderr.
6012 # Our convention is to reserve stderr for actual errors, and write
6013 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006014 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006015
Joe Subbiania25ffab2021-08-06 09:41:27 +01006016 msg "unit test: translate_ciphers.py"
6017 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006018}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006019
Valerio Settid9e42512024-05-06 15:59:51 +02006020component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006021 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006022 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006023 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006024 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006025
Valerio Settid8b59372024-07-02 12:02:25 +02006026 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006027
6028 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006029 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006030 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006031
Valerio Setti5beb2362024-06-24 13:13:17 +02006032 msg "build basic psasim client"
6033 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6034 msg "test basic psasim client"
6035 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006036
Valerio Setti5beb2362024-06-24 13:13:17 +02006037 msg "build full psasim client"
6038 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6039 msg "test full psasim client"
6040 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006041
Valerio Settid9e42512024-05-06 15:59:51 +02006042 make -C tests/psa-client-server/psasim clean
6043}
Jerry Yud767cc42023-03-31 15:03:55 +08006044
Valerio Setti9022f712024-06-27 07:59:39 +02006045component_test_suite_with_psasim()
6046{
6047 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006048 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006049 # Modify server's library configuration here (if needed)
6050 helper_psasim_build server
6051
Valerio Settid8b59372024-07-02 12:02:25 +02006052 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006053
6054 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006055 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006056 # PAKE functions are still unsupported from PSASIM
6057 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6058 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6059 helper_psasim_build client
6060
6061 msg "build test suites"
6062 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6063
6064 helper_psasim_server start
6065
Valerio Setti1a493832024-07-01 07:29:02 +02006066 # psasim takes an extremely long execution time on some test suites so we
6067 # exclude them from the list.
6068 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6069 export SKIP_TEST_SUITES
6070
Valerio Setti9022f712024-06-27 07:59:39 +02006071 msg "run test suites"
6072 make PSASIM=1 test
6073
6074 helper_psasim_server kill
6075}
6076
Gilles Peskine192c72f2017-12-21 15:59:21 +01006077################################################################
6078#### Termination
6079################################################################
6080
Gilles Peskine8f073122018-11-27 15:58:47 +01006081post_report () {
6082 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006083 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006084
Gilles Peskine8f073122018-11-27 15:58:47 +01006085 final_report
6086}
6087
6088
6089
6090################################################################
6091#### Run all the things
6092################################################################
6093
Gilles Peskine5d996822020-03-28 21:09:21 +01006094# Function invoked by --error-test to test error reporting.
6095pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006096 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006097 if [ $KEEP_GOING -ne 0 ]; then
6098 echo "Expect three failing commands."
6099 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006100 # If the component doesn't run in a subshell, changing error_test_i to an
6101 # invalid integer will cause an error in the loop that runs this function.
6102 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006103 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006104 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006105 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006106 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006107 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006108 make unknown_target
6109 false "this should not be executed"
6110}
6111
Gilles Peskinee48351a2018-11-27 16:06:30 +01006112# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006113run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006114 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006115 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006116
6117 # Unconditionally create a seedfile that's sufficiently long.
6118 # Do this before each component, because a previous component may
6119 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006120 local dd_cmd
6121 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6122 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006123 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006124 esac
6125 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006126
Gilles Peskineec135542021-08-02 23:14:03 +02006127 # Run the component in a subshell, with error trapping and output
6128 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006129 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006130 # We want to keep running if the subshell fails, so 'set -e' must
6131 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006132 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006133 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006134 (
6135 if [ $QUIET -eq 1 ]; then
6136 # msg() will be silenced, so just print the component name here.
6137 echo "${current_component#component_}"
6138 exec >/dev/null
6139 fi
6140 if [ $KEEP_GOING -eq 1 ]; then
6141 # Keep "set -e" off, and run an ERR trap instead to record failures.
6142 set -E
6143 trap err_trap ERR
6144 fi
6145 # The next line is what runs the component
6146 "$@"
6147 if [ $KEEP_GOING -eq 1 ]; then
6148 trap - ERR
6149 exit $last_failure_status
6150 fi
6151 )
6152 component_status=$?
6153 if [ $KEEP_GOING -eq 1 ]; then
6154 set -e
6155 if [ $component_status -ne 0 ]; then
6156 failure_count=$((failure_count + 1))
6157 fi
6158 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006159
6160 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006161 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006162 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006163}
6164
6165# Preliminary setup
6166pre_check_environment
6167pre_initialize_variables
6168pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006169
Dave Rodgman21900632024-02-26 11:41:19 +00006170setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006171pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006172pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006173pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006174
Gilles Peskine878cf602019-01-06 20:50:38 +00006175build_status=0
6176if [ $KEEP_GOING -eq 1 ]; then
6177 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006178fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006179pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006180pre_print_configuration
6181pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006182cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006183if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006184 pre_generate_files
6185fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006186
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006187# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006188for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006189 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006190done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006191unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006192for component in $RUN_COMPONENTS; do
6193 run_component "component_$component"
6194done
Gilles Peskine8f073122018-11-27 15:58:47 +01006195
6196# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006197post_report